智能消息模板下发

1、概述

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

2、接口地址

POST https://rcsapi.hanwg.com/aim/template/send

3、请求参数

3.1、请求路径参数

见全局参数

3.2、请求头参数

见接口权限校验

3.3、请求体参数

名称 数据类型 是否必有 描述
phones array[string] 是 手机号码
默认最大支持100个号码
aimNumber string 是 智能消息模板编号
messageId string 是 消息编号
本条消息的唯一标识，建议用UUID
字符串长度限制范围：10-36
sendBatchId string 否 智能消息发送批次号
不传时平台自动生成UUID
sign string 是 签名
必须：单个签名，签名不用带“【】”
注意：当模板签名{smsSign}有值时，此字段sign必须与模板签名{smsSign}一致
smsContent string 是 智能消息短信内容
1. 短信到达终端后，终端自动解析此短信中的短链地址生成可视化智能消息，若解析失败，则终端展示此短信；
2. 可以携带变量；
3. 必带有短链地址${dh_rcs_aim}，用于解析；
4. 因部分终端可能拦截智能消息导致其进入短信拦截箱，为降低拦截率建议在短信内容中添加以下任一字样：“官方信息，谨防诈骗”、“官方信息，谨防失效”、“官方信息，防范诈骗”；
5. 例：给您发送了一条消息，官方信息，谨防失效，点击即可查看：${dh_rcs_aim}；
6.此字段内容不可携带签名
7.文字个数[1, 200]；
注意：为避免短链连着文字字符，到达终端后导致该短链无法解析，变量${dh_rcs_aim}前后如有文字字符，自动添加空格隔开；
示例：
添加空格前：
给您发送一条消息：${dh_rcs_aim}点击即可查看
添加空格后：
给您发送一条消息： ${dh_rcs_aim} 点击即可查看
到达手机终端:
给您发送一条消息： xxx.xxx.xxx 点击即可查看
variables map(string,string) 否 变量
替换变量模板（模板带有动态参数，短信内容带有变量）设置的变量，形式为map(key,value)，key为变量名，value为变量值。可通过变量名dh_rcs_landing_page，指定申请短链时的自定义落地页地址。落地页的域名需要再平台进行报备才能使用（该变量仅能在发送的时候指定，无法在配置模板内容时使用）
aimNoParseType int 否 对于智能消息短信不可解析为智能消息的号码，去发送其它的消息类型
  • 0：不发送
  • 1：发送普通短信
  • 2：发送5G视信
    		•
    customSmsContent string 条件 普通短信内容/5G视信编号
    当：aimNoParseType =
  • 1（发送普通短信），会发送此普通短信，可以携带变量，若此处不填，则会默认使用模板中的aimNoParseSms值；若模板中aimNoParseSms也没有指定，则无法回落普通短信
  • 2（发送5G视信）：5G视信编号，来源上传超级短信模板（5G视信模板）
    注意：此字段内容不可携带签名
    		•
    showTimes int 否 智能消息短链允许解析次数
    平台现目前【发送接口】只支持生成个性化短链，展示次数默认且只为1
    domainName string 否 可设置自定义域名，值为域名文本内容。若值不为空，则发送智能消息申请短链时会使用自定义域名前缀
    expireTime int 否 智能消息短链有效期（单位：天） 平台现目前【发送接口】只支持生成个性化短链，有效期默认为7，取值范围[1, 7]

    4、请求示例

    POST /aim/template/send HTTP/1.1

Content-Type: application/json
Accept: application/json
Authorization: eWM4NTExOmI1MDQ5MmJlMTNhZDYyOGVhZWJkN2RjNWQwNTFlYWQ5
Date: 2022-10-11 16:07:20
Host: example.com
Accept-Encoding: gzip, deflate, br
Connection: keep-alive
Content-Length: 5746

{
  "phones": [
    "15766666666"
  ],
  "aimNumber": "eb53ff9fc1be43b38f29d82bf628c0a5",
  "messageId": "{{uuid}}",
  "sendBatchId": "",
  "sign": "XX通信",
  "smsContent": "给您发送了一条消息，点击即可查看：${xx_rcs_aim}",
  "variables": {},
  "aimNoParseType": 0,
  "customSmsContent": "",
  "showTimes": 1,
  "expireTime": 1,
  "domainName": "im3t.cn"
}

    5、响应参数

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

    6、响应示例

    {
    "code": 0,
    "desc": "请求成功",
    "result": {
        "messageId": "fee7af4d27a7497e8fb7d0397ec35ea2",
        "time": "2023-02-16 19:48:10",
        "failPhones": []
    }
}
    文档更新时间: 2026-05-15 14:31   作者：王超