淘宝开放平台

请求地址：

环境	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	HeartBeatRequest	可选			请求入参
└ mix_game_id String 可选 cgeabntyjfjdtg 游戏id └ user_id String 可选 1234 主播用户id └ room_id Number 可选 1 房间id └ seq Number 必须 1 心跳序列 └ interval Number 必须 20 心跳间隔(s) └ token String 必须 xxx 验签token

名称	类型	示例值	描述
result	Result		返回结果
└ code String OK 返回状态码 data HeartBeatResponse 返回结果 └ user_id String 1234 用户id └ room_id Number 1029 房间id └ ext_info String {} 扩展字段 └ report_time Number 1649680000 上报时间戳 └ seq Number 1 上报序列 └ message String OK 返回描述

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
AlibabaCloudgameInteractiveGameHeartbeatRequest req = new AlibabaCloudgameInteractiveGameHeartbeatRequest();
AlibabaCloudgameInteractiveGameHeartbeatRequest.HeartBeatRequest obj1 = new AlibabaCloudgameInteractiveGameHeartbeatRequest.HeartBeatRequest();
obj1.setMixGameId("cgeabntyjfjdtg");
obj1.setUserId("1234");
obj1.setRoomId(1L);
obj1.setSeq(1L);
obj1.setInterval(20L);
obj1.setToken("xxx");
req.setStartGameRequest(obj1);
AlibabaCloudgameInteractiveGameHeartbeatResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
AlibabaCloudgameInteractiveGameHeartbeatRequest req = new AlibabaCloudgameInteractiveGameHeartbeatRequest();
AlibabaCloudgameInteractiveGameHeartbeatRequest.HeartBeatRequestDomain obj1 = new AlibabaCloudgameInteractiveGameHeartbeatRequest.HeartBeatRequestDomain();
obj1.MixGameId = "cgeabntyjfjdtg";
obj1.UserId = "1234";
obj1.RoomId = 1L;
obj1.Seq = 1L;
obj1.Interval = 20L;
obj1.Token = "xxx";
req.StartGameRequest_ = obj1;
AlibabaCloudgameInteractiveGameHeartbeatResponse rsp = client.Execute(req);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new AlibabaCloudgameInteractiveGameHeartbeatRequest;
$start_game_request = new HeartBeatRequest;
$start_game_request->mix_game_id="cgeabntyjfjdtg";
$start_game_request->user_id="1234";
$start_game_request->room_id="1";
$start_game_request->seq="1";
$start_game_request->interval="20";
$start_game_request->token="xxx";
$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.heartbeat' \
-d 'partner_id=apidoc' \
-d 'sign=F285EBE3714E0C22FAA56EEC5D934051' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-04-30+16%3A29%3A44' \
-d 'v=2.0' \
-d 'start_game_request=null'

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

req=top.api.AlibabaCloudgameInteractiveGameHeartbeatRequest(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.heartbeat");
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.heartbeat', {
	'start_game_request':'数据结构JSON示例'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<alibaba_cloudgame_interactive_game_heartbeat_response>
    <result>
        <code>OK</code>
        <data>
            <user_id>1234</user_id>
            <room_id>1029</room_id>
            <ext_info>{}</ext_info>
            <report_time>1649680000</report_time>
            <seq>1</seq>
        </data>
        <message>OK</message>
    </result>
</alibaba_cloudgame_interactive_game_heartbeat_response>

{
    "alibaba_cloudgame_interactive_game_heartbeat_response":{
        "result":{
            "code":"OK",
            "data":{
                "user_id":"1234",
                "room_id":1029,
                "ext_info":"{}",
                "report_time":1649680000,
                "seq":1
            },
            "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.heartbeat (游戏玩家心跳)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