创建页面主题配置

1. 接口描述

接口请求域名： essbasic.tencentcloudapi.com 。

用来创建嵌入式页面个性化主题配置（例如是否展示电子签logo、定义主题色等），该接口配合其他所有可嵌入页面接口使用 创建配置对当前第三方应用全局生效，如果多次调用，会以最后一次的配置为准

默认接口请求频率限制：20次/秒。

推荐使用 API Explorer

点击调试

API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：ChannelCreateWebThemeConfig。
Version	是	String	公共参数，本接口取值：2021-05-26。
Region	否	String	公共参数，此参数为可选参数。
Agent	是	Agent	应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 必填。
ThemeType	是	String	主题类型 EMBED_WEB_THEME：嵌入式主题 EMBED_WEB_THEME，web页面嵌入的主题风格配置 COMPANY_AUTHENTICATE，子客认证主题配置， 对当前第三方应用号生效， 目前支持的有，背景图替换，隐藏企业认证页面导航栏和隐藏企业认证顶部logo
WebThemeConfig	是	WebThemeConfig	主题配置

3. 输出参数

参数名称	类型	描述
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 生成嵌入式主题

生成嵌入式主题

输入示例

POST / HTTP/1.1
Host: essbasic.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ChannelCreateWebThemeConfig
<公共请求参数>

{
    "Agent": {
        "AppId": "yDRsbUUgy***y8lsS7ZfBvipOMJ",
        "ProxyOperator": {
            "OpenId": "5d18c1c4****--3a0c8926cd11"
        },
        "ProxyOrganizationOpenId": "572c69b2-****-14e06d1245e4"
    },
    "ThemeType": "EMBED_WEB_THEME",
    "WebThemeConfig": {
        "DisplaySignBrandLogo": true,
        "WebEmbedThemeColor": "#4de813"
    }
}

输出示例

{
    "Response": {
        "RequestId": "s169*****642528438"
    }
}

示例2 生成嵌入式主题：不支持的主题类型

不支持的主题类型

输入示例

POST / HTTP/1.1
Host: essbasic.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ChannelCreateWebThemeConfig
<公共请求参数>

{
    "Agent": {
        "AppId": "yDRsbUUgy***y8lsS7ZfBvipOMJ",
        "ProxyOperator": {
            "OpenId": "5d18c1c4****--3a0c8926cd11"
        },
        "ProxyOrganizationOpenId": "572c69b2-****-14e06d1245e4"
    },
    "ThemeType": "EMBED",
    "WebThemeConfig": {
        "DisplaySignBrandLogo": true,
        "WebEmbedThemeColor": "#4de813"
    }
}

输出示例

{
    "Response": {
        "Error": {
            "Code": "OperationDenied",
            "Message": "不支持的主题类型"
        },
        "RequestId": "43b9474a-c909-4d89-aa7b-3632f02fa8a4"
    }
}

5. 错误码

以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。

错误码	描述
FailedOperation	操作失败。
OperationDenied	操作被拒绝。