即时通信 IM 全员推送 - 服务端 API

功能说明

• 支持全员推送。
• 支持按用户属性推送。
• 支持按用户标签推送。
• 管理员推送消息，接收方看到消息发送者是管理员。
• 管理员指定某一帐号向其他帐号推送消息，接收方看到发送者不是管理员，而是管理员指定的帐号。
• 支持消息离线存储，不支持漫游。
• 由于全员推送需要下发的帐号数量巨大，下发完全部帐号需要一定时间（根据帐号总数而定，一般在一分钟内）。

接口调用说明

本功能仅针对旗舰版客户开放申请（如您降级为专业版将无法使用），您可通过 工单 申请开通该功能，申请后我们将对您的需求进行评估，需求评估合理后您方可使用该功能。

请求 URL 示例

https://console.tim.qq.com/v4/all_member_push/im_push?usersig=xxx&identifier=admin&sdkappid=88888888&random=99999999&contenttype=json

请求参数说明

调用频率

本接口包含全员/属性/标签推送，默认每天最多调用100次，每两次推送间隔必须大于1s。有特别频率需求的（如需提高频率），请在申请工单中说明。

请求包示例

• 全员推送示例
  管理员进行全员推送：

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

  管理员指定某一帐号进行全员推送（示例中发送方帐号为 xiaoming）：

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

  管理员指定某一帐号进行全员推送，同时设置离线推送信息：

  {
  "From_Account": "xiaoming",
   "MsgRandom": 3674128,
   "MsgBody": [
       {
           "MsgType": "TIMTextElem",
           "MsgContent": {
               "Text": "hi, beauty"
           }
       }
   ],
   "OfflinePushInfo": {
       "PushFlag": 0,
       "Desc": "离线推送内容",
       "Ext": "这是透传的内容",
       "AndroidInfo": {
           "Sound": "android.mp3"
       },
       "ApnsInfo": {
           "Sound": "apns.mp3",
           "BadgeMode": 1, // 这个字段缺省或者为 0 表示需要计数，为 1 表示本条消息不需要计数，即右上角图标数字不增加
           "Title":"apns title", // apns title
           "SubTitle":"apns subtitle", // apns subtitle
           "Image":"www.image.com" // image url
       }
   }
  }

  管理员给全员推送消息，并且消息离线保存120秒（即2分钟）：

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

• 按用户标签推送示例
  管理员给带有关注“股票A”和“股票B”标签的用户推送消息：

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

  管理员给带有关注”股票A“或“股票B”标签的用户推送消息：

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

  管理员给关注”股票A“或“股票B”的用户推送消息，并且消息离线保存120秒（即2分钟）：

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

• 按用户属性推送
  管理员给在深圳的超白金会员用户推送消息：

  {
  "From_Account": "admin",
   "MsgRandom": 389475,
   "Condition": {
       "AttrsAnd": {
           "会员等级": "超白金会员",
           "city": "深圳"
       }
   },
   "MsgBody": [
       {
           "MsgType": "TIMTextElem",
           "MsgContent": {
               "Text": "hi, beauty"
           }
       }
   ]
  }

  管理员给在深圳或者性别为男的用户推送消息：

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

  管理员给在深圳的超白金用户推送消息，并且消息离线保存120秒（即2分钟）：

  {
  "From_Account": "admin",
   "MsgRandom": 9312457,
  "MsgLifeTime": 120,
   "Condition": {
       "AttrsAnd": {
           "会员等级": "超白金用户",
           "city": "深圳"
       }
   },
   "MsgBody": [
       {
           "MsgType": "TIMTextElem",
           "MsgContent": {
               "Text": "hi, beauty"
           }
       }
   ]
  }

请求包字段说明

应答包体示例

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

应答包字段说明

错误码说明

除非发生网络错误（例如502错误），否则该接口的 HTTP 返回码均为200。真正的错误码，错误信息是通过应答包体中的 ErrorCode、ErrorInfo 来表示的。公共错误码（60000到79999）参见 错误码 文档。
本 API 私有错误码如下：

接口调试工具

通过 REST API 在线调试 工具调试本接口。

参考

• 全员推送接口说明
• 设置应用属性名称
• 获取应用属性名称
• 设置用户属性
• 删除用户属性
• 获取用户属性
• 添加用户标签
• 获取用户标签
• 删除用户标签
• 删除用户所有标签