API: rcs/template - 模板創(chuàng)建API
概覽
rcs/template 用于創(chuàng)建、管理5G消息模板。
URL
https://api-v4.mysubmail.com/rcs/template
接口響應(yīng)數(shù)據(jù)格式
| 格式 | URL |
|---|---|
json | https://api-v4.mysubmail.com/rcs/template.json（默認） |
xml | https://api-v4.mysubmail.com/rcs/template.xml |
yaml | https://api-v4.mysubmail.com/rcs/template.yaml |
一、創(chuàng)建模板
| 請求方式 | content-type設(shè)置 |
|---|---|
post | multipart/form-data、x-www-form-urlencoded、application/json |
請求參數(shù)
| 參數(shù) | 類型 | 必須/可選 | 默認 | 描述 |
|---|---|---|---|---|
appid | string | 必須 | 無 | 在 SUBMAIL Chatbot中創(chuàng)建的5G消息應(yīng)用ID |
timestamp | int | 可選 | 無 | UNIX 時間戳，結(jié)果以秒為單位，使用加密鑒權(quán)方式，此參數(shù)必填 |
signType | enum | 可選 | normal | API 鑒權(quán)模式，可選參數(shù)normal、sha256 |
signature | string | 必須 | 無 | 鑒權(quán)簽名 1. 當 signType為sha256時，將以下參數(shù)拼接appid+appkey+appid=12345&signType=sha256& timestamp=1712122221+appid+appkey“+”號為鏈接符號，不參與拼接 用sha256將以上拼接字符串加密作為鑒權(quán)參數(shù) 當 signType為normal時，appkey即是signature的值 |
title | string | 可選 | 無 | 模板標題，最大長度64個字符 |
sms | string | 可選 | false | 是否支持短信回落， true：轉(zhuǎn)短信，false：不轉(zhuǎn)短信 |
smsContent | string | 可選 | 無 | 當sms參數(shù)為true時，此參數(shù)必填，當接收方手機不支持5G消息時，消息會以短信的形式回落。當sms參數(shù)為false時，此參數(shù)無效注： 回落短信至終端時平臺會自動在短信內(nèi)容的基礎(chǔ)上拼接中文括號+Chatbot簽名，總長度按UTF-8編碼字節(jié)數(shù)計算，示例： 短信內(nèi)容：回落短信 Chatbot簽名：機器人 最終回落內(nèi)容：【機器人】回落短信 最終回落內(nèi)容字節(jié)數(shù)：27<br/>如最終回落內(nèi)容字節(jié)數(shù)超過1340，回落至終端的文本會轉(zhuǎn)化為鏈接，以終端實際效果為準。 |
mms | string | 可選 | false | 是否支持彩信回落，true：轉(zhuǎn)彩信，false：不轉(zhuǎn)彩信 |
mmsSubject | string | 可選 | 無 | 彩信標題，最長60個字節(jié) |
mmsTemplate | string | 可選 | 無 | 素材ID |
contentType | enum | 必須 | 無 | 消息類型： 1. text/plain 普通文本(包含地位位置消息)。5G消息系統(tǒng)中默認Chatbot下發(fā)位置信息采用Geolocation fallback SMS方式。2. application/vnd.gsma.rcs-ft-http+xml，普通文件消息，可以是圖片、音頻、視頻、名片等消息。3. application/vnd.gsma.botmessage.v1.0+json chatbot卡片消息。注： 消息體內(nèi)媒體文件URL需使用上傳素材文件后的鏈接 |
message | string | 必須 | 無 | 消息正文：當消息類型為普通文本消息時，此參數(shù)為文本消息，當消息為卡片消息或文件消息時，此參數(shù)為json object，文件消息結(jié)構(gòu)說明見文檔《文件消息結(jié)構(gòu)說明》，卡片消息結(jié)構(gòu)說明見文檔《卡片消息結(jié)構(gòu)說明》。 |
suggestions | string | 可選 | 無 | 懸浮菜單：數(shù)據(jù)結(jié)構(gòu)見文檔《卡片消息結(jié)構(gòu)說明》中關(guān)于suggestions的部分。 |
請求示例
curl --location 'https://api-v4.mysubmail.com/rcs/template' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'appid=appid' \
--data-urlencode 'signature=appkey' \
--data-urlencode 'title=這是模板標題' \
--data-urlencode 'contentType=text/plain' \
--data-urlencode 'message=你好，這是一條5G文本消息'成功返回
{
"status": "success",
"id": "ikJvMC", //模板ID
}失敗返回
{
"status":"error",
"code":"2xxx",
"msg":"錯誤信息描述"
}