将用户移出当前游戏 BanRoomUser--云游戏-火山引擎

文档中心

立即注册

导航

将用户移出当前游戏 BanRoomUser

最近更新时间：2025.01.20 15:42:49首次发布时间：2024.04.19 13:53:04

本接口将指定用户移出当前游戏。

请求说明

请求方式：POST
请求地址：https://open.volcengineapi.com?Action=BanRoomUser&Version=2023-03-18

请求参数

下表仅列出了接口特有的请求参数和部分公共参数。完整的公共参数列表，参考公共请求参数。

Query

参数	类型	是否必选	示例值	描述
Action	String	是	`BanRoomUser`	接口名称。当前 API 的名称为 `BanRoomUser`。
Version	String	是	`2023-03-18`	接口版本。当前 API 的版本为 `2023-03-18`。

Body

参数	类型	是否必选	示例值	描述
GameId	String	否	`12839089248923`	游戏 ID，可通过调用 ListGame 接口获取返回的游戏 ID。`GameId` 和 `CustomGameId` 二选一，二者同时指定时，`GameId` 取值优先。
CustomGameId	String	否	`239103281-301`	游戏标识，在注册游戏时指定。可通过调用 ListGame 接口获取返回的游戏 ID。`GameId` 和 `CustomGameId` 二选一，二者同时指定时，`GameId` 取值优先。
ReservedId	String	是	`9827309381`	资源预锁定 ID，可通过调用 PreAllocateResource 接口获取，或通过客户端 SDK `start()` 接口成功回调。
ClientUserId	String	是	`9823028420113`	需要移出游戏的用户 ID，即唯一用户身份标识，由业务方自定义，用于标识用户在游戏中的身份。与调用 PreAllocateResource 接口时指定的 `ClientUserId` 相同。

返回参数

下表仅列出本接口特有的返回参数。更多信息请见返回结构。

参数	类型	示例值	描述
Result	String	`success`	将用户移出当前游戏成功，返回 `success`；否则返回错误。

请求示例

POST https://open.volcengineapi.com?Action=BanRoomUser&Version=2023-03-18
{
    "GameId": "724853800***4210092",
    "ReservedId": "729113685***12940332",
    "ClientUserId": "9823028420113"
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "202306041104200100100232280022D31",
        "Action": "BanRoomUser",
        "Version": "2023-03-18",
        "Service": "veGame",
        "Region": "cn-north-1"
    },
    "Result": {
        "Result": "success"
    }
}

错误码

您可访问公共错误码，获取更多错误码信息。