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
`json`	`https://api-v4.mysubmail.com/aim/template.json`（默認(rèn)）

http 請求方式

請求方式	content-type設(shè)置
`post`	`multipart/form-data、x-www-form-urlencoded、application/json`

是否需要授權(quán)

是

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

請求參數(shù)

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

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

參數(shù)	類型	必需/可選	默認(rèn)值	描述
`type`	`int`	必需	無	動態(tài)參數(shù)類型，可選值 1. 表示文本類型
`name`	`string`	必需	無	動態(tài)參數(shù)名稱 *命名規(guī)范：${paramN}，N=1,2,3... 參數(shù)名稱保證唯一，不能重復(fù)。*
`example`	`string`	必需	無	動態(tài)參數(shù)示例，不能大于100個字符

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

參數(shù)	類型	必需/可選	默認(rèn)值	描述
`contents`	`array`	必需	無	該 page下的協(xié)議內(nèi)容，內(nèi)容參數(shù)見下方 `content` 說明

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

參數(shù)	類型	必需/可選	默認(rèn)值	描述
`type`	`string`	必需	無	資源類型，可選參數(shù)如下： `text` 表示文本 `image` 表示圖片 `video` 表示視頻 `button` 表示按鈕參數(shù)示例：`text`
`content`	`string`	條件可選	無	當(dāng)資料類型為 `text` 或 `button` 時，該參數(shù)必填，文本長度限制請閱讀模板版式標(biāo)準(zhǔn)。
`srcType`	`int`	條件可選	無	資源類型為 `image` 或 `video` 時，該參數(shù)必填，可選參數(shù)： 1 資源ID
`src`	`string`	條件可選	無	素材的 `fodder_id`
`cover`	string	條件可選	無	資源類型為 `video`時，該參數(shù)必填，填寫圖片素材的 `fodder_id`
`isTextTitle`	`bool`	可選	false	是否為文本標(biāo)題，可選參數(shù)： true 是 false 不是
`actionType`	`string`	條件可選	無	資源類型為 `image` 和 `button` 時，該參數(shù)必填，必需綁定事件，其他類型的 `type` 不需要填，可選參數(shù)： `OPEN_URL` 表示跳轉(zhuǎn)H5 `OPEN_QUICK` 表示跳轉(zhuǎn)快應(yīng)用 `OPEN_APP` 表示跳轉(zhuǎn)App `DIAL_PHONE` 表示拉起撥號盤 `OPEN_SMS` 表示新建短信息 `OPEN_EMAIL` 表示打開郵箱 `OPEN_SCHEDULE` 表示新建日程 `OPEN_BROWSER` 表示打開瀏覽器 `OPEN_POPUP` 表示彈窗 `COPY_PARAMETER` 表示復(fù)制 1、`com.hbm.carouse` 橫滑類1,`com.hbm.carouseltitle` 橫滑類2 版式的圖片不支持綁定事件，默認(rèn)與按鈕事件一致 2、米 OV支持配置的事件列表見【閱信模板各版式報文示例】
`action`	`json`	必填	無	根據(jù) `actionType` 設(shè)置對應(yīng)的信息，參照 `action` 數(shù)據(jù)結(jié)構(gòu)
`positionNumber`	`int`	必填	無	資源在卡片上相對的位置序號，按照優(yōu)先從左到右，再從上到下的編排原則，統(tǒng)一編號
`visible`	`int`	可選	1	是否可以見，0:不可見，1:可見，默認(rèn)可見

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

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

廠商	華為	小米	OPPO	VIVO
是否支持此事件	√	√	√	√

參數(shù)	類型	必需/可選	默認(rèn)值	描述
`target`	`string`	必填	無	H5訪問地址，必需為https，支持動參，最大不能超過3000個字符參數(shù)示例:https://${param1} *注：建議如果鏈接包含動參，協(xié)議后的整個鏈接作為參數(shù)，否則鏈接封裝可能會失效，導(dǎo)致審核不通過*
`merchantName`	`string`	必填	無	用于跳轉(zhuǎn)時提示“正在跳轉(zhuǎn)到xxx(商戶名稱)” 不能超過20個字符參數(shù)示例:正在跳轉(zhuǎn)到人工客服

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

廠商	華為	小米	OPPO	VIVO
是否支持此事件	√	√	√	√

參數(shù)	類型	必需/可選	默認(rèn)值	描述
`target`	`string`	必填	無	快應(yīng)用deeplink地址，支持含動態(tài)參數(shù)，不能超過3000個字符參數(shù)示例:hap://app/xxx/${param1}
`merchantName`	`string`	必填	無	用于跳轉(zhuǎn)時提示“正在跳轉(zhuǎn)到xxx(商戶名稱)” 不能超過20個字符參數(shù)示例:xx應(yīng)用

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

廠商	華為	小米	OPPO	VIVO
是否支持此事件	√	√	√	√

