模板管理

接入准备

注意事项

接口列表

1、添加模板

1.1 请求地址

• 请求方式：post
• Content-Type：application/x-www-form-urlencoded
• 请求地址：https://api.chuanglan.com/api/apis/template/add

1.2 请求参数

参数名	类型	是否必传	描述
username	string	是	深度接口账号名，由创蓝商务提供。 示例：13899999999
timestamp	string	是	时间戳（10 位）
signature	string	是	标准的 MD5 加密（32 位小写值），如：signature=md5(userName+password+timestamp) 两边通过相同的签名进行校验
api_name	String	是	发短信的API账号，请填写对应的API账号。示例：N617810_N7533106。
content	string	是	模板内容（不包含短信签名也不包含退订语，提交短信时在末尾带上退订语“拒收请回复R”即可，系统会自动校验是否携带这个退订语）模板内容长度不超过500个字。
remark	string	否	备注内容，一般是描述模板的应用场景，有利于加速模板审核
unsubscribe	string	废弃	该字段已废弃，添加营销模板时可以不传，短信发送时只需在内容结尾拼接上任意合法退订语即可，如“拒收请回复R”。如需在模板中固定退订语，可在content字段内添加。 需注意：固定退订语后，如需修改退订语就相当于修改模板内容，需要再次审核，建议不要固定退订语，则在后续退订语使用上更为灵活。

1.3 响应参数

参数名	类型	默认值	描述
code	string		000000 代表成功，其他代表失败，会有 message 错误信息返回
status	string		状态说明 success：成功，error：失败
msg	string		提示信息
data	object		返回数据
id	Ingeger		模板 id

{
    "code": "000000",
    "data": {
        "id": "767669"
    },
    "msg": "深度接口新增模板成功",
    "status": "success"
}

1.4 请求示例

{
    "username":"17321332052",
    "timestamp":"1659584150",
    "signature":"2d68b71096508ae6b921cea4ca2c62e6",
    "appid":"49",
    "start":"0",
    "length":"10"
}

2、模板列表

2.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。
appid	Integer	已废弃	现在已废弃，改成api_name参数了。产品类型，通知账号=49；会员营销账号=52；验证码账号=153；BK 账号=126；DK 账号=119；HK 账号=151
sub_id	String	已废弃	现在已废弃，改成api_name参数了。子账号 id，如果报备到子账号，则需要传递该参数，登录后台子账户管理界面获取。

2.3 响应参数

参数名	类型	默认值	描述
code	string		000000 代表成功，其他代表失败，会有 message 错误信息返回
status	string		状态说明 success：成功，error：失败
msg	string		提示信息
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：电商订单
signature	string		原签名字段，已废弃，模板不在必须与某个签名强关联。
content_task	string		任务内容
content	string		模板内容
remark	string		模板备注
create_time	string		创建时间
status	string		模板状态，0:未审核；1:已审核；2:审核驳回；4：模板过期
audit_date	string		审核时间
audit_reason	string		驳回原因
unsubscribe	string		原营销模板的退订语，该字段已废弃
remote_id	Integer		远程 id

{
    "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
    }
}

2.4 请求示例

{
    "username":"17321332052",
    "timestamp":"1659584575",
    "signature":"58ea5ae01b54881a84f7ba4e63aa2b2a",
    "appid":"49",
    "start":"0",
    "length":"10"
}

3、模板 ID 单个查询

3.1 请求地址

• 请求方式：post
• Content-Type：application/x-www-form-urlencoded
• 请求地址：https://api.chuanglan.com/api/apis/template/getSingleTemplateInfo

3.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。
appid	Integer	已废弃	现在已废弃，改成api_name参数了。产品类型，通知账号=49；会员营销账号=52；验证码账号=153；BK 账号=126；DK 账号=119；HK 账号=151
sub_id	String	已废弃	现在已废弃，改成api_name参数了。子账号 id，如果报备到子账号，则需要传递该参数，登录后台子账户管理界面获取。

3.3 响应参数

参数名	类型	默认值	描述
code	string		000000 代表成功，其他代表失败，会有 message 错误信息返回
status	string		状态说明 success：成功，error：失败
msg	string		提示信息
data	object		返回数据
id	string		返回分页总数量
list	string		item 类型: 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		模板内容
remark	string		模板备注
create_time	string		创建时间
status	string		模板状态，0:未审核；1:已审核；2:审核驳回；4：模板过期
audit_date	string		审核时间
audit_reason	string		驳回原因
unsubscribe	string		后缀，适用于营销短信
status_desc	string		状态描述

