淘宝开放平台

请求地址：

环境	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。

名称	类型	是否必须	示例值	更多限制	描述
start_game_request	StartGameRequest	可选			请求入参
└ mix_game_id String 必须 N0A6X0JIJGA= 游戏id └ user_id String 必须 1234 主播用户id └ room_id Number 必须 1 房间id └ token String 必须 xxxx 验签token

名称	类型	示例值	描述
result	Result		返回结果
└ code String OK 返回状态码 data StartGameResponse 返回结果 game OpenGameDTO 游戏详情 └ mix_game_id String N0A6X0JIJGA= 游戏id └ name String 超级玛丽游戏名称 └ creator String 1234 主播id └ total_player_num Number 4 支持玩家数量 └ player_num Number 2 当前玩家数量 └ room_id Number 1 房间id └ game_session String xxxx 游戏会话id └ join_code String xxxx 联机码 player_list OpenGamePlayerDTO [] {} 玩家列表 └ user_id String 1234 玩家id └ player_index String 0 位置索引 └ ext_info String {} 扩展字段 slot GetSlotResponse 联机信息 └ mix_game_id String xxxxxx 编码后的游戏ID └ game_session String adfadfae3e23ff 会话ID └ game_token String adfadfae3e23ff 游戏token └ queue_state_desc String 正常游戏状态描述 └ link_mark String 正常会话状态备注 └ mix_user_id String 1232 用户id └ sched_type String sched_type 调度类型 └ join_code String [] 联机码 └ queue_state Number 1 会话状态 └ user_level Number 1 用户等级 └ vip_level Number 1 vip等级 └ host Boolean true 是否是主控 └ force_h264 Boolean true 是否是强制264 └ polling_interval Number 5 轮询时间间隔 endpoints GameEndPoint [] 串流信息 └ type String H5 H5或者Native的访问点 └ provider String provider 后端的isv类型 └ ws_server String ws_server websocket 域名 H5 └ ws_port String 8888 websocket 端口 H5 └ ws_token String ws_token websocket token └ isp String isp isp └ region_id String region_id region_id └ area_id Number area_id area_id └ h5_domain String h5_domain h5_domain endpoint_server EndpointServerDTO [] h5servier地址 └ name String name name └ type String type 类型 └ isp String isp isp └ web_socket_domain String webSocketDomain webSocketDomain └ web_socket_port Number webSocketPort webSocketPort └ ws_token String wsToken wsToken └ message String OK 返回描述

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
AlibabaCloudgameInteractiveGameStartRequest req = new AlibabaCloudgameInteractiveGameStartRequest();
AlibabaCloudgameInteractiveGameStartRequest.StartGameRequest obj1 = new AlibabaCloudgameInteractiveGameStartRequest.StartGameRequest();
obj1.setMixGameId("N0A6X0JIJGA=");
obj1.setUserId("1234");
obj1.setRoomId(1L);
obj1.setToken("xxxx");
req.setStartGameRequest(obj1);
AlibabaCloudgameInteractiveGameStartResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
AlibabaCloudgameInteractiveGameStartRequest req = new AlibabaCloudgameInteractiveGameStartRequest();
AlibabaCloudgameInteractiveGameStartRequest.StartGameRequestDomain obj1 = new AlibabaCloudgameInteractiveGameStartRequest.StartGameRequestDomain();
obj1.MixGameId = "N0A6X0JIJGA=";
obj1.UserId = "1234";
obj1.RoomId = 1L;
obj1.Token = "xxxx";
req.StartGameRequest_ = obj1;
AlibabaCloudgameInteractiveGameStartResponse rsp = client.Execute(req);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new AlibabaCloudgameInteractiveGameStartRequest;
$start_game_request = new StartGameRequest;
$start_game_request->mix_game_id="N0A6X0JIJGA=";
$start_game_request->user_id="1234";
$start_game_request->room_id="1";
$start_game_request->token="xxxx";
$req->setStartGameRequest(json_encode($start_game_request));
$resp = $c->execute($req);

curl -X POST 'http://gw.api.taobao.com/router/rest' \
-H 'Content-Type:application/x-www-form-urlencoded;charset=utf-8' \
-d 'app_key=12129701' \
-d 'format=json' \
-d 'method=alibaba.cloudgame.interactive.game.start' \
-d 'partner_id=apidoc' \
-d 'sign=F05EEDCD21735F4759F2CFF73E67A1A3' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-04-30+16%3A31%3A55' \
-d 'v=2.0' \
-d 'start_game_request=null'

# -*- coding: utf-8 -*-
import top.api

req=top.api.AlibabaCloudgameInteractiveGameStartRequest(url,port)
req.set_app_info(top.appinfo(appkey,secret))

req.start_game_request="数据结构示例JSON格式"
try:
	resp= req.getResponse()
	print(resp)
except Exception,e:
	print(e)