參數(shù)	類型	必需/可選	默認(rèn)值	描述
`target`	`string`	必填	無	APP的deeplink地址，支持含動態(tài)參數(shù)，不能超過3000個字符參數(shù)示例:weixin://
`merchantName`	`string`	必填	無	用于跳轉(zhuǎn)時提示“正在跳轉(zhuǎn)到xxx(商戶名稱)” 不能超過20個字符參數(shù)示例:xx應(yīng)用
`packageName`	`array`	必填	無	包名，不能超過50個字符參數(shù)示例:xx.xx.xx
`floorType`	`int`	可選	0	兜底類型： 0:打開應(yīng)用市場 1:打開H5 2:打開瀏覽器 3:打開快應(yīng)用不填時，默認(rèn)為0:打開應(yīng)用市場
`floorUrl`	`string`	可選	無	支持快應(yīng)用deeplink或H5的HTTPS網(wǎng)址，不能超過3000個字符 *注：兜底類型為0:打開應(yīng)用市場，可不填*

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

廠商	華為	小米	OPPO	VIVO
是否支持此事件	√	√

參數(shù)	類型	必需/可選	默認(rèn)值	描述
`target`	`string`	必填	無	電話號碼，不能超過20位參數(shù)示例:18666668888

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

廠商	華為	小米	OPPO	VIVO
知否支持此事件	√	√

參數(shù)	類型	必需/可選	默認(rèn)值	描述
`target`	`string`	必填	無	電話號碼，不能超過20位參數(shù)示例:18666668888
`body`	`string`	必填	無	短信正文，不能超過100個字符參數(shù)示例:今天回家吃飯嗎

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

廠商	華為	小米	OPPO	VIVO
是否支持此事件	√	√

參數(shù)	類型	必需/可選	默認(rèn)值	描述
`target`	`string`	必填	無	郵箱地址，不能超過100個字符參數(shù)示例:service@mysubmail.com
`subject`	`string`	必填	無	郵件標(biāo)題，不能超過100個字符參數(shù)示例:618活動促銷
`body`	`string`	必填	無	郵件正文，不能超過500個字符參數(shù)示例:您有一張優(yōu)惠券領(lǐng)取

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

廠商	華為	小米	OPPO	VIVO
是否支持此事件	√	√

參數(shù)	類型	必需/可選	默認(rèn)值	描述
`target`	`string`	必填	無	日程標(biāo)題，不能超過100個字符參數(shù)示例:日常需求評審
`description`	`string`	必填	無	日程內(nèi)容描述，不能超過100個字符參數(shù)示例:評審這個月版本需求
`beginTime`	`string`	必填	無	日程開始時間,格式為yyyy-MM-dd HH:mm:ss
`endTime`	`string`	必填	無	日程結(jié)束時間,格式為yyyy-MM-dd HH:mm:ss

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

廠商	華為	小米	OPPO	VIVO
是否支持此事件	√	√	√	√

參數(shù)	類型	必需/可選	默認(rèn)值	描述
`target`	`string`	必填	無	網(wǎng)址，支持HTTPS或HTTP，支持含動態(tài)參數(shù)，不能超過3000個字符參數(shù)示例:https://${param1} *注：建議如果鏈接包含動參，協(xié)議后的整個鏈接作為參數(shù)，否則鏈接封裝可能會失效，導(dǎo)致審核不通過*
`merchantName`	`string`	必填	無	用于跳轉(zhuǎn)時提示“正在跳轉(zhuǎn)到xxx(商戶名稱)” 不能超過20個字符參數(shù)示例:人工客服

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

廠商	華為	小米	OPPO	VIVO
是否支持此事件	√	√

參數(shù)	類型	必需/可選	默認(rèn)值	描述
`target`	`string`	必填	無	彈窗標(biāo)題，不能超過30個字符參數(shù)示例:xxx商品
`content`	`string`	必填	無	彈窗內(nèi)容，不能超過100個字符參數(shù)示例:是否喜歡該商品
`textButton`	`string`	必填	無	按鈕展示文本，不能超過12個字符參數(shù)示例:確定
`mode`	`int`	必填	無	彈窗模態(tài): 0:模態(tài)（默認(rèn)） 1:非模態(tài)（暫不支持）

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

廠商	華為	小米	OPPO	VIVO
是否支持此事件	√	√

參數(shù)	類型	必需/可選	默認(rèn)值	描述
`target`	`string`	必填	無	復(fù)制的內(nèi)容，支持含動態(tài)參數(shù)，不能超過20個字符復(fù)制驗證碼示例:83721

代碼示例

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

POST URL

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

POST DATA

{
    "appid":"your_app_id",
    "signature":"your_app_key",
    "cardId": "com.hbm.imageandtext",
    "tplName": "圖文模板測試",
    "scene": "測試",
    "useId": 2,
    "smsExample": "圖文模板測試",
    "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": "點擊按鈕",
                "actionType": "DIAL_PHONE",
                "action": {
                    "target": "18666826056"
                },
                "positionNumber": 4
            }
        ]
    }]
}

成功返回

{
    "status": "success",  //請求狀態(tài)
    "id": "ikJvMC", //模板ID
}

失敗返回

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

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

短信

語音

郵件

短網(wǎng)址

國際短信

智慧短信

免密登錄

身份驗證

5G 閱信

多媒體彩信

電商行業(yè)

教育行業(yè)

游戲行業(yè)

政府及公共事業(yè)

關(guān)于賽郵

云聯(lián)生態(tài)

云信防護(hù)