Skip to end of metadata
Go to start of metadata

Received API 以 msg_id 作为参数,去获取该 msg_id 的送达统计数据。

如果一次 API 调用推送有很多对象(比如广播推送),则此 API 返回的统计数据会因为持续有客户端送达而持续增加。

每条推送消息的送达统计数据最多保留 10 天。即一条消息推送发起 10 天后送达统计将被清除。

API Endpoint

https://report.jpush.cn

(info)说明:仅支持 https 访问,不支持直接 http 访问。

Resource

GET /v2/received

Example Request

Request Params

  • msg_ids 推送API返回的 msg_id 列表,多个 msg_id 用逗号隔开,最多支持100个msg_id。
  • HTTP Header Authorization 的值:Basic base64_auth_string

    • base64_auth_string 生成规则是:base64(appKey:masterSecret) 
    • 留意 appKey 与 masterSecret 中间使用 ":" 冒号隔开
    • 请参考相关规范文档:HTTP基本认证

Example Response

Response Params

JSON Array.

  • android_received Android 送达。如果无此项数据则为 null。
  • ios_apns_sent iOS 推送成功。如果无此项数据则为 null。

Example Error Response

 

< HTTP/1.1 401 Unauthorized
< Content-Type: application/json
< 
{
  "error": {
        "code": 3001,
        "message": "Basic authentication failed"
     }
}

 

HTTP 返回码

参考文档:HTTP-Status-Code

错误码定义

Code描述详细解释
10系统内部错误 
3001

HTTP Basic authorization 失败。

请参考 API 文档相关说明
3002msg_ids 参数不存在 
Labels
  • None