{
    "code": "000000",
    "data": {
        "account_id": "252289",
        "audit_date": "0",
        "audit_reason": "",
        "content": "我是测试模板不要找我",
        "content_task": "",
        "create_time": "1659584385",
        "id": "767669",
        "model_id": "0",
        "remark": "非必选参数。备注内容",
        "remote_id": "0",
        "signature": "非必选参数。签名 [新注：新建模板不需要传此参数]",
        "status": "0",
        "status_desc": "未使用（假如是自定义模板为未审核）",
        "type": "4",
        "unsubscribe": "",
        "web_or_api": "0"
    },
    "msg": "深度接口根据 id 查询模板成功",
    "status": "success"
}

3.4 请求示例

{
    "username":"17321332052",
    "timestamp":"1659584443",
    "signature":"db0da4a3c61c5621b76c154ef89c74e2",
    "appid":"49",
    "id":"767669"
}

4、模板编辑

4.1 请求地址

• 请求方式：post
• Content-Type：application/x-www-form-urlencoded
• 请求地址：https://api.chuanglan.com/api/apis/template/update

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逻辑也保留，但优先级没有此参数高。
content	string	是	模板内容，填写你需要修改后的内容（不包含短信签名也不包含退订语）
id	Integer	是	要修改的模板 id
appid	Integer	已废弃	现在已废弃，改成api_name参数了。产品类型，通知账号=49；会员营销账号=52；验证码账号=153；BK 账号=126；DK 账号=119；HK 账号=151
unsubscribe	string	废弃	该字段已废弃，添加营销模板时可以不传，短信发送时只需在内容结尾拼接上任意合法退订语即可，如“拒收请回复R”。如需在模板中固定退订语，可在content字段内添加。 需注意：固定退订语后，如需修改退订语就相当于修改模板内容，需要再次审核，建议不要固定退订语，则在后续退订语使用上更为灵活。
sub_id	String	已废弃	现在已废弃，改成api_name参数了。子账号 id，如果报备到子账号，则需要传递该参数，登录后台子账户管理界面获取。
remark	string	否	备注内容

4.3 响应参数

参数名	类型	默认值	描述
code	string		000000 代表成功，其他代表失败，会有 message 错误信息返回
status	string		状态说明 success：成功，error：失败
msg	string		提示信息

{
    "code": "000000",
    "msg": "深度接口更新模板成功",
    "status": "success"
}

4.4 请求示例

{
    "username":"17321332052",
    "timestamp":"1659587151",
    "signature":"6db736ee9e84324513c98ba80c89ef9f",
    "appid":"49",
    "id":"750853",
    "content":"编辑模板内容 22",
    "remark":"测试模板接口"
}

5、删除模板

5.1 请求地址

• 请求方式：post
• Content-Type：application/x-www-form-urlencoded
• 请求地址：https://api.chuanglan.com/api/apis/template/del

5.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
appid	Integer	已废弃	现在已废弃，改成api_name参数了。产品类型，通知账号=49；会员营销账号=52；验证码账号=153；BK 账号=126；DK 账号=119；HK 账号=151
sub_id	String	已废弃	现在已废弃，改成api_name参数了。子账号 id，如果报备到子账号，则需要传递该参数，登录后台子账户管理界面获取。

5.3 响应参数

参数名	类型	默认值	描述
code	string		000000 代表成功，其他代表失败，会有 message 错误信息返回
status	string		状态说明 success：成功，error：失败
msg	string		提示信息

{
    "code": "000000",
    "msg": "深度接口根据 id 删除模板成功",
    "status": "success"
}

5.4 请求示例

{
    "username":"17321332052",
    "timestamp":"1659584769",
    "signature":"41144120685f578a4d137f16e07d9932",
    "appid":"49",
    "id":"750665"
}

6、 审核结果推送

6.1 推送方式

• 回调方式：post
• Content-Type：application/x-www-form-urlencoded
• 审核回调地址：深度接口回调地址请联系对应商务配置和查询。

6.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	驳回时的原因，如：内容不支持发送。如果审核结果是通过，该参数为空值。

6.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	查询状态参数不合法	对接技术