模板管理
更新时间:2026-07-29 20:09:09
接入准备
- 1、请先联系商务开通"深度接口账号"才能使用本目录下所有接口。
- 2、请登录控制台拿到发送短信的"API账号",添加模板根据API账号为导向的。
注意事项
- 1、添加模板或修改模板,都需要审核人员审核通过。如需催审请联系官网在线客服。
- 2、模板的报备规范请遵循模板规范。
接口列表
1、添加模板
1.1 请求地址
- 请求方式:post
- Content-Type:application/x-www-form-urlencoded
- 请求地址:
https://api.chuanglan.com/api/apis/v3/template/add
1.2 请求参数
| 参数名称 | 类型 | 是否必传 | 描述 | 示例 |
|---|---|---|---|---|
| username | String | 是 |
深度接口账号名
| "username":"13899999999" |
| timestamp | String | 是 |
时间戳
| "timestamp":"1755068823" |
| signature | String | 是 |
验签
| "signature":"e10adc3949ba59abbe56e057f20f883e" |
| api_name | String | 是 |
发短信的API账号
| "api_name":"N617810_N7533106" |
| content | String | 是 |
模板内容
| "content":"您的验证码为 {s},有效期5分钟" |
| content_name | String | 是 |
模板名称
| "content_name":"登录验证码模板" |
| signature_name | String | 是 |
关联签名名称
| "signature_name":"253 云通讯" |
| need_unsubscribe | String | 否 |
是否需要退订语
| "need_unsubscribe":"1" |
| business_category | String | 是 |
业务大类
| "business_category":"1001" |
| business_subcategory | String | 是 |
业务细类
| "business_subcategory":"100101" |
|
guide_url
| String | 否 |
引流链接
| "guide_url":"{\"guide_type\":\"2\",\"content\":\"https://api.253.com\",\"domain_example\":\"https://api.253.com/ZKPDCasdasdfT\"}" |
|
guide_phone
| String | 否 |
联系方式
| "guide_phone":"[{\"guide_type\":\"1\",\"content\":\"130XXXXXXXX\"}]" |
|
variable_params
| String | 否 |
变量属性
| "variable_params":"[{\"name\":\"变量1\",\"type\":\"3\",\"length\":\"30\",\"position\":0}]" |
| remark | String | 否 |
备注内容
| "remark":"请尽快审核,用于用户登录验证" |
1.3 请求示例(换行易读,实际请求需删除换行)
username=17321332052×tamp=1659584150&signature=2d68b71096508ae6b921cea4ca2c62e6&api_name=N123&content_name=测试&signature_name=关联签名&
content=测试模板{s}详情请戳 https://www.xxx.com 联系方式:130XXXXXXXX&need_unsubscribe=1&guide_url={"guide_type": "2","content": "https://www.xxx.com"}&
guide_phone=[{"guide_type": "1","content": "130XXXXXXXX"}]&business_category=01&business_subcategory=02&variable_params=[{"name":"变量1","type":"3","length":"4","position":0}]&remark=变量1为人名,最大长度为10
1.4 响应参数(JSON格式,中文部分需Unicode字符解码)
| 参数名 | 类型 | 描述 |
|---|---|---|
| code | String | 000000 代表成功,其他代表失败,会有 message 错误信息返回 |
| status | String | 状态说明 success:成功,error:失败 |
| msg | String | 提示信息(Unicode字符编码,需自行解码为中文) |
| data | object | 返回数据 |
| id | Ingeger | 模板 id |
返回数据示例(JSON):
{
"code": "000000",
"data": {
"id": "767669"
},
"msg": "深度接口新增模板成功",
"status": "success"
}2、查询模板类型枚举
2.1 请求地址
- 请求方式:post
- Content-Type:application/x-www-form-urlencoded
- 请求地址:
https://api.chuanglan.com/api/apis/template/queryTypeEnum
2.2 请求参数
| 参数名 | 类型 | 是否必传 | 描述 |
|---|---|---|---|
| username | String | 是 | 深度接口账号名,由创蓝商务提供。 示例:13899999999 |
| timestamp | String | 是 | 时间戳(10 位) |
| signature | String | 是 | 标准的 MD5 加密(32 位小写值),如:signature=md5(userName+password+timestamp) 两边通过相同的签名进行校验 |
| api_name | String | 是 | 发短信的API账号,请填写对应的API账号。示例:N617810_N7533106。 |
2.3 请求示例
username=17321332052×tamp=1659584575&signature=58ea5ae01b54881a84f7ba4e63aa2b2a&api_name=N123456
2.4 响应参数(JSON格式,中文部分需Unicode字符解码)
| 参数名 | 类型 | 描述 |
|---|---|---|
| code | String | 000000 代表成功,其他代表失败,会有 message 错误信息返回 |
| status | String | 状态说明 success:成功,error:失败 |
| msg | String | 提示信息(Unicode字符编码,需自行解码为中文) |
| data | object | 返回数据 |
| -variable_types | object [] | 变量类型 item 类型: object |
| --id | String | 类型id |
| --type | String | 类型名称 |
| -mobile_types | object [] | 号码类型 item 类型: object |
| --id | String | 类型id |
| --type | String | 类型名称 |
| -url_types | object [] | 引流类型 item 类型: object |
| --id | String | 类型id |
| --type | String | 类型名称 |
| -business_types | object [] | 业务类型 item 类型: object |
| --id | String | 类型id |
| --type | String | 类型名称 |
| --details | object [] | 业务明细 item 类型: object |
| ---id | String | 类型id |
| ---type | String | 类型名称 |
返回数据示例(JSON):
{
"code": "000000",
"data": {
"variable_types": [
{
"id": "1",
"type": "字符型"
},
{
"id": "2",
"type": "整数型"
},
{
"id": "3",
"type": "小数型"
},
{
"id": "4",
"type": "字符数据混合型"
}
],
"mobile_types": [
{
"id": "1",
"type": "手机号码"
},
{
"id": "2",
"type": "固定号码"
},
{
"id": "3",
"type": "400电话"
},
{
"id": "4",
"type": "800电话"
},
{
"id": "5",
"type": "95开头号码"
},
{
"id": "6",
"type": "96开头号码"
},
{
"id": "7",
"type": "1开头号码(非手机号码)"
},
{
"id": "8",
"type": "其他号码"
}
],
"url_types": [
{
"id": "1",
"type": "ip类型链接"
},
{
"id": "2",
"type": "域名类型链接"
}
],
"business_types": [
{
"id": "00",
"type": "业务管理和服务类",
"details": [
{
"id": "00",
"type": "其他用途"
},
{
"id": "01",
"type": "通知服务"
},
{
"id": "02",
"type": "验证码"
},
{
"id": "03",
"type": "业务提醒(非金融类)"
},
{
"id": "04",
"type": "业务提醒(金融类)"
},
{
"id": "05",
"type": "还款通知"
}
]
},
{
"id": "01",
"type": "商业性",
"details": [
{
"id": "00",
"type": "其它营销类别"
},
{
"id": "01",
"type": "金融推销(贷款理财和保险推销)"
},
{
"id": "02",
"type": "零售业推销"
},
{
"id": "03",
"type": "电信业务宣传"
},
{
"id": "04",
"type": "网络游戏推广"
},
{
"id": "05",
"type": "教育培训推销"
},
{
"id": "06",
"type": "房产中介推销"
},
{
"id": "07",
"type": "股票证券推销"
},
{
"id": "08",
"type": "医疗卫生推销"
},
{
"id": "09",
"type": "猎头招聘推广"
},
{
"id": "10",
"type": "旅游推广"
},
{
"id": "11",
"type": "未主动更新"
}
]
},
{
"id": "02",
"type": "公益性",
"details": [
{
"id": "00",
"type": "其他公益信息"
},
{
"id": "01",
"type": "政务民生信息"
},
{
"id": "02",
"type": "应急通知"
}
]
}
]
},
"msg": "深度接口枚举类型查询成功",
"status": "success"
}3、模板列表
3.1 请求地址
- 请求方式:post
- Content-Type:application/x-www-form-urlencoded
- 请求地址:
https://api.chuanglan.com/api/apis/template/list
2.2 请求参数
| 参数名 | 类型 | 是否必传 | 描述 |
|---|---|---|---|
| username | String | 是 | 深度接口账号名,由创蓝商务提供。 示例:13899999999 |
| timestamp | String | 是 | 时间戳(10 位) |
| signature | String | 是 | 标准的 MD5 加密(32 位小写值),如:signature=md5(userName+password+timestamp) 两边通过相同的签名进行校验 |
| api_name | String | 是 | 发短信的API账号,请填写对应的API账号。示例:N617810_N7533106。注:原sub_id和appid升级版参数,现在直接传对应的API账号值即可。 原来接入的appid和sub_id逻辑也保留,但优先级没有此参数高。 |
| start | Integer | 是 | 起始值,代表从第几个开始查起,传0代表从第一个查起,传1代表从第二个查起,默认为 0。 |
| length | Integer | 是 | 查询的长度,代表要查询出来多少条数据,默认为 10,最大值为 100。 |
| signature_name | string | 否 | 关联签名名称(精确匹配) |
| content_name | string | 否 | 模板名称(模糊查询) |
| Integer | 已废弃 | 现在已废弃,改成api_name参数了。产品类型,通知账号=49;会员营销账号=52;验证码账号=153;BK 账号=126;DK 账号=119;HK 账号=151 | |
| String | 已废弃 | 现在已废弃,改成api_name参数了。子账号 id,如果报备到子账号,则需要传递该参数,登录后台子账户管理界面获取。 |
3.3 请求示例
username=17321332052×tamp=1659584575&signature=58ea5ae01b54881a84f7ba4e63aa2b2a&api_name=N123&start=0&length=10
3.4 响应参数(JSON格式,中文部分需Unicode字符解码)
| 参数名 | 类型 | 描述 |
|---|---|---|
| code | String | 000000 代表成功,其他代表失败,会有 message 错误信息返回 |
| status | String | 状态说明 success:成功,error:失败 |
| msg | string | 提示信息(Unicode字符编码,需自行解码为中文) |
| data | object | 返回数据 |
| total | Integer | 返回分页总数量 |
| list | object [] | item 类型: object |
| id | String | 模板 id |
| web_or_api | Integer | 1:web;2:api 0:web api 通用 |
| account_id | String | 自助通账号 id |
| type | Integer | 模板类型:1:通知短信 2:营销样板 3:变量样板 4:自定义样板 5:物流订单 6:验证码 7:医疗行业 8:电商订单 |
| content_task | String | 任务内容 |
| content | String | 模板内容 |
| remark | String | 模板备注 |
| create_time | String | 创建时间 |
| status | String | 模板状态,0:未审核;1:已审核;2:审核驳回;4:模板过期 |
| audit_date | String | 审核时间 |
| audit_reason | String | 驳回原因 |
| String | 原营销模板的退订语,该字段已废弃 | |
| remote_id | Integer | 远程 id |
| signature_name | String | 关联签名名称 |
| content_name | string | 模板名称 |
| cm_operator_status | string | 移动运营商审核状态 1:未审核,2:审核通过,3:审核驳回,-1:查询失败 |
| ct_operator_status | string | 电信运营商审核状态 1:未审核,2:审核通过,3:审核驳回,-1:查询失败 |
| cu_operator_status | string | 联通运营商审核状态 1:未审核,2:审核通过,3:审核驳回,-1:查询失败 |
返回数据示例(JSON):
{
"code": "000000",
"data": {
"list": [
{
"account_id": "252289",
"appkey": "cl_normal_sms",
"audit_date": "0",
"audit_reason": "",
"content": "我是测试模板不要找我",
"content_task": null,
"create_time": "1659584385",
"id": "767669",
"model_id": "0",
"remark": "非必选参数。备注内容",
"remote_id": "0",
"status": "0",
"type": "4",
"web_or_api": "0"
},
{
"account_id": "252289",
"appkey": "cl_normal_sms",
"audit_date": "1659051510",
"audit_reason": "模板内容为测试无意义内容,驳回处理,如有疑问请联系客服。",
"content": "1111 测试验证 v6 接口测试新建模板 2022071411",
"content_task": null,
"create_time": "1659032032",
"id": "765145",
"model_id": "0",
"remark": "测试 cxq",
"remote_id": "0",
"status": "2",
"type": "4",
"web_or_api": "0"
}
],
"total": 2
}
}4、模板内容 ID 单个查询
4.1 请求地址
- 请求方式:post
- Content-Type:application/x-www-form-urlencoded
- 请求地址:
https://api.chuanglan.com/api/apis/template/getSingleTemplateInfo
4.2 请求参数
| 参数名 | 类型 | 是否必传 | 描述 |
|---|---|---|---|
| username | String | 是 | 深度接口账号名,由创蓝商务提供。 示例:13899999999 |
| timestamp | String | 是 | 时间戳(10 位) |
| signature | String | 是 | 标准的 MD5 加密(32 位小写值),如:signature=md5(userName+password+timestamp) 两边通过相同的签名进行校验 |
| api_name | String | 是 | 发短信的API账号,请填写对应的API账号。示例:N617810_N7533106。注:原sub_id和appid升级版参数,现在直接传对应的API账号值即可。 原来接入的appid和sub_id逻辑也保留,但优先级没有此参数高。 |
| id | String | 是 | 模板 id,需要查询的模板对应的id。 |
| Integer | 已废弃 | 现在已废弃,改成api_name参数了。产品类型,通知账号=49;会员营销账号=52;验证码账号=153;BK 账号=126;DK 账号=119;HK 账号=151 | |
| String | 已废弃 | 现在已废弃,改成api_name参数了。子账号 id,如果报备到子账号,则需要传递该参数,登录后台子账户管理界面获取。 |
4.3 请求示例
username=17321332052×tamp=1659584443&signature=db0da4a3c61c5621b76c154ef89c74e2&api_name=N123&id=767669
4.4 响应参数(JSON格式,中文部分需Unicode字符解码)
| 参数名 | 类型 | 默认值 | 描述 |
|---|---|---|---|
| code | String | 000000 代表成功,其他代表失败,会有 message 错误信息返回 | |
| status | String | 状态说明 success:成功,error:失败 | |
| msg | String | 提示信息(Unicode字符编码,需自行解码为中文) | |
| data | object | 返回数据 | |
| id | String | 模板 id | |
| web_or_api | String | 1:web;2:api 0:web api 通用 | |
| account_id | String | 模板内容 | |
| type | Integer | 模板类型:1:通知短信 2:营销样板 3:变量样板 4:自定义样板 5:物流订单 6:验证码 7:医疗行业 8:电商订单 | |
| signature | String | 签名(该字段已废弃,以前报备模板有传入签名的,会返回字段,否则不返回) | |
| content_task | String | 任务内容 | |
| content | String | 模板内容(Unicode字符编码,需自行解码为中文) | |
| remark | String | 模板备注 | |
| create_time | String | 创建时间 | |
| status | String | 模板状态,0:未审核;1:已审核;2:审核驳回;4:模板过期 | |
| audit_date | String | 审核时间 | |
| audit_reason | String | 驳回原因 | |
| unsubscribe | String | 后缀,适用于营销短信 | |
| status_desc | String | 状态描述 | |
| content_name | String | 是 | 模板名称* |
| signature_name | String | 是 | 关联签名名称(从签名列表接口查询审核通过的签名) |
| need_unsubscribe | String | 否 | 是否需要退定语;0 不需要,1 需要,营销类型必传。 |
| business_category | String | 是 | 业务大类(类型枚举接口获取,本目录第二个接口,id值) |
| business_subcategory | String | 是 | 业务细类(类型枚举接口获取,本目录第二个接口,id值) |
| guide_url | String | 否 | 引流链接(object类型转成json) |
| -guide_type | String | 否 | 引流链接类型(类型枚举接口获取,本目录第二个接口,id值) |
| -content | String | 否 | 引流链接内容(模板内容中包含的引流链接) |
| -domain_example | String | 否 | 完整链接示例(例如引流链接内容为xx.cn,完整链接 http://www.xxx.cn) |
| guide_phone | String | 否 | 联系方式(object[]类型转成json) |
| -guide_type | String | 否 | 联系方式类型(类型枚举接口获取,本目录第二个接口,id值) |
| -content | String | 否 | 联系方式内容(模板内容中包含的联系方式) |
| variable_params | String | 否 | 变量属性(应运营商要求变量模版的变量词最多支持20个)(object[]类型转成json) |
| -name | String | 否 | 变量名称 |
| -type | String | 否 | 变量类型(类型枚举接口获取,本目录第二个接口,id值) |
| -length | String | 否 | 变量长度 |
| -position | String | 否 | 变量位置(位置:0,1,2,3...) |
| -cm_operator_status | String | 移动运营商审核签名状态 1:未审核,2:审核通过,3:审核驳回,-1:查询失败 | |
| -ct_operator_status | String | 电信运营商审核签名状态 1:未审核,2:审核通过,3:审核驳回,-1:查询失败 | |
| -cu_operator_status | String | 联通运营商审核签名状态 1:未审核,2:审核通过,3:审核驳回,-1:查询失败 | |
| -cm_operator_reject_reason | List | 移动运营商审核驳回原因集合 | |
| --issue_type | Integer | 问题类型,1:签名问题,2:签名材料问题,3:终端资质问题,4:其他,5:引流问题 | |
| --issue_desc | String | 问题描述 | |
| --operation_recommend | String | 操作建议 | |
| --modify_modules | String | 修改模块,1:新增终端资质,2:变更签名终端资质,3:修改签名材料 a,4:变更签名类型,5:新增签名,6:修改链接材料,7:修改联系方式材料,8:无需修改 | |
| -cu_operator_reject_reason | List | 联通运营商审核驳回原因集合 | |
| --issue_type | Integer | 问题类型,1:签名问题,2:签名材料问题,3:终端资质问题,4:其他,5:引流问题 | |
| --issue_desc | String | 问题描述 | |
| --operation_recommend | String | 操作建议 | |
| --modify_modules | String | 修改模块,1:新增终端资质,2:变更签名终端资质,3:修改签名材料 a,4:变更签名类型,5:新增签名,6:修改链接材料,7:修改联系方式材料,8:无需修改 | |
| -ct_operator_reject_reason | List | 电信运营商审核驳回原因集合 | |
| --issue_type | Integer | 问题类型,1:签名问题,2:签名材料问题,3:终端资质问题,4:其他,5:引流问题 | |
| --issue_desc | String | 问题描述 | |
| --operation_recommend | String | 操作建议 | |
| --modify_modules | String | 修改模块,1:新增终端资质,2:变更签名终端资质,3:修改签名材料 a,4:变更签名类型,5:新增签名,6:修改链接材料,7:修改联系方式材料,8:无需修改 |
返回数据示例(JSON):
{
"code": "000000",
"status": "success",
"msg": "深度接口根据 id 查询签名成功",
"data": {
"is_system_signature": "0",
"signature_id": "31257",
"signature_name": "深度接口 v6 子账号 00333",
"signature_status": "2",
"operator_status": "2",
"real_name_status": "3",
"audit_reason": "该签名行业属性不符合规定的发送要求。",
"real_name_audit_reason": "实名材料模板错误",
"cm_operator_status": "3",
"ct_operator_status": "3",
"cu_operator_status": "3",
"cm_operator_reject_reason": [
{
"issue_type": 1,
"issue_desc": "签名名称包含违规字符",
"operation_recommend": "修改签名名称后重新提交审核",
"modify_modules": "5"
}
],
"cu_operator_reject_reason": [
{
"issue_type": 3,
"issue_desc": "终端资质证明材料不完整",
"operation_recommend": "新增完整的终端资质",
"modify_modules": "1"
}
],
"ct_operator_reject_reason": [
{
"issue_type": 2,
"issue_desc": "营业执照模板不符合要求",
"operation_recommend": "更换签名材料后重新提交",
"modify_modules": "3"
}
]
}
}5、模板编辑
注意事项:
- 只有未审核状态的模板才能使用此接口。如需修改审核驳回或审核通过的模板,请调用模板引流编辑的接口。
5.1 请求地址
- 请求方式:post
- Content-Type:application/x-www-form-urlencoded
- 请求地址:
https://api.chuanglan.com/api/apis/v3/template/update
5.2 请求参数
| 参数名称 | 类型 | 是否必传 | 描述 | 示例 |
|---|---|---|---|---|
| username | String | 是 |
深度接口账号名
| "username":"13899999999" |
| timestamp | String | 是 |
时间戳
| "timestamp":"1755068823" |
| signature | String | 是 |
验签
| "signature":"e10adc3949ba59abbe56e057f20f883e" |
| api_name | String | 是 |
发短信的API账号
| "api_name":"N617810_N7533106" |
| content | String | 是 |
模板内容
| "content":"您的验证码为 {s},有效期5分钟" |
| id | Integer | 是 | 要修改的模板ID | "id":10086 |
| content_name | String | 是 | 模板名称 | "content_name":"登录验证码模板" |
| signature_name | String | 是 |
关联签名名称
| "signature_name":"253 云通讯" |
| need_unsubscribe | String | 否 |
是否需要退订语
| "need_unsubscribe":"1" |
| business_category | String | 是 |
业务大类
| "business_category":"1001" |
| business_subcategory | String | 是 |
业务细类
| "business_subcategory":"100101" |
|
guide_url
| String | 否 |
引流链接
| "guide_url":"{\"guide_type\":\"2\",\"content\":\"https://api.253.com\",\"domain_example\":\"https://api.253.com/ZKPDCasdasdfT\"}" |
|
guide_phone
| String | 否 |
联系方式
| "guide_phone":"[{\"guide_type\":\"1\",\"content\":\"130XXXXXXXX\"}]" |
|
variable_params
| String | 否 |
变量属性
| "variable_params":"[{\"name\":\"变量1\",\"type\":\"3\",\"length\":\"30\",\"position\":0}]" |
| remark | String | 否 | 备注内容 | "remark":"请尽快审核,用于用户登录验证" |
});
5.3 请求示例
username=17321332052×tamp=1659584769&signature=41144120685f578a4d137f16e07d9932&api_name=N123&id=750665&
content=您的验证码为{s},有效期5分钟&content_name=登录验证码模板&signature_name=253云通讯&need_unsubscribe=1&business_category=1001&
business_subcategory=100101&guide_url={"guide_type":"2","content":"https://api.253.com","domain_example":"https://api.253.com/ZKPDCasdasdfT",
"icp_img":"data:image/jpeg;base64,/9j/4AAQXXXXXXXXXXX","origin_link_auth_img":"data:image/jpeg;base64,/9j/4AAQXXXXXXXXXXX",
"redirect_link_auth_img":"data:image/jpeg;base64,/9j/4AAQXXXXXXXXXXX"}&guide_phone=[{"guide_type":"1","content":"130XXXXXXXX",
"phone_material_img":"data:image/jpeg;base64,/9j/4AAQXXXXXXXXXXX"}]&variable_params=[{"name":"变量1","type":"3","length":"30","position":"0"}]&remark=请尽快审核,用于用户登录验证5.4 响应参数(JSON格式,中文部分需Unicode字符解码)
| 参数名 | 类型 | 默认值 | 描述 |
|---|---|---|---|
| code | String | 000000 代表成功,其他代表失败,会有 message 错误信息返回 | |
| status | String | 状态说明 success:成功,error:失败 | |
| msg | String | 提示信息(Unicode字符编码,需自行解码为中文) |
返回数据示例(JSON):
{
"code": "000000",
"msg": "深度接口更新模板成功",
"status": "success"
}6、模板引流信息编辑
注意事项:
- 此接口用于审核通过或驳回的模板里的引流信息。
6.1 请求地址
- 请求方式:post
- Content-Type:application/x-www-form-urlencoded
- 请求地址:
https://api.chuanglan.com/api/apis/v1/template/updateLinkMaterial
6.2 请求参数
| 参数名称 | 类型 | 是否必传 | 描述 | 示例 |
|---|---|---|---|---|
| username | String | 是 |
深度接口账号名
| "username":"13899999999" |
| timestamp | String | 是 |
时间戳
| |
| signature | String | 是 |
验签
| |
| api_name | String | 是 |
发短信的API账号
| "api_name":"N617810_N7533106" |
| id | Integer | 是 |
要修改的模板 id
| |
| phone_one_material_img | String | 否 |
引流号码材料一
| "phone_one_material_img":"data:image/jpg;base64,/9j/4AAQSkZJR" |
| phone_two_material_img | String | 否 |
引流号码材料二
| "phone_two_material_img":"data:image/jpg;base64,/9j/4AAQSkZJR" |
| icp_img | String | 否 |
域名ICP备案截图
| "icp_img":"data:image/jpg;base64,/9j/4AAQSkZJR" |
| origin_link_auth_img | String | 否 |
原链接授权书
| "origin_link_auth_img":"data:image/jpg;base64,/9j/4AAQSkZJR" |
| redirect_link_auth_img | String | 否 |
跳转后链接授权书
| "redirect_link_auth_img":"data:image/jpg;base64,/9j/4AAQSkZJR" |
});
6.3 请求示例
username=17321332052×tamp=1659584769&signature=41144120685f578a4d137f16e07d9932&api_name=N123456
6.4 响应参数(JSON格式,中文部分需Unicode字符解码)
| 参数名 | 类型 | 默认值 | 描述 |
|---|---|---|---|
| code | String | 000000 代表成功,其他代表失败,会有 message 错误信息返回 | |
| status | String | 状态说明 success:成功,error:失败 | |
| msg | String | 提示信息(Unicode字符编码,需自行解码为中文) | |
| data | object | 返回数据 |
返回数据示例(JSON):
{
"code": "000000",
"data": null,
"msg": "深度接口修改模板引流材料成功",
"status": "success"
}7、删除模板
7.1 请求地址
- 请求方式:post
- Content-Type:application/x-www-form-urlencoded
- 请求地址:
https://api.chuanglan.com/api/apis/template/del
7.2 请求参数
| 参数名 | 类型 | 是否必传 | 描述 |
|---|---|---|---|
| username | String | 是 | 深度接口账号名,由创蓝商务提供。 示例:13899999999 |
| timestamp | String | 是 | 时间戳(10 位) |
| signature | String | 是 | 标准的 MD5 加密(32 位小写值),如:signature=md5(userName+password+timestamp) 两边通过相同的签名进行校验 |
| api_name | String | 是 | 发短信的API账号,请填写对应的API账号。示例:N617810_N7533106。注:原sub_id和appid升级版参数,现在直接传对应的API账号值即可。 原来接入的appid和sub_id逻辑也保留,但优先级没有此参数高。 |
| id | Integer | 是 | 模板 id |
| Integer | 已废弃 | 现在已废弃,改成api_name参数了。产品类型,通知账号=49;会员营销账号=52;验证码账号=153;BK 账号=126;DK 账号=119;HK 账号=151 | |
| String | 已废弃 | 现在已废弃,改成api_name参数了。子账号 id,如果报备到子账号,则需要传递该参数,登录后台子账户管理界面获取。 |
7.3 请求示例
username=17321332052×tamp=1659584769&signature=41144120685f578a4d137f16e07d9932&api_name=N123&id=750665
7.4 响应参数(JSON格式,中文部分需Unicode字符解码)
| 参数名 | 类型 | 默认值 | 描述 |
|---|---|---|---|
| code | String | 000000 代表成功,其他代表失败,会有 message 错误信息返回 | |
| status | String | 状态说明 success:成功,error:失败 | |
| msg | String | 提示信息(Unicode字符编码,需自行解码为中文) |
返回数据示例(JSON):
{
"code": "000000",
"msg": "深度接口根据 id 删除模板成功",
"status": "success"
}8、 审核结果推送
8.1 推送方式
- 回调方式:post
- Content-Type:application/x-www-form-urlencoded
- 审核回调地址:深度接口回调地址请联系对应商务配置和查询。
注:推送会有 15 分钟左右的延迟,有定时任务一起推送。
8.2 推送参数
| 参数名 | 类型 | 描述 |
|---|---|---|
| username | String | 深度接口账号名,接口请求添加模板时用的账号。 示例:13899999999 |
| timestamp | String | 时间戳(10 位) |
| signature | String | 标准的 MD5 加密(32 位小写值),如:signature=md5(userName+password+timestamp) 两边通过相同的签名进行校验 |
| action | String | 功能类型,messageModel(模板)、smsSignature(签名) |
| id | String | 模板id,添加模板时返回的id,一般是10位纯数字,不排除以后增长或缩减。 |
| auditStatus | String | 审核结果,模板(1通过,2驳回),签名(2通过,3驳回),返回值里是数字。 |
| auditReason | String | 驳回时的原因,如:内容不支持发送。如果审核结果是通过,该参数为空值。 |
8.3 推送参数示例
{
"username": "cl13908446911",
"timestamp": "1702971183",
"signature": "8e563949655a851c34a71ac2c5f4a542",
"action": "messageModel",
"id": "593965",
"auditStatus": "1",
"auditReason": "请修改文案"
}提交响应码说明
| 序号 | 参数 | 说明 | 问题处理人 |
|---|---|---|---|
| 1 | cl0000 | 未知错误 | 对接技术 |
| 2 | cl0001 | 参数不全 | 对接技术 |
| 3 | cl0002 | 传过来的时间戳与服务器时间误差在 10s 以上 | 对接技术 |
| 4 | cl0003 | 接口账号不存在 | 商务 |
| 5 | cl0004 | 签名不正确 | 对接技术 |
| 6 | cl0005 | 非法操作 | 对接技术 |
| 7 | cl9999 | 未知错误 | 对接技术 |
| 8 | cl0101 | 内容含有敏感词 | 客服 |
| 9 | cl0102 | 营销短信缺少退订信息 | 对接技术 |
| 10 | cl0103 | 营销短信退订信息输入错误 | 对接技术 |
| 11 | cl0104 | 当前产品账号未激活 | 对接技术 |
| 12 | cl0201 | 分配权限格式不正确 | 对接技术 |
| 13 | cl0202 | 请选择用途类型 | 对接技术 |
| 14 | cl0203 | 账号用途长度为 1-50 字符 | 对接技术 |
| 15 | cl0204 | 姓名为数字字母中文且不超过 8 个字 | 对接技术 |
| 16 | cl0205 | 部门为数字字母中文且不超过 8 个字 | 对接技术 |
| 17 | cl0206 | 职位为数字字母中文且不超过 8 个字 | 对接技术 |
| 18 | cl0207 | 账号为非中文 6-20 个字符 | 对接技术 |
| 19 | cl0208 | 密码为非中文 6-16 个字符 | 对接技术 |
| 20 | cl0209 | 该账户已被占用 | 客服 |
| 21 | cl0210 | 当前账号对应的自助通账号不存在 | 商务 |
| 22 | cl0211 | 子账号个数超过限制,请联系客服 | 客服 |
| 23 | cl0212 | 子账号创建失败 | 对接技术 |
| 24 | cl0213 | 当前子账号不存在 | 对接技术 |
| 25 | cl0214 | 子账号没有该权限 | 对接技术 |
| 26 | cl0215 | 该应用已激活 | 对接技术 |
| 27 | cl0216 | 当前账号没有完成信息认证 | 对接技术 |
| 28 | cl0217 | 激活失败 | 对接技术 |
| 29 | cl0218 | 额度只能为正整数 | 对接技术 |
| 30 | cl0219 | 该应用未激活 | 对接技术 |
| 31 | cl0220 | 余额不足无法充值 | 商务 |
| 32 | cl0221 | 子账号余额不足无法转回 | 商务 |
| 33 | cl0222 | 条数调拨失败 | 商务 |
| 34 | cl0301 | 当前应用未激活 | 对接技术 |
| 35 | cl0302 | 签名长度为 2-10 个字符 | 对接技术 |
| 36 | cl0303 | 开启审核提醒的情况下,接收手机号必须 | 客服 |
| 37 | cl0304 | 至少选择一项应用场景 | 客服 |
| 38 | cl0305 | 应用场景名称为 2-30 个字符 | 对接技术 |
| 39 | cl0306 | 签名个数达到上限 | 商务 |
| 40 | cl0307 | 添加签名失败 | 对接技术 |
| 41 | cl0308 | 查询列表最大长度为 100 | 对接技术 |
| 42 | cl0309 | 当前签名不存在 | 对接技术 |
| 43 | cl0310 | 该签名已经被添加模板,请先删除对应的模板 | 客服 |
| 44 | cl0311 | 删除签名失败 | 对接技术 |
| 45 | cl0312 | 当前签名已存在 | 客服 |
| 46 | cl0401 | 查询列表最大长度为 100 | 对接技术 |
| 47 | cl0402 | 当前应用未激活 | 对接技术 |
| 48 | cl0501 | 查询列表最大长度为 100 | 对接技术 |
| 49 | cl0502 | 当前应用未激活 | 对接技术 |
| 50 | cl0503 | 查询状态参数不合法 | 对接技术 |
这篇文档对您有帮助吗?