pTopRequest pRequest = alloc_top_request();
pTopResponse pResponse = NULL;
pTaobaoClient pClient = alloc_taobao_client(url, appkey, appsecret);
set_api_name(pRequest,"alibaba.cloudgame.interactive.game.start");
add_param(pRequest,"start_game_request","数据结构JSON示例");
pResponse = top_execute(pClient,pRequest,NULL);
printf("ret code:%d\n",pResponse->code);
if(pResponse->code == 0){
	pTopResponseIterator ite = init_response_iterator(pResponse);
	pResultItem pResultItem = alloc_result_item();
	while(parseNext(ite, pResultItem) == 0){
		printf("%s:%s\n",pResultItem->key,pResultItem->value);
	}
	destroy_response_iterator(ite);
	destroy_result_item(pResultItem);
}
destroy_top_request(pRequest);
destroy_top_response(pResponse);
destroy_taobao_client(pClient);

TopClient = require('./topClient').TopClient;
var client = new TopClient({
	'appkey': 'appkey',
	'appsecret': 'secret',
	'REST_URL': 'http://gw.api.taobao.com/router/rest'
});

client.execute('alibaba.cloudgame.interactive.game.start', {
	'start_game_request':'数据结构JSON示例'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<alibaba_cloudgame_interactive_game_start_response>
    <result>
        <code>OK</code>
        <data>
            <game>
                <mix_game_id>N0A6X0JIJGA=</mix_game_id>
                <name>超级玛丽</name>
                <creator>1234</creator>
                <total_player_num>4</total_player_num>
                <player_num>2</player_num>
            </game>
            <room_id>1</room_id>
            <game_session>xxxx</game_session>
            <join_code>xxxx</join_code>
            <player_list>
                <open_game_player_d_t_o>
                    <user_id>1234</user_id>
                    <player_index>0</player_index>
                </open_game_player_d_t_o>
            </player_list>
            <ext_info>{}</ext_info>
            <slot>
                <mix_game_id>xxxxxx</mix_game_id>
                <game_session>adfadfae3e23ff</game_session>
                <game_token>adfadfae3e23ff</game_token>
                <queue_state_desc>正常</queue_state_desc>
                <link_mark>正常</link_mark>
                <mix_user_id>1232</mix_user_id>
                <sched_type>sched_type</sched_type>
                <queue_state>1</queue_state>
                <user_level>1</user_level>
                <vip_level>1</vip_level>
                <host>true</host>
                <force_h264>true</force_h264>
                <polling_interval>5</polling_interval>
                <endpoints>
                    <game_end_point>
                        <type>H5</type>
                        <provider>provider</provider>
                        <ws_server>ws_server</ws_server>
                        <ws_port>8888</ws_port>
                        <ws_token>ws_token</ws_token>
                        <isp>isp</isp>
                        <region_id>region_id</region_id>
                        <area_id>area_id</area_id>
                        <h5_domain>h5_domain</h5_domain>
                    </game_end_point>
                </endpoints>
                <endpoint_server>
                    <endpoint_server_d_t_o>
                        <name>name</name>
                        <type>type</type>
                        <isp>isp</isp>
                        <web_socket_domain>webSocketDomain</web_socket_domain>
                        <web_socket_port>webSocketPort</web_socket_port>
                        <ws_token>wsToken</ws_token>
                    </endpoint_server_d_t_o>
                </endpoint_server>
            </slot>
        </data>
        <message>OK</message>
    </result>
</alibaba_cloudgame_interactive_game_start_response>

{
    "alibaba_cloudgame_interactive_game_start_response":{
        "result":{
            "code":"OK",
            "data":{
                "game":{
                    "mix_game_id":"N0A6X0JIJGA=",
                    "name":"超级玛丽",
                    "creator":"1234",
                    "total_player_num":4,
                    "player_num":2
                },
                "room_id":1,
                "game_session":"xxxx",
                "join_code":"xxxx",
                "player_list":{
                    "open_game_player_d_t_o":[
                        {
                            "user_id":"1234",
                            "player_index":"0"
                        }
                    ]
                },
                "ext_info":"{}",
                "slot":{
                    "mix_game_id":"xxxxxx",
                    "game_session":"adfadfae3e23ff",
                    "game_token":"adfadfae3e23ff",
                    "queue_state_desc":"正常",
                    "link_mark":"正常",
                    "mix_user_id":"1232",
                    "sched_type":"sched_type",
                    "queue_state":1,
                    "user_level":1,
                    "vip_level":1,
                    "host":true,
                    "force_h264":true,
                    "polling_interval":5,
                    "endpoints":{
                        "game_end_point":[
                            {
                                "type":"H5",
                                "provider":"provider",
                                "ws_server":"ws_server",
                                "ws_port":"8888",
                                "ws_token":"ws_token",
                                "isp":"isp",
                                "region_id":"region_id",
                                "area_id":area_id,
                                "h5_domain":"h5_domain"
                            }
                        ]
                    },
                    "endpoint_server":{
                        "endpoint_server_d_t_o":[
                            {
                                "name":"name",
                                "type":"type",
                                "isp":"isp",
                                "web_socket_domain":"webSocketDomain",
                                "web_socket_port":webSocketPort,
                                "ws_token":"wsToken"
                            }
                        ]
                    }
                }
            },
            "message":"OK"
        }
    }
}

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>

{
	"error_response":{
		"msg":"Remote service error",
		"code":50,
		"sub_msg":"非法参数",
		"sub_code":"isv.invalid-parameter"
	}
}

错误码	错误描述	解决方案

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

云游戏API

alibaba.cloudgame.interactive.game.start (云游戏场景互动开始游戏)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