{
"id": "<string>",
"to": "+16315551111",
"verificationCode": "123456",
"language": "en",
"regionCode": "US",
"totalSegments": 1,
"totalPrice": 0.05,
"currency": "USD",
"status": "sent",
"errorCode": "<string>",
"createTime": "2022-03-01T12:00:00.000Z",
"updateTime": "2022-03-01T12:00:00.000Z",
"externalId": "<string>",
"callbackUrl": "https://httpbin.org/anything?tag=api-voice",
"bizType": "voice",
"verificationId": "VERIFICATION-ID"
}Send a voice code
Sends an outbound voice call verification code.
{
"id": "<string>",
"to": "+16315551111",
"verificationCode": "123456",
"language": "en",
"regionCode": "US",
"totalSegments": 1,
"totalPrice": 0.05,
"currency": "USD",
"status": "sent",
"errorCode": "<string>",
"createTime": "2022-03-01T12:00:00.000Z",
"updateTime": "2022-03-01T12:00:00.000Z",
"externalId": "<string>",
"callbackUrl": "https://httpbin.org/anything?tag=api-voice",
"bizType": "voice",
"verificationId": "VERIFICATION-ID"
}Body
Voice call request that needs to be sent.
The recipient's phone number in E.164 format.
"+16315551111"
ISO 639 Language Code. If not specified, language will be set as en by default. Notably, in certain countries or regions, language will be automatically set as the local language due to the regional restrictions.
Applicable languages:
ar: Arabic
de: German
en: English
es: Spanish
fr: French
id: Indonesian
it: Italian
pt: Portuguese
ru: Russian
tr: Turkish
vi: Vietnamese
zh: Chinese
"en"
Delivery report URL. You can provide a URL, and we will push the updated status report to your server in time. e.g., https://httpbin.org/anything?tag=api. Note: We recommend configuring Webhook Endpoints instead.
"https://httpbin.org/anything?tag=api-voice"
Response
The request is successfully accepted.
The recipient's phone number in E.164 format.
"+16315551111"
"en"
"US"
Price currency. ISO 4217 currency code.
"USD"
Delivery status. One of accepted, sent, delivered, undelivered, or failed.
accepted: The messaging request is accepted by our system.failed: The message failed to be sent from our system.sent: The message has been sent from our system.delivered: Our system has received a delivery receipt indicating that message is delivered.undelivered: Our system has received a delivery receipt indicating that message is not delivered.
accepted, failed, sent, delivered, undelivered "sent"
The time at which this message was created, formatted in RFC 3339. e.g., 2022-03-01T12:00:00.000Z.
"2022-03-01T12:00:00.000Z"
The time at which the delivery report for this message was updated, formatted in RFC 3339. e.g., 2022-03-01T12:00:00.000Z.
"2022-03-01T12:00:00.000Z"
Delivery report URL. You can provide a URL, and we will push the updated status report to your server in time. e.g., https://httpbin.org/anything?tag=api. Note: We recommend configuring Webhook Endpoints instead.
"https://httpbin.org/anything?tag=api-voice"

