接口请求域名: gme.intl.tencentcloudapi.com 。
本接口(DeleteRoomMember)用户删除房间或者剔除房间内用户
默认接口请求频率限制:200次/秒。
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:DeleteRoomMember。 |
| Version | 是 | String | 公共参数,本接口取值:2018-07-11。 |
| Region | 否 | String | 公共参数,此参数为可选参数。 |
| RoomId | 是 | String | 要操作的房间id |
| DeleteType | 是 | Integer | 剔除类型 1-删除房间 2-剔除用户 |
| BizId | 是 | Integer | 应用id |
| Uids.N | 否 | Array of String | 要剔除的用户列表(整型) |
| StrUids.N | 否 | Array of String | 要剔除的用户列表(字符串类型) |
| 参数名称 | 类型 | 描述 |
|---|---|---|
| DeleteResult | DeleteResult | 剔除房间或成员的操作结果 |
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
剔除房间内某两个用户
POST / HTTP/1.1
Host: gme.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DeleteRoomMember
<公共请求参数>
{
"DeleteType": 2,
"RoomId": "100",
"BizId": 1400000000,
"Uids": [
"2",
"1"
],
"StrUids": []
}
{
"Response": {
"RequestId": "dfe39c29-ce97-44df-ba79-7d947d465694",
"DeleteResult": {
"Code": 0,
"ErrorMsg": ""
}
}
}
云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| FailedOperation | 操作失败。 |
| InternalError | 内部错误。 |
| InvalidParameter | 参数错误。 |
| InvalidParameterValue.InvalidDeleteType | 输入删除类型应为1或2。 |
| InvalidParameterValue.InvalidStrUin | 不需要填写StrUid,请填写Uid |
| InvalidParameterValue.InvalidUinOrStrUin | 不能同时输入uid和strUid |
| ResourceNotFound | 资源不存在。 |
| UnsupportedOperation | 操作不支持。 |
| UnsupportedOperation.LimitDeleteExceeded | 超过最大踢人数量 |
文档反馈