文档概览/
Feedback

单发推送

功能说明

给定接收方账号列表进行推送，接收方账号列表在 [1, 500] 个之间。

接口调用说明

请求 URL 示例

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

请求参数说明

参数
说明
https
请求协议：HTTPS。
请求方式：POST。
xxxxxx
SDKAppID 所在国家/地区对应的专属域名。
新加坡：adminapisgp.im.qcloud.com
首尔：adminapikr.im.qcloud.com
东京：adminapijpn.im.qcloud.com
法兰克福：adminapiger.im.qcloud.com
硅谷：adminapiusa.im.qcloud.com
雅加达：adminapiidn.im.qcloud.com
利雅得：adminapiksa.im.qcloud.com
v4/timpush/webbatch
请求接口。
usersig
App 管理员账号生成的签名，参见 生成 UserSig。
identifier
必须为 App 管理员账号，更多详情请参见 App 管理员。
sdkappid
创建应用时，Chat 控制台分配的 SdkAppid。
random
请输入随机的32位无符号整数，取值范围0 - 4294967295。
contenttype
固定值为：json。

调用频率

体验版 30 人/秒，标准版 500 人/秒。

请求包示例

{
  "From_Account": "administrator",
  "To_Account": ["user1","user2"], // 数组大小范围在[1,500]之间
  "MsgRandom": 3674128,
  "WebInfo": {
      "Title": "离线推送标题",
      "Desc": "离线推送内容",
      "URL": "http://url"
  }
}

请求包字段说明

字段
类型
属性
说明
From_Account
String
必填
发送方账号。
To_Account
Array
必填
接收方账号列表。
MsgRandom
Integer
必填
32位无符号整数随机数，取值范围0 - 4294967295。
后台用于同一秒内的消息去重，请确保是随机数。
WebInfo
Object
选填
浏览器通知栏推送，具体请参见 公共参数（WebInfo 和 Message 字段说明）。
WebInfo 和 Message 至少有一个存在：
仅 WebInfo 存在时只有浏览器通知栏展示推送。
仅 Message 存在时仅网页未被关闭时可以收到在线推送。
WebInfo 和 Message 同时存在时在线收到 Message 推送，离线收到 WebInfo 系统通知栏推送。
Message
Object
选填
DataId
String
选填
客户业务自定义标识，回调会透传该字段给 App 后台。该字段限制不超过64字节。
TaskName
String
选填
自定义推送任务名称，对应控制台推送管理中的任务名称。该字段限制不超过20字节。

应答包体示例

{
    "ActionStatus": "OK",
    "ErrorInfo": "",
    "ErrorCode": 0,
    "TaskId": "wbat@1_6943e4b7_669462cf_2000012099531ab_4bfee607_3dbc55"
}

应答包字段说明

字段
类型
说明
ActionStatus
String
请求处理的结果：
OK：表示处理成功。
FAIL：表示失败。
ErrorCode
Integer
错误码。
ErrorInfo
String
错误信息。
TaskId
String
推送任务 ID。

错误码说明

除非发生网络错误（例如502错误），否则该接口的 HTTP 返回码均为200。真正的错误码和错误信息是通过应答包体中的 ErrorCode、ErrorInfo 来表示的。公共错误码（60000到79999）参见 错误码 文档。
本 API 私有错误码如下：
错误码
含义说明
90001
JSON 格式解析失败，请检查请求包是否符合 JSON 规范。
90009
请求需要 App 管理员权限。
90045
未开通全员/标签/单推推送功能。
90057
客户业务自定义标识 DataId 过长，目前支持最大64字节。
91000
服务内部错误，请重试。