查询企业电子印章
1. 接口描述
接口请求域名: ess.tencentcloudapi.com 。
查询企业印章的列表,需要操作者具有查询印章权限 客户指定需要获取的印章数量和偏移量,数量最多100,超过100按100处理;入参InfoType控制印章是否携带授权人信息,为1则携带,为0则返回的授权人信息为空数组。接口调用成功返回印章的信息列表还有企业印章的总数。
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:DescribeOrganizationSeals。 |
Version | 是 | String | 公共参数,本接口取值:2020-11-11。 |
Region | 否 | String | 公共参数,本接口不需要传递此参数。 |
Operator | 是 | UserInfo | 调用方用户信息,userId 必填 |
Limit | 是 | Integer | 返回最大数量,最大为100 |
Offset | 否 | Integer | 偏移量,默认为0,最大为20000 |
InfoType | 否 | Integer | 查询信息类型,为0时不返回授权用户,为1时返回 |
SealId | 否 | String | 印章id(没有输入返回所有) |
SealTypes.N | 否 | Array of String | 印章类型列表(都是组织机构印章)。 为空时查询所有类型的印章。 目前支持以下类型: OFFICIAL:企业公章; CONTRACT:合同专用章; ORGANIZATION_SEAL:企业印章(图片上传创建); LEGAL_PERSON_SEAL:法定代表人章 |
Agent | 否 | Agent | 代理相关应用信息,如集团主企业代子企业操作的场景中ProxyOrganizationId必填 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
TotalCount | Integer | 在设置了SealId时返回0或1,没有设置时返回公司的总印章数量,可能比返回的印章数组数量多 |
Seals | Array of OccupiedSeal | 查询到的印章结果数组 |
RequestId | String | 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 请求详细印章列表信息
查询企业印章的列表,需要操作者具有查询印章权限 客户指定需要获取的印章数量和偏移量,数量最多100,超过100按100处理;入参InfoType控制印章是否携带授权人信息,为1则携带,为0则返回的授权人信息为空数组。接口调用成功返回印章的信息列表还有企业印章的总数。
输入示例
POST / HTTP/1.1
Host: ess.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeOrganizationSeals
<公共请求参数>
{
"InfoType": "1",
"Limit": "1",
"Offset": "0",
"Operator": {
"UserId": "yDRt***gygqb1n5zUuO4zjEwzVL5XuTW"
}
}
输出示例
{
"Response": {
"RequestId": "901***5e-7113-4f50-a472-11eb9fe61d9a",
"Seals": [
{
"AuthorizedUsers": [
{
"UserId": "yDR1fUUgygj9ic***uO4zjEvDps0boOj"
},
{
"UserId": "yDxojUUgydjfd2x8UuO4zjEEwSQl****"
}
],
"CreateOn": 1628061951,
"Creator": "yDRtSUUgygqb1n5zUuO4zjEwzVL5****",
"FailReason": "",
"IsAllTime": true,
"SealId": "yDxMjUyKQDN7EkUuO4zjEBpGXvHE****",
"SealName": "深圳市腾讯计算机系统有限公司企业公章企业公章",
"SealPolicyId": "",
"SealStatus": "SUCCESS",
"SealType": "",
"Url": "https://*********80"
}
],
"TotalCount": 40
}
}
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
- Tencent Cloud SDK 3.0 for Java
- Tencent Cloud SDK 3.0 for PHP
- Tencent Cloud SDK 3.0 for Go
- Tencent Cloud SDK 3.0 for NodeJS
- Tencent Cloud SDK 3.0 for .NET
- Tencent Cloud SDK 3.0 for C++
- Tencent Cloud SDK 3.0 for Ruby
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
FailedOperation | 操作失败。 |
InvalidParameter.ParamError | 参数错误。 |
MissingParameter.UserId | 缺少用户id,请检查后重试。 |
OperationDenied.Forbid | 禁止此项操作。 |
OperationDenied.NoLogin | 用户未登录,请先登录后再操作。 |
OperationDenied.OperatorHasNoPermission | 操作者权限不足。 |
ResourceNotFound | 资源不存在。 |
UnauthorizedOperation.NoPermissionFeature | 请升级到对应版本后即可使用该接口。 |