签名管理

接入准备

接入流程

注意事项

接口列表

1、添加签名

1.1 请求地址

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

1.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逻辑也保留，但优先级没有此参数高。
signature_scene_type	Integer	是	应用场景，传3 代表签名为自己产品名/网站名/APP 名称等； 传4 代表签名为他人产品名/网站名等
logo	string	是	图片，数组格式提交：当signature_scene_type 为3时需要上传三张图片：签名授权书、具有版权的商标或 logo、体现公司logo或名称的产品截图； 如果signature_scene_type 为4时则还需要上传“经办人授权书”，总共四张图片。每张图片大小2M以内，支持png,jpg,gif,jpeg格式的图片，Base64处理后的。
signature_name	string	是	短信签名，比如：253 云通讯。（不需要带中文括号，只包含括号里的文案） 长度限2-16个字符，中文、字母都算一个占位字符，具体规范请参考签名规范。
is_online	Integer	是	是否上线，传1 代表已上线， 传0 代表未上线； 选择未上线时，该签名会被限制发送短信数量，日限100条。 （已上线：需要上传 app 名称或者官网地址，详情看下面参数。如选择未上线，则不需要）
web_site	String	否	官网网址（如果 is_online 选择了已上线，则本参数和 app 参数选其中一个参数传递即可，都传也行。）
app	String	否	app 名称，可在应用商城能够搜到。（如果 is_online 选择了已上线，则本参数和 web_site 参数选其中一个参数传递即可，都传也行。）
real_name_text_img_flag	String	否	选择实名信息上传的方式。应用场景为他人时，则为必传。传0为文本，传1为图片。应用场景为自己时，只能传文本，就可以直接跳过本参数直接传下面的。 实名信息上传方式二选一。
real_name_logo	String	否	实名信息图片，real_name_text_img_flag=1，则为必填，上传三张图片，按顺序，第一张身份证人像，第二张身份证国徽，第三张营业执照。 每张图片不大于2M，支持 png,jpg,gif,jpeg 格式的图片，base64处理后，以数组格式提交。
enterprise_name	String	否	企业名称，应用场景为自己或者real_name_text_img_flag=0时，则为必填
unified_social_credit_code	String	否	统一社会信用代码，应用场景为自己或者及real_name_text_img_flag=0，则为必填
attention_line	String	否	经办人姓名，应用场景为自己或者real_name_text_img_flag=0，则为必填
attention_id_card	String	否	经办人身份证号，应用场景为自己或者real_name_text_img_flag=0，则为必填
remind_type	string	否	审核结果用手机短信告知，1 需要，0 不需要
remind_phone	Integer	否	提醒手机，remind_type 为 1 的情况下此值必传，示例：135xxxxxxxx
appid	Integer	已废弃	现在已废弃，改成api_name参数了。产品类型，通知账号=49；会员营销账号=52；验证码账号=153；BK 账号=126；DK 账号=119；HK 账号=151
sub_id	String	已废弃	现在已废弃，改成api_name参数了。子账号 id，如果报备到子账号，则需要传递该参数，登录后台子账户管理界面获取。

1.3 响应参数

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

{
    "code": "000000",
    "data": {
        "id": "341708"
    },
    "msg": "深度接口新增签名成功",
    "status": "success"
}

1.4 请求示例

{
    "username": "17321332052",
    "timestamp": "1659583889",
    "signature": "f3ecceccfb68922930e3f139b599477e",
    "appid": "49",
    "signature_name": "深度接口测试 1111",
    "signature_scene_type": "3",
    "is_onlone": "1",
    "logo[0]": "data:image/jpg;base64,/9j/4AAQSkZJR",
    "logo[1]": "data:image/jpg;base64,/9j/4AAQSkZJR",
    "app": "创蓝小程序",
    "remind_type": "0",
    "remind_phone": "0"

}

2、签名列表

2.1 请求地址

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

2.1 请求参数

参数名	类型	是否必传	描述
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，是第一页。
length	Integer	是	分页的大小，表示每页显示的签名个数为多少个。默认为 10，可选择10、20、50、100这4个长度。
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
signature_id	string		模板 id
signature_name	string		名称
signature_status	string		平台审签名状态 1：未审核，2：审核通过，3：审核驳回，-1：历史签名
operator_status	number		运营商审核签名状态 1：未审核，2：审核通过，3：审核驳回
is_system_signature	string		是否为默认签名：0：普通签名，1：默认签名

