跳到主要内容

查询企业扩展服务授权信息

1. 接口描述​

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

查询企业扩展服务的开通和授权情况，当前支持查询以下内容：

  1. 企业自动签
  2. 企业与港澳台居民签署合同
  3. 使用手机号验证签署方身份
  4. 骑缝章
  5. 拓宽签署方年龄限制
  6. 下载企业合同/文件

注: 此接口 参数Agent. ProxyOperator.OpenId 需要传递超管或者法人的OpenId

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

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

2. 输入参数​

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

参数名称必选类型描述
Action是String公共参数，本接口取值：DescribeExtendedServiceAuthInfo。
Version是String公共参数，本接口取值：2021-05-26。
Region否String公共参数，此参数为可选参数。
Agent是Agent关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。

此接口下面信息必填。

  • 渠道应用标识: Agent.ProxyOrganizationOpenId
  • 第三方平台子客企业标识: Agent. ProxyOperator.OpenId
  • 第三方平台子客企业中的员工标识: Agent.AppId

3. 输出参数​

参数名称类型描述
AuthInfoArray of ExtentServiceAuthInfo服务开通和授权的信息列表，根据查询类型返回所有支持的扩展服务开通和授权状况，或者返回特定扩展服务的开通和授权状况。
注意：此字段可能返回 null，表示取不到有效值。
RequestIdString唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 示例​

示例1 查询企业扩展服务授权信息​

查询企业扩展服务授权信息

输入示例​

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

{
    "Agent": {
        "ProxyOperator": {
            "OpenId": "admin-open-id"
        },
        "ProxyOrganizationOpenId": "org-open-id",
        "AppId": "APPID12344556667777777"
    }
}

输出示例​

{
    "Response": {
        "AuthInfo": [
            {
                "Name": "企业与港澳台居民*签署合同",
                "OperateOn": 1671692727,
                "OperatorOpenId": "admin-open-id",
                "Status": "DISABLE",
                "Type": "OVERSEA_SIGN"
            },
            {
                "Name": "使用手机号验证签署方身份",
                "OperateOn": 1673331249,
                "OperatorOpenId": "admin-open-id",
                "Status": "DISABLE",
                "Type": "MOBILE_CHECK_APPROVER"
            },
            {
                "Name": "企业自动签（自动签署）",
                "OperateOn": 1672989237,
                "OperatorOpenId": "admin-open-id",
                "Status": "DISABLE",
                "Type": "AUTO_SIGN"
            },
            {
                "Name": "下载企业合同/文件",
                "OperateOn": 1673331721,
                "OperatorOpenId": "admin-open-id",
                "Status": "ENABLE",
                "Type": "DOWNLOAD_FLOW"
            },
            {
                "Name": "骑缝章",
                "OperateOn": 1673331246,
                "OperatorOpenId": "admin-openid",
                "Status": "DISABLE",
                "Type": "PAGING_SEAL"
            },
            {
                "Name": "拓宽合同签署年龄",
                "OperateOn": 0,
                "OperatorOpenId": "",
                "Status": "ENABLE",
                "Type": "EXPANSION_AGE_LIMIT"
            }
        ],
        "RequestId": "s16733xxx81"
    }
}

示例2 无权限的openid调用此接口​

查询企业扩展服务授权信息，经办人openid不是超管或者法人，会报错返回

输入示例​

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

{
    "Agent": {
        "ProxyOperator": {
            "OpenId": "normal-open-id"
        },
        "ProxyOrganizationOpenId": "org-open-id",
        "AppId": "APPID12344556667777777"
    }
}

输出示例​

{
    "Response": {
        "Error": {
            "Code": "OperationDenied",
            "Message": "操作被拒绝。"
        },
        "RequestId": "s1**********72"
    }
}

5. 错误码​

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

错误码描述
FailedOperation操作失败。
InternalError内部错误。
InvalidParameter参数错误。
InvalidParameter.ParamError参数错误。
MissingParameter缺少参数错误。
OperationDenied操作被拒绝。
ResourceNotFound.Application应用号不存在。
UnauthorizedOperation.NoPermissionFeature请升级到对应版本后即可使用该接口。