创建个人用户H5签署链接
1. 接口描述
接口请求域名: ess.tencentcloudapi.com 。
创建个人H5签署链接,请联系客户经理申请使用
该接口用于发起合同后,生成C端签署人的签署链接
注意:该接口目前签署人类型仅支持个人签署方(PERSON)
注意:该接口可生成签署链接的C端签署人必须仅有手写签名和时间类型的签署控件
注意:该接口返回的签署链接是用于APP集成的场景,支持APP打开或浏览器直接打开,不支持微信小程序嵌入。微信小程序请使用小程序跳转或半屏弹窗的方式
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:CreateFlowSignUrl。 |
Version | 是 | String | 公共参数,本接口取值:2020-11-11。 |
Region | 否 | String | 公共参数,此参数为可选参数。 |
FlowId | 是 | String | 流程编号 |
FlowApproverInfos.N | 是 | Array of FlowCreateApprover | 流程签署人,其中ApproverName,ApproverMobile和ApproverType必传,其他可不传,ApproverType目前只支持个人类型的签署人。还需注意签署人只能有手写签名和时间类型的签署控件,其他类型的填写控件和签署控件暂时都未支持。 |
Operator | 否 | UserInfo | 用户信息,此结构体UserId必填 |
Agent | 否 | Agent | 代理相关应用信息,如集团主企业代子企业操作的场景中ProxyOrganizationId必填 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
FlowApproverUrlInfos | Array of FlowApproverUrlInfo | 签署人签署链接信息 |
RequestId | String | 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 创建个人用户H5签署链接
发起流程后,给其中的C端签署人创建签署链接
输入示例
POST / HTTP/1.1
Host: ess.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateFlowSignUrl
<公共请求参数>
{
"Operator": {
"UserId": "yD*****************1Khs7"
},
"FlowApproverInfos": [
{
"ApproverMobile": "test",
"ApproverName": "test",
"ApproverType": 1
}
],
"FlowId": "test"
}
输出示例
{
"Response": {
"FlowApproverUrlInfos": [
{
"ApproverMobile": "test",
"ApproverName": "test",
"ApproverType": 1,
"SignUrl": "https://***cn/7YIxx"
}
],
"RequestId": "s1672381196019320421"
}
}
5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python
- Tencent Cloud SDK 3.0 for Java
- Tencent Cloud SDK 3.0 for PHP
- Tencent Cloud SDK 3.0 for Go
- Tencent Cloud SDK 3.0 for NodeJS
- Tencent Cloud SDK 3.0 for .NET
- Tencent Cloud SDK 3.0 for C++
- Tencent Cloud SDK 3.0 for Ruby
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
FailedOperation | 操作失败。 |
InternalError | 内部错误。 |
InternalError.Api | 第三方接口失败。 |
InvalidParameter | 参数错误。 |
MissingParameter | 缺少参数错误。 |
OperationDenied.ErrNoResourceAccess | 此企业无该资源使用权限。 |
OperationDenied.Forbid | 禁止此项操作。 |
OperationDenied.NoIdentityVerify | 未通过个人实名认证。 |
OperationDenied.NoLogin | 用户未登录,请先登录后再操作。 |
ResourceNotFound.Flow | 签署流程未找到,请检查参数。 |
UnauthorizedOperation.NoPermissionFeature | 请升级到对应版本后即可使用该接口。 |