查询企业电子印章
1. 接口描述
接口请求域名: ess.tencentcloudapi.com 。
查询企业印章列表。
注:
- 此操作要求操作者具备印章查询权限(若调用者尚无此权限,请联系超级管理员前往Web控制台【组织管理】->【角色管理】添加相应权限)。
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:DescribeOrganizationSeals。 |
Version | 是 | String | 公共参数,本接口取值:2020-11-11。 |
Region | 否 | String | 公共参数,此参数为可选参数。 |
Operator | 是 | UserInfo | 执行本接口操作的员工信息。 注: 在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。 |
Limit | 否 | Integer | 指定分页每页返回的数据条数,如果不传默认为 20,单页最大支持 200。 示例值:10 |
Offset | 否 | Integer | 指定分页返回第几页的数据,如果不传默认返回第一页,页码从 0 开始,即首页为 0,最大 20000。 示例值:0 |
InfoType | 否 | Integer | 查询授权用户信息类型,取值如下:
示例值:1 |
SealId | 否 | String | 印章id,是否查询特定的印章(没有输入返回所有) |
SealTypes.N | 否 | Array of String | 印章种类列表(均为组织机构印章)。 若无特定需求,将展示所有类型的印章。 目前支持以下几种:
|
Agent | 否 | Agent | 代理企业和员工的信息。 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。 |
SealStatuses.N | 否 | Array of String | 需查询的印章状态列表。
|
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
TotalCount | Integer | 在设定了SealId时,返回值为0或1;若未设定SealId,则返回公司的总印章数量 示例值:10 |
Seals | Array of OccupiedSeal | 查询到的印章结果数组 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 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. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
FailedOperation | 操作失败。 |
InternalError.DependsDb | 数据库执行错误。 |
InvalidParameter.ParamError | 参数错误。 |
MissingParameter.UserId | 缺少用户id,请检查后重试。 |
OperationDenied | 操作被拒绝。 |
OperationDenied.Forbid | 禁止此项操作。 |
OperationDenied.NoIdentityVerify | 未通过个人实名认证。 |
OperationDenied.NoLogin | 用户未登录,请先登录后再操作。 |
OperationDenied.OperatorHasNoPermission | 操作者权限不足。 |
OperationDenied.SubOrgNotJoin | 子企业暂未加入。 |
ResourceNotFound | 资源不存在。 |
ResourceUnavailable | 资源不可用。 |
UnauthorizedOperation.NoPermissionFeature | 请升级到对应版本后即可使用该接口。 |