{
"id": "<string>",
"to": "+16315551111",
"text": "Your verification code is 123456.",
"senderId": "Brand",
"regionCode": "US",
"totalSegments": 1,
"totalPrice": 0.0085,
"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-sms",
"bizType": "sms",
"verificationId": "VERIFICATION-ID"
}Send an SMS
Sends an outbound text message.
{
"id": "<string>",
"to": "+16315551111",
"text": "Your verification code is 123456.",
"senderId": "Brand",
"regionCode": "US",
"totalSegments": 1,
"totalPrice": 0.0085,
"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-sms",
"bizType": "sms",
"verificationId": "VERIFICATION-ID"
}Body
SMS request that needs to be sent.
The recipient's phone number in E.164 format.
"+16315551111"
The text of this message.
"Your verification code is 123456."
Sender ID to be used.
"Brand"
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-sms"
Response
The request is successfully accepted.
The recipient's phone number in E.164 format.
"+16315551111"
"US"
Number of message segments. See SMS character encoding for more info.
x >= 11
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-sms"

