业务状态码

本文档定义 UMS REST API 的所有业务返回码。

通用状态码

code 描述 说明
0 成功 当请求成功并且有其他参数返回时,code 定义为 0
4004 参数非法 请改正
4005 auth验证失败 鉴权失败,请检查 ChannelKey 和 MasterSecret 的正确性
5000 服务器发生错误 请联系 support@jiguang.cn

消息发送

code 描述 说明
1015004 一次消息发送最多传 1000 个 userid 请减少请求的 userID 数量
1015005 渠道已关闭 请在渠道信息中检查渠道的使用状态
1015006 当前渠道的APP通道未授权/未开启/无效 请登录官网检查通道状态
1015007 当前渠道的SMS通道未授权/未开启/无效 请登录官网检查通道状态
1015008 当前渠道的微信公众号通道未授权/未开启/无效 请登录官网检查通道状态
1015009 当前渠道的微信小程序通道未授权/未开启/无效 请登录官网检查通道状态
1015010 当前渠道的email通道未授权/未开启/无效 请登录官网检查通道状态
1015011 当前渠道的支付宝生活号通道未授权/未开启/无效 请登录官网检查通道状态
1015012 当前渠道的钉钉通道未授权/未开启/无效 请登录官网检查通道状态
1015023 该渠道开启了api审核,请正确填写owner owner 代表消息的提交人,申请记录将记录在账号名下
1015025 当前渠道已失效 vip导致的渠道失效,请联系商务
1015026 发送策略已失效 请登录官网查看发送策略的有效性,修改正确后再使用
1015029 今日广播消息额度已用完 广播发送有频率限制,请稍后再试
1015030 api请求超出频率限制 消息发送有频率限制,请稍后再试
1015031 模板ID不存在 请检查template_id字段,登录官网获取
1015032 模板ID有误,必须使用通用模板的模板ID 请检查template_id字段,登录官网获取
1015034 消息内容中含有敏感词,请修改后重试 请修改消息内容过关闭敏感词检测
1015038 触发免打扰时间管控 请调整消息发送时间或关闭免打扰
1015046 黑名单id不存在 请检查黑名单是否存在,修改后重试
1015073 通用模板已失效 vip导致该通用模板失效,请联系商务
1015074 用户黑名单为VIP功能,需升级服务后使用 如需使用请联系商务
1015075 用户白名单为VIP功能,需升级服务后使用 如需使用请联系商务
1015084 缺少 App 的 platform 信息 如果对 App 通道发消息,必须填写推送平台 platform
1015085 App 的 platform 信息错误 请检查 App platform 的传值
1015094 模板消息发送时不允许传msg_xxx 请参考模板消息的 API
1015095 短信模板ID非法 请检查极光短信模板ID的正确性
1015097 黑名单ID和白名单ID不允许同时存在 黑白名单是互斥的,一次发送只能选择一个
1015107 自定义通道目标和 tag/userid/segment 不允许同时存在 请检查 aud_xxx
1015108 广播发送时不允许传 aud_xxx 广播发送使用专用 API,无需对 aud_xxx 传值
1015109 目标不合法,请检查后重试 请检查 aud_xxx 的值
1015110 目标不存在,请检查后重试 请检查 aud_xxx 的值
1015111 使用自定义通道 ID 发送时,不允许设置 rule_id 在 aud_xxx 使用自定义通道注册 ID 时,发送策略无效
1015112 发送策略中包含的 %s 通道缺少对应的消息内容 发送策略中包含了某个通道,但 msg_xxx 或模板内容中并不包含此通道的内容
1019201 分群ID不存在 请检查分群ID的正确性
1019202 仅支持传1个分群ID 虽然分群参数定义为数组,但当前仅支持向1个分群发送消息
1019203 分群ID非法 请检查分群ID的正确性
1019204 分群ID无效 由于 vip 过期导致分群无效,请联系商务
1020020 回调url不在配置的回调列表中 请登录官网进行回调地址配置后再请求
1020021 回调功能已经关闭,参数callback无效 请登录官网开启回调
1020022 回调设置为VIP功能,需升级服务后使用 请联系商务

消息撤回

code 描述 说明
1015054 消息ID为空 请检查msgid
1015055 消息已经被撤回 请勿重复操作
1015057 消息撤回失败,msgid不存在 请检查msgid
1015058 消息撤回失败,msgid非法 请检查msgid
1015059 消息已超过撤回时效 仅支持撤回 24 小时内发出的消息
1015025 当前渠道已失效 vip导致的渠道失效,请联系商务

用户管理

code 描述 说明
1013004 用户ID非法 用户ID的有效性说明:
  • 大小写字母、数字、下划线、特殊字符@!#$&*+=.|¥。
  • 长度不超过 64 字符
1013005 用户标签不能超过40个字节 标签的有效性说明:
  • 中英文、数字、下划线、特殊字符@!#$&*+=.|¥。
  • 长度不超过 40 字节(UTF-8 编码)
1013006 用户标签不合法 标签的有效性说明:
  • 中英文、数字、下划线、特殊字符@!#$&*+=.|¥。
  • 长度不超过 40 字节(UTF-8 编码)
1013009 手机号不合法 请改正
1013010 邮箱不合法 请改正
1013011 app regid 不合法 请改正
1013012 用户关联标识不合法 请改正
1013013 用户微信公众号ID不合法 请改正
1013014 用户微信小程序ID不合法 请改正
1013015 用户支付宝生活号ID不合法 请改正
1013016 用户钉钉ID不合法 请改正
1013018 用户添加失败!用户数超过上限,请联系商务 请联系商务

素材管理

code 描述 说明
1015113 素材类型不合法,请修改后重试 当前仅支持 attachment 1 种类型,代表附件
1015115 缺少必填的参数 请根据API文档检查参数
1015116 您添加的附件大小超过10M 免费用户每次上传的附件大小不可超过10M
1015117 您添加的附件大小超过50M VIP客户每次上传的附件大小不可超过50M

Copyright 2011-2020, jiguang.cn, All Rights Reserved.
粤ICP备12056275号-13 深圳市和讯华谷信息技术有限公司

Documentation built with MkDocs.