新增或更新直播助教账号信息--企业直播-火山引擎

文档中心

立即注册

导航

新增或更新直播助教账号信息

最近更新时间：2024.06.19 11:33:29首次发布时间：2024.02.01 14:52:51

您可通过此接口在指定直播间新增直播助教账号，或更新已有直播助教账号的功能权限、登录密码、昵称等信息。

说明

当助教在线时更新对应助教账号的登录密码或功能权限，则该助教将被强制退出。

使用说明

接口行为

新增直播助教账号：在请求参数中不传 Id（直播助教账号 ID）和 IdentityId（直播助教登录账号）或传入 Id 和 IdentityId 且参数取值为 0 ，即可新增直播助教账号。
更新直播助教账号信息：在请求参数中传入待更新信息的直播助教的账号 ID 和登录账号作为 Id 和 IdentityId 参数值，即可更新该账号信息。您可以通过 ListTeachAssistantAccounts 接口查询直播助教的账号 ID 和登录账号。
说明
更新直播助教账号信息时，确保请求参数中 Id 与 IdentityId 的参数值对应同一个直播助教账号。

注意事项

请求频率：单用户请求频率限制为 6 次/秒。

请求说明

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

请求参数

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

Query

参数	类型	是否必选	示例值	描述
Action	String	是	`UpdateTeachAssistantAccount`	接口名称。当前 API 的名称为 `UpdateTeachAssistantAccount`。
Version	String	是	`2023-08-01`	接口版本。当前 API 的版本为 `2023-08-01`。

Body

参数	类型	是否必选	示例值	描述
TeachAssistantAccount	Object of TeachAssistantAccount	是	`-`	直播助教账号信息列表。
ActivityId	Long	是	`1779870487296`	直播间 ID。您可以通过 ListActivityAPI 接口查询 ID。

TeachAssistantAccount

参数	类型	是否必选	示例值	描述
Id	Long	否	`0`	直播助教账号 ID。新增直播助教账号：不传该参数或传入该参数且取值为 `0`。更新直播助教账号信息：传入待更新信息的直播助教账号 ID。您可以通过 ListTeachAssistantAccounts 接口查询 ID。说明更新直播助教账号信息时，确保 `Id` 与 `IdentityId` 的参数值对应同一个直播助教账号。
Title	String	是	`助教头衔`	直播助教头衔。最多支持输入 10 个字符。
NickName	String	是	`助教昵称`	直播助教昵称。最多支持输入 20 个字符。
Password	String	否	`123456`	直播助教平台的登录密码。新增直播助教账户时，若未配置则由系统随机生成。最多支持输入 20 个字符。支持以下字符类型：数字。英文字母，区分大小写。
TeachAssistantFeatures	Array of Integer	是	`[1,2,3]`	直播助教的功能权限。 `1`：观众聊天：直播控制页面的聊天互动菜单。详见聊天互动。说明直播助教的聊天互动菜单中，不支持聊天审核、导出聊天、机器人评论和管理系统消息功能。 `2`：直播画面：控制台播放器。说明如果当前直播间配置了多个直播频道，则频道选择入口固定放置于播放器内。有关如何配置直播频道，详见直播频道管理。 `3`：观众列表。直播控制页面的观众列表。详见观众列表。说明直播助教的观众列表中，不支持查看详情和导出数据功能。 `4`：互动工具：直播控制页面的互动工具菜单。详见互动工具。 `5`：商品管控：直播控制页面的商品卡片菜单。详见商品卡片。 `6`：直播中断：锁定预告。详见锁定预告。 `7`：互动问答：直播控制页面的互动问答菜单。详见互动问答。说明直播助教的互动问答菜单中，不支持聊天审核和导出聊天功能。 `8`：私聊：直播控制页面的私聊互动菜单。详见私聊互动。说明仅在同时满足以下条件时，直播助教才可以使用观众聊天、互动工具、商品管控、互动问答或私聊功能。配置了对应功能权限。在菜单管理模块启用了对应菜单。
IdentityId	String	否	`0`	直播助教的登录账号。新增直播助教账号：不传该参数或传入该参数且取值为 `0`。更新直播助教账号信息：传入待更新信息的直播助教登录账号。您可以通过 ListTeachAssistantAccounts 接口查询登录账号。说明更新直播助教账号信息时，确保 `IdentityId` 与 `Id` 的参数值对应同一个直播助教账号。
AudienceGroupIds	Array of Long	是	`[17895452525,14912545655]`	助教可管理的直播分组列表。取值为 `-2` 时，表示全部直播分组。您可以通过 GetAudienceGroupConfig 接口查询 ID。