{
    "code": "000000",
    "data": {
        "list": [
            { "is_system_signature": "0", "signature_id": "341708", "signature_name": "深度接口测试 1111", "signature_status": "1","operator_status"：2 },
            { "is_system_signature": "0", "signature_id": "340215", "signature_name": "常量签名 02", "signature_status": "2","operator_status"：2 },
            { "is_system_signature": "1", "signature_id": "318409", "signature_name": "常量签名 01", "signature_status": "2","operator_status"：2 },
            { "is_system_signature": "0", "signature_id": "301312", "signature_name": "测试未上线签名 0706", "signature_status": "2","operator_status"：2 },
            { "is_system_signature": "0", "signature_id": "296483", "signature_name": "0531 测试自助通 V6", "signature_status": "2","operator_status"：2 }
        ],
        "total": 10
    },
    "msg": "深度接口签名列表查询成功",
    "status": "success"
}

2.4 请求示例

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

3、签名 id 查询

3.1 请求地址

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

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	Integer	是	签名 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		返回信息
is_system_signature	string		是否为默认签名：0 普通签名，1 默认签名
signature_id	string		模板 id
signature_name	string		短信签名名称
signature_status	string		平台审签名状态 1：未审核，2：审核通过，3：审核驳回，-1：历史签名
operator_status	number		运营商审核签名状态 1：未审核，2：审核通过，3：审核驳回
audit_reason	string		审核驳回的状态才有该参数，审核驳回的具体原因。如：此签名为测试签名，请修改成常规签名测试

{
    "code": "000000",
    "data": {
        "is_system_signature": "0",
        "signature_id": "31257",
        "signature_name": "深度接口 v6 子账号 00333",
        "signature_status": "2",
        "operator_status"：2
    },
    "msg": "深度接口根据 id 查询签名成功",
    "status": "success"
}

3.4 请求示例

{
    "username": "17321332052",
    "timestamp": "1659584250",
    "signature": "63c8f97e69a30497ab576123d10316ff",
    "appid": "49",
    "id": "341708"
}

4、签名编辑

4.1 请求地址

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

4.2 请求参数

参数名	类型	是否必传	描述
username	string	是	深度接口账号名，由创蓝商务提供。 示例：13899999999
timestamp	string	是	时间戳（10 位）
signature	string	是	验签，标准的 MD5 加密（32 位小写值），如：signature=md5(userName+password+timestamp) 两边通过相同的签名进行校验
api_name	String	是	发短信的API账号，请填写对应的API账号。示例：N617810_N7533106。
id	string	是	签名 id，添加签名时返回的签名id。
signature_scene_type	Integer	是	应用场景，传3 代表签名为自己产品名/网站名/APP 名称等； 传4 代表签名为他人产品名/网站名等
logo	string	是	图片，数组格式提交：当signature_scene_type 为3时需要上传三张图片：签名授权书、具有版权的商标或 logo、体现公司logo或名称的产品截图； 如果signature_scene_type 为4时则还需要上传“经办人授权书”，总共四张图片。每张图片大小2M以内，支持png,jpg,gif,jpeg格式的图片，Base64处理后的。
signature_name	string	是	短信签名，比如：253 云通讯。（不需要带中文括号，只包含括号里的文案） 长度限2-16个字符，中文、字母都算一个占位字符，具体规范请参考签名规范。
is_online	Integer	是	是否上线，传1 代表已上线， 传0 代表未上线； 选择未上线时，该签名会被限制发送短信数量，日限100条。 （已上线：需要上传 app 名称或者官网地址，详情看下面参数。如选择未上线，则不需要）
web_site	String	否	官网网址（如果 is_online 选择了已上线，则本参数和 app 参数选其中一个参数传递即可，都传也行。）
app	String	否	app 名称，可在应用商城能够搜到。（如果 is_online 选择了已上线，则本参数和 web_site 参数选其中一个参数传递即可，都传也行。）
real_name_text_img_flag	String	否	选择实名信息上传的方式。应用场景为他人时，则为必传。传0为文本，传1为图片。应用场景为自己时，只能传文本，就可以直接跳过本参数直接传下面的。 实名信息上传方式二选一。
real_name_logo	String	否	实名信息图片，real_name_text_img_flag=1，则为必填，上传三张图片，按顺序，第一张身份证人像，第二张身份证国徽，第三张营业执照。 每张图片不大于2M，支持 png,jpg,gif,jpeg 格式的图片，base64处理后，以数组格式提交。
enterprise_name	String	否	企业名称，应用场景为自己或者real_name_text_img_flag=0时，则为必填
unified_social_credit_code	String	否	统一社会信用代码，应用场景为自己或者及real_name_text_img_flag=0，则为必填
attention_line	String	否	经办人姓名，应用场景为自己或者real_name_text_img_flag=0，则为必填
attention_id_card	String	否	经办人身份证号，应用场景为自己或者real_name_text_img_flag=0，则为必填
remind_type	string	否	审核结果用手机短信告知，1 需要，0 不需要
remind_phone	Integer	否	提醒手机，remind_type 为 1 的情况下此值必传，示例：135xxxxxxxx

