5G消息模板发送

1、概述

本接口用于发送审核通过的模板，接口中涉及到的平台参数，请在平台上获取。在创建模板时设置的变量需要在此接口填写真实替换值。下发成功，即可在终端手机看到发送的消息。

2、接口地址

POST https://rcsapi.hanwg.com/rcs/template/send/{{chatbotId}}

3、请求参数

3.1、请求路径参数

见全局参数

3.2、请求头参数

见接口权限校验

3.3、请求体参数

名称 数据类型 是否必有 描述
phone array[string] 是 手机号码
默认最大支持200个号码
templateId string 是 模板编号
messageId string 是 消息编号
本条消息的唯一标识，建议用UUID，与contributionId一样都是对于一条消息的标识，区别在于messageId用于状态报告回调
字符串长度限制范围：10-36
conversationId string 是 唯一标识【主被叫】用户间的一次会话，建议用UUID，触发上行消息携带的conversationId将填写该下行消息的conversationId值
字符串长度限制范围：10-36
contributionId string 是 唯一标识一条消息，建议用UUID，对上行消息回复时携带该字段作为inReplyTo的值
字符串长度限制范围：10-36
inReplyTo string 条件 标识此条消息是对【某条上行消息】的回复，值为对方某条上行消息的contributionId，既可以是终端对客户的回复，也可以是客户对终端的回复。比如上行事件、场景发送等。
variables map(string,string) 否 替换变量模板设置的变量，包括5G消息和智能消息中的变量，形式为map(key,value)，key为变量名，value为变量值
showTimes int 条件 智能消息短链允许解析次数（详见智能消息短地址解析次数）
平台现目前【发送接口】只支持生成个性化短链，展示次数默认且只为1
必需：smsSupported = 4（模板回落为智能消息回落）或者templateSource = 1（全终端模板）
expireTime int 条件 智能消息短链有效期（单位：天）
平台现目前【发送接口】只支持生成个性化短链，有效期默认为7，取值范围[1, 7]
必需：smsSupported = 4（模板回落为智能消息回落）或者templateSource = 1（全终端模板）
taskId string 条件 发送任务编号
必需：smsSupported = 4（模板回落为智能消息回落）且 智能消息模板没有变量
一批发送填写同一个任务编号，可以更快触达终端
templateSource int 否 模板来源；
  • 0：5G消息模板（默认）
  • 1：全终端模板（现目前全终端模板只能在平台创建）
    		•
    aimSmsContent string 条件 智能消息短信内容
    必需：要发送5G消息模板配置的回落类型为智能消息回落（即smsSupported = 4）或者指定为全终端模板（即templateSource = 1）时
    1. 短信到达终端后，终端自动解析此短信中的短链地址生成可视化智能消息，若解析失败，则终端展示此短信；
    2. 可以携带变量；
    3. 必带有短链地址${xx_rcs_aim}，用于解析；
    4. 因部分终端可能拦截智能消息导致其进入短信拦截箱，为降低拦截率建议在短信内容中添加以下任一字样：“官方信息，谨防诈骗”、“官方信息，谨防失效”、“官方信息，防范诈骗”；
    5. 例：给您发送了一条消息，官方信息，谨防失效，点击即可查看：${xx_rcs_aim}；
    6.文字个数[1, 200]；
    注意：为避免短链连着文字字符，到达终端后导致该短链无法解析，变量${xx_rcs_aim}前后如有文字字符，自动添加空格隔开；
    示例：
    添加空格前：
    给您发送一条消息：${xx_rcs_aim}点击即可查看
    添加空格后：
    给您发送一条消息： ${xx_rcs_aim} 点击即可查看
    到达手机终端:
    给您发送一条消息： xxx.xxx.xxx 点击即可查看。
    请勿在该字段中添加签名，因为系统将会自动添加Chatbot签名。计费时，总字符数将包括自动添加的签名字符及该字段的字符数，请务必注意计费细节。
    aimNoParseType int 条件 对于智能消息短信不可解析为智能消息的号码，是否需要发送其它消息类型
  • 0：不发送
  • 1：发送短信（默认）
    必需：smsSupported = 4（5G消息新增模板中的回落为智能消息回落）或者templateSource = 1（全终端模板）
    		•
    aimNoParseSms string 条件 普通短信内容（对于智能消息短信不可解析为智能消息的号码，去发送其它的消息类型）
    必需：aimNoParseType = 1（发送短信）
    注意：请勿在该字段中添加签名，因为系统将会自动添加Chatbot签名。计费时，总字符数将包括自动添加的签名字符及该字段的字符数，请务必注意计费细节。

    4、请求示例

    文本+悬浮菜单(上行回复) 的模板

    POST /rcs/template/send/a92e43085a0049ba8928b61fa04eeee HTTP/1.1
