> For the complete documentation index, see [llms.txt](https://docs.innopaas.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.innopaas.com/api-reference/api-reference-en/sms-api/sms-api-interface-v3.0.md).

# SMS-API Interface V3.0

## Send Message

#### **Request API URL**

```
POST    https://api.innopaas.com/api/sms/v3/msg/send
```

#### **Request Parameters**

<table data-header-hidden><thead><tr><th width="114.8203125"></th><th width="121.640625"></th><th width="63.59765625"></th><th></th></tr></thead><tbody><tr><td>Field</td><td>Data Type</td><td>Required</td><td>Description</td></tr><tr><td>mobile<br></td><td>String</td><td>Yes</td><td>Phone number, format (country code + phone number), for example: 8615800000000, where 86 is China's country code; do not prefix the country code with 00. 15800000000 is the real recipient phone number. 5-20 characters <strong>Supports multiple; separate multiple entries with commas</strong></td></tr><tr><td>msg</td><td>String</td><td>Yes</td><td>SMS content; length must not exceed 2000 characters</td></tr><tr><td>senderId</td><td>String</td><td>No</td><td>The sender displayed to the user after receiving the SMS. Customization is not supported domestically; supported abroad but requires prior registration and coordination with carriers. Please confirm specifics with TIG contact.</td></tr><tr><td>uid</td><td>String</td><td>No</td><td>Customer-defined batch number, within 64 characters</td></tr><tr><td>callBackUrl<br></td><td>String</td><td>No</td><td>Callback URL for status receipts. Please provide the full address including the http protocol header. If not provided, default is empty. Do not include spaces, as that will cause push address errors. The address can be provided via the API parameter or configured manually in the console.</td></tr></tbody></table>

#### **Request Example (verification code)**

```json
{
  "msg": "ongratulations! Your application has been approved. ",
  "mobile": "13800138000,13900139000",
  "senderId": "10690000",
  "uid": "ORDER_20251104_001",
  "callBackUrl": "https://api.example.com/callback/sms"
}
```

#### **Response Example**

```json

{
    "code": "0",
    "message": "Submission successful",
    "data": {
        "messageId": "162575412960104448"
    }
}
```

## Status Report<br>

<mark style="color:red;">To be supplemented</mark>

## Error Code

### API Response Code

<table><thead><tr><th width="204.015625">Status Code</th><th>Description</th></tr></thead><tbody><tr><td>0</td><td>Submission Successful</td></tr><tr><td>101</td><td>Account Does Not Exist</td></tr><tr><td>102</td><td>Incorrect Password</td></tr><tr><td>103</td><td>Pull count format error</td></tr><tr><td>104</td><td>Pull count not within range</td></tr><tr><td>105</td><td>Batch number exceeds 128 bits</td></tr><tr><td>106</td><td>SMS content length error (>3000)</td></tr><tr><td>108</td><td>Phone number format error (>20 or &#x3C;5)</td></tr><tr><td>109</td><td>Incorrect number of phone numbers</td></tr><tr><td>112</td><td>Product configuration error</td></tr><tr><td>114</td><td>Request IP does not match bound IP</td></tr><tr><td>115</td><td>Domestic SMS permission not enabled</td></tr><tr><td>116</td><td>Account deleted or disabled</td></tr><tr><td>117</td><td>Access number length exceeds 20 characters</td></tr><tr><td>119</td><td>Account not on current node</td></tr><tr><td>123</td><td>SMS content cannot be empty</td></tr><tr><td>124</td><td>Synopsis or verification code cannot be empty</td></tr><tr><td>125</td><td>A specific customer's phone number cannot exceed ten times per day</td></tr><tr><td>128</td><td>Account length error (>50 or &#x3C;=0)</td></tr><tr><td>129</td><td>Product price configuration error</td></tr><tr><td>130</td><td>Unknown Exception</td></tr><tr><td>131</td><td>Exceeded daily sending limit</td></tr><tr><td>132</td><td>Exceeded monthly sending limit</td></tr><tr><td>133</td><td>Exceeded sending limit</td></tr><tr><td>134</td><td>Exceeded anti-complaint limit</td></tr><tr><td>150</td><td>Sub-account attached billing configuration error</td></tr><tr><td>151</td><td>Quoted country not enabled</td></tr><tr><td>152</td><td>Product account quote does not exist</td></tr><tr><td>153</td><td>Main account for attached billing does not exist</td></tr><tr><td>154</td><td>Product account billing method does not exist</td></tr><tr><td>155</td><td>Account has not enabled unified billing</td></tr><tr><td>156</td><td>Product account disabled</td></tr><tr><td>157</td><td>Insufficient account balance</td></tr><tr><td>158</td><td>Insufficient credit limit</td></tr><tr><td>159</td><td>Customer has not enabled unified wallet</td></tr></tbody></table>

### Status Report Error Codes

| Status Code | Description                              |
| ----------- | ---------------------------------------- |
| DELIVRD     | SMS sent successfully                    |
| UNKNOWN     | Unknown SMS status                       |
| REJECTD     | SMS was rejected by the message center   |
| MBBLACK     | Destination number is a blacklist number |
| SM11        | Gateway verified number format error     |
| SM12        | Our side verified number format error    |
| Other       | Gateway internal status                  |

## Billing Rules Explanation

1. International SMS does not support emoji
2. Spaces in the editor are represented as ".". If a space without "." appears, it indicates hidden code and may cause one SMS to be counted as two. Please be aware.
3. International numbers must include the corresponding country's area code, for example Chinese number 86138\*\*\*\*1234, where 86 is the China country code.
4. When sending to Chinese numbers, the SMS content must start with \[signature]. The signature content is: company or brand name, length requirement 2-80 characters; carriers require this field.
5. When sending to Chinese number ranges, content must be legal; cannot send content strictly prohibited by national laws and regulations such as real estate, invoices, immigration, etc.
6. Please include hyperlinks in the SMS content for verification. Some Android systems have hyperlink recognition issues; add spaces before and after the hyperlink.
7. Messages containing non-English characters are billed as Chinese.