You need to enable JavaScript to run this app.
导航
企业直播
  • 文档首页
    • /
  • 企业直播

添加或更新直播助教账号信息

最近更新时间：2024.02.23 15:48:51

首次发布时间：2024.02.01 14:52:51

我的收藏

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

说明

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

注意事项

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

请求说明

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

请求参数

以下请求参数列表仅列出了该接口的部分公共参数，完整公共参数列表见公共请求参数。

Query

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

Body

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

TeachAssistantAccount

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

Id

Long

否

0

直播助教账号 ID。

  • 添加直播助教账号：不传该参数或传入该参数且取值为 0。
  • 更新直播助教账号信息：传入待更新信息的直播助教账号 ID。您可以通过 ListTeachAssistantAccounts 接口查询 ID。

说明

更新直播助教账号信息时，确保 Id 与 IdentityId 的参数值对应同一个直播助教账号。

TitleString是助教头衔直播助教头衔。最多支持输入 10 个字符。
NickNameString是助教昵称直播助教昵称。最多支持输入 20 个字符。
PasswordString否123456直播助教平台的登录密码。若未配置则由系统随机生成。最多支持输入 20 个数字或英文字符，且英文字母区分大小写。

TeachAssistantFeatures

Array of Integer

是

[1,2,3]

直播助教的功能权限。

  • 1：观众聊天：：直播控制页面的聊天互动菜单。详见聊天互动。

    说明

    直播助教的聊天互动菜单中，不支持聊天审核、导出聊天、机器人评论和管理系统消息功能。

  • 2：直播画面：控制台播放器。

    说明

    如果当前直播间配置了多个直播频道，则频道选择入口固定放置于播放器内。有关如何配置直播频道，详见直播频道管理。

  • 3：观众列表。详见观众列表。

    说明

    直播助教的观众列表中，不支持查看详情和导出数据功能。

  • 4：互动工具：直播控制页面的互动工具菜单。详见互动工具。
  • 5：商品管控：直播控制页面的商品卡片菜单。详见商品卡片。
  • 6：直播中断：锁定预告。详见锁定预告。
  • 7：互动问答：直播控制页面的互动问答菜单。详见互动问答。

    说明

    直播助教的互动问答中，不支持聊天审核和导出聊天功能。

  • 8：私聊：直播控制页面的私聊互动菜单。详见私聊互动。

说明

仅在同时满足以下条件时，直播助教才可以使用观众聊天、互动工具、商品管控、互动问答或私聊功能。

  • 配置了对应功能。
  • 在菜单管理模块启用了对应菜单。

IdentityId

String

否

0

直播助教的登录账号。

  • 添加直播助教账号：不传该参数或传入该参数且取值为 0。
  • 更新直播助教账号信息：传入待更新信息的直播助教登录账号。您可以通过 ListTeachAssistantAccounts 接口查询登录账号。

说明

更新直播助教账号信息时，确保 IdentityId 与 Id 的参数值对应同一个直播助教账号。

返回参数

参数类型示例值描述
TeachAssistantAccountsArray of TeachAssistantAccounts-直播助教账号信息列表。
MaxTeachAssistantAccountNumberLong2最多支持添加的直播助教账号数量。

TeachAssistantAccounts

参数类型示例值描述
PasswordString123456直播助教平台的登录密码。
IdLong1直播助教账号 ID。
NickNameString助教昵称直播助教昵称。

TeachAssistantFeatures

Array of Integer

[1,2,3]

直播助教可以使用的功能。

  • 1：观众聊天：：直播控制页面的聊天互动菜单。详见聊天互动。

    说明

    直播助教的聊天互动菜单中，不支持聊天审核、导出聊天、机器人评论和管理系统消息功能。

  • 2：直播画面：控制台播放器。

    说明

    如果当前直播间配置了多个直播频道，则频道选择入口固定放置于播放器内。有关如何配置直播频道，详见直播频道管理。

  • 3：观众列表。详见观众列表。

    说明

    直播助教的观众列表中，不支持查看详情和导出数据功能。

  • 4：互动工具：直播控制页面的互动工具菜单。详见互动工具。
  • 5：商品管控：直播控制页面的商品卡片菜单。详见商品卡片。
  • 6：直播中断：锁定预告。详见锁定预告。
  • 7：互动问答：直播控制页面的互动问答菜单。详见互动问答。

    说明

    直播助教的互动问答中，不支持聊天审核和导出聊天功能。

  • 8：私聊：直播控制页面的私聊互动菜单。详见私聊互动。
IdentityIdString9188382直播助教的登录账号。
TitleString助教头衔直播助教头衔。
LoginUrlStringhttps://live.byteoc.com/ta/1779870487296/login?identity_id=9188382直播助教的登录地址。
OneStepLoginUrlStringhttps://live.byteoc.com/ta/1779854981841/login?identity_id=9188382&p=***直播助教的一键免登录地址，即助教可通过该地址免登录进入直播助教页面。

示例

请求示例

POST https://livesaas.volcengineapi.com/?Action=UpdateTeachAssistantAccount&Version=2023-08-01
{
    "TeachAssistantAccount": {
        "Id": 0,
        "Title": "助教头衔",
        "NickName": "助教昵称",
        "Password": "123456",
        "TeachAssistantFeatures": [
            1,2,3
        ],
        "IdentityId": "0"
    },
    "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.byteoc.com/ta/1779870487296/login?identity_id=9188382",
                "OneStepLoginUrl":"https://live.byteoc.com/ta/1779854981841/login?identity_id=9188382&p=***"
            }
        ],
        "MaxTeachAssistantAccountNumber": 2
    }
}

错误码

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

状态码错误码错误信息说明
400InvalidParameter.TeachAssistantAccountInvalidThe specified parameter TeachAssistantAccount is invalid.TeachAssistantAccount 参数错误。请修改后重试。
400InvalidParameter.TitleInvalidThe specified parameter Title is invalid.Title 参数错误。请修改后重试。
400InvalidParameter.NickNameInvalidThe specified parameter NickName is invalid.NickName 参数错误。请修改后重试。
400InvalidParameter.TeachAssistantFeaturesInvalidThe specified parameter TeachAssistantFeatures is invalid.TeachAssistantFeatures 参数错误。请修改后重试。
400InvalidParameter.IdentityIdInvalidThe specified parameter IdentityId is invalid.IdentityId 参数错误。请修改后重试。
400InvalidParameter.PasswordInvalidThe specified parameter Password is invalid.Password 参数错误。请修改后重试。
400InvalidParameter.IdInvalidThe specified parameter Id is invalid.Id 参数错误。请修改后重试。
409OperationDenied.TitleHitSensitiveWordsOperation is denied because the title hits sensitive words.Title 参数包含敏感词。请修改后重试。
400OperationDenied.NickNameHitSensitiveWordsOperation is denied because the nickName hits sensitive wordsNickName 参数包含敏感词。请修改后重试。
400OperationDenied.TeachAssistantAccountOverLimitOperation is denied because the number of teaching assistant accounts exceeds the limit.超出添加直播助教账号数量的上限。