调用 DeleteTeachAssistantAccount
接口,删除直播间中的指定助播账号,并查看该直播间剩余助播账号的信息。
说明
如果助播在线期间账号被删除,则
LoginType
取值为 0
时,助播会被强制退出并返回助播平台登录页面。LoginType
取值为 1
时,助播会收到助播管理员权限收回的通知并继续以观众身份留在观看页。下表仅列出该接口特有的请求参数和部分公共参数。更多信息详见公共参数。
参数 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | DeleteTeachAssistantAccount | 接口名称。当前 API 的名称为 DeleteTeachAssistantAccount 。 |
Version | String | 是 | 2023-08-01 | 接口版本。当前 API 的版本为 2023-08-01 。 |
参数 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Id | Long | 是 | 2 | 助播账号 ID。您可以通过 ListTeachAssistantAccounts 接口查询 ID。 |
ActivityId | Long | 是 |
| 直播间 ID。您可以通过 ListActivityAPI 接口查询 ID。 说明 使用子账号调用接口时,确保该直播间对子账号可见。有关如何配置子账号的可见范围,详见子账号管理。 |
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
TeachAssistantAccounts | Array of TeachAssistantAccounts | - | 直播间剩余助播账号的信息列表。 |
MaxTeachAssistantAccountNumber | Long |
| 直播间内助播账号的数量上限。 说明 开通的功能版本不同,该参数的取值也不同:
|
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
LoginType | Integer |
| 登录方式。取值如下:
|
Title | String | 助播 | 助播头衔。 |
NickName | String | 老师 | 助播昵称。 |
TeachAssistantFeatures | Array of Integer |
| 助播的功能权限。当
|
LoginUrl | String |
|
|
OneStepLoginUrl | String |
| 助播平台的一键免登录地址,即助播可通过该地址免登录进入助播平台。 说明 当 |
Password | String |
| 助播平台的登录密码。 说明 仅当 |
IdentityId | String |
| 助播平台的登录账号。 说明 仅当 |
Id | Long | 1 | 助播账号 ID。 |
AudienceGroupIds | Array of Long |
| 助播可管理的直播分组 ID。 说明 仅当 |
UserId | String |
| 助播的用户 ID。 说明 仅当 |
POST https://livesaas.volcengineapi.com/?Action=DeleteTeachAssistantAccount&Version=2023-08-01 { "Id": 2, "ActivityId": 177****8945 }
{ "ResponseMetadata": { "RequestId": "20230604110420****100232280022D31", "Action": "DeleteTeachAssistantAccount", "Version": "2023-08-01", "Service": "livesaas", "Region": "cn-north-1", "SystemTime": 1697446406 }, "Result": { "TeachAssistantAccounts": [ { "Id": 1, "Password": "123456", "IdentityId": "9188382", "NickName": "老师", "Title": "助播", "TeachAssistantFeatures": [ 1, 2, 3 ], "LoginUrl": "https://live.example.com/ta/1779854981841/login?identity_id=918**82", "OneStepLoginUrl": "https://live.example.com/ta/1779854981841/login?identity_id=918**82&p=***", "AudienceGroupIds": [ 0, 149112456 ], "LoginType": 0, "UserId": "123" } ], "MaxTeachAssistantAccountNumber": 5 } }