發(fā)送語音驗(yàn)證碼 API
共 1541字，需瀏覽 4分鐘
·
2023-04-19 15:15
使用該接口發(fā)送語音驗(yàn)證碼 (撥打電話) 至一個(gè)接收人。閱讀本文檔前請(qǐng)先閱讀 API 通用說明。
接口定義
- 接口名：
sms.voice.verification.send - HTTP Method：
POST - Content-Type：
application/json
請(qǐng)求參數(shù) (Body)
| 參數(shù)名 | 類型 | 是否必填 | 描述 | 示例值 |
|---|---|---|---|---|
| to | string | 是 | 接聽人手機(jī)號(hào) | 18509872103 |
| code | string | 是 | 驗(yàn)證碼，為 4 或 6 位數(shù)字 | 5201 |
* 注：暫不支持使用國際手機(jī)號(hào)
請(qǐng)求示例
curl -X POST 'https://uni.apistd.com/?action=sms.voice.verification.send&accessKeyId=YOUR_ACCESS_KEY_ID' \
-H 'Content-Type: application/json' \
-d '{
"to": "1850987xxxx",
"code": "5201"
}'響應(yīng)參數(shù) (Body)
| 參數(shù)名 | 類型 | 描述 | 示例值 |
|---|---|---|---|
| code | string | 返回碼 | 101301 |
| message | string | 返回信息 | 未設(shè)置有效的上游服務(wù)商 |
| 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.05 |
| payAmount | number | 支付消費(fèi)金額 | 0.05 |
| messages | JSON[] | 發(fā)送語音報(bào)告 |
發(fā)送語音報(bào)告 (data.messages)
| 參數(shù)名 | 類型 | 描述 | 示例值 |
|---|---|---|---|
| id | string | 語音標(biāo)識(shí) | 7086bf2f0c2e944b15b08897277d8414 |
| to | string | 接聽人手機(jī)號(hào) (E.164) | +8618509872103 |
| regionCode | string | 國際代碼 | CN |
| countryCode | string | 國際電話區(qū)號(hào) | 86 |
| messageCount | integer | 計(jì)費(fèi)語音總條數(shù) | 1 |
| status | string | 發(fā)送狀態(tài) | sent |
| upstream | string | 短信上游 | monyun.standard |
| price | string | 消費(fèi)金額 | 0.050000 |
響應(yīng)示例
成功響應(yīng)示例
Status Code: 200, Response Body:
{
"data": {
"recipients": 1,
"messageCount": 1,
"totalAmount": "0.050000",
"payAmount": "0.050000",
"virtualAmount": "0",
"messages": [
{
"id": "7086bf2f0c2e944b15b08897277d8414",
"to": "+8618509872103",
"regionCode": "CN",
"countryCode": "86",
"messageCount": 1,
"status": "sent",
"upstream": "monyun.standard",
"price": "0.050000"
}
]
},
"code": "0",
"message": "Success"
}失敗響應(yīng)示例
Status Code: 400, Response Body:
{
"code": "101301",
"message": "未設(shè)置有效的上游服務(wù)商"
}評(píng)論
圖片
表情