根据用户ID进行广播消息
更新时间：2025-06-30 10:38:42
接口描述
根据用户ID列表向指定频道内的用户广播消息
接口支持https协议
接口URL
https://api.polyv.net/live/v5/chat/redirect/channel/emit-by-userId/post
请求方式
POST
接口约束
1、接口同时支持HTTP 、HTTPS ，建议使用HTTPS 确保接口安全。
2、userIds 列表不能为空。
3、userIds 列表长度不能超过2000。
4、系统会进行频率限制，如果系统繁忙会返回错误信息。
请求参数描述
| 参数名 | 必选 | 类型 | 说明 |
|---|---|---|---|
| appId | true | String | 账号appId【详见获取密钥】 |
| timestamp | true | Long | 当前13位毫秒级时间戳，3分钟内有效 |
| sign | true | String | 签名，为32位大写的MD5值,生成签名的appSecret密钥作为通信数据安全的关键信息，严禁保存在客户端直接使用，所有API都必须通过客户自己服务器中转调用POLYV服务器获取响应数据【详见签名生成规则】 |
请求体参数描述
| 参数名 | 必选 | 类型 | 说明 |
|---|---|---|---|
| roomId | true | String(1, 100) | 频道id |
| userIds | true | Array(String(1, 2000)) | 用户id列表 |
| payload | true | String(1, 1000) | 消息内容 |
示例
请求体json参数：
{
"roomId": "123456",
"userIds": ["user1", "user2", "user3"],
"payload": "Hello everyone!"
}
响应体json:
{
"code": 200,
"status": "success",
"message": "success"
}
WebSocket 消息广播说明
调用此接口成功后，系统会通过WebSocket向指定频道内的用户广播消息。
广播事件为 `customMessage`，广播内容为请求体中的 `payload` 字段。
例如：`io.emit('customMessage', payload);`
响应参数描述
| 参数名 | 类型 | 说明 |
|---|---|---|
| code | Integer | 响应状态码，200为成功返回，非200为失败 |
| status | String | 响应结果，由业务决定，成功返回success，失败返回error |
| message | String | 响应消息 |
| data | Object | 成功时返回空对象 {} |
| error | Object | 状态码非200时的错误信息【详见Error字段说明】 |
Error参数描述
| 参数名 | 类型 | 说明 |
|---|---|---|
| code | Integer | 错误代码，用于确定具体的错误原因 |
| desc | String | 错误描述，与 error.code 对应 |
异常示例
{
"code": 400,
"status": "fail",
"message": "userIds is required"
}
{
"code": 400,
"status": "fail",
"message": "userIds is too long, max is 2000"
}
{
"code": 400,
"status": "fail",
"message": "系统繁忙，请等1秒后再试"
}
