Switch Seat(New version)
Feature Description
The App admin can use this API to move a certain on-mic user to another seat. Automatic unlock is triggered when muting, and it also supports forcing a move, exchanging seats, and other operations.
Note:
This API is for the new version of the Moving Mic feature. For the earlier version, refer to Switch Seat(Old version). The earlier version supports only moving to an empty mic slot.
API Call Description
Sample Request URL
https://console.tim.qq.com/v4/room_engine_http_mic/move_user_to_seat?sdkappid=88888888&identifier=admin&usersig=xxx&random=99999999&contenttype=json
Request Parameters
The following table lists only the parameters involved in modification when calling this API and their descriptions. For more details about the parameters, please refer to REST API introduction.
Parameter | Description |
v4/room_engine_http_mic/move_user_to_seat | Request API |
sdkappid | The SDKAppID assigned by the IM console when creating an application. |
identifier | |
usersig | The signature generated by the App administrator account. For specific operations, see generate UserSig. |
random | Enter a random 32-bit unsigned integer in the range of [0, 4294967295]. |
contenttype | The request format is fixed as json. |
Maximum Calling Frequency
200 times/second.
Sample Request Packet
Basic form
{"RoomId":"room-test","SeatIndex": 1,"Member_Account": "user","Policy": 0 // Specify the seat move mode when occupied, 0 cancel, 1 force move and kick this user, 2 exchange seats}
Request Packet Fields
Field | Type | Attribute | Description |
RoomId | String | Required | room ID |
SeatIndex | Integer | Required | Seat ID. |
Member_Account | String | Required | user ID. |
Policy | Integer | Required | Seat move mode. When the seat is occupied, 0 cancel, 1 force move and kick this user, 2 exchange seats. |
Response Payload Example
Basic form
{"ErrorCode": 0,"ErrorInfo": "","ActionStatus": "OK","RequestId": "Id-7c1680be52734bdc8d6de398ab9505e7-O-Seq-57717"}
Response Packet Fields
Field | Type | Description |
ActionStatus | String | Request processing result. OK: processing successful; FAIL: processing failed. |
ErrorCode | Integer | Error code: 0 indicates success, non-zero indicates failure. |
ErrorInfo | String | Error message. |
RequestId | String | Unique request ID, returned for each request. To troubleshoot a request, its RequestId should be provided. |
Error Code Description
Unless a network error (such as 502) occurs, the HTTP return code of this API is 200. The actual error code and error information are indicated by ErrorCode and ErrorInfo in the response payload.
Private error codes of this API are as follows:
Error Code | Description |
100001 | Server internal error, please try again. |
100002 | Illegal request parameters. Check whether the request is correct according to the error description. |
100004 | The room does not exist, or it may have existed but has been dismissed. |
100005 | Microphone User Non-room Member |
100200 | Seat locked. Can try another seat. |
100203 | Already on mic |
100206 | User not on mic |
100210 | User on seat |