4.3 响应参数

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

{
    "code": "000000",
    "msg": "深度接口签名修改成功	",
    "status": "success"
}

4.4 请求示例

{
    "username": "17321332052",
    "timestamp": "1659583889",
    "signature": "f3ecceccfb68922930e3f139b599477e",
    "appid": "49",
    "signature_name": "深度接口测试 1111",
    "signature_scene_type": "3",
    "is_onlone": "1",
    "logo[0]": "data:image/jpg;base64,/9j/4AAQSkZJR",
    "logo[1]": "data:image/jpg;base64,/9j/4AAQSkZJR",
    "app": "创蓝小程序",
    "remind_type": "0",
    "remind_phone": "0"

}

5、实名信息编辑

5.1 请求地址

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

5.2 请求参数

参数名	类型	是否必传	描述
username	string	是	深度接口账号名，由创蓝商务提供。 示例：13899999999
timestamp	string	是	时间戳（10 位）
signature	string	是	验签，标准的 MD5 加密（32 位小写值），如：signature=md5(userName+password+timestamp) 两边通过相同的签名进行校验
api_name	String	是	发短信的API账号，请填写对应的API账号。示例：N617810_N7533106。
id	string	是	签名id，添加签名时返回的签名id。
real_name_text_img_flag	String	否	选择实名信息上传的方式。应用场景为他人时，则为必传。传0为文本，传1为图片。应用场景为自己时，只能传文本，就可以直接跳过本参数直接传下面的。 实名信息上传方式二选一。
real_name_logo	String	否	实名信息图片，real_name_text_img_flag=1，则为必填，上传三张图片，按顺序，第一张身份证人像，第二张身份证国徽，第三张营业执照。 每张图片不大于2M，支持 png,jpg,gif,jpeg 格式的图片，base64处理后，以数组格式提交。
enterprise_name	String	否	企业名称，应用场景为自己或者real_name_text_img_flag=0时，则为必填
unified_social_credit_code	String	否	统一社会信用代码，应用场景为自己或者及real_name_text_img_flag=0，则为必填
attention_line	String	否	经办人姓名，应用场景为自己或者real_name_text_img_flag=0，则为必填
attention_id_card	String	否	经办人身份证号，应用场景为自己或者real_name_text_img_flag=0，则为必填

5.3 响应参数

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

{
    "code": "000000",
    "msg": "深度接口修改签名实名信息成功",
    "status": "success"
}

5.4 请求示例

{
    "username": "17321332052",
    "timestamp": "1659583889",
    "signature": "f3ecceccfb68922930e3f139b599477e",
    "api_name": "N123456",
    "id": "123456",
    "real_name_text_img_flag": "0",
    "real_name_logo[0]": "data:image/jpg;base64,/9j/4AAQSkZJR",
    "real_name_logo[1]": "data:image/jpg;base64,/9j/4AAQSkZJR",
    "enterprise_name": "创蓝云智科技",
    "unified_social_credit_code": "123456",
    "attention_line": "李先生",
    "attention_id_card": "123456",

}

6、签名删除

6.1 请求地址

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

6.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，如果报备到子账号，则需要传递该参数，登录后台子账户管理界面获取。

6.3 响应参数

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

{
    "code": "000000",
    "msg": "深度接口签名删除成功",
    "status": "success"
}

6.4 请求示例

{
    "username": "17321332052",
    "timestamp": "1659584250",
    "signature": "63c8f97e69a30497ab576123d10316ff",
    "appid": "49",
    "id": "341708"
}

7、审核结果推送

7.1 推送方式

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

7.2 推送参数

参数名	类型	描述
username	string	深度接口账号名，接口请求添加签名时用的账号。 示例：13899999999
timestamp	string	时间戳（10 位）
signature	string	标准的 MD5 加密（32 位小写值），如：signature=md5(userName+password+timestamp) 两边通过相同的签名进行校验
action	string	功能类型，smsSignature（签名）、messageModel（模板）
id	string	签名 id，添加签名时返回的 id，一般是 6 位纯数字，不排除以后增长或缩减。
auditStatus	string	审核结果，模板（1 审核，2 驳回），签名（2 通过，3 驳回），返回值里是数字。
auditReason	string	驳回时的原因，如：此签名为测试签名，请修改成常规签名测试。如果审核结果是通过，该参数为空值。

7.3 推送数据示例：

{
  "username":"cl13908446911",
  "timestamp":"1702971183",
  "signature":"8e563949655a851c34a71ac2c5f4a542",
  "action":"smsSignature",
  "id":"593965",
  "auditStatus":"3",
  "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	查询状态参数不合法	对接技术