The API reference for this function: https://documenter.getpostman.com/view/12135254/UVsQr3zh#419a6dbb-f618-4c8a-959a-420d5bac24bf
This API endpoint allows you to send an outbound SMS with a custom message from any Alive5 phone number (local or toll free) in your account to any mobile or VoIP phone number.
Before sending, youâll need the following information / variables:
AUTHORIZATION
- Value: This is your API Key you can obtain in the Alive5 Console, under Integrations.
Body
- phone_number_from: This is the Alive5 phone number in their account.
- message: the custom SMS message defined by you.
- phone_number_to: This is the end userâs mobile or VoIP phone number.
- channel_id: This is a unique UUID generated in Alive5. See below for further instructions.
- user_id: This is a unique UUID generated in Alive5. See below for further instructions.
How to get âchannel_idâ and âuser_idâ
These variables are a must have - youâll need to get them via another API endpoint: https://documenter.getpostman.com/view/12135254/UVsQr3zh#b92b1e5b-6a1c-40b8-9302-4a89165edbcf
The above will output a list of ALL channels and users in your account.
- channel_id - The âphone_number_fromâ value must have the corresponding âchannel_idâ. Each phone number is tied to a channel, so make sure these are consistent.
- user_id - When sending an outbound text, you must specify the Alive5 user who this message is sending from. If you are unsure of which user, just pick a random one in your account.
Once you have all your variables, you should able to send a text!