获取直播助教平台的页面设置--企业直播-火山引擎

文档中心

立即注册

导航

企业直播

获取直播助教平台的页面设置

最近更新时间：2024.05.29 15:39:52首次发布时间：2024.02.01 14:52:51

您可通过此接口获取指定直播间的直播助教平台的页签名称等页面设置。

注意事项

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

请求说明

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

请求参数

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

Query

参数	类型	是否必选	示例值	描述
Action	String	是	`GetTeachAssistantConfig`	接口名称。当前 API 的名称为 `GetTeachAssistantConfig`。
Version	String	是	`2023-08-01`	接口版本。当前 API 的版本为 `2023-08-01`。
ActivityId	Long	是	`177985487296`	直播间 ID。您可以通过 ListActivityAPI 接口查询 ID。

返回参数

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

TeachAssistantConfig

参数	类型	示例值	描述
Label	String	`直播助教平台`	直播助教平台的页签名称。
Logo	String	`https://p.example.org/433bc58f~tplv-z75.image`	直播助教平台页面 Logo 的 URL，带协议头。取值为空表示默认 Logo。

请求示例

GET https://livesaas.volcengineapi.com/?Action=GetTeachAssistantConfig&Version=2023-08-01&ActivityId=177985487296

返回示例

{
    "ResponseMetadata": {
        "RequestId": "202306041104200100100232280022D31",
        "Action": "GetTeachAssistantConfig",
        "Version": "2023-08-01",
        "Service": "livesaas",
        "Region": "cn-north-1",
        "SystemTime": 1697446406
    },
    "Result": {
        "TeachAssistantConfig": {
            "Label": "直播助教平台",
            "Logo": "https://p.example.org/433bc58f~tplv-z75.image"
        }
    }
}

错误码

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