а√在线中文网新版地址在线,播五月开心婷婷综合,午夜国产精品视频在线,√8天堂资源地址中文在线,80岁色老头oldmanvideos

注冊(cè)送短信

API: aim/template - 創(chuàng)建模板


概覽


aim/template 是 SUBMAIL AIM閱信的模板創(chuàng)建 API。


URL


https://api-v4.mysubmail.com/aim/template


接口響應(yīng)數(shù)據(jù)格式


格式URL
jsonhttps://api-v4.mysubmail.com/aim/template.json（默認(rèn)）


http 請(qǐng)求方式


請(qǐng)求方式content-type設(shè)置
postmultipart/form-data、x-www-form-urlencoded、application/json


是否需要授權(quán)


是
參閱 API 授權(quán)和驗(yàn)證機(jī)制


請(qǐng)求參數(shù)


參數(shù)類(lèi)型必需/可選默認(rèn)描述
appidstring必需無(wú)在 SUBMAIL 應(yīng)用集成中創(chuàng)建的短信應(yīng)用ID
cardIdstring必需無(wú)版式ID，可選參數(shù)如下：
1. com.hbm.video 視頻類(lèi)
2. com.hbm.imageandtext 圖文類(lèi)
3. com.hbm.standardimageandtext 多圖文類(lèi)
4. com.hbm.videoimageandtext 視頻圖文
5. com.hbm.videoimageandtext2 圖文視頻
6. com.hbm.carouse 橫滑類(lèi)1
7. com.hbm.carouseltitle 橫滑類(lèi)2
7. com.hbm.carouseltitle 橫滑類(lèi)2
8. com.hbm.carouselImageSixteenToNine 圖片輪播類(lèi) 16:9
9. com.hbm.carouselQuareImage 圖片輪播類(lèi) 1:1
10. com.hbm.carouselVerticalImage 圖片輪播類(lèi) 48:65
11. com.hbm.pureText 長(zhǎng)文本
12. com.hbm.notification 通知類(lèi)
13. com.hbm.notificationplus 賬單
14. com.hbm.trip 行程類(lèi)
15. com.hbm.redpacket 紅包類(lèi)
16. com.hbm.redpacketPersonal 個(gè)性化紅包
17. com.hbm.ecimageandtext 電商類(lèi)
18. com.hbm.ecommerce 多商品類(lèi)
19. com.hbm.cardVoucher 單卡券類(lèi)
20. com.hbm.cardVouchers 多卡券類(lèi)
具體模板樣式和配置要求見(jiàn)【模板配置說(shuō)明】
tplNamestrng必需無(wú)模板名稱(chēng)，不能超過(guò)20個(gè)字符
參數(shù)示例：雙十一活動(dòng)促銷(xiāo)
scenestring必需無(wú)使用場(chǎng)景，不能超過(guò)10個(gè)字符
參數(shù)示例：活動(dòng)促銷(xiāo)
useIdint必需無(wú)1: 正式模板
2: 測(cè)試模板
注：測(cè)試模板在終端廠商審核環(huán)節(jié)要求相對(duì)比較寬松，但是測(cè)試模板必須在標(biāo)題/正文中攜帶“測(cè)試”兩字
subTypeint可選1當(dāng)版式ID為 com.hbm.notification 通知類(lèi)時(shí)：
1. 增強(qiáng)通知
2. 一般通知
當(dāng)版式ID為 com.hbm.trip 行程類(lèi)時(shí)：
1. 飛機(jī)票
2. 火車(chē)票
3. 汽車(chē)票
其他版式可不填
factorysjson array可選無(wú)需要提交的廠商列表：
指定模板提交的廠商，不填則由運(yùn)營(yíng)人員選擇提交的廠商。
模板支持廠商列表:
HuaWei 表示華為廠商
XiaoMi 表示小米廠商
OPPO 表示OPPO廠商
VIVO 表示VIVO廠商
注：
1. 參數(shù)區(qū)分大小寫(xiě)
2. 如填寫(xiě)，請(qǐng)注意cardId、actionType是否支持所填廠商，否則接口報(bào)錯(cuò)/無(wú)法通過(guò)廠商模板審核
smsExamplestring必需無(wú)所要發(fā)送的短信原文的示例，用于模版審核時(shí)使用，最大150個(gè)字符。
pagesjson array必需無(wú)消息內(nèi)容，最大支持10頁(yè)消息內(nèi)容，數(shù)據(jù)結(jié)構(gòu)見(jiàn)下方 pages 說(shuō)明
paramsjson array可選無(wú)模板動(dòng)參，最大可創(chuàng)建20個(gè)動(dòng)參，動(dòng)參數(shù)據(jù)結(jié)構(gòu)見(jiàn)下方 params 說(shuō)明
pages.contents 中使用動(dòng)態(tài)參數(shù)，在文本/鏈接中插入?yún)?shù)，參數(shù)名稱(chēng)需跟 params 中的 name 保持一致。
申請(qǐng)短鏈接接口中，如果是生成個(gè)性化短鏈接，paramList.dyncParams的 key需和 params 中的 name 保持一致。
smsSignsjson array可選無(wú)短信簽名，最多可以填寫(xiě)三個(gè)，發(fā)送時(shí)，只要匹配了其中一個(gè)即可
每個(gè)簽名最多20個(gè)字，支持中文、英文、數(shù)字、符號(hào)，不支持【】符號(hào)，如果模板要發(fā)送 VIVO，則此參數(shù)必填，否則模板無(wú)法通過(guò)審核
smsTemplatestring可選無(wú)短信原文模板
正則類(lèi)型僅支持文本、字母、數(shù)字三種，且長(zhǎng)度最大為99，切中括號(hào)為英文中括號(hào)。靜態(tài)短信文案加正則動(dòng)態(tài)文案最大值的總字?jǐn)?shù)不超過(guò)370個(gè)字符
如果要下發(fā) VIVO，則此參數(shù)必填，否則模板無(wú)法通過(guò)審核
timestampint可選無(wú)UNIX 時(shí)間戳，結(jié)果以秒為單位，使用加密鑒權(quán)方式，此參數(shù)必填
signTypestring可選normalAPI 鑒權(quán)模式，可選參數(shù)normal、sha256
signaturestring必需無(wú)鑒權(quán)簽名 :
1. 當(dāng)signType為sha256時(shí)，將以下參數(shù)拼接appid+appkey+appid=12345&signType=sha256& timestamp=1712122221+appid+appkey ,“+”號(hào)為鏈接符號(hào)，不參與拼接用sha256將以上拼接字符串加密作為鑒權(quán)參數(shù)
2.當(dāng)signType為normal時(shí)，appkey即是signature的值。



