腾讯电子签集成版查询子客企业电子印章-API 文档-文档中心-腾讯云

1. 接口描述

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

此接口（ChannelDescribeOrganizationSeals）查询子客企业电子印章。

注:

查询子客企业电子印章，需要操作者具有管理印章权限
客户指定需要获取的印章数量和偏移量，数量最多100，超过100按100处理
此接口只能查询启用的印章

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

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：ChannelDescribeOrganizationSeals。
Version	是	String	公共参数，本接口取值：2021-05-26。
Region	否	String	公共参数，此参数为可选参数。
Agent	是	Agent	关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。此接口下面信息必填。渠道应用标识: Agent.AppId 第三方平台子客企业标识: Agent.ProxyOrganizationOpenId 第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId 第三方平台子客企业和员工必须已经经过实名认证
Limit	是	Integer	返回最大数量，最大为100 示例值：10
Offset	否	Integer	分页查询偏移量，默认为0，最大为20000 示例值：0
InfoType	否	Integer	查询信息类型支持的值如下： 0-默认，不返回授权用户信息 1-返回授权用户信息示例值：1
SealId	否	String	印章id（没有输入返回所有）注: `没有输入返回所有记录，最大返回100条。`
SealTypes.N	否	Array of String	电子印章类型 , 可选类型如下: OFFICIAL: (默认)公章 CONTRACT: 合同专用章; FINANCE: 财务专用章; PERSONNEL: 人事专用章 INVOICE: 发票专用章注: `为空时查询所有类型的印章。`

3. 输出参数

参数名称	类型	描述
TotalCount	Integer	在设置了SealId时返回0或1，没有设置时返回公司的总印章数量，可能比返回的印章数组数量多示例值：10
Seals	Array of OccupiedSeal	查询到的印章结果数组
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询子客企业电子印章

1.查询应用yDwhxUUckp3gl8j5UuFX33LSNozpRsbi下认证的子客org_dianziqian的印章
2.设置InfoType=1，返回时会同时返回授权用例的相关信息

输入示例

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

{
    "InfoType": "1",
    "Limit": "1",
    "Agent": {
        "AppId": "yDwhxUUckp3gl8j5UuFX33LSNozpRsbi",
        "ProxyOrganizationOpenId": "org_dianziqian",
        "ProxyOperator": {
            "OpenId": "n9527"
        },
        "ProxyAppId": ""
    },
    "Offset": "0"
}

输出示例

{
    "Response": {
        "RequestId": "8ff****2-be87-af68a7842493",
        "Seals": [
            {
                "AuthorizedUsers": [
                    {
                        "OpenId": "xxxtest1"
                    }
                ],
                "CreateOn": 163549000069,
                "Creator": "xxxtest1",
                "FailReason": "",
                "IsAllTime": true,
                "SealId": "yDxHTUUgydj94zlcUuO4zjESIzF*****",
                "SealName": "测试环境_测试",
                "SealPolicyId": "",
                "SealStatus": "SUCCESS",
                "SealType": "OFFICIAL",
                "Url": "https://***************.jpg"
            }
        ],
        "TotalCount": 35
    }
}

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. 错误码

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

错误码	描述
FailedOperation	操作失败。
InternalError.DependsDb	数据库异常。
InvalidParameter	参数错误。
MissingParameter	缺少参数错误。
MissingParameter.UserId	缺少用户ID参数
OperationDenied	操作被拒绝。
OperationDenied.OperatorHasNoPermission	操作者权限不足。
ResourceNotFound.Application	应用号不存在。
UnauthorizedOperation.NoPermissionFeature	请升级到对应版本后即可使用该接口。

查询子客企业电子印章

本页目录：