智能消息短链申请
1、概述
智能消息模板在平台审核通过后,平台提供生成该模板短链的功能。
使用此功能,请先联系商务人员开通接口权限。
2、接口地址
POST https://rcsapi.hanwg.com/aim/template/applyUrl
3、请求参数
3.1、请求路径参数
见全局参数
3.2、请求头参数
3.3、请求体参数
| 字段 | 数据类型 | 是否必有 | 描述 | |
|---|---|---|---|---|
| aimNumber | string | 是 | 智能消息模板编号 | |
| signList | array[string] | 是 | 签名 1. 支持多个签名,签名不用带“【】” 2. 要与实际下发的智能消息短信中签名保持一致 3. 当模板签名{smsSign}有值时,此字段signList内容必须与模板签名{smsSign}一致 |
|
| aimUrlType | int | 是 | 智能消息短链类型 |
|
| showTimes | int | 是 | 智能消息短链允许解析次数(详见智能消息短地址解析次数) 当:aimUrlType = |
|
| expireTime | int | 是 | 智能消息短链有效期(单位:天) 当:aimUrlType = |
|
| domain | string | 否 | 用户已审核通过的自定义域名,用作申请短链的前缀 | |
| paramInfo | array[object] | 是 | 动态参数信息 array长度指明了想要获取短链的个数,范围[1, 100] |
|
| customFlag | string | 是 | 客户自定义标识 用于客户自己识别短链 |
|
| customUrl | string | 否 | 自定义跳转地址。长度要求不超过128。 说明: 未填时,终端用户点击短信原文中的短链后,跳转智能信息模板H5页 已填时,终端用户点击短信原文中的短链后,跳转该字段对应的页面,填写时必须为http或https作为前缀 使用自定义跳转链接功能请联系运营人员进行域名备案 |
|
| params | map(string,string) | 条件 | 动态参数替换 1. 当模板带有动态参数,必填。 2. 第一个string填写参数名称,第二个string填写参数值。 3. 动态参数格式:以${}标识动态参数,{}中填写参数名称,只能输入数字、英文字母、下划线。 |
|
4、请求示例
申请群发短链:
POST /aim/template/applyUrl HTTP/1.1
Content-Type: application/json
Accept: application/json
Authorization: ZGgxODUyODowM2NhYjk0ODYyOGQwMzkxMGQ0ZTRmMDk0YjBkMzJhYg==
Date: 2023-02-16 18:56:01
User-Agent: PostmanRuntime/7.31.0
Postman-Token: 499866bd-f794-463d-9a9d-d616de80bdeb
Host: 172.18.1.104:31205
Accept-Encoding: gzip, deflate, br
Connection: keep-alive
Content-Length: 428
{
"aimNumber": "62589d0c9b2d45369599f71019831d60",
"signList": [
"XX通信",
"XX软件"
],
"aimUrlType": 1,
"showTimes": 10,
"expireTime": 1,
"domain ":"im3t.cn",
"paramInfo": [
{
"customFlag": "{{uuid}}",
"params": {}
},
{
"customFlag": "{{uuid}}",
"params": {}
}
]
}申请个性化短链(带参数):
POST /aim/template/applyUrl HTTP/1.1
Content-Type: application/json
Accept: application/json
Authorization: ZGgxODUyODpjMDQ4OTkxYmI2N2IwNDVkNDUzMTA2MjA5YWFlNmExYw==
Date: 2023-02-16 19:01:13
User-Agent: PostmanRuntime/7.31.0
Postman-Token: 03ada7cf-fb2a-4c66-9287-436f413c7dde
Host: 172.18.1.104:31205
Accept-Encoding: gzip, deflate, br
Connection: keep-alive
Content-Length: 623
{
"aimNumber": "048ceef2b56449448dd4123794e7baf9",
"signList": [
"XX通信",
"XX软件"
],
"showTimes": 1,
"expireTime": 7,
"aimUrlType": 2,
"paramInfo": [
{
"customFlag": "8b3f08752cee4de0a1cb5d1905587b5a",
"params": {
"price": "99.00",
"rule": "支付宝",
"date": "2023-02-10"
}
},
{
"customFlag": "8b3f08752cee4de0a1cb5d1905587b5a",
"params": {
"price": "95.00",
"rule": "微信",
"date": "2023-02-10"
}
}
]
}5、响应参数
| 名称 | 数据类型 | 是否必有 | 描述 | ||
|---|---|---|---|---|---|
| code | int | 是 | 响应状态码 | ||
| desc | string | 是 | 响应描述 | ||
| result | object | 条件 | 响应内容 需:code = 0(请求成功) |
||
| aimNumber | string | 是 | 智能消息模板编号 与请求的aimNumber一致 |
||
| signs | string | 是 | 签名 与请求的签名一致,多个签名以英文逗号“,”隔开 |
||
| urlInfoResult | array[object] | 是 | 申请短链信息 | ||
| url | string | 是 | 申请的短链 | ||
| customerFlag | string | 是 | 客户标识 与请求时客户自定义标识customFlag一致 |
||
| customerId | string | 是 | 平台响应给客户的标识 | ||
6、响应示例
申请群发短链响应:
HTTP/1.1 200 OK
Content-Type: application/json
Transfer-Encoding: chunked
Date: Thu, 16 Feb 2023 10:56:00 GMT
Connection: close
{
"code": 0,
"desc": "请求成功",
"result": {
"aimNumber": "62589d0c9b2d45369599f71019831d60",
"signs": "XX通信,XX软件",
"urlInfoResult": [
{
"url": "im3t.cn/Mb2HnZ",
"customerFlag": "41b870c6ed9b4712bc3e63d1b27a8909",
"customerId": "cdc062d6959e4b80869fa5c6f30d623f"
},
{
"url": "im3t.cn/Mb2vBi",
"customerFlag": "450913bd54404c96b877507345871faf",
"customerId": "cdc062d6959e4b80869fa5c6f30d623f"
}
]
}
}申请个性化短链响应:
HTTP/1.1 200 OK
Content-Type: application/json
Transfer-Encoding: chunked
Date: Thu, 16 Feb 2023 11:01:12 GMT
Connection: close
{
"code": 0,
"desc": "请求成功",
"result": {
"aimNumber": "048ceef2b56449448dd4123794e7baf9",
"signs": "XX通信,XX软件",
"urlInfoResult": [
{
"url": "im3t.cn/Mb0H9T",
"customerFlag": "8b3f08752cee4de0a1cb5d1905587b5a",
"customerId": "97ee732eedc64f638c99ef139a5599c9"
},
{
"url": "im3t.cn/Mb2q3d",
"customerFlag": "41b870c6ed9b4712bc3e63d1b27a8909",
"customerId": "97ee732eedc64f638c99ef139a5599c9"
}
]
}
}文档更新时间: 2026-05-15 14:31 作者:王超