You need to enable JavaScript to run this app.
导航
更新观众的直播分组
最近更新时间:2024.06.19 11:42:26首次发布时间:2024.06.19 11:42:26

您可通过此接口更新观众所在的直播分组。

注意事项

请求频率:单用户请求频率限制为 10 次/秒

请求说明

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

请求参数

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

Query

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

Body

参数类型是否必选示例值描述
ActivityIdLong1798536670530570直播间 ID。您可以通过 ListActivityAPI 接口查询 ID。

AudienceGroupUsers

Array of AudienceGroupUsers

-

待更新的观众分组信息。

说明

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

AudienceGroupUsers

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

UserId

Long

1798536670530571

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

说明

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

FlagId

String

昵称A

观众的唯一标识。最多支持输入 100 个字符。您可以通过 ListAudienceGroupUser 接口查询唯一标识。

说明

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

AudienceGroupName

String

分组1

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

说明

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

AudienceGroupId

Long

1798536670530572

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

说明

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

返回参数

参数类型示例值描述

Status

Boolean

true

是否更新成功。支持以下取值:

  • true:成功
  • false:失败

请求示例

POST https://livesaas.volcengineapi.com/?Action=UpdateAudienceGroupUserConfig&Version=2023-08-01
{
    "ActivityId": 1798536670530570,
    "AudienceGroupUsers": [
        {
            "UserId": 1798536670530571,
            "AudienceGroupId": 1798536670530572
        }
    ]
}

返回示例

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

错误码

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