跳到主要内容

查询企业扩展服务授权详情

1. 接口描述​

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

查询企业扩展服务的授权详情（列表），当前支持查询以下内容：

  1. 企业授权签
  2. 批量签署

注: 所在企业的超管、法人才有权限调用此接口(Agent.ProxyOperator.OpenId 需要传递超管或者法人的OpenId)

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

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

2. 输入参数​

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

参数名称必选类型描述
Action是String公共参数，本接口取值：DescribeExtendedServiceAuthDetail。
Version是String公共参数，本接口取值：2021-05-26。
Region否String公共参数，此参数为可选参数。
Agent是Agent

关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。

此接口下面信息必填。

  • 渠道应用标识: Agent.AppId
  • 第三方平台子客企业标识: Agent.ProxyOrganizationOpenId
  • 第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId
第三方平台子客企业和员工必须已经经过实名认证
ExtendServiceType是String

要查询的扩展服务类型。
如下所示：

枚举值：

  • AUTO_SIGN： 企业授权签署
  • BATCH_SIGN： 批量签署

示例值：AUTO_SIGN
Limit否Integer

指定每页返回的数据条数，和Offset参数配合使用。 注：1.默认值为20，单页做大值为200。


示例值：10
Offset否Integer

查询结果分页返回，指定从第几页返回数据，和Limit参数配合使用。 注：1.offset从0开始，即第一页为0。 2.默认从第一页返回。


示例值：0

3. 输出参数​

参数名称类型描述
AuthInfoDetailAuthInfoDetail

服务授权的信息列表，根据查询类型返回特定扩展服务的开通和授权状况。

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

4. 示例​

示例1 查询企业扩展服务授权详情- 企业授权签​

输入示例​

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

{
    "Agent": {
        "AppId": "yDxjsxxxxxxxxxxxxxxMOX9y",
        "ProxyOrganizationOpenId": "open_id_test",
        "ProxyOperator": {
            "OpenId": "user_open_id"
        }
    },
    "ExtendServiceType": "OPEN_SERVER_SIGN",
    "Limit": 10,
    "Offset": 0
}

输出示例​

{
    "Response": {
        "AuthInfoDetail": {
            "AuthOrganizationTotal": 1,
            "AuthUserTotal": 1,
            "HasAuthOrganizationList": [
                {
                    "AuthorizeTime": 1682521720,
                    "AuthorizedOrganizationName": "xxxx有限公司",
                    "AuthorizedOrganizationOpenId": "org_open_id",
                    "OrganizationName": "xxxxxx有限公司",
                    "OrganizationOpenId": "org_open_id"
                }
            ],
            "HasAuthUserList": [
                {
                    "OpenId": "us-user_open_id"
                }
            ],
            "Name": "企业授权签",
            "Type": "OPEN_SERVER_SIGN"
        },
        "RequestId": "s1699xxxxxxx898950"
    }
}

示例2 查询企业扩展服务授权详情-批量签署​

输入示例​

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

{
    "Agent": {
        "AppId": "yDxjsxxxxxxxxxxxxxxMOX9y",
        "ProxyOrganizationOpenId": "open_id_test",
        "ProxyOperator": {
            "OpenId": "user_open_id"
        }
    },
    "ExtendServiceType": "BATCH_SIGN",
    "Limit": 10,
    "Offset": 0
}

输出示例​

{
    "Response": {
        "AuthInfoDetail": {
            "AuthOrganizationTotal": 0,
            "AuthUserTotal": 1,
            "HasAuthOrganizationList": [],
            "HasAuthUserList": [
                {
                    "OpenId": "us-user_open_id"
                }
            ],
            "Name": "批量签署",
            "Type": "BATCH_SIGN"
        },
        "RequestId": "s1699xxxxxxx898950"
    }
}

5. 错误码​

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

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