注册送短信

API: rcs/template - 模板创建API


概览


rcs/template 用于创建、管理5G消息模板。



URL


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


接口响应数据格式


格式URL
jsonhttps://api-v4.mysubmail.com/rcs/template.json(默认)
xmlhttps://api-v4.mysubmail.com/rcs/template.xml
yamlhttps://api-v4.mysubmail.com/rcs/template.yaml


一、创建模板


请求方式content-type设置
postmultipart/form-data、x-www-form-urlencoded、application/json




请求参数


参数类型必须/可选默认描述
appidstring必须在 SUBMAIL Chatbot中创建的5G消息应用ID
timestampint可选UNIX 时间戳,结果以秒为单位,使用加密鉴权方式,此参数必填
signTypeenum可选normalAPI 鉴权模式,可选参数normalsha256
signaturestring必须鉴权签名
1. 当signTypesha256时,将以下参数拼接
appid+appkey+appid=12345&signType=sha256& timestamp=1712122221+appid+appkey
“+”号为链接符号,不参与拼接
用sha256将以上拼接字符串加密作为鉴权参数
signTypenormal时,appkey即是signature的值
titlestring可选模板标题,最大长度64个字符
smsstring可选false是否支持短信回落, true:转短信,false:不转短信
smsContentstring可选sms参数为true时,此参数必填,当接收方手机不支持5G消息时,消息会以短信的形式回落。当sms参数为false时,此参数无效
注:
回落短信至终端时平台会自动在短信内容的基础上拼接中文括号+Chatbot签名,总长度按UTF-8编码字节数计算,示例:
短信内容:回落短信
Chatbot签名:机器人
最终回落内容:【机器人】回落短信
最终回落内容字节数:27<br/>如最终回落内容字节数超过1340,回落至终端的文本会转化为链接,以终端实际效果为准。
mmsstring可选false是否支持彩信回落,true:转彩信,false:不转彩信
mmsSubjectstring可选彩信标题,最长60个字节
mmsTemplatestring可选素材ID
contentTypeenum必须消息类型:
1. text/plain 普通文本(包含地位位置消息)。5G消息系统中默认Chatbot下发位置信息采用Geolocation fallback SMS方式。
2. application/vnd.gsma.rcs-ft-http+xml,普通文件消息,可以是图片、音频、视频、名片等消息。
3. application/vnd.gsma.botmessage.v1.0+json chatbot卡片消息。

注:
消息体内媒体文件URL需使用上传素材文件后的链接
messagestring必须消息正文:当消息类型为普通文本消息时,此参数为文本消息,当消息为卡片消息或文件消息时,此参数为json object,文件消息结构说明见文档《文件消息结构说明》,卡片消息结构说明见文档《卡片消息结构说明》。
suggestionsstring可选悬浮菜单:数据结构见文档《卡片消息结构说明》中关于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":"错误信息描述"
}