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

更新直播助教平台的页面设置

最近更新时间：2024.02.02 12:30:31

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

我的收藏

更新指定直播间直播助教平台的页面设置。

注意事项

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

请求说明

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

请求参数

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

Query

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

Body

参数类型是否必选示例值描述
TeachAssistantConfigObject of TeachAssistantConfig是-直播助教平台的页面设置。
ActivityIdLong是1784125542762直播间 ID。您可以通过 ListActivityAPI 接口查询 ID。

TeachAssistantConfig

参数类型是否必选示例值描述
LogoString否https://p-boe.byted.org/tos-boe-i-6ed59yyum2/4db233bc58f~tplv-6ed59yyum2-z75.image直播助教平台页面 Logo 的 URL。需要带协议头。默认为企业直播 Logo。
LabelString否直播助教平台直播助教平台的页签名称。默认为直播助教平台。最多支持输入 20 个字符。

返回参数

参数类型示例值描述
TeachAssistantConfigObject of TeachAssistantConfigResponse-直播助教平台的页面设置。

TeachAssistantConfigResponse

参数类型示例值描述
LabelString直播助教平台直播助教平台的页签名称。
LogoStringhttps://p-boe.byted.org/tos-boe-i-6ed59yyum2/4db233bc58f~tplv-6ed59yyum2-z75.image直播助教平台页面 Logo 的 URL。

示例

请求示例

POST https://livesaas.volcengineapi.com/?Action=UpdateTeachAssistantConfig&Version=2023-08-01
{
    "ActivityId":1784125542762,
    "TeachAssistantConfig":{
        "Logo":"https://p-boe.byted.org/tos-boe-i-6ed59yyum2/4db233bc58f~tplv-6ed59yyum2-z75.image",
        "Label":"直播助教平台"
    }
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "202306041104200100100232280022D31",
        "Action": "GetTeachAssistantConfig",
        "Version": "2023-08-01",
        "Service": "livesaas",
        "Region": "cn-north-1",
        "SystemTime": 1697446406
    },
    "Result": {
        "TeachAssistantConfig": {
            "Label": "直播助教平台",
            "Logo": "https://p-boe.byted.org/tos-boe-i-6ed59yyum2/4db233bc58f~tplv-6ed59yyum2-z75.image"
        }
    }
}

错误码

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

状态码错误码错误信息说明
400InvalidParameter.TeachAssistantConfigInvalidThe specified parameter TeachAssistantConfig is invalid.TeachAssistantConfig 参数错误。请修改后重试。