Feature Description

• This API can be used to push messages to all users.
• This API can be used to push messages by user attribute.
• This API can be used to push messages by user tag.
• When the admin pushes messages, the message sender displayed to the recipients is the admin.
• When the admin specifies an account to push messages to other accounts, the sender displayed to the recipients is not the admin but the account specified by the admin.
• This API supports offline storage of messages, but not message roaming.
• It takes time to push messages to all users. The required time depends on the number of accounts. Typically, it is within 1 minute.

API Calling Description

Only users with Flagship Edition accounts can apply for this feature. You can submit a ticket to apply for this feature. If we determine that this feature suits your needs, we will approve your application. After your application is approved, the feature will be enabled 48 hours later.

Sample request URL

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

Request parameters

Calling frequency

This API supports push to all users, push by attribute, and push by tag. By default, it can be called up to 100 times per day, and the interval between two pushes must be greater than 1s. If you have special requirements, such as raising the frequency limit, describe your requirements in the ticket.

Sample requests

• Pushing messages to all users
  The admin pushes messages to all users.

  {
  "From_Account": "admin",
   "MsgRandom": 56512,
   "MsgBody": [
       {
           "MsgType": "TIMTextElem",
           "MsgContent": {
               "Text": "hi, beauty"
           }
       }
   ]
  }
  

  The admin specifies an account to push messages to all users. (In this example, the sender account is xiaoming.)

  {
  "From_Account": "xiaoming",
   "MsgRandom": 3674128,
   "MsgBody": [
       {
           "MsgType": "TIMTextElem",
           "MsgContent": {
               "Text": "hi, beauty"
           }
       }
   ]
  }
  

  The admin specifies an account to push messages to all users and sets the offline push information.

  {
  "From_Account": "xiaoming",
   "MsgRandom": 3674128,
   "MsgBody": [
       {
           "MsgType": "TIMTextElem",
           "MsgContent": {
               "Text": "hi, beauty"
           }
       }
   ],
   "OfflinePushInfo": {
       "PushFlag": 0,
       "Desc": "Content to push offline",
       "Ext": "Passthrough content",
       "AndroidInfo": {
           "Sound": "android.mp3"
       },
       "ApnsInfo": {
           "Sound": "apns.mp3",
           "BadgeMode": 1, // If this field is left as default or is set to `0`, the message is counted. If this field is set to `1`, the message is not counted, that is, the icon number in the upper-right corner does not increase.
           "Title":"apns title", // APNs title
           "SubTitle":"apns subtitle", // APNs subtitle
           "Image":"www.image.com" // Image URL
       }
   }
  }
  

  The admin pushes messages to all users and retains the messages offline for 120s.

  {
  "From_Account": "admin",
   "MsgRandom": 21302570,
   "MsgLifeTime": 120,
   "MsgBody": [
       {
           "MsgType": "TIMTextElem",
           "MsgContent": {
               "Text": "hi, beauty"
           }
       }
   ]
  }
  

• Pushing messages by user tag
  The admin pushes messages to users tagged with "A shares" and "B shares".

  {
  "From_Account": "admin",
  "MsgRandom": 214,
  "Condition": {
    "TagsAnd": ["A shares","B shares"]
  },
  "MsgBody": [
    {
        "MsgType": "TIMTextElem",
        "MsgContent": {
            "Text": "hi, beauty"
        }
    }
  ]
  }
  

  The admin pushes messages to users tagged with "A shares" or "B shares".

  {
  "From_Account": "admin",
  "MsgRandom": 103698523,
  "Condition": {
    "TagsOr": ["A shares","B shares"]
  },
  "MsgBody": [
    {
        "MsgType": "TIMTextElem",
        "MsgContent": {
            "Text": "hi, beauty"
        }
    }
  ]
  }
  

  The admin pushes messages to users tagged with "A shares" and "B shares" and retains the messages offline for 120s.

  {
  "From_Account": "admin",
  "MsgRandom": 124032,
  "MsgLifeTime": 120,
  "Condition": {
    "TagsOr": ["A shares","B shares"]
  },
  "MsgBody": [
    {
        "MsgType": "TIMTextElem",
        "MsgContent": {
            "Text": "hi, beauty"
        }
    }
  ]
  }
  

• Pushing messages by user attribute
  The admin pushes messages to Shenzhen Platinum Premier users.

  {
  "From_Account": "admin",
   "MsgRandom": 389475,
   "Condition": {
       "AttrsAnd": {
           "Membership Level": "Platinum Premier members",
           "city": "Shenzhen"
       }
   },
   "MsgBody": [
       {
           "MsgType": "TIMTextElem",
           "MsgContent": {
               "Text": "hi, beauty"
           }
       }
   ]
  }
  

  The admin pushes messages to users in Shenzhen or male users.

  {
  "From_Account": "admin",
   "MsgRandom": 9657,
   "Condition": {
       "AttrsOr": {
           "sex": "M",
           "city": "Shenzhen"
       }
   },
   "MsgBody": [
       {
           "MsgType": "TIMTextElem",
           "MsgContent": {
               "Text": "hi, beauty"
           }
       }
   ]
  }
  

  The admin pushes messages to Shenzhen Platinum Premier users and retains the messages offline for 120s.

  {
  "From_Account": "admin",
   "MsgRandom": 9312457,
  "MsgLifeTime": 120,
   "Condition": {
       "AttrsAnd": {
           "Membership Level": "Platinum Premier users",
           "city": "Shenzhen"
       }
   },
   "MsgBody": [
       {
           "MsgType": "TIMTextElem",
           "MsgContent": {
               "Text": "hi, beauty"
           }
       }
   ]
  }
  

Request fields

Sample response

{
  "ActionStatus":"OK",
  "ErrorInfo": "",
  "ErrorCode": 0,
  "TaskId": "1400123456_144115212910570789_4155518400_15723514"
}

Response fields

Error Codes

Unless a network error (such as error 502) occurs, the HTTP return code for this API is always 200. ErrorCode and ErrorInfo in the response represent the actual error code and error information. For public error codes (60000 to 79999), please see Error Codes.
The following table describes the error codes specific to this API:

Debugging Tool

Use the RESTful API online debugging tool to debug this API.

References

• API for Pushing to All Users
• Setting Application Attribute Names
• Getting Application Attribute Names
• Setting User Attributes
• Deleting User Attributes
• Getting User Attributes
• Adding User Tags
• Getting User Tags
• Deleting User Tags
• Deleting All Tags of a User