Querying Push Information for a Single Task

Last updated: 2020-01-15 10:23:55


API Description

Request method: POST.
Calling frequency limit: 200 times/hour.


Feature: This API queries the basic information and settings of a task according to its pushid.

Parameter Descriptions

Request Parameters

Parameter Name Required Type Description
pushId Yes string Push task ID

Response Parameters

Parameter name Type Description
retCode int Returned status code
errMsg string Error message
pushRecordData JsonArray Returned results, with pushRecordData structure variables shown in following table


Parameter name Type Description Value description
date string Push time Format: YYYY-MM-DD hh:mm:ss
pushId int Message ID -
title string Push title -
content string Push content -
status string Push status
  • PUSH_INIT //Task created
  • PUSH_WAIT; // Waiting for task to be scheduled
  • PUSH_STARTED; // Push started
  • PUSH_FINISHED; // Push finished
  • PUSH_FAILED; //Push failed
  • PUSH_CANCELED; // Push canceled by user
  • PUSH_DELETED; // Push deleted
  • pushType string Push target
  • all //Full push
  • tag //Tag push
  • token_list //Device list
  • account_list //Account list
  • package_account_push //Number package push
  • messageType string Push type
  • notify //Notification
  • message //Message
  • environment string Push environment
  • product //Production environment
  • dev //Development environment
  • expireTime uint32 Expiration time Unit: second
    xgMediaResources string Rich media information -
    multiPkg bool Multi-package-name push? -
    targetList jsonArrary(string) Push account or push device list Valid when pushType is token_list or account_list
    tagSet JsonObject Tag settings Valid when pushType is tag
    Data structure:
    "op":"OR", //Inter–tag logic operation
    { "tagTypeName":"xg_user_define", //Tag type
    "tagValue":"test68" //Tag value}
    uploadId uint32 Number package ID Valid when pushType is package_account_push
    pushConfig JsonObject Push configuration information
    "Android": for specific push configuration information related to Android, refer to the following code
    "iOS": for specific push configuration related to iOS, refer to the following code

    Configuration Information

    Android Push Configuration Information

     "ring":1, //ring
     "vibrate":0, //vibrate
     "lights":1, //breathing light
     "clearable":1, //whether clearable or not
     // Action type; 1. Open activity or app; 2. Open browser; 3. Open Intent
     "custom_content":"{}" //custom parameter

    iOS Push Configuration Information

     "aps": {
     "alert": {
     "subtitle": "my subtitle"
     "badge_type": 5, //badge number displayed by app (optional) -2 auto-increment,-1 unchanged,
     "sound":"notification sound effect", //default means the default sound effect
     "category": "INVITE_CATEGORY",
     "mutable-content" : 1


    Request Example

     "pushId": "133703"

    Response Example

     "retCode": 0,
     "errMsg": "NO_ERROR",
     "pushRecordData": [
     "date": "2019-07-25 20:06:28",
     "pushId": 133703,
     "title": "1",
     "content": "2",
     "status": "PUSH_FINISHED"