發(fā)送短信 API
共 2165字，需瀏覽 5分鐘
·
2023-04-19 15:14
使用該接口發(fā)送文本短信至一個(gè)或多個(gè)收件人。閱讀本文檔前請(qǐng)先閱讀 API 通用說明。
接口定義
- 接口名：
sms.message.send - HTTP Method：
POST - Content-Type：
application/json
請(qǐng)求參數(shù) (Body)
| 參數(shù)名 | 類型 | 是否必填 | 描述 | 示例值 |
|---|---|---|---|---|
| to | string | string[] | 是 | 收件手機(jī)號(hào)，國(guó)際手機(jī)號(hào)使用 E.164 格式 | 18688061234 |
| signature | string | 是 | 短信簽名，2-16 個(gè)字符 | 合一短信 |
| content | string | 否 | 短信正文文本，templateId或content二選一 | 您的驗(yàn)證碼是9153，15分鐘內(nèi)有效。 |
| templateId | string | 否 | 短信模板 ID 或自定義模板碼，templateId或content二選一 | login_notify |
| templateData | JSON | 否 | 模板變量 | {"code": "9153", "ttl": "15"} |
* 注：為幫助開發(fā)者快速遷移，UniSMS支持使用 content 參數(shù)直接傳入文本，新接入用戶建議優(yōu)先使用 templateId 傳參
請(qǐng)求示例
curl -X POST 'https://uni.apistd.com/?action=sms.message.send&accessKeyId=YOUR_ACCESS_KEY_ID' \
-H 'Content-Type: application/json' \
-d '{
"to": "1860571xxxx",
"signature": "合一短信",
"templateId": "signup",
"templateData": {"code": "3241", "ttl": "10"}
}'響應(yīng)參數(shù) (Body)
| 參數(shù)名 | 類型 | 描述 | 示例值 |
|---|---|---|---|
| code | string | 返回碼 | 105400 |
| message | string | 返回信息 | InsufficientFunds |
| data | JSON | 返回結(jié)果 |
返回結(jié)果 (data)
| 參數(shù)名 | 類型 | 描述 | 示例值 |
|---|---|---|---|
| status | string | 發(fā)送狀態(tài) | sent |
| recipients | integer | 收件人個(gè)數(shù) | 1 |
| messageCount | integer | 計(jì)費(fèi)消息總條數(shù) | 1 |
| totalAmount | number | 總消費(fèi)金額 | 0.045 |
| payAmount | number | 支付消費(fèi)金額 | 0.045 |
| virtualAmount | number | 虛擬消費(fèi)金額 | 0 |
| messages | JSON[] | 發(fā)送消息報(bào)告 |
發(fā)送消息報(bào)告 (data.messages)
| 參數(shù)名 | 類型 | 描述 | 示例值 |
|---|---|---|---|
| id | string | 消息標(biāo)識(shí) | 7cf4b5c12c5ad49379ce07290d9b00bb |
| to | string | 收件人手機(jī)號(hào) (E.164) | +8618688061234 |
| regionCode | string | 國(guó)際代碼 | CN |
| countryCode | string | 國(guó)際電話區(qū)號(hào) | 86 |
| messageCount | integer | 計(jì)費(fèi)消息總條數(shù) | 1 |
| status | string | 發(fā)送狀態(tài) | sent |
| upstream | string | 短信上游 | emay.standard |
| price | string | 消費(fèi)金額 | 0.040000 |
響應(yīng)示例
成功響應(yīng)示例
Status Code: 200, Response Body:
{
"code": "0",
"message": "Success",
"data": {
"recipients": 2,
"messageCount": 2,
"totalAmount": "0.187500",
"payAmount": "0.187500",
"virtualAmount": "0",
"messages": [
{
"id": "4e88293e50aac21d027a9d6c0f33661e",
"to": "+8618688061234",
"regionCode": "CN",
"countryCode": "86",
"messageCount": 1,
"status": "sent",
"upstream": "emay.standard",
"price": "0.050000"
},
{
"id": "ce02a6c4195c6f8c4b6a7250ccb3b0a1",
"to": "+12894260331",
"regionCode": "CA",
"countryCode": "1",
"messageCount": 1,
"status": "sent",
"upstream": "emay.intl.standard",
"price": "0.137500"
}
]
}
}失敗響應(yīng)示例
Status Code: 400, Response Body:
{
"code": "105400",
"message": "InsufficientFunds"
}評(píng)論
圖片
表情