外观
广播消息
约 288 字小于 1 分钟
2026-01-07
说明
1、单次广播的用户量有限制,具体参照控制台中的套餐中的广播消息条数限制,如果单次广播的用户量超过限制,业务端可以进行分批次广播。
2、广播消息可能存在一定的延时,具体延时请以实际情况为准。
3、xbcim的版本 >= 1.3.8
1. 接口地址
{$host}/im/message/broadcast2. 请求方式
POST
3. 请求参数
3.1 Header 参数
X-Token: 授权码
3.2 Body 参数
| 参数名 | 必填 | 类型 | 说明 |
|---|---|---|---|
| userIds | 是 | Array | 要广播的用户ID数组,这个用户ID是业务系统中的用户ID,不是xbcim中的用户ID |
| data | 是 | Any | 要广播的数据,支持任意格式的数据,比如字符串、对象、数组等 |
4. 返回结果
无返回值,如果广播成功,则xbcim会向这些用户发送一条广播消息,消息内容为data参数的内容。
5. 前端示例代码
XBCIM.on(XBCIM.EVENT.BROADCAST_RECEIVED, (message: any) => {
// 这里可以获取到发送的数据data,进而执行后续逻辑
console.log(message)
})