You need to enable JavaScript to run this app.
导航
删除直播助教账号
最近更新时间:2024.06.19 11:33:29首次发布时间:2024.02.01 14:52:51

您可通过此接口删除直播间中的指定直播助教账号,并查看该直播间剩余直播助教账号的信息。

说明

当助教在线时删除对应助教账号,则该助教将被强制退出。

注意事项

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

请求说明

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

请求参数

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

Query

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

Body

参数类型是否必选示例值描述
IdLong2直播助教账号 ID。您可以通过 ListTeachAssistantAccounts 接口查询 ID。
ActivityIdLong17798548945直播间 ID。您可以通过 ListActivityAPI 接口查询 ID。

返回参数

参数类型示例值描述
TeachAssistantAccountsArray of TeachAssistantAccounts-剩余的直播助教账号信息列表。

MaxTeachAssistantAccountNumber

Long

2

最多支持新增的直播助教账号个数。

说明

开通的功能版本不同,该参数的取值也不同:

  • 旗舰版:2
  • 定制版:5

TeachAssistantAccounts

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

TeachAssistantFeatures

Array of Integer

[1,2,3]

直播助教的功能权限。

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

    说明

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

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

    说明

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

  • 3:观众列表。直播控制页面的观众列表。详见观众列表

    说明

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

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

    说明

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

  • 8:私聊:直播控制页面的私聊互动菜单。详见私聊互动
LoginUrlStringhttps://live.example.com/ta/17798548945/login?identity_id=9188382直播助教平台的登录地址。
OneStepLoginUrlStringhttps://live.example.com/ta/1779854981841/login?identity_id=9188382&p=***直播助教平台的一键免登录地址,即助教可通过该地址免登录进入直播助教平台。
AudienceGroupIdsArray of Long[17895452525,14912545655]助教可管理的直播分组列表。

请求示例

POST https://livesaas.volcengineapi.com/?Action=DeleteTeachAssistantAccount&Version=2023-08-01
{
    "Id": 2,
    "ActivityId": 17798548945
}

返回示例

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

错误码

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