• 서비스
  • 가격
  • 리소스
  • 기술지원
이 페이지는 현재 영어로만 제공되며 한국어 버전은 곧 제공될 예정입니다. 기다려 주셔서 감사드립니다.

All/Tagged Users Push Loss Analysis

Feature Description

After enabling the Push service, call this API to view error code classification statistics for all users/tag pushes.

API Call Description

Sample Request URL

https://xxxxxx/v4/timpush/all_member_push_loss?sdkappid=88888888&identifier=admin&usersig=xxx&random=99999999&contenttype=json

Request Parameters

The following table lists only the parameters involved in modification and their descriptions when calling this API. For more details about the parameters, refer to 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/all_member_push_loss
Request API
sdkappid
SDKAppID assigned by the IM console when creating an application
identifier
Must be an App administrator account. For more details, see app admin.
usersig
The generated signature of the App administrator account. For specific operations, see generate UserSig.
random
Enter a random 32-bit unsigned integer, value ranges from 0 to 4294967295.
contenttype
The request format is fixed as json.

Maximum Calling Frequency

1 time/second

Sample Request Packet

{
"StartTime":1741104000,
"EndTime":1741795200,
"TaskID":["xxx-yyy-zzz","aaa-bbb-ccc"]
}


Request Packet Fields

Field
Type
Attribute
Description
StartTime
Integer
Required
The start unix timestamp for the query, in seconds, supports up to 7 days of data query.
EndTime
Integer
Required
Start unix timestamp for query, in seconds, supports a maximum of 7-day data query.
TaskID
Array
Required
Support multiple task IDs for simultaneous query, up to 5. Leave blank for overall statistics.

Response Packet Body Example

{
"ActionStatus": "OK",
"ErrorCode": 0,
"ErrorInfo": "sucess",
"Results": [
{
"TaskID": "xxx-yyy-zzz",
"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": [
{
"EventType":1,
"PushPlatform": 1,
"ErrCode": "-1",
"ErrCount": 5,
"ErrInfo": "Certificate id not set"
},
{
"EventType":1,
"PushPlatform": 2,
"ErrCode": "-1",
"ErrCount": 123,
"ErrInfo": "Certificate id not set"
}
],
"PlatformPostSendDeliveredLoss": [
{
"EventType":1,
"PushPlatform": 1,
"ErrCode": "1",
"ErrCount": 217,
"ErrInfo": "regid_invalid"
},
{
"EventType":1,
"PushPlatform": 2,
"ErrCode": "410",
"ErrCount": 35,
"ErrInfo": "Unregistered"
}
]
},
{
"TaskID": "aaa-bbb-ccc",
"ReadyToSendLoss": [
{
"ErrCode": "-1",
"ErrCount": 159,
"ErrInfo": "Certificate id not set"
},
{
"ErrCode": "-2",
"ErrCount": 104,
"ErrInfo": "token not uploaded"
}
],
"PostSendDeliveredLoss": [
{
"ErrCode": "410",
"ErrCount": 26,
"ErrInfo": "Unregistered"
},
{
"ErrCode": "10302",
"ErrCount": 143,
"ErrInfo": "User Id invalid"
}
],
"PlatformReadyToSendLoss": [
{
"EventType":1,
"PushPlatform": 1,
"ErrCode": "-1",
"ErrCount": 3,
"ErrInfo": "Certificate id not set"
},
{
"EventType":1,
"PushPlatform": 1,
"ErrCode": "-1",
"ErrCount": 1,
"ErrInfo": "Certificate id not set"
}
],
"PlatformPostSendDeliveredLoss": [
{
"EventType":1,
"PushPlatform": 1,
"ErrCode": "16",
"ErrCount": 56,
"ErrInfo": ""
},
{
"EventType":1,
"PushPlatform": 2,
"ErrCode": "1",
"ErrCount": 177,
"ErrInfo": "regid_invalid"
},
]
}
]
}

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.
Results
Array
Statistical result of TaskID.
TaskID
String
Push task flag. When empty, it indicates overall statistics.
ReadyToSendLoss
Array
Sent to the sending stage, push overall analysis.
PostSendDeliveredLoss
Array
Sent to the delivery stage, push holistic analysis.
PlatformReadyToSendLoss
Array
Sent to the sending stage, analyze each push channel.
PlatformPostSendDeliveredLoss
Array
Sent to the delivery stage, analyze each push channel.
EventType
Integer
1=Offline push; 2=Online push.
PushPlatform
Integer
Push vendor (Online push EventType = 2 is case-insensitive, returns 0 by default), value ranges from 0 to 8.
0: Unknown vendor
1:Apple APNS
2: Xiaomi
3: Huawei
4:Google FCM
5: Meizu
6:OPPO
7:vivo
8: honor
ErrCode
String
Push error code.
ErrInfo
String
Push error code with the most frequent error description.
ErrCount
Integer
Total number of push error codes.

Error Code Description

Unless a network error (such as 502) occurs, the HTTP return code of this API is 200. The actual error code and error information are indicated in the response packet body by ResultCode, ResultInfo, ErrorCode, and ErrorInfo.
Common error codes (60000 to 79999), please refer to Error Code.
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 parameters according to the documentation to verify the validity.
90102
Internal error, please try again later.
90103
Failed to switch accounts. Please check if the UserID is valid.