tencent cloud

文档反馈

设置房间自定义信息

最后更新时间:2024-09-11 17:28:53

    功能说明

    App 管理员可以通过该接口设置房间自定义信息。

    接口调用说明

    请求 URL 示例

    https://xxxxxx/v4/live_engine_http_srv/set_room_metadata?
    sdkappid=88888888&identifier=admin&usersig=xxx&random=99999999&contenttype=json

    请求参数说明

    下表仅列出调用本接口时涉及修改的参数及其说明,更多参数详情请参见 REST API 简介
    参数
    说明
    xxxxxx
    SDKAppID 所在国家/地区对应的专属域名:
    中国:console.tim.qq.com
    新加坡:adminapisgp.im.qcloud.com
    v4/live_engine_http_srv/set_room_metadata
    请求接口
    sdkappid
    创建应用时即时通信 IM 控制台分配的 SDKAppID
    identifier
    必须为 App 管理员账号,更多详情请参见 App 管理员
    usersig
    App 管理员账号生成的签名,具体操作请参见 生成 UserSig
    random
    请输入随机的32位无符号整数,取值范围0 - 4294967295
    contenttype
    请求格式固定值为json

    最高调用频率

    200次/秒。

    请求包示例

    基础形式
    {
    "RoomId": "live-room",
    "Metadata": [
    {
    "Key":"key1", //当key存在时候则是更新,否则就是新增
    "Value":"value1"
    },
    {
    "Key":"key2",
    "Value":"value2"
    }
    ]
    }

    请求包字段说明

    字段
    类型
    属性
    说明
    RoomId
    String
    必填
    房间 ID
    Metadata
    Array
    必填
    房间自定义信息列表,房间自定义信息列表,单个 key 的长度不超过50 字节, value 长度不超过2K

    应答包体示例

    基础形式
    {
    "ActionStatus": "OK",
    "ErrorInfo": "",
    "ErrorCode": 0,
    "RequestId": "Id-8c9858f01e954611ae2d4c1b1ed7d583-O-Seq-52720"
    }

    应答包字段说明

    字段
    类型
    说明
    ActionStatus
    String
    请求处理的结果,OK 表示处理成功,FAIL 表示失败
    ErrorCode
    Integer
    错误码,0表示成功,非0表示失败
    ErrorInfo
    String
    错误信息
    RequestId
    String
    唯一请求 ID,每次请求都会返回,定位问题时需要提供该次请求的 RequestId

    错误码说明

    除非发生网络错误(例如502错误),否则该接口的 HTTP 返回码均为200。真正的错误码,错误信息是通过应答包体中的 ErrorCode、ErrorInfo 来表示的。 公共错误码(60000到79999)参见 错误码 文档。 本 API 私有错误码如下:
    错误码
    含义说明
    100001
    服务器内部错误,请重试
    100002
    请参数非法,请根据错误描述检查请求是否正确
    100003
    房间 ID 已存在,请选择其他房间 ID
    100006
    无权限操作房间自定义信息
    100007
    无付费信息,需在控制台购买套餐包
    100500
    房间自定义信息 key 数量超过上限10
    100501
    房间自定义信息单个 key 对应的 value 字节数超过上限2KB
    100502
    房间自定义信息所有 key 对应的 value 字节数总和超过上限16KB
    100503
    删除自定义信息时候指定的 key 没有一个有效的
    联系我们

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

    技术支持

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

    7x24 电话支持