Send a Voice Message

The fastest way to send your first voice message is to try out the Voice API Explorer below. If you have your credentials, follow the instructions to use TeleSign’s Voice API for the first time. You will also be able to get a code snippet for the request in the language of your choice.

Voice API Explorer
NOTE: When using the Voice API Explorer, you will be charged your contracted rate for each transaction. The time shown in ms is not indicative of regular transmission rates, and only applies to the SMS API Explorer.
Send requests directly from the browser (CORS must be enabled)
$$.env
No $$.env variables are being used in this request.

Use these instructions with the Voice API Explorer (above) to send a voice request and get a code snippet for making the request in the language of your choice.

  1. Click the Auth [basic] tab.
  2. In the Username field, put your customer ID.
  3. In the Password field, put your API key.
  4. Click the Body tab.
  5. In the phone_number field, enter your complete phone number including the country code. Do not include any special characters or spaces.
  6. Click Send.
  7. If you want the code for your request, so you can see how this request is implemented using basic authentication, click the Code Generation tab and use the Language and Library drop-downs to choose the language you want your code snippet in. The Language drop-down shows you what languages you can generate code in, and the Library drop-down shows you what libraries you could use to create the code.
  8. After you send your request, you will see the Body tab and a JSON response. Look through the JSON response and save the value for the reference_id parameter. You will need this to receive transaction status results, described on the Obtain Transaction Status Results page.

Congratulations! You’ve sent your first voice message using TeleSign’s Voice API and generated your first code snippet!

Here are a few extra details about the pre-populated parameters:

  • message - You use the message parameter to provide your message. TeleSign APIs work with UTF-8 encoded strings.
  • message_type - When you send messages, for compliance purposes, you must label the kind of message you are sending. You can choose from:
    • ARN - Alerts, reminders, and notifications
    • MKT - Marketing messages such as promotions and coupons
    • OTP - For messages where you send a verification code only
  • phone_number - The phone number you want to send a message to.

You can see more about available parameters for requests on the Voice Request (POST v1/voice) page.

The rest of this page details the different ways you can send a voice message with TeleSign’s Voice API. You can choose from these options:

Voice API Information

This section provides general information about the Voice API. Requests for the Voice API:

  • Can be authenticated with Basic (easiest to implement) and Digest.
  • Use https://rest-api.telesign.com/v1/voice as the base endpoint.
  • Accept only UTF-8 encoded unicode characters as inputs.
  • Use Content-Type application/x-www-form-urlencoded in request headers.

Examples

You use a POST request to send your voice message.

POST Request Example
POST https://rest-api.telesign.com/v1/voice HTTP/1.1
Authorization: Basic 12345678-9ABC-DEF0-1234-56789ABCDEF0:51p3DmaSH8oSfV0yHdAp9HNgifg=
Content-Type: application/x-www-form-urlencoded

phone_number=15555551212&message=Your message here.&account_lifecycle_event=create&originating_ip=203.0.113.45

Here is an example response to your POST request:

POST Response Body
{
"reference_id": "ABCDEF0123456789ABCDEF0123456789",
"status": {
   "updated_on": "2017-02-28T19:02:31Z",
   "code": 103,
   "description": "Call in progress",   
 },
"voice": "f-en-GB",
}

Next Steps

This section offers some suggestions for next steps to take: