调用 ListTeachAssistantAccounts 接口,获取指定直播间的助播账号信息列表,包括助播的功能权限、登录账号、登录密码等。
注意事项
- 请求频率:单用户请求频率限制为 6 次/秒。
- 前提条件:确保您拥有火山引擎主账号或具备以下任一直播间权限的子账号。有关如何添加子账号,详见子账号管理。
- 观看页管理 > 可编辑权限
- 观看页管理 > 仅查看权限
- 直播控制 > 可编辑权限
- 直播控制 > 仅查看权限
请求说明
- 请求方式:GET
- 请求地址:https://livesaas.volcengineapi.com/?Action=ListTeachAssistantAccounts&Version=2023-08-01
调试
API Explorer
您可以通过 API Explorer 在线发起调用,无需关注签名生成过程,快速获取调用结果。
去调试请求参数
下表仅列出该接口特有的请求参数和部分公共参数。更多信息详见公共参数。
Query
| 参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|
| Action | String | 是 | ListTeachAssistantAccounts | 接口名称。当前 API 的名称为 ListTeachAssistantAccounts。 |
| Version | String | 是 | 2023-08-01 | 接口版本。当前 API 的版本为 2023-08-01。 |
ActivityId | Long | 是 | 177****841
| 直播间 ID。您可以通过 ListActivityAPI 接口查询 ID。 说明 使用子账号调用接口时,确保该直播间对子账号可见。有关如何配置子账号的可见范围,详见子账号管理。 |
返回参数
| 参数 | 类型 | 示例值 | 描述 |
|---|
| TeachAssistantAccounts | Array of TeachAssistantAccounts | - | 助播账号信息列表。 |
MaxTeachAssistantAccountNumber | Long | 5
| 直播间内助播账号的数量上限。 |
TeachAssistantAccounts
| 参数 | 类型 | 示例值 | 描述 |
|---|
LoginType | Integer | 0
| 登录方式。取值如下: 0:密码登录。助播可通过登录地址和密码登录助播平台,并根据指定功能权限,在 PC 端管理直播间。1:邀请登录。助播可通过邀请链接在 PC 端或手机端进入观看页,并在登录直播间(仅输入昵称除外)后,在聊天互动菜单下管理直播间。
|
| Title | String | 助播 | 助播头衔。 |
| NickName | String | 老师 | 助播昵称。 |
TeachAssistantFeatures | Array of Integer | [1,2,3]
| 助播的功能权限。当 LoginType 取值为 1 时,该参数取值固定为 1。 1:观众聊天:配置该权限后,助播可在聊天互动菜单下完成相关操作。为保证助播可正常使用聊天互动菜单,确保您已启用聊天互动菜单。助播平台的操作与控制台一致,具体操作方法,详见聊天互动。说明 助播平台不支持导出聊天和管理系统消息功能。如需审核观众聊天,请为助播开启聊天审核权限。 2:直播画面:配置该权限后,助播可监控直播画面、查看直播间人气值和点赞数等。说明 如果当前直播间配置了多个直播频道,则频道选择入口固定放置于播放器内。有关如何配置直播频道,详见直播频道管理。 3:观众列表:配置该权限后,助播可查看观众列表并进行相关操作。助播平台的操作与控制台一致,具体操作方法,详见观众列表。4:互动工具:配置该权限后,助播可在互动工具菜单下完成相关操作。为保证助播可正常使用互动工具菜单,确保您已启用互动工具菜单。助播平台的操作与控制台一致,具体操作方法,详见互动工具。5:商品管控:配置该权限后,助播可在商品卡片菜单下完成相关操作。为保证助播可正常使用商品卡片菜单,确保您已启用商品卡片菜单。助播平台的操作与控制台一致,具体操作方法,详见商品卡片。6:直播中断:配置该权限后,助播可通过单击锁定预告,将观看页锁定在预告画面,不播放直播或回放画面。详见锁定预告。7:互动问答:配置该权限后,助播可在互动问答菜单下完成相关操作。为保证助播可正常使用互动问答菜单,确保您已启用互动问答菜单。助播平台的操作与控制台一致,具体操作方法,详见互动问答。说明 助播平台不支持导出聊天功能。如需审核观众聊天,请为助播开启聊天审核权限。 8:私聊:配置该权限后,助播可在私聊互动菜单下完成相关操作。为保证助播可正常使用私聊互动菜单,确保您已启用私聊互动菜单。助播平台的操作与控制台一致,具体操作方法,详见私聊互动。9:敏感词。配置该权限后,助播可以在聊天互动菜单中点击敏感词图标,打开敏感词管理窗口。在该窗口中,助播可以查看并实时添加敏感词,从而实现对聊天内容的即时过滤与管控。详见直播敏感词。10:观众数据。配置该权限后,助播可以在观众数据菜单中查看观众数据,数据说明详见数据大屏。同时支持导出观众行为数据,包括用户ID、进入时机、用户进入-离开时间、地区、来源等信息,详见观众行为数据。11:聊天审核。配置该权限后,助播可以进入聊天审核页面,审核观众聊天。有关审核规则和操作,详见聊天审核。
|
LoginUrl | String | https://live.example.com/ta/1779854981841/login?identity_id=918**82
| LoginType 的取值不同,该参数的含义也不同。
- 当
LoginType 取值为 0 时,参数取值为助播平台的登录地址。 - 当
LoginType 取值为 1 时,参数取值为助播专属的观看页地址。
|
OneStepLoginUrl | String | https://live.example.com/ta/1779854981841/login?identity_id=918**82&p=***
| 助播平台的一键免登录地址,即助播可通过该地址免登录进入助播平台。 说明 当 LoginType 取值为 1 时,该参数的取值与 LoginUrl 的取值一致。 |
Password | String | 123456
| 助播平台的登录密码。 说明 仅当 LoginType 取值为 0 时,该参数有值。 |
IdentityId | String | 91**382
| 助播平台的登录账号。 说明 仅当 LoginType 取值为 0 时,该参数有值。 |
| Id | Long | 1 | 助播账号 ID。 |
AudienceGroupIds | Array of Long | [0,149112456]
| 助播可管理的直播分组 ID。 |
UserId | String | 123
| 助播的用户 ID。 说明 仅当 LoginType 取值为 1 且助播已登录直播间时,该参数有值。 |
请求示例
GET https://livesaas.volcengineapi.com/?Action=ListTeachAssistantAccounts&Version=2023-08-01&ActivityId=177****841
返回示例
{
"ResponseMetadata": {
"RequestId": "20230604110420****100232280022D31",
"Action": "ListTeachAssistantAccounts",
"Version": "2023-08-01",
"Service": "livesaas",
"Region": "cn-north-1",
"SystemTime": 1697446406
},
"Result": {
"TeachAssistantAccounts": [
{
"Title": "助播",
"NickName": "老师",
"Password": "123456",
"TeachAssistantFeatures": [
1,
2,
3
],
"Id": 1,
"IdentityId": "91**382",
"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": ""
}
],
"MaxTeachAssistantAccountNumber": 5
}
}
错误码
访问公共错误码和错误码获取详细信息。