Sign in

v1

latestOpenAPI 3.0.02026-07-2491237338.9 KB
SMS

Send an SMS

Sends an outbound text message.

post/sms

Request body

tostring required

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

textstring required

The text of this message.

senderIdstring

Sender ID to be used.

signaturestring

This parameter is only required for Chinese mainland SMS messages. You must specify an approved signature such as Brand. It will be added to the beginning of SMS body and wrapped with 【】, e.g. 【Brand】Your verification code is 123456.

externalIdstring

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.

callbackUrlstring

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 request

{
  "to": "+16315551111",
  "text": "Your verification code is 123456.",
  "senderId": "Brand",
  "signature": "Brand",
  "callbackUrl": "https://httpbin.org/anything?tag=api-sms"
}

Response

The request is successfully accepted.

idstring required

Unique ID for the object.

tostring required

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

textstring

The text of this message.

senderIdstring

Sender ID to be used.

regionCodestring

ISO 3166-1 alpha-2 country code

totalSegmentsinteger

Number of message segments. See SMS character encoding for more info.

totalPricenumber double

Total price of this message.

currencystring

Price currency. ISO 4217 currency code.

status'accepted' | 'failed' | 'sent' | 'delivered' | 'undelivered'

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.
errorCodestring

Error code when the message is undeliverable.

createTimestring date-time

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

updateTimestring 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.

externalIdstring

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.

callbackUrlstring

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.

bizTypestring

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

  • sms: Indicates that the message is sent via the SMS product.
  • verify: Indicates that the message is sent via the Verify product.
verificationIdstring

The verification ID. Included only when bizType is verify.

Example response

{
  "to": "+16315551111",
  "text": "Your verification code is 123456.",
  "senderId": "Brand",
  "regionCode": "US",
  "totalSegments": 1,
  "totalPrice": 0.0085,
  "currency": "USD",
  "status": "sent",
  "createTime": "2022-03-01T12:00:00.000Z",
  "updateTime": "2022-03-01T12:00:00.000Z",
  "callbackUrl": "https://httpbin.org/anything?tag=api-sms",
  "bizType": "sms",
  "verificationId": "VERIFICATION-ID"
}