API Reference
Help Center

Send an SMS

post
https://api.ycloud.com/v2/sms

Sends an outbound text message.

Body Params

SMS request that needs to be sent.

string
required

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

string
required

The text of this message.

string

Sender ID to be used.

string

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.

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.

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.

Response

Updated 12 months ago

Language
Credentials
Header
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
Updated 12 months ago