語(yǔ)音驗(yàn)證碼接口
功能說(shuō)明:
- 通過(guò)電話直呼到用戶手機(jī)并語(yǔ)音播放驗(yàn)證碼,海外號(hào)碼默認(rèn)最多播放 2 次,國(guó)內(nèi)(+86)號(hào)碼播放 2 次。如:您的驗(yàn)證碼是 1234。 系統(tǒng)已提供的默認(rèn)模板。
特別說(shuō)明:驗(yàn)證碼短信,請(qǐng)?jiān)谑謾C(jī)驗(yàn)證環(huán)節(jié),加入圖片驗(yàn)證碼, 以免被惡意攻擊。
為防止騷擾用戶,國(guó)內(nèi)(+86號(hào)碼段)每天22:00至次日7:30禁止發(fā)送語(yǔ)音驗(yàn)證碼。
HTTP 頭信息:
Accept:application/json;charset=utf-8; Content-Type:application/x-www-form-urlencoded;charset=utf-8;
請(qǐng)求
URL:https://voice.yunpian.com/v2/voice/send.json 訪問(wèn)方式:POST
請(qǐng)求參數(shù)
參數(shù)名 | 類型 | 是否必須 | 描述 | 示例 |
apikey | string | 是 | 用戶唯一標(biāo)識(shí),在"賬號(hào)設(shè)置"-"子帳號(hào)管理"中查看 | 9b11127a9701975c734b8aee81ee3526 |
mobile | string | 是 | 接收的手機(jī)號(hào),國(guó)際號(hào)碼需包含國(guó)際地區(qū)前綴號(hào)碼,國(guó)內(nèi)號(hào)碼可直接傳號(hào)碼 | 國(guó)內(nèi)號(hào)碼15205201314 國(guó)際號(hào)碼 +93701234567 |
code | string | 是 | 驗(yàn)證碼,支持 4~6 位阿拉伯?dāng)?shù)字 | 1234 |
language | string | 否 | 播放語(yǔ)言,非中國(guó)大陸地區(qū),默認(rèn)值為en,其中: zh:中文; en:英文; id:印尼語(yǔ); vi:越南語(yǔ); tr:土耳其語(yǔ); ru:俄語(yǔ); de:德語(yǔ); fr:法語(yǔ); it:意大利語(yǔ); pt:葡萄牙語(yǔ); es:西班牙語(yǔ); ar:阿拉伯語(yǔ)。 (中國(guó)大陸地區(qū),固定為中文播放,參數(shù)無(wú)效) | en |
uid | string | 否 | 該條短信在您業(yè)務(wù)系統(tǒng)內(nèi)的 ID,如訂單號(hào)或者短信發(fā)送記錄流水號(hào)。默認(rèn)不開(kāi)放,如有需要請(qǐng)聯(lián)系客服申請(qǐng)。 | 10001 |
callback_url | string | 否 | 本條語(yǔ)音驗(yàn)證碼狀態(tài)報(bào)告推送地址。 如推送地址固定,建議在"數(shù)據(jù)推送與獲取”做批量設(shè)置。 | http://your_receive_url_address |
附注:該接口加密時(shí),需對(duì)手機(jī)號(hào)和驗(yàn)證碼同時(shí)加密。
響應(yīng)
名稱 | 類型 | 描述 |
count | integer | 成功發(fā)送的語(yǔ)音呼叫次數(shù) |
fee | integer | 扣費(fèi)金額,一次語(yǔ)音驗(yàn)證碼呼叫扣一條短信 |
sid | string | 記錄 id,不超過(guò)32 位的唯一字符串 |
Json 返回示例:
調(diào)用成功的返回示例:
{ "count": 1, "fee": 1, "sid": "3375655611" }
調(diào)用失敗的返回示例:
{ "http_status_code": 400, "code": 22, "msg": "驗(yàn)證碼類短信1小時(shí)內(nèi)同一手機(jī)號(hào)發(fā)送次數(shù)不能超過(guò)3次", "detail": "驗(yàn)證碼類短信1小時(shí)內(nèi)同一手機(jī)號(hào) 15841153871 發(fā)送次數(shù)不能超過(guò)3次" }
防騷擾過(guò)濾
過(guò)濾規(guī)則:同一個(gè)手機(jī)號(hào)碼,30 秒內(nèi)最多發(fā)送 1 次,1小時(shí)內(nèi)最多發(fā)送 3 次,24小時(shí)內(nèi)最多發(fā)送 5次。
語(yǔ)言對(duì)照表
language | 語(yǔ)言 | 播放內(nèi)容 |
zh | 中文 | 您的驗(yàn)證碼是1-2-3-4 |
en | 英文 | Your verification code is?1-2-3-4 |
id | 印尼語(yǔ) | Kode verifikasi Anda adalah?1-2-3-4 |
vi | 越南語(yǔ) | M? xác minh c?a b?n là?1-2-3-4 |
tr | 土耳其語(yǔ) | Do?rulama kodunuz?1-2-3-4 |
ru | 俄語(yǔ) | Ваш проверочный код?1-2-3-4 |
de | 德語(yǔ) | Ihr Best?tigungscode lautet?1-2-3-4 |
fr | 法語(yǔ) | Votre code de vérification est?1-2-3-4 |
it | 意大利語(yǔ) | Il tuo codice di verifica è?1-2-3-4 |
pt | 葡萄牙語(yǔ) | O seu código de verifica??o é?1-2-3-4 |
es | 西班牙語(yǔ) | Su código de verificación es 1-2-3-4 |
ar | 阿拉伯語(yǔ) | ??? ?????? ????? ?? ?? 1-2-3-4 |