服务端 API v2
  • API概览
  • 调用方式
  • 房间信令接口
  • 混流接口
  • 媒体服务接口
  • 媒体文件接口
  • 音视频流审核接口
  • 回调说明
  • 全局返回码
  • 调测指南

推送自定义消息

更新时间:2022-01-18 11:43

1 描述

调用本接口在房间内推送自定义消息,即向同一房间内指定的单个或多个用户发送信令消息。

客户端接收消息使用 ZEGO SDK 回调接口:

ZegoExpress SDK LiveRoom SDK
iOS/macOS onIMRecvCustomCommand onReceiveCustomCommand
Android onIMRecvCustomCommand onRecvCustomCommand
Windows onIMRecvCustomCommand OnRecvCustomCommand
Web IMRecvCustomCommand onRecvCustomCommand

2 接口原型

  • 请求方法:GET
  • 请求地址:https://rtc-api.zego.im/?Action=SendCustomCommand
  • 传输协议:HTTPS
  • 调用频率限制(同一个 AppID 下所有房间):100 次/秒(测试环境:10 次/秒)

3 请求参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表请参考 调用方式 - 公共请求参数

参数 类型 是否必选 描述
RoomId String 房间 ID。
FromUserId String 用户 ID。
ToUserId[] Array of String 自定义消息目的用户 ID,最大支持 10 个目的用户ID。
如果没有此字段,自定义消息广播给房间内所有用户;如果有此字段,自定义消息只推送到目的用户。
示例:ToUserId[]=123&ToUserId[]=456
MessageContent String 自定义消息内容,长度不能超过 1024 个字节。

4 请求示例

https://rtc-api.zego.im/?Action=SendCustomCommand
&RoomId=123321
&FromUserId=123
&ToUserId[]=123
&ToUserId[]=456
&MessageContent=%E6%8E%A8%E9%80%81%E8%87%AA%E5%AE%9A%E4%B9%89%E4%BF%A1%E6%81%AF-%E6%96%B0%E6%8E%A5%E5%8F%A3
&<公共请求参数>

5 响应参数

参数 类型 描述
Code Number 返回码。
Message String 操作结果描述。
RequestId String 请求 ID。
Data Object 响应数据。
└ FailUsers Array of Object 处理失败的目标用户 ID 列表。
  └ Uid String 用户 ID。
  └ Code Number 失败的错误码(不在线:50003)。

6 响应示例

{
    "Code": 0,
    "Message": "success",
    "RequestId": "3005402395393320157",
    "Data": {
        "FailUsers": [{
            "Uid": "1111",
            "Code": 50003
        }]
    }
}

7 返回码

以下仅列出了接口业务逻辑相关的返回码,完整返回码请参考 全局返回码

返回码 说明
50001 房间不存在。
  • 当房间内没有用户时,房间会被 SDK 自动销毁。
  • 当房间内只有一个用户时,该用户退出房间或被踢出房间,房间会被 SDK 自动销毁。
  • 当房间心跳请求超时 100 秒后,房间会被 SDK 自动销毁。
50002 用户账号不存在。
50003 查找用户在线信息失败。
50004 读取用户信息失败。
50009 审核失败。
50011 推送自定义消息目的用户个数超过限制。
50012 推送自定义消息长度超过限制。
50013 发送自定义消息失败。