跳到主要内容

管理企业扩展服务

1. 接口描述

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

管理企业扩展服务 ,企业经办人需要是企业超管或者法人。

跳转小程序的几种方式:主要是设置不同的EndPoint

  1. 通过链接Url直接跳转到小程序,不需要返回 设置EndPoint为WEIXINAPP,得到链接打开即可。

  2. 客户App直接跳转到小程序-->腾讯电子签小程序操作完成-->返回App 跳转到小程序的实现,参考官方文档打开 App 设置EndPoint为APP,得到path。

  3. 客户小程序直接跳到电子签小程序-->腾讯电子签小程序操作完成--->回到客户小程序 跳转到小程序的实现,参考官方文档(分为全屏半屏两种方式),如何配置也可以请参考: 跳转电子签小程序配置 设置EndPoint为APP,得到path。

4.其中小程序的原始Id如下,或者查看小程序信息自助获取。

小程序AppID原始ID
腾讯电子签(正式版)wxa023b292fd19d41dgh_da88f6188665
腾讯电子签Demowx371151823f6f3edfgh_39a5d3de69fa

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

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

2. 输入参数

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

参数名称必选类型描述
ActionString公共参数,本接口取值:ModifyExtendedService。
VersionString公共参数,本接口取值:2021-05-26。
RegionString公共参数,此参数为可选参数。
AgentAgent关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。

此接口下面信息必填。

  • 渠道应用标识: Agent.AppId
  • 第三方平台子客企业标识: Agent.ProxyOrganizationOpenId
  • 第三方平台子客企业中的员工标识: Agent.ProxyOperator.OpenId


第三方平台子客企业和员工必须已经过实名认证
ServiceTypeString扩展服务类型

  • AUTO_SIGN 企业自动签(自动签署)
  • OVERSEA_SIGN 企业与港澳台居民签署合同
  • MOBILE_CHECK_APPROVER 使用手机号验证签署方身份
  • PAGING_SEAL 骑缝章
  • DOWNLOAD_FLOW 授权渠道下载合同
  • AGE_LIMIT_EXPANSION 拓宽签署方年龄限制
  • HIDE_OPERATOR_DISPLAY 隐藏合同经办人姓名


示例值:AUTO_SIGN
OperateString操作类型

  • OPEN : 开通
  • CLOSE : 关闭


示例值:OPEN
EndpointString链接跳转类型,支持以下类型

  • WEIXINAPP : 短链直接跳转到电子签小程序 (默认值)
  • APP : 第三方APP或小程序跳转电子签小程序


示例值:APP

3. 输出参数

参数名称类型描述
OperateUrlString操作跳转链接,有效期24小时
若操作时没有返回跳转链接,表示无需跳转操作,此时会直接开通/关闭服务。

当操作类型是 OPEN 且 扩展服务类型是 AUTO_SIGN 或 DOWNLOAD_FLOW 或者 OVERSEA_SIGN 时返回操作链接,
返回的链接需要平台方自行触达超管或法人,超管或法人点击链接完成服务开通操作
示例值:https://res.ess.tencent.cn/cdn/h5-activity-dev/jump-mp.html?to=OPEN_SERVER_SIGN&request_token=xxxxx&organizationId=xxxxx&channelType=xxxxx&expired_time=1673428532&login=1&verify=1
RequestIdString唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 开通骑缝章

开通骑缝章扩展服务

输入示例

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

{
"Agent": {
"ProxyOperator": {
"OpenId": "admin-open-id"
},
"ProxyOrganizationOpenId": "org-open-id",
"AppId": "APPID122344555"
},
"ServiceType": "PAGING_SEAL",
"Operate": "OPEN"
}

输出示例

{
"Response": {
"OperateUrl": "",
"RequestId": "s1673342239896659883"
}
}

示例2 关闭自动签署

关闭企业静默签署扩展服务

输入示例

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

{
"Agent": {
"ProxyOperator": {
"OpenId": "admin-open-id"
},
"ProxyOrganizationOpenId": "org-open-id",
"AppId": "APPID122344555"
},
"ServiceType": "AUTO_SIGN",
"Operate": "CLOSE"
}

输出示例

{
"Response": {
"OperateUrl": "",
"RequestId": "s1673342276656659884"
}
}

示例3 开通企业自动签署

开通企业自动签署扩展服务

输入示例

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

{
"Agent": {
"ProxyOperator": {
"OpenId": "admin-open-id"
},
"ProxyOrganizationOpenId": "org-open-id",
"AppId": "APPID122344555"
},
"ServiceType": "AUTO_SIGN",
"Operate": "OPEN"
}

输出示例

{
"Response": {
"OperateUrl": "https://res.ess.tencent.cn/cdn/h5-activity-dev/jump-mp.html?to=OPEN_SERVER_SIGN&request_token=xxxxx&organizationId=xxxxx&channelType=xxxxx&expired_time=1673428532&login=1&verify=1",
"RequestId": "s1673342132009427709"
}
}

示例4 修改不支持的特定扩展服务

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

输入示例

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

{
"Agent": {
"ProxyOperator": {
"OpenId": "admin-open-id"
},
"ProxyOrganizationOpenId": "org-open-id",
"AppId": "APPID122344555"
},
"ServiceType": "TEST",
"Operate": "OPEN"
}

输出示例

{
"Response": {
"Error": {
"Code": "InvalidParameter.ParamError",
"Message": "参数错误。"
},
"RequestId": "s1**********72"
}
}

5. 错误码

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

错误码描述
FailedOperation操作失败。
InternalError内部错误。
InternalError.DbRead数据库读取失败。
InvalidParameter参数错误。
InvalidParameter.ParamError参数错误。
MissingParameter缺少参数错误。
OperationDenied操作被拒绝。
UnauthorizedOperation.NoPermissionFeature请升级到对应版本后即可使用该接口。
更多开发者交流反馈
购买咨询
4006-808-062
4006-808-062