Send Your First Voice Notification

Create a template and submit it for review

Call content is defined by a template. Create a text template on the Template Management page of the Console voice product console (variables use ordinal placeholders such as {1} and {2}), or create one via the Template API; once the review is passed, the status becomes Approved — note down the templateId. For details, see Using the Voice Console.

Confirm the template country

The country/region (alpha-2 code) bound at template creation determines routing and billing for the call; no country code is needed in the send request. See Country/Region Codes.

Place the call

Call the send API, replacing {BASE_URL} with your access endpoint and {API_KEY} with your API Key:

curl -X POST '{BASE_URL}/open/v1/voice/notify/batch' \
  -H 'Authorization: Bearer {API_KEY}' \
  -H 'Content-Type: application/json;charset=utf-8' \
  -d '{
    "bulkId": "first-voice-call-001",
    "messages": [
      {
        "templateId": "Tpl_0001",
        "destinations": [
          { "to": "8613800138000", "variables": ["John", "A12345"] }
        ]
      }
    ]
  }'

The variables array maps in order to the template placeholders {1}…{n}; omit it if the template has no variables. The call country is derived from the template — no country code is required in the request.

A returned code of 000000 means the request was accepted. Note down data.callId for later troubleshooting:

{
  "code": "000000",
  "message": "success",
  "data": {
    "bulkId": "first-voice-call-001",
    "callId": "YYYX931******64224",
    "acceptedCount": 1
  }
}

View the send results

View call details (call result, release code, call duration, initiation time) on the Send Records page of the Console voice product console, with filtering by recipient number and call result. You can also call the send-record query API to fetch call records by task or number — see Voice Message.