场景化消息-响应参数

场景化消息-响应参数

Response Body

参数 是否必选 参数类型 描述
code String 响应码。
msg String 响应码描述。
requestId String 请求标识。

响应示例

响应成功示例:

{
  "code": "80000000",
  "msg": "Success",
  "requestId": "RASS_0227_0f3b*******2c0"
}

响应失败示例:

{
  "code": "80200005",
  "msg": "Jwt token expired",
  "requestId": "RASE_0227_bb85*******9d1"
}

HTTP响应码

HTTP响应码 描述 解决方法
200 成功。 -
400 参数错误。 请检查业务响应码并根据业务响应码进一步排查问题。
404 找不到服务。 请检查请求URI是否正确。
500 服务内部错误。 请联系技术支持提交问题。
502 请求连接异常,常见于网络状况不稳定。 建议稍后重试,或联系技术支持提交问题。
503 流量控制。 平均分配发送速度。平均分布推送时间段,不要集中发送。

业务响应码

注意

通过业务响应码定位问题之前,请优先检查消息推送接口URL(https://oh-push-api.getui.com/v3/[appId]/messages:send)是否正确:

  • 请检查推送接口地址中的appId,确保与您当前应用保持一致,若不一致请更新推送接口URL中的appId,并重新生成鉴权令牌,应用重新获取Push
    Token,再进行消息推送。

80000000 成功

错误信息

Success.

错误描述

发送成功。

可能原因

发送成功。

处理步骤

不涉及。

80100000 部分Token发送成功

错误信息

Check Parameter Partial Success.

错误描述

部分Token发送成功。

可能原因

  1. noRight:生成Push Token的应用不属于请求url中appId对应的应用。
  2. tokenFormatError:Token格式错误。
  3. appinfoError:应用未创建。

处理步骤

请根据响应消息中的提示,排查失败的Token是否存在以下情况:

  1. noRight:请检查生成Push Token的应用是否与请求url中appId对应。

  2. tokenFormatError:请检查Push Token格式是否错误, 并重新申请Push Token。

  3. appinfoError:检查应用是否创建,如果应用已成功创建,请稍后重试。

响应示例:

{
  "code": "80100000",
  "msg": "{\"illegalTokens\":{\"tokenFormatError\":[\"xxxxxx\"]},\"success\":1,\"failure\":1}",
  "requestId": "RASL_0227_0ff3******330"
}

80100001 请求参数部分错误

错误信息

Check Parameter Error.

错误描述

请求参数部分错误。

可能原因

请求参数部分错误。

处理步骤

请根据响应消息中的提示,检查并修改请求参数内容。

80100003 消息结构体错误

错误信息

Illegal payload, {errorTips}.

错误描述

消息结构体错误。

可能原因

消息结构体错误。

处理步骤

请根据响应消息中的提示,检查并修改请求体结构。

80200001 认证错误

错误信息

Authentication Error.

错误描述

认证错误。

可能原因

  1. 发送消息时未添加Authorization参数或Authorization的值为空。
  2. 用于申请JWT Token的appId和推送消息的appId不一致。
  3. Authorization参数中的JWT Token与实际应用不匹配。

处理步骤

请根据响应消息中的提示,排查请求头中Authorization参数鉴权失败是否存在以下情况:

  1. 请检查发送消息时是否添加Authorization参数或Authorization的值为空。
  2. 检查推送请求URL(https://oh-push-api.getui.com/v3/[appId]/messages:send)中的appId,确保与您当前应用所属的项目保持一致。
  3. 请检查Authorization参数中的JWT Token与实际应用是否匹配。
  4. 使用JWT(JSON Web Tokens)方式生成令牌后再推送消息。

80200005 JWT Token过期

错误信息

Jwt token expired.

错误描述

JWT Token过期。

可能原因

JWT Token过期。

处理步骤

请根据响应消息中的提示,重新生成JWT Token后再推送消息。

80300007 所有Token都是无效的

错误信息

All the tokens are invalid.

错误描述

所有Token都是无效的。

可能原因

  1. noRight:生成Push Token的应用不属于请求url中appId对应的应用。
  2. tokenFormatError:Token格式错误。
  3. appinfoError:应用未创建。

处理步骤

请根据响应消息中的提示,排查失败的Token是否存在以下情况:

  1. noRight:请检查生成Push Token的应用是否与请求url中appId对应。
  2. tokenFormatError:请检查Push Token格式是否错误, 并重新申请Push Token。
  3. appinfoError:检查应用是否创建,如果应用已成功创建,请稍后重试。

响应示例:

{
  "code": "80300007",
  "msg": "{\"illegalTokens\":{\"tokenFormatError\":[\"xxxxxxx\"]},\"success\":0,\"failure\":1}",
  "requestId": "RASE_0227_06e9******ec7"
}

80300008 消息体大小超过4096Bytes(不包括Push Token)

错误信息

Push message size is too long.

错误描述

消息体大小超过4096Bytes(不包括Push Token)。

可能原因

请求消息体大小超过4096Bytes(不包括Push Token)

处理步骤

请根据响应消息中的提示,减小消息体后重新发送消息。

80300010 消息体中的Token数量超过系统设置的默认值

错误信息

token count should within {0} and {1}.

错误描述

消息体中的Token数量超过系统设置的默认值。

可能原因

  1. 单次发送消息最多携带1000个Token。

处理步骤

请根据响应消息中的提示,请减少Token数量后分批发送消息。

80300036 JWT有效期超过1天

错误信息

JWT expire period over threshold.

错误描述

JWT有效期超过1天。

可能原因

JWT有效期超过1天。

处理步骤

请根据响应消息中的提示,重新生成有效期小于1天的JWT Token后再推送消息。

81000001 系统内部错误

错误信息

Inner Error.

错误描述

系统内部错误。

可能原因

其他未知错误。

处理步骤

请联系技术支持提交问题。

开发者中心 SDK 下载

文档中心搜索

技术
咨询

微信扫一扫

随时联系技术支持

在线
咨询