添加模版
HTTP 頭信息:
Accept:application/json;charset=utf-8;
Content-Type:application/x-www-form-urlencoded;charset=utf-8;
請(qǐng)求
URL:`https://sms.yunpian.com/v2/tpl/add.json`
注意:海外服務(wù)器地址 us.yunpian.com
訪問方式:POST
請(qǐng)求參數(shù)
參數(shù)名 | 類型 | 是否必須 | 描述 | 示例 |
apikey | string | 是 | 用戶唯一標(biāo)識(shí),在"賬號(hào)設(shè)置"-"子帳號(hào)管理"中查看 | 9b11127a9701975c734b8aee81ee3526 |
tpl_content | string | 是 | 模板內(nèi)容。當(dāng)region參數(shù)傳入global時(shí),模板必須以帶符號(hào)【】的簽名開頭 | 【云片網(wǎng)】您的驗(yàn)證碼是#code# |
region | string | 是 | 國(guó)際模板可發(fā)地區(qū)。其中: abroad:除中國(guó)大陸外的國(guó)家及地區(qū); global:全球。 (美國(guó)、加拿大、臺(tái)灣、馬來西亞等地報(bào)備需要2-5個(gè)工作日) | abroad |
tpl_type | integer | 否 | 1 代表驗(yàn)證碼類模板。當(dāng)region為global且模板類型為驗(yàn)證碼類模板時(shí),此參數(shù)必傳1; 0 代表通知類模板; (僅適用于系統(tǒng)子號(hào),營(yíng)銷子號(hào)無需傳此參數(shù),默認(rèn)都是營(yíng)銷類模板) | 1 |
website | string | 否 | 驗(yàn)證碼類模板對(duì)應(yīng)的注冊(cè)頁面網(wǎng)址 | |
lang (已過期,請(qǐng)使用region) | string | 是 | 國(guó)際短信模板所需參數(shù),模板語言:簡(jiǎn)體中文 zh_cn;英文 en; 繁體中文 zh_tw; 韓文 ko,日文 ja; 其他語言 other (其他語言功能需聯(lián)系在線客服開通) | zh_cn |
notify_type | integer | 否 | 審核結(jié)果短信通知的方式。其中: 0 表示需要通知,默認(rèn); 1 表示僅審核不通過時(shí)通知; 2 表示僅審核通過時(shí)通知; 3 表示不需要通知; | 1 |
callback | string | 否 | 審核結(jié)果會(huì)向這個(gè)地址推送,推送參數(shù)如下 |
|
apply_description | string | 否 | 說明模板的發(fā)送場(chǎng)景、對(duì)象、發(fā)送國(guó)家地區(qū)等 | 發(fā)送國(guó)家包含:美國(guó)、加拿大 |
callback 推送參數(shù)舉例
名稱 | 類型 | 描述 |
tpl_id | string | 模板 id |
tpl_content | string | 模板內(nèi)容 |
check_status | string | //審核狀態(tài):CHECKING/SUCCESS/FAIL |
reason | string | 審核未通過的原因 |
響應(yīng)
名稱 | 類型 | 描述 |
tpl_id | string | 模板 id |
tpl_content | string | 模板內(nèi)容 |
check_status | string | //審核狀態(tài):CHECKING/SUCCESS/FAIL |
reason | string | 審核未通過的原因 |
country_code | string | 支持地區(qū) |
Json 返回值示例(國(guó)際短信模板):
{
"tpl_id": 3614732,
"tpl_content": "【Yunpian】your verification code is 1234",
"check_status": "CHECKING",
"reason": null,
"lang": null,
"country_code": "abroad"
}