Content-Type: application/json
Accept: application/json
Authorization: ZGgxODUyODo0MWNkZjdmNTRlYjAyODU0OWExMDc1ODJkOGUwMTkwZQ==
Date: 2023-02-16 16:08:45
User-Agent: PostmanRuntime/7.31.0
Postman-Token: 243783fd-e933-47e0-84cd-7de894f12dbd
Host: 172.18.1.104:31205
Accept-Encoding: gzip, deflate, br
Connection: keep-alive
Content-Length: 470

{
  "phone": [
    "15766666666"
  ],
  "templateId": "b3aed3e2a241437dab082a19c2905531",
  "messageId": "{{uuid}}",
  "conversationId": "{{uuid}}",
  "contributionId": "{{uuid}}",
  "inReplyTo": "",
  "variables": {},
  "showTimes": 1,
  "expireTime": 1,
  "taskId": "",
  "templateSource": 0,
  "aimSmsContent": "",
  "aimNoParseType": 0,
  "aimNoParseSms": ""
}

    单卡片(动态参数)+智能消息(动态参数)的模板

    POST /rcs/template/send/a92e43085a0049ba8928b61fa04eeee HTTP/1.1
Content-Type: application/json
Accept: application/json
Authorization: ZGgxODUyODo5NmIzMWNmMmVkZTc0YzEwYjFjOWQ1MzJmMjE2NTgzMw==
Date: 2023-02-16 17:05:52
User-Agent: PostmanRuntime/7.31.0
Postman-Token: 26b0c009-009e-46a3-87fa-9dbb9af37db4
Host: 172.18.1.104:31205
Accept-Encoding: gzip, deflate, br
Connection: keep-alive
Content-Length: 699

{
  "phone": [
    "15766666666"
  ],
  "templateId": "b02982770afa4cde92d073a64f3e3c0f",
  "messageId": "{{uuid}}",
  "conversationId": "{{uuid}}",
  "contributionId": "{{uuid}}",
  "inReplyTo": "",
  "variables": {
    "title": "标题",
    "description": "描述",
    "param1": "智能消息中的动态参数"
  },
  "showTimes": 1,
  "expireTime": 2,
  "taskId": "",
  "templateSource": 0,
  "aimSmsContent": "给您发送了一条消息，官方信息，谨防失效，点击即可查看：${dh_rcs_aim}",
  "aimNoParseType": 1,
  "aimNoParseSms": "此为普通短信"
}

    5、响应参数

    名称 数据类型 是否必有 描述
    code int 是 响应状态码
    desc string 是 请求响应描述
    result object 条件 请求响应内容
    code = 0（请求成功）
    messageId string 是 消息编号
    成功时返回本条消息在平台的唯一标识
    time date 是 请求成功返回时的时间
    格式：yyyy-MM-dd HH:mm:ss
    failPhones array[string] 是 提交的手机号码中的发送失败号码
    失败原因有：
    1.号码格式不正确
    2.账号不支持此运营商

    6、响应示例

    {
  "code":0,
  "desc":"请求成功",
  "result":{
    "messageId":"9181a2f5bb9650ceb21f5f6de62d2b9a",
    "time":"2020-11-24 02:36:20",
    "failPhones":[]
  }
}
    文档更新时间: 2025-12-17 09:34   作者：王超