获取个人签署H5页面
1. 接口描述
接口请求域名: essbasic.tencentcloudapi.com 。
创建个人签署H5签署链接,请联系客户经理申请使用
该接口用于发起合同后,生成C端签署人的签署链接
注意:该接口目前签署人类型仅支持个人签署方(PERSON)
注意:该接口可生成签署链接的C端签署人必须仅有手写签名和时间类型的签署控件
注意:该接口返回的签署链接是用于APP集成的场景,支持APP打开或浏览器直接打开,不支持微信小程序嵌入。微信小程序请使用小程序跳转或半屏弹窗的方式
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:ChannelCreateFlowSignUrl。 |
Version | 是 | String | 公共参数,本接口取值:2021-05-26。 |
Region | 否 | String | 公共参数,此参数为可选参数。 |
Agent | 是 | Agent | 应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 必填 |
FlowId | 是 | String | 流程编号 |
FlowApproverInfos.N | 是 | Array of FlowApproverInfo | 流程签署人,其中Name和Mobile必传,其他可不传,ApproverType目前只支持PERSON类型的签署人,如果不传默认为该值。还需注意签署人只能有手写签名和时间类型的签署控件,其他类型的填写控件和签署控件暂时都未支持。 |
JumpUrl | 否 | String | 签署完之后的H5页面的跳转链接,此链接支持http://和https://,最大长度1000个字符。 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
FlowApproverUrlInfos | Array of FlowApproverUrlInfo | 签署人签署链接信息 |
RequestId | String | 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 创建个人用户H5签署链接
发起流程后,给其中的C端签署人创建签署链接
输入示例
POST / HTTP/1.1
Host: essbasic.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ChannelCreateFlowSignUrl
<公共请求参数>
{
"Agent": {
"ProxyOperator": {
"OpenId": "00498cc***********3aff766cac"
},
"AppId": "100***2432",
"ProxyOrganizationOpenId": "d7c13a8***********0ee248f04"
},
"FlowApproverInfos": [
{
"Mobile": "185***12",
"Name": "张三"
}
],
"FlowId": "yDRCL*****zjEwg0vjoimj"
}
输出示例
{
"Response": {
"FlowApproverUrlInfos": [
{
"ApproverType": "PERSON",
"LongUrl": "https://quick.beta.qian.tencent.cn/home?ApproverIdCardNumber=NCoqK***&ApproverIdCardType=ID_CARD&ApproverMobile=MTU4%3D&ApproverName=%25E9%2583%2591%****1%2589&ApproverType=1&Code=yDwhGUUckp3s****z1m3P&CodeType=QUICK&FlowId=yDwhGUUckp3s****T&ShowHeader=1&token=HXC5rU3bEd",
"Mobile": "158***3432",
"Name": "张三",
"SignUrl": "https://test.essurl.cn/HXC5rU3bEd"
}
],
"RequestId": "s1690514917653165172"
}
}
5. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
FailedOperation | 操作失败。 |
InternalError | 内部错误。 |
InvalidParameter | 参数错误。 |
MissingParameter | 缺少参数错误。 |
OperationDenied | 操作被拒绝。 |
ResourceNotFound | 资源不存在。 |
ResourceNotFound.Flow | 未找到对应流程。 |
UnauthorizedOperation.NoPermissionFeature | 请升级到对应版本后即可使用该接口。 |