{
"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"
}SMS
Send an SMS
Sends an outbound text message.
POST
https://api.ycloud.com/v2
/
sms
{
"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"
}Authorizations
Body
application/json
SMS request that needs to be sent.
The text of this message.
Example:
"Your verification code is 123456."
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.
Example:
"Brand"
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.
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-sms"
Response
200 - application/json
The request is successfully accepted.
Unique ID for the object.
Required string length:
6 - 128The text of this message.
Example:
"Your verification code is 123456."
Sender ID to be used.
Example:
"Brand"
Example:
"US"
Number of message segments. See SMS character encoding for more info.
Required range:
x >= 1Example:
1
Total price of this message.
Example:
0.0085
Price currency. ISO 4217 currency code.
Example:
"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.
Available options:
accepted, failed, sent, delivered, undelivered Example:
"sent"
Error code when the message is undeliverable.
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.
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-sms"
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.
Example:
"sms"
The verification ID. Included only when bizType is verify.
Example:
"VERIFICATION-ID"