生成子客登录链接

1. 接口描述

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

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

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

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

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

相关视频指引

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

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：CreateConsoleLoginUrl。
Version	是	String	公共参数，本接口取值：2021-05-26。
Region	否	String	公共参数，此参数为可选参数。
Agent	是	Agent	关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容 此接口下面信息必填。 渠道应用标识: Agent.AppId 第三方平台子客企业标识: Agent.ProxyOrganizationOpenId 第三方平台子客企业中的员工标识: Agent.ProxyOperator.OpenId 注: 1. 企业激活时， 此时的Agent.ProxyOrganizationOpenId将会是企业激活后企业的唯一标识，建议开发者保存企业ProxyOrganizationOpenId，后续各项接口调用皆需要此参数。 2. 员工认证时， 此时的Agent.ProxyOperator.OpenId将会是员工认证加入企业后的唯一标识，建议开发者保存此员工的OpenId，后续各项接口调用皆需要此参数。 3. 同渠道应用(Agent.AppId)下，企业唯一标识ProxyOrganizationOpenId需要保持唯一，员工唯一标识OpenId也要保持唯一 (而不是企业下唯一)。 示例值： "Agent": { "ProxyOperator": { "OpenId": "n9527" }, "ProxyOrganizationOpenId": "org_dianziqian", "AppId": "yDRSRUUgygj6qnwfUuO4zjEwc193c2hH" }
ProxyOrganizationName	是	String	第三方平台子客的企业名称，请确认该企业名称与企业营业执照中注册的名称完全一致。 在测试环境联调的过程中，企业名称请统一加上“测试”二字，如：典子谦示例企业测试，否则将无法审核通过。 企业名称请使用以下名称, 以下名称可以不用走收录。 子客测试专用企业1 - 子客测试专用企业9 注: 1. 如果名称中包含英文括号()，请使用中文括号（）代替。 2、该名称需要与Agent.ProxyOrganizationOpenId相匹配, 企业激活后Agent.ProxyOrganizationOpenId会跟此企业名称一一绑定; 如果您的企业已经在认证授权中或者激活完成，这里修改子客企业名字将不会生效。 示例值：典子谦示例企业测试
UniformSocialCreditCode	否	String	子客企业统一社会信用代码，最大长度200个字符 注意：如果您的企业已经在认证授权中或者激活完成，这里修改子客企业名字将不会生效。 示例值：9XXXXXXXXXXXXXXXX1
ProxyOperatorName	否	String	子客企业员工的姓名，最大长度50个字符, 员工的姓名将用于身份认证和电子签名，请确保填写的姓名为签署方的真实姓名，而非昵称等代名。 注：该姓名需要和Agent.ProxyOperator.OpenId相匹配, 当员工完成认证后该姓名会和Agent.ProxyOperator.OpenId一一绑定, 若员工已认证加入企业，这里修改经办人名字传入将不会生效 示例值：典子谦
ProxyOperatorMobile	否	String	子客企业员工的手机码, 支持国内手机号11位数字(无需加+86前缀或其他字符)。注：该手机号需要和Agent.ProxyOperator.OpenId相匹配, 当员工完成认证后该手机号会和Agent.ProxyOperator.OpenId一一绑定, 若员工已认证加入企业，这里修改经办人手机号传入将不会生效 示例值：18888888888
Module	否	String	Web控制台登录后进入的功能模块, 支持的模块包括： 空值 :(默认)企业中心模块 DOCUMENT :合同管理模块 TEMPLATE :企业模板管理模块 SEAL :印章管理模块 OPERATOR :组织管理模块 注意： 1、如果EndPoint选择"CHANNEL"或"APP"，该参数仅支持传递"SEAL"，进入印章管理模块 2、该参数仅在企业和员工激活已经完成，登录控制台场景才生效。 示例值：SEAL
ModuleId	否	String	该参数和Module参数配合使用，用于指定模块下的资源Id，指定后链接登录将展示该资源的详情。 根据Module参数的不同所代表的含义不同(ModuleId需要和Module对应，ModuleId可以通过API或者控制台获取到)。当前支持： Module传值 ModuleId传值 进入的目标页面 SEAL 印章ID 查看指定印章的详情页面 TEMPLATE 合同模板ID 指定模板的详情页面 DOCUMENT 合同ID 指定合同的详情页面 注意：该参数仅在企业和员工激活完成，登录控制台场景才生效。 示例值：yDRSRUUgygj6qnwfUuO4zjEwc193c2hH
MenuStatus	否	String	是否展示左侧菜单栏 ENABLE : (默认)进入web控制台展示左侧菜单栏 DISABLE : 进入web控制台不展示左侧菜单栏 注：该参数仅在企业和员工激活完成，登录控制台场景才生效。 示例值：ENABLE
Endpoint	否	String	生成链接的类型： PC：(默认)web控制台链接, 需要在PC浏览器中打开 CHANNEL：H5跳转到电子签小程序链接, 一般用于发送短信中带的链接, 打开后进入腾讯电子签小程序 SHORT_URL：H5跳转到电子签小程序链接的短链形式, 一般用于发送短信中带的链接, 打开后进入腾讯电子签小程序 WEIXIN_QRCODE_URL：直接跳转至电子签小程序的二维码链接，无需通过中转页。您需要自行将其转换为二维码，使用微信扫码后可直接进入。请注意，直接点击链接是无效的。 APP：APP或小程序跳转电子签小程序链接, 一般用于贵方小程序或者APP跳转过来, 打开后进入腾讯电子签小程序 H5：H5长链接跳转H5链接, 一般用于贵方H5跳转过来, 打开后进入腾讯电子签H5页面 SHORT_H5：H5短链跳转H5的短链形式, 一般用于发送短信中带的链接, 打开后进入腾讯电子签H5页面 示例值：PC
AutoJumpBackEvent	否	String	触发自动跳转事件，仅对EndPoint为App类型有效，可选值包括： VERIFIED :企业认证完成/员工认证完成后跳回原App/小程序 示例值：VERIFIED
AuthorizationTypes.N	否	Array of Integer	可选的此企业允许的授权方式, 可以设置的方式有: 2：转法定代表人授权 5：授权书+对公打款 示例值：[2, 5]
ProxyOperatorIdCardNumber	否	String	子客经办人身份证 注意：如果已同步，这里非空会更新同步的经办人身份证号，暂时只支持中国大陆居民身份证类型。 示例值：620000198802020000
AutoJumpUrl	否	String	认证完成跳转链接。 注意：此功能仅在Endpoint参数设置成 H5 或 PC时才有效。 示例值：https://qian.tencent.com/
TopNavigationStatus	否	String	是否展示头顶导航栏 ENABLE : (默认)进入web控制台展示头顶导航栏 DISABLE : 进入web控制台不展示头顶导航栏 注：该参数仅在企业和员工激活完成，登录控制台场景才生效。 点击查看头顶导航栏位置 示例值：ENABLE
AutoActive	否	Boolean	是否自动激活子客企业，有下面两种选项： false（默认设置）：不自动激活子客户。您需要通过控制台或调用激活或者续期子企业接口手动完成激活过程。 true：若持有的许可证充足，子客户企业注册完成后将自动激活，无需手动操作或访问控制台。 注：如果应用扩展服务中的自动激活子客企业为打开态， 则忽略本接口的AutoActive这个参数（若持有的许可证充足，子客户企业注册完成后将自动激活），具体位置参考下图： 示例值：false
BusinessLicense	否	String	营业执照正面照（支持PNG或JPG格式）需以base64格式提供，且文件大小不得超过5MB。 示例值：aHR0cHM6Ly9jYXBpLndvYS5jb20vhaWwlM0ZpZCUzRGVzc2Jhc2ljJTI2dGFiJTNEYXBp..图片base64省略
ProxyAddress	否	String	组织机构企业注册地址。 请确认该企业注册地址与企业营业执照中注册的地址一致。 示例值：深圳市南山区高新区科技中一路腾讯大厦
ProxyLegalName	否	String	组织机构法人的姓名。 请确认该企业统一社会信用代码与企业营业执照中注册的法人姓名一致。 示例值：典子谦
PowerOfAttorneys.N	否	Array of String	授权书(PNG或JPG或PDF) base64格式, 大小不超过8M 。 p.s. 如果上传授权书 ，需遵循以下条件 1. 超管的信息（超管姓名，超管手机号）必须为必填参数。 2. 认证方式AuthorizationTypes必须只能是上传授权书方式 示例值：["/9j/4A5IWWEAgABA*"]
OrganizationAuthorizationOptions	否	OrganizationAuthorizationOptions	企业认证时个性化能力信息 示例值：{"OrganizationAuthorizationOptions": { "BankAccountNumberSame": true, "OrganizationNameSame": true, "LegalNameSame": true, "UniformSocialCreditCodeSame": true }}
BankAccountNumber	否	String	组织机构对公打款 账号，账户名跟企业名称一致。 p.s. 只有认证方式是授权书+对公打款时才生效。 示例值：6222024060740816912

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: CNB, GitHub, Gitee
• Tencent Cloud SDK 3.0 for Java: CNB, GitHub, Gitee
• Tencent Cloud SDK 3.0 for PHP: CNB, GitHub, Gitee
• Tencent Cloud SDK 3.0 for Go: CNB, GitHub, Gitee
• Tencent Cloud SDK 3.0 for Node.js: CNB, GitHub, Gitee
• Tencent Cloud SDK 3.0 for .NET: CNB, GitHub, Gitee
• Tencent Cloud SDK 3.0 for C++: CNB, GitHub, Gitee
• Tencent Cloud SDK 3.0 for Ruby: CNB, GitHub, Gitee

命令行工具

• Tencent Cloud CLI 3.0

6. 错误码

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