返回参数

参数	类型	示例值	描述
TeachAssistantAccounts	Array of TeachAssistantAccounts	`-`	直播助教账号信息列表。
MaxTeachAssistantAccountNumber	Long	`2`	最多支持新增的直播助教账号数量。说明开通的功能版本不同，该参数的取值也不同：旗舰版：2。定制版：5。

TeachAssistantAccounts

参数	类型	示例值	描述
Password	String	`123456`	直播助教平台的登录密码。
Id	Long	`1`	直播助教账号 ID。
NickName	String	`助教昵称`	直播助教昵称。
TeachAssistantFeatures	Array of Integer	`[1,2,3]`	直播助教的功能权限。 `1`：观众聊天：：直播控制页面的聊天互动菜单。详见聊天互动。说明直播助教的聊天互动菜单中，不支持聊天审核、导出聊天、机器人评论和管理系统消息功能。 `2`：直播画面：控制台播放器。说明如果当前直播间配置了多个直播频道，则频道选择入口固定放置于播放器内。有关如何配置直播频道，详见直播频道管理。 `3`：观众列表。直播控制页面的观众列表。详见观众列表。说明直播助教的观众列表中，不支持查看详情和导出数据功能。 `4`：互动工具：直播控制页面的互动工具菜单。详见互动工具。 `5`：商品管控：直播控制页面的商品卡片菜单。详见商品卡片。 `6`：直播中断：锁定预告。详见锁定预告。 `7`：互动问答：直播控制页面的互动问答菜单。详见互动问答。说明直播助教的互动问答菜单中，不支持聊天审核和导出聊天功能。 `8`：私聊：直播控制页面的私聊互动菜单。详见私聊互动。
IdentityId	String	`9188382`	直播助教的登录账号。
Title	String	`助教头衔`	直播助教头衔。
LoginUrl	String	`https://live.example.com/ta/1779870487296/login?identity_id=9188382`	直播助教平台的登录地址。
OneStepLoginUrl	String	`https://live.example.com/ta/1779854981841/login?identity_id=9188382&p=***`	直播助教平台的一键免登录地址，即助教可通过该地址免登录进入直播助教平台。
AudienceGroupIds	Array of Long	`[17895452525,14912545655]`	助教可管理的直播分组列表。

请求示例

POST https://livesaas.volcengineapi.com/?Action=UpdateTeachAssistantAccount&Version=2023-08-01
{
    "TeachAssistantAccount": {
        "Id": 0,
        "Title": "助教头衔",
        "NickName": "助教昵称",
        "Password": "123456",
        "TeachAssistantFeatures": [
            1,2,3
        ],
        "IdentityId": "0",
        "AudienceGroupIds":[
            17895452525,
            14912545655
        ]
    },
    "ActivityId": 1779870487296
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "202306041104200100100232280022D31",
        "Action": "UpdateTeachAssistantAccount",
        "Version": "2023-08-01",
        "Service": "livesaas",
        "Region": "cn-north-1",
        "SystemTime": 1697446406
    },
    "Result": {
        "TeachAssistantAccounts": [
            {
                "Password": "123456",
                "Id": 1,
                "NickName": "助教昵称",
                "TeachAssistantFeatures": [
                    1,2,3
                ],
                "IdentityId": "9188382",
                "Title": "助教头衔",
                "LoginUrl": "https://live.example.com/ta/1779870487296/login?identity_id=9188382",
                "OneStepLoginUrl":"https://live.example.com/ta/1779854981841/login?identity_id=9188382&p=***",
                "AudienceGroupIds":[
                    17895452525,
                    14912545655
                ]
            }
        ],
        "MaxTeachAssistantAccountNumber": 2
    }
}

错误码

下表提供了该接口特有的错误码，公共错误码请参见公共错误码和错误码文档。

状态码	错误码	错误信息	说明
409	OperationDenied.TitleHitSensitiveWords	Operation is denied because the title hits sensitive words.	`Title` 参数包含敏感词。请修改后重试。
400	OperationDenied.NickNameHitSensitiveWords	Operation is denied because the nickName hits sensitive words	`NickName` 参数包含敏感词。请修改后重试。
400	OperationDenied.TeachAssistantAccountOverLimit	Operation is denied because the number of teaching assistant accounts exceeds the limit.	超出新增直播助教账号数量的上限。