/data/send_sms_otp
1.API Specification
2.Request Params
3.Response Params
4.Error Codes
5.Sample
1.API Specification
This API is used to send an OTP SMS.
Request Method
POST
Request URL
https://cloudapi.peru.accuauth.com/data/send_sms_otp
Debugging Tool
2.Request Params
2.1 Request Header
| Parameter | Type | Required | Description |
|---|---|---|---|
| X-DF-API-ID | string | Yes | For API credentials，Please visit API Request |
| X-DF-API-SECRET | string | Yes | For API credentials，Please visit API Request |
2.2 Request Body
| Fields | Type | Description | |
|---|---|---|---|
| required | phone_number | string | The mobile number to receive SMS |
| optional | template_id | string | The template ID, please contact us to apply for a template |
| optional | content | string | Variable names and parameter values in the template, multiple values are separated by ",". For example: code:1234,expire_at:5 |
3.Response Params
| Fields | Type | Description |
|---|---|---|
| request_id | string | Unique id of each request |
| status | string | Response status, OK if request success, other if failed; See Error Codes for details |
| charge_info | object | Charge info，See 3.1 belowed for details |
3.1 Elements in charge_info:
| Fields | Type | Description |
|---|---|---|
| charge | integer | The number of billed messages. A SMS supports up to 160 characters, or up to 70 if the message contains one or more Unicode characters. Long message will be sent as two or more messages. |
Response Syntax
{
"status": "OK",
"charge_info": {
"charge": 1
},
"request_id": "TIDf374ebf432c34fa8840c9fa75b7b8df2"
}
4.Error Codes
Common error codes of this API:
| Http Status Code | Status field |
Description |
|---|---|---|
400 |
FAILED | SMS sending failed, see reason field for details |
400 |
INVALID_ARGUMENT | Request parameter is invalid |
401 |
UNAUTHORIZED | Unauthorized or access is denied |
401 |
KEY_EXPIRED | Your API ID has expired |
403 |
NO_PERMISSION | You are not authorized to use this API |
403 |
OUT_OF_QUOTA | API calls quota exceeded |
403 |
RATE_LIMIT_EXCEEDED | API request frequency exceeds the limit |
404 |
NOT_FOUND | Requested API cannot be found |
500 |
INTERNAL_ERROR | Internal server error |
Comment: Please see the reason field for details when the above 40X error occurred
Response Syntax
{
"status": "INVALID_ARGUMENT",
"reason": "argument 'phone_number': not found",
"request_id": "TID0bb59f6aa6454717b870b16202ccf36f"
}