params 數(shù)據(jù)結(jié)構(gòu)

參數(shù)類(lèi)型必需/可選默認(rèn)值描述
typeint必需無(wú)動(dòng)態(tài)參數(shù)類(lèi)型，可選值
1. 表示文本類(lèi)型
namestring必需無(wú)動(dòng)態(tài)參數(shù)名稱(chēng)
命名規(guī)范：${paramN}，N=1,2,3... 參數(shù)名稱(chēng)保證唯一，不能重復(fù)。
examplestring必需無(wú)動(dòng)態(tài)參數(shù)示例，不能大于100個(gè)字符



pages 數(shù)據(jù)結(jié)構(gòu)

參數(shù)類(lèi)型必需/可選默認(rèn)值描述
contentsarray必需無(wú)該 page下的協(xié)議內(nèi)容，內(nèi)容參數(shù)見(jiàn)下方 content 說(shuō)明



contents 數(shù)據(jù)結(jié)構(gòu)

參數(shù)類(lèi)型必需/可選默認(rèn)值描述
typestring必需無(wú)資源類(lèi)型，可選參數(shù)如下：
text 表示文本
image 表示圖片
video 表示視頻
button 表示按鈕
參數(shù)示例：text
contentstring條件可選無(wú)當(dāng)資料類(lèi)型為 text 或 button 時(shí)，該參數(shù)必填，文本長(zhǎng)度限制請(qǐng)閱讀模板版式標(biāo)準(zhǔn)。
srcTypeint條件可選無(wú)資源類(lèi)型為 image 或 video 時(shí)，該參數(shù)必填，可選參數(shù)：
1 資源ID
srcstring條件可選無(wú)素材的 fodder_id
coverstring條件可選無(wú)資源類(lèi)型為 video時(shí)，該參數(shù)必填，填寫(xiě)圖片素材的 fodder_id
isTextTitlebool可選false是否為文本標(biāo)題，可選參數(shù)：
true 是
false 不是
actionTypestring條件可選無(wú)資源類(lèi)型為 image 和 button 時(shí)，該參數(shù)必填，必需綁定事件，其他類(lèi)型的 type 不需要填，可選參數(shù)：
OPEN_URL 表示跳轉(zhuǎn)H5
OPEN_QUICK 表示跳轉(zhuǎn)快應(yīng)用
OPEN_APP 表示跳轉(zhuǎn)App
DIAL_PHONE 表示拉起撥號(hào)盤(pán)
OPEN_SMS 表示新建短信息
OPEN_EMAIL 表示打開(kāi)郵箱
OPEN_SCHEDULE 表示新建日程
OPEN_BROWSER 表示打開(kāi)瀏覽器
OPEN_POPUP 表示彈窗
COPY_PARAMETER 表示復(fù)制
1、com.hbm.carouse 橫滑類(lèi)1,com.hbm.carouseltitle 橫滑類(lèi)2 版式的圖片不支持綁定事件，默認(rèn)與按鈕事件一致
2、米 OV支持配置的事件列表見(jiàn)【閱信模板各版式報(bào)文示例】
actionjson必填無(wú)根據(jù) actionType 設(shè)置對(duì)應(yīng)的信息，參照 action 數(shù)據(jù)結(jié)構(gòu)
positionNumberint必填無(wú)資源在卡片上相對(duì)的位置序號(hào)，按照優(yōu)先從左到右，再?gòu)纳系较碌木幣旁瓌t，統(tǒng)一編號(hào)
visibleint可選1是否可以見(jiàn)，0:不可見(jiàn)，1:可見(jiàn)，默認(rèn)可見(jiàn)

