观众一键同玩接入说明

我的收藏

更新记录

时间	更新内容
2024.9.8	创建文档
2024.9.27	修正错误码及其排查建议
2024.10.30	标注「获取直播信息」部分响应字段仅在观众一键同玩能力开放
2024.12.4	修正「嘉宾云启动玩法」、「嘉宾关闭玩法」room_id格式

能力介绍

开放平台观众一键同玩能力，可支持玩法接入以下能力：

•支持玩法获取直播信息，获取当前进入游戏的用户 open_id、用户角色、当前直播间可支持的游戏场景等信息。

•支持玩法查询直播间当前麦位信息、嘉宾宿主是否具备云启动条件等。

•支持玩法指定嘉宾云启动玩法。

•支持玩法指定嘉宾关闭玩法。

注意：
嘉宾关闭玩法的来源，除了开放给开发者的 API，还包括主播退出玩法、嘉宾自行下麦、嘉宾被踢出麦。

•（可选）支持玩法上报连麦对局内用户积分，同步展示在直播间麦位上。

接入时序

厂商接入观众一键同玩能力需要接入红色箭头 API。

接口明细

获取直播信息

查询直播间麦位信息

嘉宾云启动玩法

嘉宾关闭玩法

上报连麦对局内用户积分

礼物推送

具体数据开放接入流程参考：数据开放__抖音开放平台

礼物数据-payload

当观众一键同玩能力开通后，观众可以给嘉宾送礼，送礼的流水中会增加audience_sec_open_id。

•如果被送礼的是嘉宾，则audience_sec_open_id为被送礼的嘉宾open_id。
•如果被送礼的是主播，则audience_sec_open_id为空字符串。

[ 
  {
    msg_id: "123456782", // string类型id
    sec_openid: "xxxx", // 用户的加密openid，当前其实没有加密
    sec_gift_id: "xxxx", // 加密的礼物id
    gift_num: 123, // 送出的礼物数量
    gift_value: 10000, // 礼物总价值，单位分
    avatar_url: "xxx", // 用户头像
    nickname: "xxxx", // 用户昵称(不加密)
    timestamp: 1649068964, // 礼物毫秒级时间戳
    test: true, // 非真实测试数据，会下发该字段。测试工具下发的送礼数据属于调试模式，不会有该字段
    audience_sec_open_id:"xxx" // 被送礼的嘉宾openid，当前没有加密
    },
    ];