Tencent Cloud

Recent Pages

单发推送

最后更新时间：2024-12-30 16:59:16

功能说明
给定接收方账号列表进行推送，接收方账号列表在 [1, 500] 个之间。
支持在线通道，厂商通道（APNS、华为、荣耀、OPPO、vivo、小米、魅族、Google）。
注意：
本接口支持在线推送和离线推送，在线推送仅 SDK 版本 >= 8.2.6325支持。
接口调用说明
请求 URL 示例
https://xxxxxx/v4/timpush/batch?usersig=xxx&identifier=admin&sdkappid=88888888&random=99999999&contenttype=json
请求参数说明
参数
说明
https
请求协议：HTTPS
请求方式：POST
xxxxxx
SDKAppID 所在国家/地区对应的专属域名。
中国：console.tim.qq.com
新加坡：adminapisgp.im.qcloud.com
首尔： adminapikr.im.qcloud.com
法兰克福：adminapiger.im.qcloud.com
硅谷：adminapiusa.im.qcloud.com
v4/timpush/batch
请求接口
usersig
App 管理员账号生成的签名，具体操作请参见 生成 UserSig﻿
identifier
必须为 App 管理员账号，更多详情请参见 App 管理员﻿
sdkappid
创建应用时，即时通信控制台分配的 SdkAppid
random
32位无符号整数随机数
contenttype
固定值为：json
调用频率
30次/s
请求包示例
{
  "From_Account": "administrator",
  "To_Account": ["user1","user2"], // 数组大小范围在[1,500]之间
  "MsgRandom": 3674128,
  "OfflinePushInfo": {
      "PushFlag": 0,  // 0表示进行离线推送，1表示不进行离线推送
      "Title": "离线推送标题",
      "Desc": "离线推送内容"
  }
}
注意：
本接口支持在线推送和离线推送，在线推送仅 SDK 版本 >= 8.2.6325支持。
请求包字段说明
字段
类型
属性
说明
From_Account
String
必填
消息推送方账号（支持指定为任意存在的账号）
To_Account
Array
必填
消息接收方用户 UserID
MsgRandom
Integer
必填
消息随机数（32位无符号整数），后台用于同一秒内的消息去重。请确保该字段填的是随机
OfflinePushInfo
Object
必填
推送信息配置，具体请参见 离线推送OfflinePushInfo说明﻿
应答包体示例
{
    "ActionStatus": "OK",
    "ErrorInfo": "",
    "ErrorCode": 0,
    "TaskId": "batch_667015d4_537529d8_2000005e80aa873_d03ac87_56f5e750"
}
应答包字段说明
字段
类型
说明
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
未开通全员/标签/单推推送功能。
91000
服务内部错误，请重试。
接口调试工具
通过 REST API 在线测试 工具调试本接口。
参考
﻿发起全员/标签推送﻿
﻿单发推送﻿
﻿获取应用属性名称﻿
﻿设置应用属性名称﻿
﻿获取用户属性﻿
﻿设置用户属性﻿
﻿删除用户属性﻿
﻿获取用户标签﻿
﻿添加用户标签﻿
﻿删除用户标签﻿
﻿清空用户标签﻿
﻿推送撤回﻿
﻿

联系我们

联系我们，为您的业务提供专属服务。

技术支持

如果你想寻求进一步的帮助，通过工单与我们进行联络。我们提供7x24的工单服务。

7x24 电话支持

tencent cloud

Recent Pages

单发推送

接口调用说明

请求 URL 示例

请求参数说明

调用频率

请求包示例

请求包字段说明

应答包体示例

应答包字段说明

错误码说明

接口调试工具

参考

本页内容是否解决了您的问题？

本页内容是否解决了您的问题？

参数	说明
https	请求协议：HTTPS 请求方式：POST
xxxxxx	SDKAppID 所在国家/地区对应的专属域名。中国：`console.tim.qq.com` 新加坡：`adminapisgp.im.qcloud.com` 首尔： `adminapikr.im.qcloud.com` 法兰克福：`adminapiger.im.qcloud.com` 硅谷：`adminapiusa.im.qcloud.com`
v4/timpush/batch	请求接口
usersig	App 管理员账号生成的签名，具体操作请参见生成 UserSig
identifier	必须为 App 管理员账号，更多详情请参见 App 管理员
sdkappid	创建应用时，即时通信控制台分配的 SdkAppid
random	32位无符号整数随机数
contenttype	固定值为：json

字段	类型	属性	说明
From_Account	String	必填	消息推送方账号（支持指定为任意存在的账号）
To_Account	Array	必填	消息接收方用户 UserID
MsgRandom	Integer	必填	消息随机数（32位无符号整数），后台用于同一秒内的消息去重。请确保该字段填的是随机
OfflinePushInfo	Object	必填	推送信息配置，具体请参见离线推送OfflinePushInfo说明

错误码	含义说明
90001	JSON 格式解析失败，请检查请求包是否符合 JSON 规范。
90009	请求需要 App 管理员权限。
90045	未开通全员/标签/单推推送功能。
91000	服务内部错误，请重试。

tencent cloud

注册

登录

Recent Pages

单发推送

接口调用说明

请求 URL 示例

请求参数说明

调用频率

请求包示例

请求包字段说明

应答包体示例

应答包字段说明

错误码说明

接口调试工具

参考

本页内容是否解决了您的问题？

本页内容是否解决了您的问题？