1、生成解析任务
1.1 请求地址
1.2 请求参数
| 参数名 | 类型 | 是否必传 | 描述 |
|---|
| nonce | string | 是 | 随机数。 可使用uuid |
| timestamp | string | 是 | 时间戳 |
| signature | string | 是 | 验签加密串。根据验签示例说明进行加密 |
| app_id | string | 是 | 账户app_id。从系统的页面-》系统管理 可以获取 |
| signature | string | 是 | 验签加密串 |
| template_id | string | 是 | 模板id。 |
| link_type | string | 是 | 生成类型。说明:1->群发短链 2->一号一链 |
| generate_type | string | 是 | 短链生成方式:1: 随机生成(创蓝这边生成短链,短链的跳转能力由创蓝提供) 2: 自定义(客户指定短链,短链的跳转服务需要客户自己支持) |
| params | List<CreateAimLinkParam> | 是 | 参数对象列表1、CreateAimLinkParam见下方参数定义,2、一客一链,最大支持100个,3、群发短链,目前仅支持1个,后续会调整 |
| effective_days | string | 是 | 短链有效天数。注意:群发短链1-100天,一客一链1-7天 |
| msg_signs | List<String> | 否 | 签名列表:1、不传递默认使用模板的签名,2、如果签名跟短信发送的签名不匹配,则可能会导致不解析,3、最多支持10个,4、签名示例:["签名1","签名2"] |
| show_times | string | 否 | 短链解析次数,注意:1、群发短链必传,2、一客一链,传不传递,平台均默认设置为1,3、每个群发短链的解析次数最大为show_times |
| domain | string | 否 | 解析链接域名 1、如果为空,默认使用平台域名,2、如果不为空,必须提前向运营报备域名,3、如果generate_type=2时,是必传的 |
| batch_no | string | 否 | 自定义外部批次号,回执的时候可以推送; |
| 参数名 | 类型 | 是否必传 | 描述 |
|---|
| custom_flag | string | 是 | 客户唯一标识:1、用户手机号或者唯一标识,长度不超过64,2、不能重复,否则解析结果可能会不对,3、建议手机号可以更好匹配 |
| custom_url | string | 否 | 跳转地址(原文链接)注意:1、长度要求不超过2048,2、当生成类型为随机短码时,必传 |
| custom_short_code | string | 否 | 解析链接短码,注意:1、生成类型generate_type=2时,是必传,2、长度为3到10位的数字或大小写字母,3、生成类型generate_type=2时,暂时需要客户自己做链接跳转 |
| dynamic_params | Map<String,String> | 否 | 模板动参值,注意:1、变量模板,必传,2、示例:{"param1":"aaa", "param2":"bbb"} |
1.3 响应参数
| 参数名 | 类型 | 默认值 | 描述 |
|---|
| code | string | | 000000 代表成功,其他代表失败,会有 message 错误信息返回 |
| msg | string | | 提示信息 |
| data | object | | 返回数据 |
data数据结构
| 参数名 | 类型 | 是否必传 | 描述 |
|---|
| template_id | string | 是 | 模版号 |
| params | List<CreateAimLinkResult> | 是 | 唯一标识及动态参数对象列表1、CreateAimLinkResult见下方参数定义 |
|
| 参数名 | 类型 | 是否必传 | 描述 |
|---|
| custom_flag | string | 是 | 客户唯一标识:1、用户手机号或者唯一标识,长度不超过64,2、不能重复,否则解析结果可能会不对,3、建议手机号可以更好匹配 |
| aim_url | string | 是 | 完整短链 |
| aim_code | string | 是 | 短码 |
| result_code | string | 是 | "申请结果 0 成功 其他失败" |
| result_message | string | 否 | "短链申请结果错误描述,示例:1、短码重复,2、签名sign错误,3、个别厂商失败 等等" |
| expire_date | string | 是 | 截止日期 2025-11-15 20:50:59 |
| custom_url | string | 否 | 跳转地址(原文链接)注意:1、长度要求不超过2048,2、当生成类型为随机短码时,必传 |
| custom_short_code | string | 否 | 解析链接短码,注意:1、生成类型generate_type=2时,是必传,2、长度为3到10位的数字或大小写字母,3、生成类型generate_type=2时,暂时需要客户自己做链接跳转 |
| dynamic_params | Map<String,String> | 否 | 模板动参值,注意:1、变量模板,必传,2、示例:{"param1":"aaa", "param2":"bbb"} |
|
返回数据示例:
{
"code": "000000",
"message": "成功",
"data": {
"batch_no": "LT202308040905179088662679552",
"app_id": "0AvyA8opHDqDs6X2",
"template_id": "CLAIM202207260953094148600813568",
"show_times": 1,
"effective_days": 7,
"msg_signs": ["签名1", "签名2"],
"generate_type": "2",
"link_type": "2",
"params": [
{
"custom_flag": "13535353535",
"custom_url": "https://www.chuanglan.com/",
"custom_short_code": "asdf35y",
"dynamic_params": {"param1":"aaa", "param2":"bbb"},
"aim_url": "aaa.cn/asdf35y",
"aim_code": "asdf35y",
"result_code": "0",
"result_message": "成功",
"expire_date": "2025-11-23 10:35:25"
}
],
"domain": "aaa.cn",
"batch_no": "202401020000000001"
}
}
尊敬的你好,请查收 aaa.cn/asdf35y ,退订
1.4 请求示例(随机一客一链无动参)
{
"nonce": "1a8ce7919a39495e8e15a9ea8eb74d26",
"timestamp": "1662050291029",
"signature": "313c5e2e7df1a6346048a74c16d20a6c70fc881fcd2455153fa6475e8e088d5d",
"app_id": "0AvyA8opHDqDs6X2",
"template_id": "CLAIM202207260953094148600813568",
"show_times": 1,
"effective_days": 7,
"msg_signs": ["签名1", "签名2"],
"generate_type": "2",
"link_type": "2",
"params": [
{
"custom_flag": "13535353535",
"custom_url": "https://www.chuanglan.com/",
}
],
"domain": "aaa.cn",
"batch_no": "202401020000000001",
"message_batch_id": "202408091045496568662810624"
}
1.5 请求示例(自定义一客一链有动参)
{
"nonce": "1a8ce7919a39495e8e15a9ea8eb74d26",
"timestamp": "1662050291029",
"signature": "313c5e2e7df1a6346048a74c16d20a6c70fc881fcd2455153fa6475e8e088d5d",
"app_id": "0AvyA8opHDqDs6X2",
"template_id": "CLAIM202207260953094148600813568",
"show_times": 1,
"effective_days": 7,
"msg_signs": ["签名1", "签名2"],
"generate_type": "2",
"link_type": "2",
"params": [
{
"custom_flag": "13535353535",
"custom_short_code": "asdf35y",
"dynamic_params": {"param1":"aaa", "param2":"bbb"}
}
],
"domain": "aaa.cn",
"batch_no": "202401020000000001",
"message_batch_id": "202408091045496568662810624"
}
1.6 群发随机短链
{
"nonce": "1a8ce7919a39495e8e15a9ea8eb74d26",
"timestamp": "1662050291029",
"signature": "313c5e2e7df1a6346048a74c16d20a6c70fc881fcd2455153fa6475e8e088d5d",
"app_id": "0AvyA8opHDqDs6X2",
"template_id": "CLAIM202207260953094148600813568",
"show_times": 10,
"effective_days": 30,
"msg_signs": ["签名1", "签名2"],
"generate_type": "1",
"link_type": "1",
"params": [
{
"custom_flag": "13535353535",
"custom_url": "https://www.chuanglan.com/"
}
],
"domain": "aaa.cn",
"batch_no": "202401020000000002"
}
2、寻址能力查询
2.1 请求地址
2.2 请求参数
| 参数名 | 类型 | 是否必传 | 描述 |
|---|
| nonce | string | 是 | 随机数。 可使用uuid |
| timestamp | string | 是 | 时间戳。 |
| signature | string | 是 | 验签加密串。根据验签示例说明进行加密 |
| app_id | string | 是 | 账户app_id。从系统的页面-》系统管理 可以获取 |
| template_id | string | 是 | aim模板id。 |
| mobiles | string | 是 | 接收手机号码。注意:1、最大支持100个号码 2、JSONStringArray的格式 3、生成一号一链时必传 示例:"["18587191949","17321453868","18587191949"]" |
| terminal_factory | string | 否 | 指定撞库的厂商。字段定义:XIAOMI、OPPO、VIVO、HUAWEI 注意:1、可单个,可以多个厂商,多个厂商以英文逗号分隔 2、不传值,默认撞库模板审核通过的所有厂商 示例:示例:"XIAOMI,OPPO"或者"XIAOMI" |
| encrypt_type | string | 否 | 加密类型。说明:NONE-不加密 SHA1-使用SHA1加密算法加密 注意:1、默认NONO 2、目前仅支持"86"+手机号的SHA1小写字母加密 示例:手机号:13155555555使用"8613155555555"进行SHA1加密值为:086d8af2f57fd67f7d62058f213ea87a12162951 |
2.3 响应参数
| 参数名 | 类型 | 默认值 | 描述 |
|---|
| code | string | | 000000 代表成功,其他代表失败,会有 message 错误信息返回 |
| msg | string | | 提示信息 |
| data | object | | 返回数据 |
data数据结构
| 参数名 | 类型 | 是否必传 | 描述 |
|---|
| mobile | string | 否 | 手机号。 |
| support | string | 否 | 是否支持。说明:true-支持卡片短信,false-不支持卡片短信 |
返回数据示例:
{
"code": "000000",
"message": "成功",
"data": [
{
"mobile": "15156908672",
"support": true
},
{
"mobile": "13122298708",
"support": true
}
]
}
2.4 请求示例(手机号不加密)
{
"app_id": "nRYcU4fYExYjw2m8",
"timestamp": "1659154588940",
"nonce": "80e33b2f03b44db8b5f7b4114f370602",
"signature": "1635a1fdb0f61cc9e01df9d9f84640193478d138cd80e9021c4c1a3dec916be7",
"template_id": "CLAIM202208011504569468599109632",
"mobiles": "[\"15156908672\",\"13122298708\"]"
}
2.5 请求示例(手机号加密)
{
"app_id": "nRYcU4fYExYjw2m8",
"timestamp": "1659154588940",
"nonce": "80e33b2f03b44db8b5f7b4114f370602",
"signature": "1635a1fdb0f61cc9e01df9d9f84640193478d138cd80e9021c4c1a3dec916be7",
"template_id": "CLAIM202208011504569468599109632",
"mobiles": "[\"8c88115820bffd772d27def3506f09f0c0eb4083\",\"4ddec46c6f7cd545074b6b6d3d6ae03af1d9a49d\"]",
"encrypt_type": "SHA1"
}
没有更多了