退出游戏排队--云游戏-火山引擎

文档中心

立即注册

导航

退出游戏排队

最近更新时间：2025.01.20 15:42:49首次发布时间：2023.11.28 10:18:58

用户主动退出游戏排队。

请求说明

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

请求参数

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

Query

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

Body

参数	类型	是否必选	示例值	描述
GameId	String	否	`792370237209`	游戏 ID，可通过调用 ListGame 接口获取。`GameId` 和 `CustomGameId`二选一。
CustomGameId	String	否	`79743290379`	用户自定义游戏 ID，在注册游戏时指定。`GameId` 和 `CustomGameId`二选一。
ClientUserId	String	是	`09831907491113`	唯一用户身份标识，由业务方自定义，用于标识用户在游戏中的身份。与通过客户端 SDK `start()` 接口申请游戏服务、调用 GameStop 接口停止游戏服务时指定的自定义客户端用户 ID 相同。
DeviceId	String	否	`987401131·`	客户端用户设备 ID。与通过客户端 SDK start 接口申请游戏服务时指定的 `deviceId` 一致；如不指定，则该用户 ID 对应的全部设备都从退出游戏排队。

返回参数

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

参数	类型	示例值	描述
Result	String	`success`	用户退出游戏排队成功，返回`success`。否则返回错误。

请求示例

POST https://open.volcengineapi.com?Action=ExitUserQueue&Version=2023-03-18
{
    "ClientUserId": "09831907491113"
}

返回示例

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

错误码

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