API: rcs/xsend - 交互消息API
概览
rcs/xsend 用于通过模板发送交互消息，模板正文、悬浮菜单支持变量。
URL
https://api-v4.mysubmail.com/rcs/xsend
接口响应数据格式
| 格式 | URL |
|---|---|
json | https://api-v4.mysubmail.com/rcs/xsend.json（默认） |
xml | https://api-v4.mysubmail.com/rcs/xsend.xml |
yaml | https://api-v4.mysubmail.com/rcs/xsend.yaml |
一、创建模板
| 请求方式 | content-type设置 |
|---|---|
post | multipart/form-data、x-www-form-urlencoded、application/json |
请求参数
| 参数 | 类型 | 必须/可选 | 默认 | 描述 |
|---|---|---|---|---|
appid | string | 必须 | 无 | 在 SUBMAIL Chatbot中创建的5G消息应用ID |
timestamp | int | 可选 | 无 | UNIX 时间戳，结果以秒为单位，使用加密鉴权方式，此参数必填 |
signType | enum | 可选 | normal | API 鉴权模式，可选参数normal、sha256 |
signature | string | 必须 | 无 | 鉴权签名 1. 当 signType为sha256时，将以下参数拼接appid+appkey+appid=12345&signType=sha256& timestamp=1712122221+appid+appkey“+”号为链接符号，不参与拼接 用sha256将以上拼接字符串加密作为鉴权参数 当 signType为normal时，appkey即是signature的值 |
to | string | 必须 | 无 | 接收方手机号，示例：15288888888 |
conversationID | string | 必须 | 无 | 唯一标识主被叫用户间的一个聊天对话，建议使用UUID。终端点击消息中的建议操作或建议回复按钮，触发上行消息携带的conversationID将填写该下行消息的conversationID值 |
contributionId | string | 必须 | 无 | 唯一标识一个聊天会话，建议使用UUID。终端点击此消息中的建议操作或建议回复按钮，触发上行消息携带的inReplyToContributionID将填写该下行消息的contributionID值。 |
inReplyToContributionID | string | 必须 | 无 | 下行消息回复表示标识，这是一条对上行消息的回复，该参数的值是该条上行消息的contributionID |
trafficType | enum | 可选 | advertisement | 流量标识，可选值包括：advertisement payment premium subscription plugin |
shortMessageSupported | string | 可选 | false | 是否支持短信回落， true：转短信，false：不转短信 |
smsBodyText | string | 可选 | 无 | 当sms参数为true时，此参数必填，当接收方手机不支持5G消息时，消息会以短信的形式回落。当sms参数为false时，此参数无效注： 回落短信至终端时平台会自动在短信内容的基础上拼接中文括号+Chatbot签名，总长度按UTF-8编码字节数计算，示例： 短信内容：回落短信 Chatbot签名：机器人 最终回落内容：【机器人】回落短信 最终回落内容字节数：27 如最终回落内容字节数超过1340，回落至终端的文本会转化为链接，以终端实际效果为准。 |
multimediaMessageSupported | string | 可选 | false | 是否支持彩信回落，true：转彩信，false：不转彩信 |
mmsSubject | string | 可选 | 无 | 彩信标题，最长60个字节，支持彩信回落时，该参数为必须参数 |
mmsContentLength | int | 可选 | 无 | 彩信素材大小，支持彩信回落时，该参数为必须参数 |
mmsBodyText | string | 可选 | 无 | 彩信文件url，支持彩信回落时，该参数为必须参数 注： 彩信文件URL需使用上传素材文件后的链接 |
templateID | string | 必须 | 无 | 模板ID |
vars | json | 可选 | 无 | 变量内容 |
请求示例
成功返回
{
"status": "success",
"send_id": "d30e072ff21749fc432d5835c06032b8",
"fee":1
}失败返回
{
"status":"error",
"code":"2xxx",
"msg":"错误信息描述"
}