Skip to main content
POST

Authorizations

​
X-API-Key
string
header
required

Body

application/json

Voice call request that needs to be sent.

​
to
string
required

The recipient's phone number in E.164 format.

Example:

"+16315551111"

​
verificationCode
string
required

The verification code to be sent, 4 to 6 digits.

Example:

"123456"

​
language
string

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

Example:

"en"

​
externalId
string

A unique (recommended) string to reference the object. This can be an order number or similar, and can be used to reconcile the object with your internal systems.

​
callbackUrl
string

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.

Example:

"https://httpbin.org/anything?tag=api-voice"

Response

200 - application/json

The request is successfully accepted.

​
id
string
required

Unique ID for the object.

Required string length: 6 - 128
​
to
string
required

The recipient's phone number in E.164 format.

Example:

"+16315551111"

​
verificationCode
string

The verification code to be sent, 4 to 6 digits.

Example:

"123456"

​
language
string

ISO 639 Language Code.

Example:

"en"

​
regionCode
string

ISO 3166-1 alpha-2 country code.

Example:

"US"

​
totalSegments
integer<int32>

Number of message segments. It's always 1 for voice calls.

Required range: x >= 1
Example:

1

​
totalPrice
number<double>

Total price of this message.

Example:

0.05

​
currency
string

Price currency. ISO 4217 currency code.

Example:

"USD"

​
status
enum<string>

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.
Available options:
accepted,
failed,
sent,
delivered,
undelivered
Example:

"sent"

​
errorCode
string

Error code when the message is undeliverable.

​
createTime
string<date-time>

The time at which this message was created, formatted in RFC 3339. e.g., 2022-03-01T12:00:00.000Z.

Example:

"2022-03-01T12:00:00.000Z"

​
updateTime
string<date-time>

The time at which the delivery report for this message was updated, formatted in RFC 3339. e.g., 2022-03-01T12:00:00.000Z.

Example:

"2022-03-01T12:00:00.000Z"

​
externalId
string

A unique (recommended) string to reference the object. This can be an order number or similar, and can be used to reconcile the object with your internal systems.

​
callbackUrl
string

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.

Example:

"https://httpbin.org/anything?tag=api-voice"

​
bizType
string

This can be either empty or one of voice, or verify. Defaults to voice.

  • voice: Indicates that the message is sent via the Voice product.
  • verify: Indicates that the message is sent via Verify product.
Example:

"voice"

​
verificationId
string

The verification ID. Included only when bizType is verify.

Example:

"VERIFICATION-ID"