tencent cloud

文档反馈

更新房间信息之后回调

最后更新时间:2024-06-12 11:46:26

    功能说明

    App 后台可以通过该回调实时查看房间信息的变更,包括对变动房间信息的实时记录(例如记录日志,或者同步到其他系统)。

    注意事项

    要启用回调,必须配置回调 URL,并打开本条回调协议对应的开关,配置方法详见 第三方回调配置 文档。
    回调的方向是 Room 后台向 App 后台发起 HTTP POST 请求。
    App 后台在收到回调请求之后,务必校验请求 URL 中的参数 SDKAppID 是否是自己的 SDKAppID。

    可能触发该回调的场景

    App 用户通过客户端变动房间信息。
    App 管理员通过 REST API 变动房间信息。

    回调发生时机

    房间信息变动成功之后。

    接口说明

    请求 URL 示例

    以下示例中 App 配置的回调 URL 为https://www.example.com示例:
    https://www.example.com?SdkAppid=$SDKAppID&CallbackCommand=$CallbackCommand&contenttype=json&ClientIP=$ClientIP&OptPlatform=$OptPlatform

    请求参数说明

    参数
    说明
    https
    请求协议为 HTTPS,请求方式为 POST
    www.example.com
    回调 URL
    SdkAppid
    创建应用时在即时通信 IM 控制台分配的 SDKAppID
    CallbackCommand
    固定为 Room.CallbackAfterUpdateRoomInfo
    contenttype
    固定值为 JSON
    ClientIP
    客户端 IP,格式如:127.0.0.1
    OptPlatform
    客户端平台,取值参见 第三方回调简介:回调协议 中 OptPlatform 的参数含义

    请求包示例

    {
    "CallbackCommand":"Room.CallbackAfterUpdateRoomInfo",
    "Operator_Account":"bob",
    "RoomInfo" : {
    "RoomId":"rid-123",
    "RoomName" : "rname-123",
    "Owner_Account" : "jack",
    "TakeSeatMode" : "FreeToTake",
    "MaxMemberCount" : 300, // 最大房间人数
    "IsVideoDisabled" : false, //是否开启全体禁画 默认false
    "IsAudioDisabled" : false, //是否开启全体静音 默认false
    "IsMessageDisabled" : false, //是否禁止发文本消息 默认false
    "IsScreenSharingDisabled" : false, //是否禁止屏幕共享 默认false
    "IsCloudRecordingDisabled" : "false", //是否禁止云录制 默认false
    "CustomInfo" : "123", // 房间自定义信息
    }
    "EventTime":1670574414123//毫秒级别,事件触发时间戳
    }

    请求包字段说明

    字段
    类型
    说明
    CallbackCommand
    String
    回调命令
    Operator_Account
    String
    发起创建群组请求的操作者 UserID
    RoomId
    String
    房间 ID
    RoomName
    String
    房间名称
    Owner_Account
    String
    房主 ID
    MaxMemberCount
    Integer
    最大房间成员数量
    IsVideoDisabled
    Bool
    全体禁画
    IsAudioDisabled
    Bool
    全体禁音
    IsMessageDisabled
    Bool
    禁止所有成员发文本消息
    IsScreenSharingDisabled
    Bool
    禁止屏幕共享
    IsCloudRecordingDisabled
    Bool
    禁止云录制
    CustomInfo
    String
    自定义字段
    EventTime
    Integer
    事件触发的毫秒级别时间戳

    应答包示例

    App 后台同步数据后,发送回调应答包。
    {
    "ActionStatus": "OK",
    "ErrorInfo": "",
    "ErrorCode": 0 // 忽略回调结果
    }

    应答包字段说明

    字段
    类型
    属性
    说明
    ActionStatus
    String
    必填
    请求处理的结果,OK 表示处理成功,FAIL 表示失败
    ErrorCode
    Integer
    必填
    错误码,此处填0表示忽略应答结果
    ErrorInfo
    String
    必填
    错误信息

    参考

    REST API:更新房间资料
    
    联系我们

    联系我们,为您的业务提供专属服务。

    技术支持

    如果你想寻求进一步的帮助,通过工单与我们进行联络。我们提供7x24的工单服务。

    7x24 电话支持