文档中心
ZegoMiniGameEngine 小游戏平台
文档中心
体验 App
SDK 中心
API 中心
常见问题
代码市场
进入控制台
立即注册
登录
中文站 English
  • 文档中心
  • 小游戏平台
  • 服务端 API
  • 弹幕游戏相关
  • 获取游戏启动码

获取游戏启动码

更新时间:2025-04-15 19:16

描述

开始弹幕游戏之前,请调用本接口,传入主播、房间、游戏等信息,获取唯一的游戏启动码。

游戏启动码具有时效性,过期后则失效。建议主播每次启动游戏前都通过该接口获取游戏启动码,ZEGO 能够保证获取到的的游戏启动码 2 小时内至少可使用 1 次。

当游戏开始后,请勿调用本接口再次获取新的启动码,否则当前游戏可能会被强制结束,是否会强制结束游戏由具体游戏确定。建议仅在开播游戏或切换游戏时调用。

接口原型

  • 请求方法:POST
  • 请求地址:https://mini-game-api.zego.im/?Action=DescribeGameLaunchCode
  • 传输协议:HTTPS
  • 调用频率限制:20 次/秒(以房间为维度)

请求参数

以下请求参数列表仅列出了接口请求参数,公共参数列表请参考 调用方式 - 公共请求参数。

参数 类型 是否必选 描述
RoomId
String
是
房间 ID,由您定义,长度上限为 64 字符。
MiniGameId
String
是
游戏 ID,请联系 ZEGO 技术支持获取相关内容。
AnchorId
String
是
主播的用户 ID,由您定义,长度上限为 48 字符,只允许数字和英文。
  • 请保证该主播的用户 ID 在相同的 appID 下全局唯一。
  • 如果您业务的账号系统中的用户 ID 采用了其他规则,请自行实现映射。
Nickname
String
是
主播昵称,由您定义,长度上限为 32 字符。
Avatar
String
是
主播头像的地址,必须是有效的 HTTP/HTTPS 地址,且长度在 1024 字节以内。
Sex
int
否
主播性别。
  • 1:男。
  • 2:女。

请求示例

  • 请求 URL

    https://mini-game-api.zego.im/?Action=DescribeGameLaunchCode
    &<公共请求参数>
  • 请求消息体

    {
        "RoomId": "room_123",
        "MiniGameId": "TinyLoveWar",
        "AnchorId": "anchor1",
        "Nickname": "主播",
        "Avatar": "http://xxx",
        "Sex": 1
    }

响应参数

参数 类型 描述
Code
Number
错误码。
Message
String
请求结果的说明信息。
RequestId
String
请求 ID。
Data
Object
响应对象。
GameLaunchCode
String
游戏启动码。

响应示例

{
    "Code": 0,
    "Message": "succeed",
    "RequestId": "1683811708704948224",
    "Data": {
        "GameLaunchCode":"101010512"
    }
}

返回码

以下仅列出了接口业务逻辑相关的返回码,完整返回码请参考 全局返回码。

返回码 描述说明 处理建议
7202001 游戏未找到,可能造成的原因包含:
  • MiniGameId 输入错误。
  • 未开通此游戏的权限。
  • 请检查 MiniGameId 是否正确。
  • 请联系 ZEGO 商务人员开通此游戏的权限。
7202002 MiniGameId 格式错误。 请确认格式是否为 String。
7206004 房间已被其他主播占用。 请确认传入的 AnchorId 与房主是否一致。
7206005 获取游戏码太频繁。 请稍后再试。
本篇目录
  • 免费试用
  • 提交工单
    咨询集成、功能及报价等问题
    电话咨询
    400 1006 604
    咨询客服
    微信扫码,24h在线

    联系我们

  • 文档反馈