最近更新时间:2024.02.23 15:48:51
首次发布时间:2024.02.01 14:52:51
通过本接口,您可以更新直播间已有直播助教账号的功能权限、登录密码、昵称等信息,以及新增直播助教账号。
说明
当助教在线时更新对应助教账号的登录密码或功能权限,则该助教将被强制退出。
请求频率:单用户请求频率限制为 6 次/秒。
以下请求参数列表仅列出了该接口的部分公共参数,完整公共参数列表见公共请求参数。
参数 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | UpdateTeachAssistantAccount | 接口名称。当前 API 的名称为 UpdateTeachAssistantAccount 。 |
Version | String | 是 | 2023-08-01 | 接口版本。当前 API 的版本为 2023-08-01 。 |
参数 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
TeachAssistantAccount | Object of TeachAssistantAccount | 是 | - | 直播助教账号信息列表。 |
ActivityId | Long | 是 | 1779870487296 | 直播间 ID。您可以通过 ListActivityAPI 接口查询 ID。 |
参数 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Id | Long | 否 |
| 直播助教账号 ID。
说明 更新直播助教账号信息时,确保 |
Title | String | 是 | 助教头衔 | 直播助教头衔。最多支持输入 10 个字符。 |
NickName | String | 是 | 助教昵称 | 直播助教昵称。最多支持输入 20 个字符。 |
Password | String | 否 | 123456 | 直播助教平台的登录密码。若未配置则由系统随机生成。最多支持输入 20 个数字或英文字符,且英文字母区分大小写。 |
TeachAssistantFeatures | Array of Integer | 是 |
| 直播助教的功能权限。
说明 仅在同时满足以下条件时,直播助教才可以使用观众聊天、互动工具、商品管控、互动问答或私聊功能。
|
IdentityId | String | 否 |
| 直播助教的登录账号。
说明 更新直播助教账号信息时,确保 |
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
TeachAssistantAccounts | Array of TeachAssistantAccounts | - | 直播助教账号信息列表。 |
MaxTeachAssistantAccountNumber | Long | 2 | 最多支持添加的直播助教账号数量。 |
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
Password | String | 123456 | 直播助教平台的登录密码。 |
Id | Long | 1 | 直播助教账号 ID。 |
NickName | String | 助教昵称 | 直播助教昵称。 |
TeachAssistantFeatures | Array of Integer |
| 直播助教可以使用的功能。
|
IdentityId | String | 9188382 | 直播助教的登录账号。 |
Title | String | 助教头衔 | 直播助教头衔。 |
LoginUrl | String | https://live.byteoc.com/ta/1779870487296/login?identity_id=9188382 | 直播助教的登录地址。 |
OneStepLoginUrl | String | https://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 } }
下表提供了该接口特有的错误码,公共错误码请参见公共错误码和错误码文档。
状态码 | 错误码 | 错误信息 | 说明 |
---|---|---|---|
400 | InvalidParameter.TeachAssistantAccountInvalid | The specified parameter TeachAssistantAccount is invalid. | TeachAssistantAccount 参数错误。请修改后重试。 |
400 | InvalidParameter.TitleInvalid | The specified parameter Title is invalid. | Title 参数错误。请修改后重试。 |
400 | InvalidParameter.NickNameInvalid | The specified parameter NickName is invalid. | NickName 参数错误。请修改后重试。 |
400 | InvalidParameter.TeachAssistantFeaturesInvalid | The specified parameter TeachAssistantFeatures is invalid. | TeachAssistantFeatures 参数错误。请修改后重试。 |
400 | InvalidParameter.IdentityIdInvalid | The specified parameter IdentityId is invalid. | IdentityId 参数错误。请修改后重试。 |
400 | InvalidParameter.PasswordInvalid | The specified parameter Password is invalid. | Password 参数错误。请修改后重试。 |
400 | InvalidParameter.IdInvalid | The specified parameter Id is invalid. | Id 参数错误。请修改后重试。 |
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. | 超出添加直播助教账号数量的上限。 |