SMS Send
Latest Update Time: 2022.01.05 Support For Submitting SMS Content To Multiple Mobile Phone Numbers, See Request Parameters For Details.
Note: To Ensure The Stability Of The Interface, Up To 50 Mobile Phone Numbers Can Be Submitted At The Same Time.
Interface Description
Request URL: https://www.xiaoxiaoji.com/api.sms/send.html
Request Method: POST
Parameter Type: JSON
Request Parameter
Name | ID | Type | Required | Description |
---|---|---|---|---|
Username | username | String | Yes | Login Username When Registering |
Key | token | String | Yes | Generated And Issued By The System After Opening The Interface Authority, View It In User Center - My Information |
Phone Number | phone | String | Yes | Support Up To 50 Mobile Phone Numbers Submitted At The Same Time, Use "," To Separate Multiple Numbers |
Calling Number | caller | String | No | Modifiable, the default is the caller set by the system |
Content | text | Text | Yes | Please Use URL Encoding For SMS Content |
Currency Type | currency | String | No | usd:USD,hkd:Hong Kong Dollar,Default: usd |
Area Code | acode | String | Yes | View It In User Center - SMS Pricing, Example: 0086 |
Rate Type | rate | String | Yes | View It In User Center - SMS Pricing, Example: PRM |
Rate Route | route | String | Yes | View It In User Center - SMS Pricing, Example: 6x |
Request Example
{ "username": "admin", "token": "123123123", "phone": "8613999999999,8613888888888,8613777777777", "caller": "85228828198", "text": "Your SMS verification code is 123123, please complete the operation within ten minutes!", "currency": "usd", "acode": "0086", "rate": "OTP", "route": "6x" }
Return Parameter
Name | ID | Description |
---|---|---|
Status Code | code | 1: Success, Other: Failure,For More Information, Please See The Status Code Description |
Data | data | Return On Success, Return Data |
Message | msg | Return On Failure, Failure Description |
Message ID | id | SMS System ID, Which Needs To Be Stored To Request The Status Of The SMS |
Phone Number | phone | Called Number |
Submit Status | code | 1: Submit Successfully, 0: Submit Failed |
Return Example
Request Succeeded
{ "code": 1, "data": [ { "id": "61CBF9DD0016537A", "phone": "8613999999999", "code": 1 }, { "id": "61CBF9DD0016537B", "phone": "8613888888888", "code": 0 }, { "id": "61CBF9DD0016537C", "phone": "8613777777777", "code": 1 } ] }
Request Failed
{ "code": 500, "msg": "System Error" }
Status Code Description
Status Code | Description |
---|---|
1 | Request Succeeded |
0 | Request Failed |
500 | System Error |
502 | No Interface Usage Rights |
503 | IP Is Not In The System Whitelist |
511 | Authentication Failed |
404 | Data Does Not Exist |
101 | Unsupported Currency Type |
102 | Incorrect Phone Number Parameter |
103 | Message Content Error |
105 | Rate Type Error |
106 | Rate Route Error |
107 | The Rate Type Does Not Match The Route |
108 | Submit Up To 50 Mobile Phone Numbers At The Same Time |
109 | Insufficient Balance |