返回值说明

云片接口返回值相关说明

返回码总体说明

code = 0:	正确返回。可以从api返回的对应字段中取数据。
code > 0:	调用API时发生错误,需要开发者进行相应的处理。
-50 < code <= -1:	权限验证失败,需要开发者进行相应的处理。
code <= -50:	系统内部错误,请联系技术支持,调查问题原因并获得解决方案。

返回值示例

参数名 类型 描述 示例
http_status_code int 调用失败http返回码设为400 400
code int 系统返回码 -1
msg String 错误描述 非法的apikey
detail String 具体错误描述或解决方法 apikey不正确或没有授权

API调用失败,返回错误结果示例:

{
    "http_status_code":400, //调用结束后的http_status_code值
    "code": 3,//错误码
    "msg": "账户余额不足",   //错误描述
    "detail":"账户需要充值,请充值后重试" //具体错误描述或解决方法
}

常见的返回码

返回码(code)
错误信息(msg)
具体错误描述或解决方法(detail)
问题处理人
0 OK 调用成功,该值为null 无需处理
1 请求参数缺失 补充必须传入的参数 开发者
2 请求参数格式错误 按提示修改参数值的格式 开发者
3 账户余额不足 账户需要充值,请充值后重试 开发者
4 关键词屏蔽 关键词屏蔽,修改关键词后重试 开发者
5 未找到对应id的模板 模板id不存在或者已经删除 开发者
6 添加模板失败 模板有一定的规范,按失败提示修改 开发者
7 模板不可用 审核状态的模板和审核未通过的模板不可用 开发者
8 同一手机号30秒内重复提交相同的内容 请检查是否同一手机号在30秒内重复提交相同的内容 开发者
9 同一手机号5分钟内重复提交相同的内容超过3次 为避免重复发送骚扰用户,同一手机号5分钟内相同内容最多允许发3次 开发者
10 手机号黑名单过滤 手机号在黑名单列表中(你可以把不想发送的手机号添加到黑名单列表) 开发者
11 接口不支持GET方式调用 接口不支持GET方式调用,请按提示或者文档说明的方法调用,一般为POST 开发者
12 接口不支持POST方式调用 接口不支持POST方式调用,请按提示或者文档说明的方法调用,一般为GET 开发者
13 营销短信暂停发送 由于运营商管制,营销短信暂时不能发送 开发者
14 解码失败 请确认内容编码是否设置正确 开发者
15 签名不匹配 短信签名与预设的固定签名不匹配 开发者
16 签名格式不正确 短信内容不能包含多个签名【 】符号 开发者
17 24小时内同一手机号发送次数超过限制 请检查程序是否有异常或者系统是否被恶意攻击 开发者
18 签名校验失败 签名校验失败 开发者
19 请求已失效 请求已失效 开发者
20 不支持的国家地区 不支持的国家地区 开发者
21 解密失败 解密失败 开发者
22 1小时内同一手机号发送次数超过限制 1小时内同一手机号发送次数超过限制 开发者
23 发往模板支持的国家列表之外的地区 发往模板支持的国家列表之外的地区 开发者
24 添加告警设置失败 添加告警设置失败 开发者
25 手机号和内容个数不匹配 手机号和内容个数不匹配 开发者
26 流量包错误 流量包错误 开发者
27 未开通金额计费 未开通金额计费 开发者
28 运营商错误 运营商错误 开发者
33 超过频率 同一个手机号同一验证码模板每30秒只能发送一条。此规则用于防止验证码轰炸。 可在后台- 系统设置 了解详情及设置。 开发者
40 未开启白名单 请求IP不在IP白名单中,请在后台 系统设置->IP白名单 里开启IP白名单功能并添加对应IP地址 开发者
-1 非法的apikey apikey不正确或没有授权 开发者
-2 API没有权限 用户没有对应的API权限 开发者
-3 IP没有权限 访问IP不在白名单之内,可在后台 系统设置->IP白名单 里添加该IP 开发者
-4 访问次数超限 调整访问频率或者申请更高的调用量 开发者
-5 访问频率超限 短期内访问过于频繁,请降低访问频率 开发者
-8 不支持流量业务 账户尚未开通流量业务,请联系页面右侧在线客服开通流量业务 开发者
-50 未知异常 系统出现未知的异常情况 技术支持
-51 系统繁忙 系统繁忙,请稍后重试 技术支持
-52 充值失败 充值时系统出错 技术支持
-53 提交短信失败 提交短信时系统出错 技术支持
-54 记录已存在 常见于插入键值已存在的记录 技术支持
-55 记录不存在 没有找到预期中的数据 技术支持
-57 用户开通过固定签名功能,但签名未设置 联系客服或技术支持设置固定签名 技术支持