淘宝开放平台

请求地址：

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

名称	类型	是否必须	示例值	更多限制	描述
request_param	PaasSpiSessionStatusRequestDTO	必须			会话状态同步参数
└ game_id String 必须 1 游戏ID └ user_start_time Number 可选 1 游戏开始时间 └ scheduled_time Number 可选 1 游戏调度时间 └ session_status String 可选 DISPATCHED 游戏当前状态 └ version Number 必须 1 版本 └ tags String 可选 1 tag数据 └ account_id String 必须 1 用户ID └ game_session_id String 必须 1 游戏会话ID └ session_stop_time Number 可选 1 游戏停止时间 └ message_type String 必须 DISPATCHED 游戏消息类型 └ action String 必须 SESSION_STATE_MESSAGE 模板类型 └ time Number 必须 1 触发时间 └ project_id String 必须 1 项目ID

名称	类型	示例值	描述
result	Result		状态同步返回
└ code String 0 接口状态 data PaasSpiSessionStatusResponseDTO 数据对象 └ consume_state Number 1 数据处理状态 └ message String ok 数据状态描述 └ message String success 接口状态描述

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
AlibabaCloudgameGamingSesionStatusRequest req = new AlibabaCloudgameGamingSesionStatusRequest();
AlibabaCloudgameGamingSesionStatusRequest.PaasSpiSessionStatusRequestDTO obj1 = new AlibabaCloudgameGamingSesionStatusRequest.PaasSpiSessionStatusRequestDTO();
obj1.setGameId("1");
obj1.setUserStartTime(1L);
obj1.setScheduledTime(1L);
obj1.setSessionStatus("DISPATCHED");
obj1.setVersion(1L);
obj1.setTags("1");
obj1.setAccountId("1");
obj1.setGameSessionId("1");
obj1.setSessionStopTime(1L);
obj1.setMessageType("DISPATCHED");
obj1.setAction("SESSION_STATE_MESSAGE");
obj1.setTime(1L);
obj1.setProjectId("1");
req.setRequestParam(obj1);
AlibabaCloudgameGamingSesionStatusResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
AlibabaCloudgameGamingSesionStatusRequest req = new AlibabaCloudgameGamingSesionStatusRequest();
AlibabaCloudgameGamingSesionStatusRequest.PaasSpiSessionStatusRequestDTODomain obj1 = new AlibabaCloudgameGamingSesionStatusRequest.PaasSpiSessionStatusRequestDTODomain();
obj1.GameId = "1";
obj1.UserStartTime = 1L;
obj1.ScheduledTime = 1L;
obj1.SessionStatus = "DISPATCHED";
obj1.Version = 1L;
obj1.Tags = "1";
obj1.AccountId = "1";
obj1.GameSessionId = "1";
obj1.SessionStopTime = 1L;
obj1.MessageType = "DISPATCHED";
obj1.Action = "SESSION_STATE_MESSAGE";
obj1.Time = 1L;
obj1.ProjectId = "1";
req.RequestParam_ = obj1;
AlibabaCloudgameGamingSesionStatusResponse rsp = client.Execute(req);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new AlibabaCloudgameGamingSesionStatusRequest;
$request_param = new PaasSpiSessionStatusRequestDTO;
$request_param->game_id="1";
$request_param->user_start_time="1";
$request_param->scheduled_time="1";
$request_param->session_status="DISPATCHED";
$request_param->version="1";
$request_param->tags="1";
$request_param->account_id="1";
$request_param->game_session_id="1";
$request_param->session_stop_time="1";
$request_param->message_type="DISPATCHED";
$request_param->action="SESSION_STATE_MESSAGE";
$request_param->time="1";
$request_param->project_id="1";
$req->setRequestParam(json_encode($request_param));
$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.gaming.sesion.status' \
-d 'partner_id=apidoc' \
-d 'sign=6999D62D81598E3EBEF12CF672824DD0' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-04-30+16%3A33%3A56' \
-d 'v=2.0' \
-d 'request_param=null'

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

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

req.request_param="数据结构示例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.gaming.sesion.status");
add_param(pRequest,"request_param","数据结构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.gaming.sesion.status', {
	'request_param':'数据结构JSON示例'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<alibaba_cloudgame_gaming_sesion_status_response>
    <result>
        <code>0</code>
        <data>
            <consume_state>1</consume_state>
            <message>ok</message>
        </data>
        <message>success</message>
    </result>
</alibaba_cloudgame_gaming_sesion_status_response>

{
    "alibaba_cloudgame_gaming_sesion_status_response":{
        "result":{
            "code":"0",
            "data":{
                "consume_state":1,
                "message":"ok"
            },
            "message":"success"
        }
    }
}

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.gaming.sesion.status (paas集群会话状态同步)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