Domain name for API request: gme.intl.tencentcloudapi.com.
This API is used to delete a room or remove members from the room.
A maximum of 200 requests can be initiated per second for this API.
The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| Action | Yes | String | Common Params. The value used for this API: DeleteRoomMember. |
| Version | Yes | String | Common Params. The value used for this API: 2018-07-11. |
| Region | No | String | Common Params. This parameter is not required. |
| RoomId | Yes | String | ID of the target room |
| DeleteType | Yes | Integer | Operation type. 1: Delete a room; 2: Remove members |
| BizId | Yes | Integer | Application ID |
| Uids.N | No | Array of String | List of the members to remove |
| Parameter Name | Type | Description |
|---|---|---|
| DeleteResult | DeleteResult | Result of the operation to delete a room or remove a member |
| RequestId | String | The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem. |
This example shows you how to Remove two members from the room.
POST / HTTP/1.1
Host: gme.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DeleteRoomMember
<Common request parameters>
{
"DeleteType": "2",
"RoomId": "100",
"BizId": "140014556",
"Uids": [
"2",
"1"
]
}
{
"Response": {
"RequestId": "dfe39c29-ce97-44df-ba79-7d947d465694",
"DeleteResult": {
"Code": 0,
"ErrorMsg": ""
}
}
}
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.
| Error Code | Description |
|---|---|
| FailedOperation | Operation failed. |
| InternalError | Internal error. |
| InvalidParameter | Incorrect parameter. |
| InvalidParameterValue.InvalidDeleteType | |
| InvalidParameterValue.InvalidStrUin | |
| InvalidParameterValue.InvalidUinOrStrUin | |
| ResourceNotFound | The resource does not exist. |
| UnsupportedOperation | Operation unsupported. |
| UnsupportedOperation.LimitDeleteExceeded |
フィードバック