# 获取对局玩家位次信息
接口应在服务器端调用,不可在前端(小程序、网页、APP等)直接调用,具体可参考接口调用指南。
接口英文名:lock-step.getGameIdentityInfo
本接口用于获取对局玩家位次信息
# 1. 调用方式
# HTTPS 调用
GET https://api.weixin.qq.com/wxa/getwxagameidentityinfo?access_token=ACCESS_TOKEN&access_info=ACCESS_INFO
# 云调用
调用方法:lockstep.getGameIdentityInfo
出入参和 HTTPS 调用相同,调用方式可查看 云调用 说明文档。
# 第三方调用
- 本接口不支持第三方平台调用。
# 2. 请求参数
# 查询参数 Query String Parameters
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| access_token | string | 是 | 接口调用凭证,可使用 access_token |
| access_info | string | 是 | 填onGameEnd接口返回给开发者的 gameAccessInfo |
# 请求体 Request Payload
无
# 3. 返回参数
# 返回体 Response Payload
| 参数名 | 类型 | 说明 |
|---|---|---|
| errcode | number | 错误码 |
| errmsg | string | 错误提示信息 |
| data | object | 房间/对局访问凭证数据 |
# Res.data Object Payload
房间/对局访问凭证数据
| 参数名 | 类型 | 说明 |
|---|---|---|
| info_list | objarray | 房间/对局访问凭证 |
# Res.data.info_list(Array) Object Payload
房间/对局访问凭证
| 参数名 | 类型 | 说明 |
|---|---|---|
| client_id | number | 玩家在房间里的唯一性标识 id,该 id 不同于玩家座位号,一旦分配不能修改 |
| open_id | string | 玩家 OpenId |
# 4. 注意事项
本接口无特殊注意事项
# 5. 代码示例
本接口无代码示例
# 6. 错误码
以下是本接口的错误码列表,其他错误码可参考 通用错误码;调用接口遇到报错,可使用官方提供的 API 诊断工具 辅助定位和分析问题。
| 错误码 | 错误描述 |
|---|---|
| -1 | 系统繁忙,此时请开发者稍候再试 |
| 0 | 请求成功 |
| 1 | 数据不存在 |
# 7. 适用范围
本接口支持「小游戏」账号类型调用。其他账号类型如无特殊说明,均不可调用。