根據使用者ID進行廣播訊息

更新時間：2025-06-30 10:38:42

根据用户ID列表向指定频道内的用户广播消息
接口支持https协议

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伺服器取得回應資料`【詳見簽名產生規則】

請求體json參數：

{
    "roomId": "123456",
    "userIds": ["user1", "user2", "user3"],
    "payload": "Hello everyone!"
}

回應體json:

{
  "code": 200,
  "status": "success",
  "message": "success"
}

调用此接口成功后，系统会通过WebSocket向指定频道内的用户广播消息。
广播事件为 `customMessage`，广播内容为请求体中的 `payload` 字段。
例如：`io.emit('customMessage', payload);`

參數名	類型	說明
code	Integer	回應狀態碼，200為成功回傳，非200為失敗
status	String	回應結果，由業務決定，成功回傳success，失敗回傳error
message	String	回應訊息
data	Object	成功時回傳空物件 {}
error	Object	狀態碼非200時的錯誤資訊【詳見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秒后再试"
}