https://xxxxxx/v4/live_engine_http_srv/set_room_metadata?sdkappid=88888888&identifier=admin&usersig=xxx&random=99999999&contenttype=json
参数 | 说明 |
xxxxxx | SDKAppID 所在国家/地区对应的专属域名: 中国: console.tim.qq.com 新加坡: adminapisgp.im.qcloud.com |
v4/live_engine_http_srv/set_room_metadata | 请求接口 |
sdkappid | 创建应用时即时通信 IM 控制台分配的 SDKAppID |
identifier | |
usersig | |
random | 请输入随机的32位无符号整数,取值范围0 - 4294967295 |
contenttype | 请求格式固定值为 json |
{"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 |
错误码 | 含义说明 |
100001 | 服务器内部错误,请重试 |
100002 | 请参数非法,请根据错误描述检查请求是否正确 |
100003 | 房间 ID 已存在,请选择其他房间 ID |
100006 | 无权限操作房间自定义信息 |
100007 | 无付费信息,需在控制台购买套餐包 |
100500 | 房间自定义信息 key 数量超过上限10 |
100501 | 房间自定义信息单个 key 对应的 value 字节数超过上限2KB |
100502 | 房间自定义信息所有 key 对应的 value 字节数总和超过上限16KB |
100503 | 删除自定义信息时候指定的 key 没有一个有效的 |
本页内容是否解决了您的问题?