# 开始调用流程

# 说明

通过此方式开始调用腾讯游戏来联活动中的流程，并获取返回信息。
什么是流程

重要说明：此接口是调用流程的统一入口。根据流程配置的不同，返回的数据格式会有所不同。返回数据中的 apiName 字段标识了当前返回的数据类型，jData 的结构取决于返回中 apiName 的值。常见的返回类型包括：

FlowConditionQuery：条件查询结果（见输出条件信息）

Lottery：道具发放结果（见道具发放）

Output：标准化结果输出（见标准化结果输出）

Jfcloud：云积分查询结果（见云积分查询）

其他类型请参考更多的输出格式部分

# 先决条件

在腾讯游戏来联已立项。如何立项活动？
项目中配置了测试流程

# 请求示例

curl "https://s1.livelink.qq.com/livelink/?
apiName=ApiRequest&livePlatId=xx&actId=1201&gameId=cf&v=2.0&t=&nonce=&code=diVa28UpyL5G%2BVmKNVIcg%3D%3D&sig=e3909d0a2cb7f7d8f2ec03fb4ea96007" -d '{"flowId":"69f33ur0", serialCode:"b982de7a8ada43b43f8d511f88" }'

1
2

# 公共参数(GET)

参数	类型	说明	是否必填
apiName	string	固定：ApiRequest，不参与签名	是
livePlatId	string	平台id，腾讯游戏来联统一分配	是
actId	int	活动id，立项时的项目id	是
gameId	string	业务名称，见《业务代码》	是
v	float	固定：2.0	是
t	int	Unix时间戳，精度：秒	是
nonce	string	8位随机字符串	是
code	string	用户登录态。平台侧，可参考《平台侧接入》	是
sig	string	签名，见《加密与签名》	是

# 私有参数(json)

参数	类型	说明	是否必填
flowId	string	流程id，必填，由腾讯游戏来联配置接口时生成	是
serialCode	string	防重序列号。只能由数字+大小写字母+下划线组成，长度为32位，建议填写。生成请确保该序列号唯一性。当遇到网络超时可携带该字段多次请求。	否
anchorId	string	主播id，选填	否

# 接口返回

 {
  "apiName": "FlowConditionQuery",
  "iRet": 0,
  "sMsg": "ok",
  "tid": "234792036992152138",
  "v": 2,
  "jData": [
    {
      "secure": 1,
      "name": "查询当天对局局数【推荐】",
      "api": "lol_game_daily_inner",
      "quota": "games",
      "quotaName": "对局数",
      "compVal": false,
      "expectVal": 1,
      "curVal": 0
    }
  ]
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19

# 返回参数

参数	类型	说明
iRet	int	流程调用错误码。0为流程调用正常，非0为错误
sMsg	string	错误提示信息
tid	string	日志ID，建议保留
v	int	接口版本，当前为2
apiName	string	关键字段：返回中apiName字段与请求中apiName含义不一样，此处为输出该数据的模块ID，用于标识返回数据的类型。根据流程配置的不同，可能返回不同的值（如 `FlowConditionQuery`、`Lottery`、`Output` 等）。根据此字段的值，可以确定 `jData` 的具体结构。
jData	object	数据结构取决于 `apiName` 字段：jData输出结构取决于返回中apiName部分。不同的 `apiName` 对应不同的 `jData` 结构，详见《更多的输出格式》

# 更多的输出格式

说明：apiRequest 接口的返回格式是动态的，取决于流程配置。当返回的 apiName 为以下值时，jData 的结构对应如下文档：

apiName 值	文档说明	说明
`Output`	标准化结果输出	输出数据的临时方案。在对输出格式没有特定要求的情况下，使用此方案可快速完成接口数据输出
`Error`	通用异常判定	如果接口返回为非0，则输出为此种结构
`Jfcloud`	腾讯云积分查询	查询用户云积分信息，云积分属于用户游戏角色属性，无法使用在合作平台账号ID上
`Lottery`	道具发放	道具发放结果：当流程配置了道具发放功能时，返回此格式。包含礼包ID、名称、数量、CDKey等信息
`FlowConditionQuery`	输出条件信息	输出用户在流程条件中的数字
`LotteryRecord`	输出用户抽奖领取记录	输出用户已绑定的游戏角色领取记录

如何判断返回类型：

查看返回数据中的 apiName 字段
根据 apiName 的值，查找上表对应的文档
按照对应文档中的 jData 结构解析数据

← 流程调用sig签名标准化结果输出 →