Chat Service Push Loss Analysis
Feature Description
After enabling the Push service, call this API to view error code classification statistics for Chat single/group chat message push.
API Call Description
Sample Request URL
https://xxxxxx/v4/timpush/normal_push_loss?sdkappid=88888888&identifier=admin&usersig=xxx&random=99999999&contenttype=json
Request Parameters
The following table lists only the parameters involved in modification when calling this API and their descriptions. For more details about the parameters, see REST API Introduction.
Parameter | Description |
xxxxxx | The dedicated domain name for the country/region where the SDKAppID resides. China: console.tim.qq.com Singapore: adminapisgp.im.qcloud.com Seoul: adminapikr.im.qcloud.com Frankfurt: adminapiger.im.qcloud.com Silicon Valley: adminapiusa.im.qcloud.com Jakarta: adminapiidn.im.qcloud.com |
v4/timpush/normal_push_loss | Request API |
sdkappid | The SDKAppID assigned by the IM console when creating an application |
identifier | |
usersig | The signature generated by the App administrator account. For specific operations, see generate UserSig |
random | Enter a random 32-bit unsigned integer in the range of [0, 4294967295] |
contenttype | The request format is fixed as json . |
Maximum Calling Frequency
1 Times/second.
Sample Request Packet
{"StartTime":1741708800,"EndTime":1741795200}
Request Packet Fields
Field | Type | Attribute | Description |
StartTime | Integer | Required | Query start unix timestamp in seconds, supports up to 7 days of data query. |
EndTime | Integer | Required | Query start unix timestamp in seconds, supports up to 7 days of data query. |
Sample Response Packet Body
{"ActionStatus": "OK","ErrorCode": 0,"ErrorInfo": "sucess",{"ReadyToSendLoss": [{"ErrCode": "-1","ErrCount": 167,"ErrInfo": "certificate id not set"},{"ErrCode": "-2","ErrCount": 125,"ErrInfo": "token not uploaded"}],"PostSendDeliveredLoss": [{"ErrCode": "1","ErrCount": 217,"ErrInfo": "regid_invalid"},{"ErrCode": "410","ErrCount": 35,"ErrInfo": "Unregistered"}],"PlatformReadyToSendLoss": [{"PushPlatform": 1,"ErrCode": "-1","ErrCount": 5,"ErrInfo": "certificate id not set"},{"PushPlatform": 2,"ErrCode": "-1","ErrCount": 123,"ErrInfo": "certificate id not set"}],"PlatformPostSendDeliveredLoss": [{"PushPlatform": 1,"ErrCode": "1","ErrCount": 217,"ErrInfo": "regid_invalid"},{"PushPlatform": 3,"ErrCode": "410","ErrCount": 35,"ErrInfo": "Unregistered"}]}}
Response Packet Fields
Field | Type | Description |
ActionStatus | String | Request processing result. OK: processing successful; FAIL: processing failed. |
ErrorCode | Integer | Error code: 0 indicates success, non-0 indicates failure. |
ErrorInfo | String | Error message. |
ReadyToSendLoss | Array | Sent to the sending stage, overall push analysis. |
PostSendDeliveredLoss | Array | Sent to the reach stage, overall push analysis. |
PlatformReadyToSendLoss | Array | Can be sent to the sending stage, analysis for each push channel. |
PlatformPostSendDeliveredLoss | Array | Sent to the reach stage, analysis for each push channel. |
PushPlatform | Integer | Push vendor (online push EventType = 2 case-insensitive, default return 0): PushPlatform = 0 means unknown vendor PushPlatform = 1 means Apple APNS push PushPlatform = 2 means Mi Push PushPlatform = 3 means Huawei Push PushPlatform = 4 means Google FCM push PushPlatform = 5 means Meizu Push PushPlatform = 6 means OPPO push PushPlatform = 7 means vivo push PushPlatform = 8 means HONOR Push |
ErrCode | String | Push error code. |
ErrInfo | String | The push error code corresponds to the most frequent error description. |
ErrCount | Integer | The total number of push error codes. |
Error Code Description
Unless a network error occurs (such as 502 error), this API's HTTP return code is 200. The actual error code and error information are indicated by ResultCode, ResultInfo, ErrorCode, and ErrorInfo in the response payload.
Private error codes of this API are as follows:
Error Code | Description |
91000 | Request error. According to the error prompt, troubleshoot the problem. |
90009 | Request lacks permissions. Use the administrator to call. |
90045 | The service is not enabled. Ensure the service is turned on. |
90100 | Invalid request parameters. Check whether the parameters are legal according to the documentation. |
90102 | Internal error, please try again later. |
90103 | Failed to switch accounts. Please check if the UserID is valid. |