action 數(shù)據(jù)結(jié)構(gòu)

1、OPEN_URL（跳轉(zhuǎn)H5）的數(shù)據(jù)結(jié)構(gòu)

廠商華為小米OPPOVIVO
是否支持此事件√√√√
參數(shù)類(lèi)型必需/可選默認(rèn)值描述
targetstring必填無(wú)H5訪問(wèn)地址，必需為https，支持動(dòng)參，最大不能超過(guò)3000個(gè)字符
參數(shù)示例:https://${param1}
注：建議如果鏈接包含動(dòng)參，協(xié)議后的整個(gè)鏈接作為參數(shù)，否則鏈接封裝可能會(huì)失效，導(dǎo)致審核不通過(guò)
merchantNamestring必填無(wú)用于跳轉(zhuǎn)時(shí)提示“正在跳轉(zhuǎn)到xxx(商戶(hù)名稱(chēng))”
不能超過(guò)20個(gè)字符
參數(shù)示例:正在跳轉(zhuǎn)到人工客服

2、OPEN_QUICK（跳轉(zhuǎn)快應(yīng)用）的數(shù)據(jù)結(jié)構(gòu)

廠商華為小米OPPOVIVO
是否支持此事件√√√√
參數(shù)類(lèi)型必需/可選默認(rèn)值描述
targetstring必填無(wú)快應(yīng)用deeplink地址 ，支持含動(dòng)態(tài)參數(shù)，不能超過(guò)3000個(gè)字符
參數(shù)示例:hap://app/xxx/${param1}
merchantNamestring必填無(wú)用于跳轉(zhuǎn)時(shí)提示“正在跳轉(zhuǎn)到xxx(商戶(hù)名稱(chēng))”
不能超過(guò)20個(gè)字符
參數(shù)示例:xx應(yīng)用

