文档中心 > API类目 > 云游戏API

alibaba.cloudgame.interactive.game.room.shutdown (强制关闭房间)

强制关闭房间

公共参数

请求地址：

环境	HTTP请求地址	HTTPS请求地址
正式环境	http://gw.api.taobao.com/router/rest	https://eco.taobao.com/router/rest

公共请求参数：

名称	类型	是否必须	描述
method	String	是	API接口名称。
app_key	String	是	TOP分配给应用的AppKey。
target_app_key	String	否	被调用的目标AppKey，仅当被调用的API为第三方ISV提供时有效。
sign_method	String	是	签名的摘要算法，可选值为：hmac，md5。
sign	String	是	API输入参数签名结果，签名算法介绍请点击这里。
session	String	否	用户登录授权成功后，TOP颁发给应用的授权信息，详细介绍请点击这里。当此API的标签上注明：“需要授权”，则此参数必传；“不需要授权”，则此参数不需要传；“可选授权”，则此参数为可选。
timestamp	String	是	时间戳，格式为yyyy-MM-dd HH:mm:ss，时区为GMT+8，例如：2015-01-01 12:00:00。淘宝API服务端允许客户端请求最大时间误差为10分钟。
format	String	否	响应格式。默认为xml格式，可选值：xml，json。
v	String	是	API协议版本，可选值：2.0。
partner_id	String	否	合作伙伴身份标识。
simplify	Boolean	否	是否采用精简JSON返回格式，仅当format=json时有效，默认值为：false。

请求参数

名称	类型	是否必须	示例值	更多限制	描述
shutdown_room_request	ShutdownRoomRequest	必须			请求入参
└ room_id Number 必须 1 房间ID └ token String 可选 xxxx 验签token

响应参数

名称	类型	示例值	描述
result	Result		返回结果
└ code String 0 状态码 data ShutdownRoomResponse 强制停止房间返回结果 game OpenGameDTO 游戏详情 └ creator String xmagic 创建者用户ID └ mix_game_id String N0A6X0JIJGA= 游戏ID └ name String 超级玛丽游戏名称 └ total_player_num Number 4 游戏总人数 └ player_num Number 0 游戏当前人数 player_list OpenGamePlayerDTO [] 游戏当前剩余玩家列表 └ player_index Number 0 玩家位置索引 └ user_id String xmagic 用户ID └ room_id Number 290319 房间号 └ ext_info String {} 扩展字段 └ message String SUCCESS 返回描述

请求示例

JAVA
.NET
PHP
CURL
Python
C/C++
NodeJS

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
AlibabaCloudgameInteractiveGameRoomShutdownRequest req = new AlibabaCloudgameInteractiveGameRoomShutdownRequest();
AlibabaCloudgameInteractiveGameRoomShutdownRequest.ShutdownRoomRequest obj1 = new AlibabaCloudgameInteractiveGameRoomShutdownRequest.ShutdownRoomRequest();
obj1.setRoomId(1L);
obj1.setToken("xxxx");
req.setShutdownRoomRequest(obj1);
AlibabaCloudgameInteractiveGameRoomShutdownResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

响应示例

XML示例
JSON示例

<alibaba_cloudgame_interactive_game_room_shutdown_response>
    <result>
        <code>0</code>
        <data>
            <game>
                <creator>xmagic</creator>
                <mix_game_id>N0A6X0JIJGA=</mix_game_id>
                <name>超级玛丽</name>
                <total_player_num>4</total_player_num>
                <player_num>0</player_num>
            </game>
            <player_list>
                <open_game_player_d_t_o>
                    <player_index>0</player_index>
                    <user_id>xmagic</user_id>
                </open_game_player_d_t_o>
            </player_list>
            <room_id>290319</room_id>
            <ext_info>{}</ext_info>
        </data>
        <message>SUCCESS</message>
    </result>
</alibaba_cloudgame_interactive_game_room_shutdown_response>

异常示例

XML示例
JSON示例

<error_response>
    <code>50</code>
    <msg>Remote service error</msg>
    <sub_code>isv.invalid-parameter</sub_code>
    <sub_msg>非法参数</sub_msg>
</error_response>

错误码解释

错误码	错误描述	解决方案

API工具

API测试工具错误码查询工具 SDK下载

如何获得此API

FAQ

我要提问

返回
顶部