启动云游戏服务

更新时间不可用

启动移动端云游戏服务。

POST
https://{domain}/v2/projects/{appid}/cloud-bullet-game/api/live-data/games/{gameid}/mode/cloud/rooms/{roomid}:start

注意

  • 调用频率限制:单个 APP ID 调用上限为 10 次/秒。

路径参数

roomidstring
必填

房间编号,以 appid 作为前缀的全局唯一房间 ID。

gameidstring
必填

游戏编号,调用获取云游戏列表获得。

请求 Header

Authorizationstring
必填

发送 HTTP 请求时,你需要将用于游戏推流使用的 RTC Token 填入 HTTP 请求头部的 Authorization 字段。Token 生成方式请参考使用 Token 鉴权。

Content-Typestring
必填

数据类型,必须包含 application/json。

请求 Body

字段
openidstring
必填

主播编号。以 appid 作为前缀的全局唯一主播 ID。

nicknamestring
必填

主播昵称,会显示在游戏中。

avatar_urlstring
必填

主播头像 URL 地址,会显示在游戏中。

RTC 推拉流相关配置。

broadcast_uidinteger
必填

主播 RTC uid,用于云游戏识别主播、处理主播游戏控制指令和控制离线超时停止游戏。

uidinteger
必填

云游戏推流 uid,用于标识云游戏视频流。

tokenstring
必填

云游戏推流使用的 RTC Token,生成方法详见使用 Token 鉴权。

channel_namestring
必填

云游戏推流频道名。

RTC 内置加密设置。详见enableEncrption。

响应

OK

响应 Body

字段
err_nointeger

请求错误码,0 表示请求成功,非 0 表示请求失败,对应的错误原因和解决方案详见响应状态码。

err_msgstring

err_no 为非 0 时附带的错误提示信息。

logidstring

请求链路 id, 用于出现未知问题时提供给声网技术支持以便定位问题。

请求示例

Example Request
curl --request POST \
  --url "https://:domain/v2/projects/:appid/cloud-bullet-game/api/live-data/games/:gameid/mode/cloud/rooms/:roomid:start" \
  --header 'Authorization: <string>' \
  --header 'Content-Type: application/json'

响应示例

{
  "err_no": 0,
  "err_msg": "success",
  "logid": "16000000000000052",
  "data": {
    "task_id": "xxxxxxxxx"
  }
}