管理企业扩展服务
1. 接口描述
接口请求域名: ess.tencentcloudapi.com 。
管理企业扩展服务 ,企业经办人需要是企业超管或者法人。
跳转小程序的几种方式:主要是设置不同的EndPoint
通过链接Url直接跳转到小程序,不需要返回 设置EndPoint为WEIXINAPP,得到链接打开即可。
客户App直接跳转到小程序-->腾讯电子签小程序操作完成-->返回App 跳转到小程序的实现,参考官方文档打开 App 设置EndPoint为APP,得到path。
客户小程序直接跳到电子签小程序-->腾讯电子签小程序操作完成--->回到客户小程序 跳转到小程序的实现,参考官方文档(分为全屏、半屏两种方式),如何配置也可以请参考: 跳转电子签小程序配置 设置EndPoint为APP,得到path。
4.其中小程序的原始Id如下,或者查看小程序信息自助获取。
小程序 | AppID | 原始ID |
---|---|---|
腾讯电子签(正式版) | wxa023b292fd19d41d | gh_da88f6188665 |
腾讯电子签Demo | wx371151823f6f3edf | gh_39a5d3de69fa |
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:ModifyExtendedService。 |
Version | 是 | String | 公共参数,本接口取值:2020-11-11。 |
Region | 否 | String | 公共参数,此参数为可选参数。 |
Operator | 是 | UserInfo | 执行本接口操作的员工信息。 注: 在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。 示例值:yDAVwUyKQWho8CUuO4zjEyQOAgwvr4Zy |
ServiceType | 是 | String | 要管理的拓展服务类型。
示例值:MOBILE_CHECK_APPROVER |
Operate | 是 | String | 操作类型
示例值:OPEN |
Agent | 否 | Agent | 代理企业和员工的信息。 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。 |
Endpoint | 否 | String | 链接跳转类型,支持以下类型
示例值:APP |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
OperateUrl | String | 操作跳转链接,有效期24小时 若操作时没有返回跳转链接,表示无需跳转操作,此时会直接开通/关闭服务。 当操作类型是 OPEN 且 扩展服务类型是 OPEN_SERVER_SIGN 或者 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 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 关闭自动签署
输入示例
POST / HTTP/1.1
Host: ess.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyExtendedService
<公共请求参数>
{
"Operator": {
"ClientIp": "8.8.8.8",
"UserId": "yDxjOUUgydjfxgnzUuO4zjEWA07rC2xl"
},
"ServiceType": "OPEN_SERVER_SIGN",
"Operate": "CLOSE",
"Endpoint": "WEIXINAPP"
}
输出示例
{
"Response": {
"OperateUrl": "",
"RequestId": "s1703747615889528031"
}
}
示例2 开通自动签署
1.开通企业自动签署(ServiceType 设置为WEIXINAPP) 2.设置Endpoint 为WEIXINAPP ,得到小程序链接,操作人可拿链接签署协议开通自动签署
输入示例
POST / HTTP/1.1
Host: ess.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyExtendedService
<公共请求参数>
{
"Operator": {
"ClientIp": "8.8.8.8",
"UserId": "yDxjOUUgydjfxgnzUuO4zjEWA07rC2xl"
},
"ServiceType": "OPEN_SERVER_SIGN",
"Operate": "OPEN",
"Endpoint": "WEIXINAPP"
}
输出示例
{
"Response": {
"OperateUrl": "https://res.ess.tencent.cn/cdn/h5-activity/jump-mp.html?to=OPEN_SERVER_SIGN&request_token=yAABVUUckpt7e9gdUEcsWM19s3pglRL2&organizationId=yDxjOUUgydjf7zv3ACO4zjEC0AKihrfi&channelType=TENCENTCLOUD&expired_time=1703834015&login=1&verify=1",
"RequestId": "s1703747615889528031"
}
}
示例3 管理不支持的扩展服务
输入示例
POST / HTTP/1.1
Host: ess.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyExtendedService
<公共请求参数>
{
"Operator": {
"ClientIp": "8.8.8.8",
"UserId": "yDxjOUUgydjfxgnzUuO4zjEWA07rC2xl"
},
"ServiceType": "OPEN_SERVER",
"Operate": "CLOSE",
"Endpoint": "WEIXINAPP"
}
输出示例
{
"Response": {
"Error": {
"Code": "InvalidParameter.ParamError",
"Message": "非法的扩展服务类型OPEN_SERVER,请确认后重试"
},
"RequestId": "s1703747916297948958"
}
}
5. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
FailedOperation | 操作失败。 |
OperationDenied | 操作被拒绝。 |
ResourceUnavailable | 资源不可用。 |
UnauthorizedOperation.NoPermissionFeature | 请升级到对应版本后即可使用该接口。 |