接口说明

上报附近语音用户音量，对局期间定时上报，上报后会将用户的可听见音源设置为对应音量。

初始情况下，用户可听见的音源，包括所有在连线中的用户，默认音量为100。

接入当前API建议完成以下策略：

1.对局开始时，调节初始音量

•比如：当前参与主播连线的包括以下用户：A、A1、B、B1
◦设置以下音量设置：
▪用户A可听见的用户A1、B、B1的初始音量
▪用户A1可听见的用户A、B、B1的初始音量
▪用户B可听见的用户A、A1、B1的初始音量
▪用户B1可听见的用户A、A1、B的初始音量

2.用户中途上麦时，调节新增用户可听见的初始音量，调节其他用户的新增音源的音量

•比如：当前参与主播连线的包括以下用户：A、A1、B，此时新上麦用户B1
◦设置以下音量设置：
▪用户A可听见的用户B1的音量
▪用户A1可听见的用户B1的音量
▪用户B可听见的用户B1的音量
▪用户B1可听见的用户A、A1、B的音量

3.玩法中用户移动靠近/远离其他用户时，调大/调小音量

•比如：用户A靠近/远离用户A1、B
◦设置以下音量设置：
▪调高/调小用户A可听见的用户A1、B的音量
▪调高/调小用户A1可听见的用户A的音量
▪调高/调小用户B可听见的用户A的音量

使用限制

小玩法 app_id 维度，qps 限流配置为 200 次 /s。

小玩法 app_id + 连线 ID 维度，qps 限流配置为 5 次 /s。

基本信息

名称	描述
HTTP URL	https://webcast.bytedance.com/api/gaming_con/anchor_linkmic/update_voice
HTTP Method	POST
Scope	multi_anchor_linkmic

请求参数

请求头

content-type必填String

示例：application/json

固定值"application/json"

x-token必填String

示例：08011218462b6b4b5054626e426e50685a7554643144644449413d3d

调用https://developer.toutiao.com/api/apps/v2/token生成的token

Body展开全部子属性

app_idString

玩法ID

link_idInt64

连线 ID

user_infosList

必填

展开子属性

请求示例
curl --location --request POST 'https://webcast.bytedance.com/api/gaming_con/anchor_linkmic/update_voice' \
--header 'Content-Type: application/json' \
--data-raw '{"app_id":"xxxx","link_id":740769305443176xxxx,"user_infos":[{"open_id":"_000NeUPmpLESCIEEzR4ocGY5OfG0jFfxxxx","voice_infos":[{"neighbor_open_id":"xxxx","voice":100}]}]}'

响应参数

Body

errcodeInt64

错误码，0代表成功

errmsgString

错误描述

响应示例
正常响应示例异常响应示例
{
  "errcode": 0,
  "errmsg": ""
}

切换单列布局

错误码

HTTP 状态码	错误码	错误码描述	排查建议
200	40001	参数错误	房间id、小玩法app_id等入参解析失败，检查参数解析逻辑
200	40007	请求过于频繁	接口有频控限制，建议降低请求的并发量
200	40004	access_token过期	重新生成access_token

上报附近语音用户音量在线调试

接口说明

使用限制

基本信息

请求参数

响应参数

错误码

上报附近语音用户音量