1、生成解析任务
1.1 请求地址
1.2 请求参数
参数名 | 类型 | 是否必传 | 描述 |
---|
nonce | string | 是 | 随机数。 可使用uuid |
timestamp | string | 是 | 时间戳 |
signature | string | 是 | 验签加密串。根据验签示例说明进行加密 |
app_id | string | 是 | 账户app_id。从系统的页面-》系统管理 可以获取 |
template_id | string | 是 | aim模板id。 |
link_url | string | 是 | 原文链接。填值说明:Y-签名与公司主体一致;N-签名与公司主体不一致 |
link_type | string | 是 | 生成类型。说明:1->群发短链 2->一号一链 |
mobile_count | string | 否 | 手机号数量(群发短链的短链解析次数)。注意:1、生成群发短链时必传 |
mobiles | string | 否 | 接收手机号码。注意:1、最大支持100个号码 2、JSONStringArray的格式 3、生成一号一链时必传 示例:"["18587191949","17321453868","18587191949"]" |
dynamic_params | string | 否 | 模板动态参数赋值。注意:1、JSONObjectArray格式 2、动态模板时必传 3、动参对象和手机号个数一致 示例:"[{"name": "aa","age": "34"}, {"name": "bb","age": "30"}, {"name": "cc","age": "29"}]" |
effective_days | string | 是 | 短链有效天数。注意:群发短链1100天,一客一链17天 |
aim_generate_type | string | 否 | 短码生成方式。说明:1-随机短码 2-自定义短码 默认1 |
aim_domain | string | 否 | 自定义域名。注意:短码生成方式设置为自定义的话,必填值 |
mass_aim_short_code | string | 否 | 群发短链的自定义短码。注意:1、每次调用值不要有重复 2、生成群发短链时,短码生成方式是自定义的话,必填值 |
alone_aim_short_codes | string | 否 | 一客一链的自定义短码。注意:跟mobiles格式一样,JSONStringArray格式 2、每次调用值不要有重复 3、生成一客一链时,短码生成方式是自定义的话,必填值 示例:"["ab12chy1","ab12chy2"]" |
1.3 响应参数
参数名 | 类型 | 默认值 | 描述 |
---|
code | string | | 000000 代表成功,其他代表失败,会有 message 错误信息返回 |
msg | string | | 提示信息 |
data | object | | 返回数据 |
data数据结构
参数名 | 类型 | 是否必传 | 描述 |
---|
mobile | string | 否 | 手机号 |
short_url | string | 否 | 短链 |
返回数据示例:
{
"code": "000000",
"message": "成功",
"data": [
{
"mobile": "13122298708",
"short_url": "cl2m.cn/ve2Api11"
},
{
"mobile": "15156908672",
"short_url": "cl2m.cn/ve2Api22"
}
]
}
1.4 请求示例(一客一链无动参)
{
"nonce": "123456789",
"timestamp": "1658974350",
"signature": "f9233da1efacf7934b2d68d3f2411d55d0c9c2eb92be05c36cabe7c7b8c1d169",
"app_id": "0AvyA8opHDqDs6X2",
"template_id": "CLAIM202207260953094148600813568",
"link_url": "https://www.chuanglan.com/",
"link_type": "2",
"mobiles": "[\"18587191949\",\"17321453868\",\"15156908672\",\"17764396263\"]"
}
1.5 请求示例(一客一链有动参)
{
"nonce": "123456789",
"timestamp": "1658974350",
"signature": "70fe9d11dcf7ba543724e7037b00ec72c193d60738f08a2233b0e22d41529bf0",
"app_id": "0AvyA8opHDqDs6X2",
"template_id": "CLAIM202209021653112908608677888",
"link_url": "https://www.chuanglan.com/",
"link_type": "2",
"mobiles": "[\"18587191949\",\"17321453868\",\"15156908672\",\"17764396263\"]",
"dynamic_params": "[{\"type\":\"一二\",\"num\":\"20\",\"style\":\"你好\"},{\"type\":\"三四\",\"num\":\"20\",\"style\":\"你好\"},{\"type\":\"五六\",\"num\":\"20\",\"style\":\"你好\"},{\"type\":\"七八\",\"num\":\"20\",\"style\":\"你好\"}]"
}
1.6 群发短链
{
"nonce":"1a8ce7919a39495e8e15a9ea8eb74d26",
"timestamp":"1662050291029",
"signature":"313c5e2e7df1a6346048a74c16d20a6c70fc881fcd2455153fa6475e8e088d5d",
"app_id":"0AvyA8opHDqDs6X2",
"template_id":"CLAIM202207260953094148600813568",
"link_url":"https://www.chuanglan.com",
"link_type":"1",
"mobile_count":"5"
}
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"
}
没有更多了