跳到主要内容

查询子客企业电子印章

1. 接口描述

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

查询子客企业电子印章,需要操作者具有管理印章权限 客户指定需要获取的印章数量和偏移量,数量最多100,超过100按100处理;入参InfoType控制印章是否携带授权人信息,为1则携带,为0则返回的授权人信息为空数组。接口调用成功返回印章的信息列表还有企业印章的总数,只返回启用的印章。

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

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

2. 输入参数

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

参数名称必选类型描述
ActionString公共参数,本接口取值:ChannelDescribeOrganizationSeals。
VersionString公共参数,本接口取值:2021-05-26。
RegionString公共参数,此参数为可选参数。
AgentAgent应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 必填。
LimitInteger返回最大数量,最大为100
示例值:10
OffsetInteger偏移量,默认为0,最大为20000
示例值:0
InfoTypeInteger查询信息类型,为1时返回授权用户,为其他值时不返回
示例值:1
SealIdString印章id(没有输入返回所有)
SealTypes.NArray of String印章类型列表(都是组织机构印章)。
为空时查询所有类型的印章。
目前支持以下类型:
OFFICIAL:企业公章;
CONTRACT:合同专用章;
ORGANIZATION_SEAL:企业印章(图片上传创建);
LEGAL_PERSON_SEAL:法定代表人章

3. 输出参数

参数名称类型描述
TotalCountInteger在设置了SealId时返回0或1,没有设置时返回公司的总印章数量,可能比返回的印章数组数量多
示例值:10
SealsArray of OccupiedSeal查询到的印章结果数组
RequestIdString唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 示例

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

查询子客企业电子印章,需要操作者具有管理印章权限 客户指定需要获取的印章数量和偏移量,数量最多100,超过100按100处理;入参InfoType控制印章是否携带授权人信息,为1则携带,为0则返回的授权人信息为空数组。接口调用成功返回印章的信息列表还有企业印章的总数。

输入示例

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

{
"InfoType": "1",
"Limit": "1",
"Agent": {
"AppId": "xxxx015042c9a35e0984a9657b0ec",
"ProxyOrganizationOpenId": "test1_xxxxpen_organization1",
"ProxyOperator": {
"OpenId": "xxxtest1"
}
},
"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. 错误码

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

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