跳到主要内容

查询企业扩展服务授权信息

1. 接口描述

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

查询企业扩展服务的开通和授权情况,当前支持查询以下内容:

  1. 企业自动签署
  2. 批量签署授权
  3. 企业与港澳台居民签署合同
  4. 拓宽签署方年龄限制
  5. 个人签署方仅校验手机号
  6. 隐藏合同经办人姓名
  7. 正楷临摹签名失败后更换其他签名类型
  8. 短信通知签署方
  9. 个人签署方手动签字
  10. 骑缝章
  11. 签署密码开通引导

对应能力开通页面在Web控制台-更多-企业设置-拓展服务,如下图所示:

image

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

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

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

2. 输入参数

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

参数名称必选类型描述
ActionString公共参数,本接口取值:DescribeExtendedServiceAuthInfos。
VersionString公共参数,本接口取值:2020-11-11。
RegionString公共参数,此参数为可选参数。
OperatorUserInfo执行本接口操作的员工信息。
注: 在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。
示例值:yD****oimj
ExtendServiceTypeString要查询的扩展服务类型。
默认为空,即查询当前支持的所有扩展服务信息。
若需查询单个扩展服务的开通情况,请传递相应的值,如下所示:
  • OPEN_SERVER_SIGN:企业自动签署
  • AUTO_SIGN_CAN_FILL_IN:本企业自动签合同支持签前内容补充
  • BATCH_SIGN:批量签署
  • OVERSEA_SIGN:企业与港澳台居民签署合同
  • AGE_LIMIT_EXPANSION:拓宽签署方年龄限制
  • MOBILE_CHECK_APPROVER:个人签署方仅校验手机号
  • HIDE_OPERATOR_DISPLAY:隐藏合同经办人姓名
  • ORGANIZATION_OCR_FALLBACK:正楷临摹签名失败后更换其他签名类型
  • ORGANIZATION_FLOW_NOTIFY_TYPE:短信通知签署方
  • HIDE_ONE_KEY_SIGN:个人签署方手动签字
  • ORGANIZATION_FLOW_EMAIL_NOTIFY:邮件通知签署方
  • FLOW_APPROVAL:合同审批强制开启
  • ORGANIZATION_FLOW_PASSWD_NOTIFY:签署密码开通引导

示例值:OPEN_SERVER_SIGN
AgentAgent代理企业和员工的信息。
在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。

3. 输出参数

参数名称类型描述
AuthInfoListArray of ExtendAuthInfo服务开通和授权的信息列表,根据查询类型返回所有支持的扩展服务开通和授权状况,或者返回特定扩展服务的开通和授权状况。
RequestIdString唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询全部扩展服务信息

查询全部支持的扩展服务开通和授权信息

输入示例

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

{
"Operator": {
"UserId": "yDRC*********g0vjoimj"
},
"ExtendServiceType": ""
}

输出示例

{
"Response": {
"AuthInfoList": [
{
"HasAuthUserList": [
{
"BelongTo": "CurrentOrg",
"UserId": "yDRC*********g0vjoimj"
},
{
"BelongTo": "CurrentOrg",
"UserId": "yDRC*********g0vjoimj"
},
{
"BelongTo": "CurrentOrg",
"UserId": "yDRC*********g0vjoimj"
}
],
"Name": "企业自动签(自动签署)",
"OperateOn": 1681289048,
"OperatorUserId": "yDRC*********g0vjoimj",
"Status": "ENABLE",
"Type": "OPEN_SERVER_SIGN"
},
{
"Name": "企业与港澳台居民*签署合同",
"OperateOn": 1667458840,
"OperatorUserId": "yDRC*********g0vjoimj",
"Status": "ENABLE",
"Type": "OVERSEA_SIGN",
"HasAuthUserList": []
},
{
"Name": "使用手机号验证签署方身份",
"OperateOn": 0,
"OperatorUserId": "yDRC*********g0vjoimj",
"Status": "DISABLE",
"Type": "MOBILE_CHECK_APPROVER",
"HasAuthUserList": []
},
{
"Name": "骑缝章",
"OperateOn": 0,
"OperatorUserId": "yDRC*********g0vjoimj",
"Status": "ENABLE",
"Type": "PAGING_SEAL",
"HasAuthUserList": []
},
{
"HasAuthUserList": [
{
"BelongTo": "CurrentOrg",
"UserId": "yDRC*********g0vjoimj"
},
{
"BelongTo": "CurrentOrg",
"UserId": "yDRC*********g0vjoimj"
},
{
"BelongTo": "CurrentOrg",
"UserId": "yDRC*********g0vjoimj"
}
],
"Name": "批量签署",
"OperateOn": 1667460697,
"OperatorUserId": "yDRC*********g0vjoimj",
"Status": "ENABLE",
"Type": "BATCH_SIGN"
}
],
"RequestId": "s1******80"
}
}

示例2 查询特定的扩展服务信息

查询特定的扩展服务开通和授权信息

输入示例

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

{
"Operator": {
"UserId": "yDR*****oimj"
},
"ExtendServiceType": "OPEN_SERVER_SIGN"
}

输出示例

{
"Response": {
"AuthInfoList": [
{
"HasAuthUserList": [
{
"BelongTo": "CurrentOrg",
"UserId": "yDR*****oimj"
},
{
"BelongTo": "CurrentOrg",
"UserId": "yDR*****oimj"
},
{
"BelongTo": "CurrentOrg",
"UserId": "yDR*****oimj"
}
],
"Name": "企业自动签(自动签署)",
"OperateOn": 1681289048,
"OperatorUserId": "yDR*****oimj",
"Status": "ENABLE",
"Type": "OPEN_SERVER_SIGN"
}
],
"RequestId": "s1*****90"
}
}

示例3 查询不支持的特定扩展服务

传入了不支持的特定扩展服务,返回错误

输入示例

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

{
"Operator": {
"UserId": "yDR*****oimj"
},
"ExtendServiceType": "TEST"
}

输出示例

{
"Response": {
"Error": {
"Code": "OperationDenied",
"Message": "不支持的扩展类型"
},
"RequestId": "s1**********72"
}
}

5. 错误码

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

错误码描述
FailedOperation操作失败。
OperationDenied操作被拒绝。
ResourceUnavailable资源不可用。
UnauthorizedOperation.NoPermissionFeature请升级到对应版本后即可使用该接口。
更多开发者交流反馈
购买咨询
微信客服
4006-808-062
4006-808-062