https://xxxxxx/v4/room_engine_http_mic/lock_seat?sdkappid=88888888&identifier=admin&usersig=xxx&random=99999999&contenttype=json
Parameter | Description |
xxxxxx | The reserved domain name for the country/region where the SDKAppID is located: Singapore : adminapisgp.im.qcloud.com |
v4/room_engine_http_mic/lock_seat | Request API |
sdkappid | The SDKAppID assigned by the Chat console when an app is created |
identifier | |
usersig | The Signature generated by the App administrator account. For more details, please refer to Generating UserSig. |
random | Enter a random 32-bit unsigned integer ranging from 0 to 4294967295 |
contenttype | The request format fixed value is json |
{"RoomId":"room-test","Index":2,"ForbidTaken":true,"ForbidVideo":true,"ForbidAudio":true}
Field | Type | Attribute | Description |
RoomId | String | Mandatory | Room ID |
Index | Integer | Mandatory | The seat position number |
ForbidTaken | Bool | Optional | Lock the seat position |
ForbidVideo | Bool | Optional | Disable video stream |
ForbidAudio | Bool | Optional | Disable audio stream |
{"ErrorCode": 0,"ErrorInfo": "","ActionStatus": "OK","RequestId": "Id-7c1680be52734bdc8d6de398ab9505e7-O-Seq-57717"}
Field | Type | Description |
ActionStatus | String | The result of the request process. OK for success, FAIL for failure. |
ErrorCode | Integer | Error code. 0 for success, others for failure. |
ErrorInfo | String | Error message |
RequestId | String | The unique request ID is returned with each request and required to provide this RequestId when locating issues. |
Error code | Description |
100001 | Internal server error, please retry. |
100002 | Invalid parameter, please check the request for correctness based on the error description. |
100004 | Room does not exist, or it once existed but now has been destroyed. |
100211 | This room does not support seat connection. |
Was this page helpful?