3、OPEN_APP（跳轉(zhuǎn)App）的數(shù)據(jù)結(jié)構(gòu)

廠商華為小米OPPOVIVO
是否支持此事件√√√√
參數(shù)類(lèi)型必需/可選默認(rèn)值描述
targetstring必填無(wú)APP的deeplink地址 ，支持含動(dòng)態(tài)參數(shù)，不能超過(guò)3000個(gè)字符
參數(shù)示例:weixin://
merchantNamestring必填無(wú)用于跳轉(zhuǎn)時(shí)提示“正在跳轉(zhuǎn)到xxx(商戶(hù)名稱(chēng))”
不能超過(guò)20個(gè)字符
參數(shù)示例:xx應(yīng)用
packageNamearray必填無(wú)包名，不能超過(guò)50個(gè)字符
參數(shù)示例:xx.xx.xx
floorTypeint可選0兜底類(lèi)型：
0:打開(kāi)應(yīng)用市場(chǎng)
1:打開(kāi)H5
2:打開(kāi)瀏覽器
3:打開(kāi)快應(yīng)用
不填時(shí)，默認(rèn)為0:打開(kāi)應(yīng)用市場(chǎng)
floorUrlstring可選無(wú)支持快應(yīng)用deeplink或H5的HTTPS網(wǎng)址，不能超過(guò)3000個(gè)字符
注：兜底類(lèi)型為0:打開(kāi)應(yīng)用市場(chǎng)，可不填

4、DIAL_PHONE（拉起撥號(hào)盤(pán)）的數(shù)據(jù)結(jié)構(gòu)

廠商華為小米OPPOVIVO
是否支持此事件√√
參數(shù)類(lèi)型必需/可選默認(rèn)值描述
targetstring必填無(wú)電話號(hào)碼，不能超過(guò)20位
參數(shù)示例:18666668888

5、OPEN_SMS（新建短信息）的數(shù)據(jù)結(jié)構(gòu)

廠商華為小米OPPOVIVO
知否支持此事件√√
參數(shù)類(lèi)型必需/可選默認(rèn)值描述
targetstring必填無(wú)電話號(hào)碼，不能超過(guò)20位
參數(shù)示例:18666668888
bodystring必填無(wú)短信正文，不能超過(guò)100個(gè)字符
參數(shù)示例:今天回家吃飯嗎

6、OPEN_EMAIL（打開(kāi)郵箱）的數(shù)據(jù)結(jié)構(gòu)

廠商華為小米OPPOVIVO
是否支持此事件√√
參數(shù)類(lèi)型必需/可選默認(rèn)值描述
targetstring必填無(wú)郵箱地址，不能超過(guò)100個(gè)字符
參數(shù)示例:service@mysubmail.com
subjectstring必填無(wú)郵件標(biāo)題，不能超過(guò)100個(gè)字符
參數(shù)示例:618活動(dòng)促銷(xiāo)
bodystring必填無(wú)郵件正文，不能超過(guò)500個(gè)字符
參數(shù)示例:您有一張優(yōu)惠券領(lǐng)取

7、OPEN_SCHEDULE（新建日程）的數(shù)據(jù)結(jié)構(gòu)

廠商華為小米OPPOVIVO
是否支持此事件√√
參數(shù)類(lèi)型必需/可選默認(rèn)值描述
targetstring必填無(wú)日程標(biāo)題，不能超過(guò)100個(gè)字符
參數(shù)示例:日常需求評(píng)審
descriptionstring必填無(wú)日程內(nèi)容描述，不能超過(guò)100個(gè)字符
參數(shù)示例:評(píng)審這個(gè)月版本需求
beginTimestring必填無(wú)日程開(kāi)始時(shí)間,格式為yyyy-MM-dd HH:mm:ss
endTimestring必填無(wú)日程結(jié)束時(shí)間,格式為yyyy-MM-dd HH:mm:ss

