跳到主要内容

生成控制台、移动端链接

1. 接口描述​

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

此接口（CreateConsoleLoginUrl）用于创建第三方平台子客企业控制台Web/移动登录链接。登录链接是子客控制台的唯一入口。 若子客企业未激活，会进入企业激活流程，首次参与激活流程的经办人会成为超管。（若企业激活过程中填写信息有误，需要重置激活流程，可以换一个经办人OpenId获取新的链接进入。） 若子客企业已激活，使用了新的经办人OpenId进入，则会进入经办人的实名流程。 若子客企业、经办人均已完成认证，则会直接进入子客Web控制台。

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

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

2. 输入参数​

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

参数名称必选类型描述
Action是String公共参数，本接口取值：CreateConsoleLoginUrl。
Version是String公共参数，本接口取值：2021-05-26。
Region否String公共参数，本接口不需要传递此参数。
Agent是Agent应用信息
此接口Agent.AppId、Agent.ProxyOrganizationOpenId 和 Agent. ProxyOperator.OpenId 必填
ProxyOrganizationName是String子客企业名称，最大长度64个字符
ProxyOperatorName否String子客企业经办人的姓名，最大长度50个字符
Module否StringPC控制台指定模块，文件/合同管理:"DOCUMENT"，模板管理:"TEMPLATE"，印章管理:"SEAL"，组织架构/人员:"OPERATOR"，空字符串："账号信息"。 EndPoint为"CHANNEL"/"APP"只支持"SEAL"-印章管理
ModuleId否String控制台指定模块Id
UniformSocialCreditCode否String子客企业统一社会信用代码，最大长度200个字符
MenuStatus否String是否展示左侧菜单栏 是：ENABLE（默认） 否：DISABLE
Endpoint否String链接跳转类型："PC"-PC控制台，“CHANNEL”-H5跳转到电子签小程序；“APP”-第三方APP或小程序跳转电子签小程序，默认为PC控制台
AutoJumpBackEvent否String触发自动跳转事件，仅对App类型有效，"VERIFIED":企业认证完成/员工认证完成后跳回原App/小程序
AuthorizationTypes.N否Array of Integer支持的授权方式,授权方式: "1" - 上传授权书认证 "2" - 法定代表人认证
Operator否UserInfo暂未开放

3. 输出参数​

参数名称类型描述
ConsoleUrlString子客企业Web控制台url注意事项：
1. 所有类型的链接在企业未认证/员工未认证完成时，只要在有效期内（一年）都可以访问
2. 若企业认证完成且员工认证完成后，重新获取pc端的链接5分钟之内有效，且只能访问一次
3. 若企业认证完成且员工认证完成后，重新获取H5/APP的链接只要在有效期内（一年）都可以访问
4. 此链接仅单次有效，使用后需要再次创建新的链接（部分聊天软件，如企业微信默认会对链接进行解析，此时需要使用类似“代码片段”的方式或者放到txt文件里发送链接）
5. 创建的链接应避免被转义，如：&被转义为\u0026；如使用Postman请求后，请选择响应类型为 JSON，否则链接将被转义
IsActivatedBoolean子客企业是否已开通腾讯电子签
ProxyOperatorIsVerifiedBoolean当前经办人是否已认证（false:未认证 true:已认证）
RequestIdString唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 示例​

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

生成默认的控制台链接

输入示例​

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

{
    "ProxyOrganizationName": "子客企业名称",
    "Agent": {
        "ProxyOperator": {
            "OpenId": "test"
        },
        "ProxyOrganizationOpenId": "testx",
        "AppId": "test"
    }
}

输出示例​

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

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

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

输入示例​

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

{
    "ProxyOrganizationName": "子客企业名称",
    "Agent": {
        "ProxyOperator": {
            "OpenId": "test"
        },
        "ProxyOrganizationOpenId": "test",
        "AppId": "test"
    },
    "Module": "TEMPLATE",
    "ModuleId": "test",
    "MenuStatus": "ENABLE"
}

输出示例​

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

5. 开发者资源​

腾讯云 API 平台​

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

API Inspector​

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

SDK​

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

命令行工具​

6. 错误码​

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

错误码描述
FailedOperation操作失败。
FailedOperation.HasAuthorized已授权。
InternalError内部错误。
InternalError.Api其他API错误。
InternalError.Db数据库错误。
InternalError.DbInsert数据库新增记录出错。
InternalError.System系统错误。
InvalidParameter参数错误。
InvalidParameter.AuthorizationType当前仅支持指定上传授权书和法人认证授权, 请重新指定认证方式后发起
InvalidParameter.BusinessLicense营业执照格式不合法。
InvalidParameter.DataNotFound数据不存在。
InvalidParameter.EndPoint不合法的EndPoint，请检查修改后重试。
InvalidParameter.FileType文件类型不合法。
InvalidParameter.MenuStatus菜单栏状态非法。
InvalidParameter.OpenIdOpenId不合法。
InvalidParameter.OrganizationIdOrganizationId不合法。
InvalidParameter.OrganizationName企业名称不合法。
InvalidParameter.ParamError参数错误。
LimitExceeded.FileSize文件大小限制。
MissingParameter缺少参数错误。
MissingParameter.CompanyActiveInfo合作企业激活信息不存在。
MissingParameter.OrgOpenId企业OpenId不存在。
MissingParameter.ProxyOperatorOpenIdProxyOperatorOpenId不存在。
OperationDenied操作被拒绝。
OperationDenied.BannedApplication应用号已被禁止。
OperationDenied.UserNotInOrganization用户不归属于当前企业，无法操作，请检查后重试。
ResourceNotFound资源不存在。
ResourceNotFound.Application应用号不存在。
ResourceNotFound.ApplicationIdApplicationId不存在。
ResourceNotFound.Flow未找到对应流程。
ResourceUnavailable资源不可用。
UnauthorizedOperation未授权操作。
UnauthorizedOperation.NoPermissionFeature请升级到对应版本后即可使用该接口。
UnknownParameter未知参数错误。
UnsupportedOperation操作不支持。