You need to enable JavaScript to run this app.
导航
UpdateAudienceGroupUserConfig - 更新观众的直播分组
最近更新时间:2025.07.03 16:17:19首次发布时间:2024.06.19 11:42:26
我的收藏
有用
有用
无用
无用

调用 UpdateAudienceGroupUserConfig 接口,为已进入直播间的观众更新直播分组,或在观众进入直播间前提前进行分组。通过提前分组,在观众通过输入昵称或其他方式登录直播间后,将自动进入指定的直播分组。

注意事项

  • 请求频率:单用户请求频率限制为 10 次/秒
  • 前提条件:确保您拥有火山引擎主账号或具备直播间的观看页管理 > 可编辑权限的子账号。有关如何添加子账号,详见子账号管理

请求说明

  • 请求方式:POST
  • 请求地址:https://livesaas.volcengineapi.com/?Action=UpdateAudienceGroupUserConfig&Version=2023-08-01

调试

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息详见公共参数

Query

参数类型是否必选示例值描述
ActionStringUpdateAudienceGroupUserConfig接口名称。当前 API 的名称为 UpdateAudienceGroupUserConfig
VersionString2023-08-01接口版本。当前 API 的版本为 2023-08-01

Body

参数类型是否必选示例值描述

ActivityId

Long

179853****530570

直播间 ID。您可以通过 ListActivityAPI 接口查询 ID。

说明

使用子账号调用接口时,确保该直播间对子账号可见。有关如何配置子账号的可见范围,详见子账号管理

AudienceGroupUsers

Array of AudienceGroupUsers

-

待更新的观众分组信息。

说明

最多支持同时更新 10,000 个观众的分组信息。

AudienceGroupUsers

参数类型是否必选示例值描述

UserId

Long

179853****530571

用户 ID。您可以通过 ListAudienceGroupUser 接口查询 ID。

说明

UserIdFlagId 至少需要传一个,且同时传入时,UserId 的优先级更高。

FlagId

String

昵称A

观众的唯一标识。长度为 1 到 100 个字符。

  • 如果观众已进入直播间,您可调用 ListAudienceGroupUser 接口获取唯一标识。
  • 如果观众还未进入直播间,您可将参数值设置为以下取值。观众通过输入昵称或其他方式登录直播间后,即可自动进入您期望移动到的直播分组。
    观众通过不同方式登录直播间,其唯一标识的取值如下所示。
    • 公开:观众昵称。
    • 密码:观众昵称。
    • 邀请码:观众昵称。
    • 白名单:观众登录时输入的白名单信息。
    • 飞书:飞书昵称。
    • 微信:观众昵称。
    • 企业微信:观众昵称。
    • 手机号:观众登录时输入的手机号。
    • 自定义:自定义登录时通过 UserId 传入的值。详见自定义登录
    • OAuth 2.0:您自有账号系统中用户 ID 对应的字段。

说明

  • 如果您集成了 Web 观播 SDK,且 SDK 的鉴权模式为自定义模式(即 mode = 2),唯一标识的取值为调用 GetSDKTokenAPI 接口时传入的 UserIdStr(观众 ID)。
  • UserIdFlagId 至少需要传一个,且同时传入时,UserId 的优先级更高。

AudienceGroupName

String

分组1

期望移动到的直播分组的名称。若分组不存在,会自动创建该分组。您可以通过 GetAudienceGroupConfig 接口查询分组名称。

说明

AudienceGroupNameAudienceGroupId 至少需要传一个,且同时传入时,AudienceGroupId 的优先级更高。

AudienceGroupId

Long

179853****530572

期望移动到的直播分组的 ID。您可以通过 ListAudienceGroupUser 接口查询 ID。

说明

AudienceGroupNameAudienceGroupId 至少需要传一个,且同时传入时,AudienceGroupId 的优先级更高。

返回参数

参数类型示例值描述
StatusBooleantrue直播分组是否更新成功。成功返回 true

FailCode

Integer

0

错误码。取值如下:

  • 0: 未发生错误
  • 1: 一个或多个观众直播分组更新失败

请求示例

POST https://livesaas.volcengineapi.com/?Action=UpdateAudienceGroupUserConfig&Version=2023-08-01
{
    "ActivityId": 179853****530570,
    "AudienceGroupUsers": [
        {
            "UserId": 179853****530571,
            "AudienceGroupId": 179853****530572
        }
    ]
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20230604110420****100232280022D31",
        "Action": "UpdateAudienceGroupUserConfig",
        "Version": "2023-08-01",
        "Service": "livesaas",
        "Region": "cn-north-1",
        "SystemTime": 1697446406
    },
    "Result": {
        "Status": true,
        "FailCode": 0
    }
}

错误码

访问公共错误码错误码获取详细信息。