logo
实时音视频
服务端 API
场景服务接口
当前页

SendCustomCommand

GET

https://rtc-api.zego.im/

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

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

平台ZegoExpress SDKLiveRoom SDK
iOS/macOSonIMRecvCustomCommandonReceiveCustomCommand
AndroidonIMRecvCustomCommandonRecvCustomCommand
WindowsonIMRecvCustomCommandOnRecvCustomCommand
WebIMRecvCustomCommandonRecvCustomCommand
调用频率限制
同一个 AppID 下所有房间:100 次/秒(测试环境:10 次/秒)
注意
  • 在服务端通过某个 FromUserId 发送消息时,使用相同 FromUserId 的客户端不会收到该条消息,即发送方不能接收到自己发送的消息。
  • 如果开发者需要让房间内的所有用户都收到消息,调用本接口时,应传入该房间用户之外的 FromUserId。
  • 使用的 FromUserId 无需登录该房间,即可直接发送消息。

Request

Query Parameters

    Action stringrequired

    Possible values: [SendCustomCommand]

    接口原型参数

    https://rtc-api.zego.im?Action=SendCustomCommand

    AppId uint32required

    💡公共参数。AppId,ZEGO 分配的用户唯一凭证。

    SignatureNonce stringrequired

    💡公共参数。随机字符串。

    Timestamp int64required

    💡公共参数。Unix 时间戳,单位为秒。最多允许 10 分钟的误差。

    Signature stringrequired

    💡公共参数。签名,用于验证请求的合法性。

    SignatureVersion stringrequired

    Possible values: [2.0]

    Default value: 2.0

    💡公共参数。签名版本号。

    IsTest string

    Possible values: [true, false]

    Default value: false

    💡公共参数。是否为测试环境。设为 true 表示使用测试环境。2021-11-16 及之前在 ZEGO 控制台创建的项目默认是测试环境,可根据业务需求设置此参数;而之后创建的项目默认是正式环境。

    RoomId stringrequired

    房间 ID。

    FromUserId stringrequired

    发送方用户 ID。

    ToUserId string[]

    Possible values: >= 1, <= 10

    自定义消息目的用户 ID,最大支持 10 个目的用户 ID。 如果不填写该参数,自定义消息广播给房间内所有用户;如果填写了该参数,自定义消息只推送到目的用户。 示例:ToUserId[]=user1&ToUserId[]=user2

    MessageContent stringrequired

    Possible values: <= 1024 characters

    自定义消息内容,长度不能超过 1024 个字节。使用时,需对其内容执行 URL 编码(UrlEncode)处理。

Responses

操作成功
Schema
    Code int32

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

    返回码说明处理建议
    50003查找用户在线信息失败。请确认请求用户 UserId 是否在线。
    50011用户列表长度过长。请检查请求包中的用户个数是否超过限制。
    50012消息长度超过限制。请检查参数长度是否超过限制。
    50013发送自定义消息失败。请重试,或联系 ZEGO 技术支持处理。
    Message string

    操作结果描述。

    RequestId string

    请求 ID。

    Data object
    FailUsers object[]
    处理失败的目标用户 ID 列表。
  • Array[
  • Uid string

    用户 ID。

    Code int32

    失败的错误码(不在线:50003)。

  • ]

Request
Collapse all
Base URL
https://rtc-api.zego.im
统一接入地址(不区分区域)
Parameters
queryrequired
queryrequired
queryrequired
queryrequired
queryrequired
queryrequired
queryrequired
queryrequired
queryrequired
query
query
RESPONSEClear

Click the "Send" button above and see the response here!

Previous

推送弹幕消息

Next

获取房间人数

当前页

返回到顶部