8、OPEN_BROWSER（打開(kāi)瀏覽器）的數(shù)據(jù)結(jié)構(gòu)

廠商華為小米OPPOVIVO
是否支持此事件√√√√
參數(shù)類(lèi)型必需/可選默認(rèn)值描述
targetstring必填無(wú)網(wǎng)址，支持HTTPS或HTTP，支持含動(dòng)態(tài)參數(shù)，不能超過(guò)3000個(gè)字符
參數(shù)示例:https://${param1}
注：建議如果鏈接包含動(dòng)參，協(xié)議后的整個(gè)鏈接作為參數(shù)，否則鏈接封裝可能會(huì)失效，導(dǎo)致審核不通過(guò)
merchantNamestring必填無(wú)用于跳轉(zhuǎn)時(shí)提示“正在跳轉(zhuǎn)到xxx(商戶(hù)名稱(chēng))”
不能超過(guò)20個(gè)字符
參數(shù)示例:人工客服

9、OPEN_POPUP（彈窗）的數(shù)據(jù)結(jié)構(gòu)

廠商華為小米OPPOVIVO
是否支持此事件√√
參數(shù)類(lèi)型必需/可選默認(rèn)值描述
targetstring必填無(wú)彈窗標(biāo)題，不能超過(guò)30個(gè)字符
參數(shù)示例:xxx商品
contentstring必填無(wú)彈窗內(nèi)容，不能超過(guò)100個(gè)字符
參數(shù)示例:是否喜歡該商品
textButtonstring必填無(wú)按鈕展示文本，不能超過(guò)12個(gè)字符
參數(shù)示例:確定
modeint必填無(wú)彈窗模態(tài):
0:模態(tài)（默認(rèn)）
1:非模態(tài)（暫不支持）

10、COPY_PARAMETER（復(fù)制）的數(shù)據(jù)結(jié)構(gòu)

廠商華為小米OPPOVIVO
是否支持此事件√√
參數(shù)類(lèi)型必需/可選默認(rèn)值描述
targetstring必填無(wú)復(fù)制的內(nèi)容，支持含動(dòng)態(tài)參數(shù)，不能超過(guò)20個(gè)字符
復(fù)制驗(yàn)證碼示例:83721

代碼示例


發(fā)送一封測(cè)試短信


POST URL
https://api-v4.mysubmail.com/aim/template


POST DATA
{
    "appid":"your_app_id",
    "signature":"your_app_key",
    "cardId": "com.hbm.imageandtext",
    "tplName": "圖文模板測(cè)試",
    "scene": "測(cè)試",
    "useId": 2,
    "smsExample": "圖文模板測(cè)試",
    "pages": [{
        "contents": [{
                "type": "image",
                "src": "595787049043271680",
                "srcType": 1,
                "actionType": "OPEN_URL",
                "action": {
                    "target": "https://www.baidu.com?app=123",
                    "merchantName": "京東"
                },
                "positionNumber": 1
            },
            {
                "type": "text",
                "content": "圖文模板標(biāo)題",
                "isTextTitle": true,
                "positionNumber": 2
            },
            {
                "type": "text",
                "content": "圖文模板正文",
                "isTextTitle": false,
                "positionNumber": 3
            },
            {
                "type": "button",
                "content": "點(diǎn)擊按鈕",
                "actionType": "DIAL_PHONE",
                "action": {
                    "target": "18666826056"
                },
                "positionNumber": 4
            }
        ]
    }]
}


成功返回
{
    "status": "success",  //請(qǐng)求狀態(tài)
    "id": "ikJvMC", //模板ID
}


失敗返回
{
      "status":"error",  //請(qǐng)求狀態(tài)
      "code":"1xx",      //失敗碼
      "msg":"error sms"  //失敗信息描述
}