添加超級短信模板
HTTP 頭信息:
Accept:application/json;charset=utf-8;
Content-Type:multipart/form-data;
請求
URL:https://vsms.yunpian.com/v2/vsms/add_tpl.json
訪問方式:POST
請求參數(shù)
參數(shù)名 | 類型 | 是否必傳 | 是否默認(rèn)開放 | 描述 | 示例 |
apikey | string | 是 | 是 | 用戶唯一標(biāo)識,在"賬號設(shè)置"-"子帳號管理"中查看 | 9b11127a9701975c |
sign | string | 是 | 是 | 短信簽名 | 【超級短信測試】 |
layout | json | 是 | 是 | 內(nèi)容布局的 json 描述文件 | 詳見備注 |
material | byte | 是 | 是 | 素材的字節(jié)數(shù)組,即素材內(nèi)容壓成zip包后轉(zhuǎn)成字節(jié)數(shù)組。若需在文本中添加變量,請用英文雙#號表示,變量名格式為10字以內(nèi)的英文、數(shù)字和短線,如#name_1# | 參考demo示例 |
callback_url | string | 否 | 否 | 模板審核結(jié)果更新后將向這個(gè)地址推送。 如推送地址固定,可以在“超級短信設(shè)置-數(shù)據(jù)推送設(shè)置”中添加。 如后臺已設(shè)置地址,且添加模板請求內(nèi)也包含此參數(shù),將以請求內(nèi)地址為準(zhǔn)。 | |
mobileStatSid | string | 否 | 否 | 云片短鏈sid,為模板文本中出現(xiàn)的云片短鏈開啟統(tǒng)計(jì)手機(jī)號功能時(shí)傳,多個(gè)用英文逗號分隔,如 YJfXdN,YRDOnF。請?zhí)崆奥?lián)系客服開通此功能。 |
說明:
- 模板中至少包含一段文字和一段多媒體內(nèi)容(圖片、視頻、音頻均可),且素材總數(shù)不能超過10個(gè)。文字內(nèi)容中不能包含emoji表情。
- 發(fā)送特殊行業(yè)內(nèi)容(如游戲、金融、地產(chǎn)等)請?zhí)崆白稍兛头?nèi)容中包含鏈接、二維碼需特殊報(bào)備。
- 應(yīng)部分運(yùn)營商要求,短信末尾會增加退訂說明。
- 模板自審核通過起30天內(nèi)有效,已失效模板需重新提交報(bào)備。
- layout 參數(shù)示例
可參考 Java 定義類:https://github.com/yunpian/yunpian-java-sdk/blob/v1.2.6/src/main/java/com/yunpian/sdk/model/VideoLayout.java
- material壓縮包中的txt文件編碼目前只支持utf-8,如果使用其他編碼會導(dǎo)致模版添加失敗
- 圖片只支持jpg、gif、png格式
{
"vlVersion": "0.0.1", //布局文件版本號
"subject": "title", //主題說明,限制20個(gè)字符
"frames": [ //布局的幀內(nèi)容,手機(jī)將從上到下依次顯示index值從1-N
{
"index": 1, //第1幀
"playTimes": 1, //播放次數(shù),目前沒有使用
"attachments": [ //幀內(nèi)容
{
"index": 1, //幀內(nèi)素材出現(xiàn)次序,實(shí)際次序由供應(yīng)商決定
"fileName": "text1.txt" //對應(yīng)material壓縮包里的文件
},
{
"index": 2,
"fileName": "vedio.mp4" //對應(yīng)material壓縮包里的文件
}
]
},
{
"index": 2, // 第2幀
"playTimes": 1,
"attachments": [
{
"index": 1,
"fileName": "text2.txt"
},
{
"index": 2,
"fileName": "image.jpg"
}
]
}
... // 其他幀
]
}
請求示例
python3:
import json
import requests
layout = {
"vlVersion": "0.0.1",
"subject": "title",
"frames": [
{
"index": 1,
"playTimes": 1,
"attachments": [
{
"index": 1,
"fileName": "text1.txt"
},
{
"index": 2,
"fileName": "img1.jpg"
}
]
}
]
}
def add_tpl(filepath):
"""
:param filepath: 文件路徑
:return:
"""
url = 'https://vsms.yunpian.com/v2/vsms/add_tpl.json'
data = {
'apikey': 'xxxx',
'sign': 'xxxx',
'layout': json.dumps(layout),
}
files = {
'material': (filepath, open(filepath, 'rb'), 'application/octet-stream')
}
r = requests.post(url, data=data, files=files)
print(r.text)
return 0
響應(yīng)
名稱 | 類型 | 描述 |
code | integer | 0 代表請求成功 |
msg | text | 接口狀態(tài) |
tpl_id | integer | 模板 id |
Json 返回示例
{
"code": 0,
"msg": "OK",
"data": {
"tpl_id": 126
}
}