生成子客登录链接

1. 接口描述

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

此接口（CreateConsoleLoginUrl）用于创建第三方平台子客企业控制台Web/移动登录链接。支持web控制台、电子签小程序和H5链接。登录链接是进入子客web企业控制台的唯一入口。

Web链接访问后，会根据子客企业(Agent中ProxyOrganizationOpenId表示)和员工(Agent中OpenId表示)的状态，进入不同的流程，主要情况分类如下：

1. 若在激活过程中，更换用户OpenID重新生成链接，之前的认证会被清理。因此不要在企业认证过程生成多个链接给多人同时操作，会导致认证过程互相影响。
2. 若您认证中发现信息有误需要重新认证，可通过更换用户OpenID重新生成链接的方式，来清理掉已有的流程。

系统的渠道企业, 应用, 子客企业, 子客员工的组织形式

相关视频指引

1. 【生成子客登录链接】代码编写 & 子企业认证示例
   

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

2. 输入参数

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

3. 输出参数

4. 示例

示例1 生成默认的控制台登录链接

如果典子谦示例企业的员工张三已经完成了认证和加入企业， 此时给典子谦示例企业的员工张三生成登录的PC控制台的链接

典子谦示例企业的定义标识为：org_dianziqian
员工张三定义员工标识为：n9527

输入示例

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

{
    "ProxyOrganizationName": "典子谦示例企业",
    "ProxyOperatorName": "张三",
    "Agent": {
        "ProxyOperator": {
            "OpenId": "n9527"
        },
        "ProxyOrganizationOpenId": "org_dianziqian",
        "AppId": "yDRSRUUgygj6qnwfUuO4zjEwc193c2hH"
    }
}

输出示例

{
    "Response": {
        "ConsoleUrl": "https://xxx.xxxx.tencent.com/?channel=PROXYCHANNEL&expiredTime=1631712951&code=123456asdfghjk&menuStatus=ENABLE",
        "IsActivated": false,
        "ProxyOperatorIsVerified": false,
        "RequestId": "s16221***14775648"
    }
}

示例2 生成默认的控制台认证链接

如果典子谦示例企业的员工张三还没有认证， 此时给典子谦示例企业的员工张三生成企业认证和个人认证的PC链接

典子谦示例企业的定义标识为：org_dianziqian
员工张三定义员工标识为：n9527

输入示例

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

{
    "ProxyOrganizationName": "典子谦示例企业",
    "ProxyOperatorName": "张三",
    "Agent": {
        "ProxyOperator": {
            "OpenId": "n9527"
        },
        "ProxyOrganizationOpenId": "org_dianziqian",
        "AppId": "yDRSRUUgygj6qnwfUuO4zjEwc193c2hH"
    }
}

输出示例

{
    "Response": {
        "ConsoleUrl": "https://xxx.xxxx.tencent.com/?channel=PROXYCHANNEL&expiredTime=1631712951&code=123456asdfghjk&menuStatus=ENABLE",
        "IsActivated": false,
        "ProxyOperatorIsVerified": false,
        "RequestId": "s16221***14775648"
    }
}

示例3 生成到模板详情的控制台链接

生成到模板详情的控制台链接

输入示例

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

{
    "ProxyOrganizationName": "典子谦示例企业",
    "Agent": {
        "ProxyOperator": {
            "OpenId": "n9527"
        },
        "ProxyOrganizationOpenId": "org_dianziqian",
        "AppId": "yDRSRUUgygj6qnwfUuO4zjEwc193c2hH"
    },
    "Module": "TEMPLATE",
    "ModuleId": "yDwFdUUckpsvet4jUEn0aFRxtu5TdalM",
    "MenuStatus": "ENABLE"
}

输出示例

{
    "Response": {
        "ConsoleUrl": "https://es*.ap*.tencent.com/template-preview?channel=PROXYCHANNEL&expiredTime=1631712951&code=123456asdfghjk&templateId=yDxlzxxxoTxQfVnyxs&menuStatus=ENABLE",
        "IsActivated": false,
        "ProxyOperatorIsVerified": false,
        "RequestId": "s16221***14775648"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。

• Tencent Cloud SDK 3.0 for Python: GitHub Gitee
• Tencent Cloud SDK 3.0 for Java: GitHub Gitee
• Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
• Tencent Cloud SDK 3.0 for Go: GitHub Gitee
• Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
• Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
• Tencent Cloud SDK 3.0 for C++: GitHub Gitee
• Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee

命令行工具

• Tencent Cloud CLI 3.0

6. 错误码

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