获取发起合同web页面
1. 接口描述
接口请求域名: essbasic.tencentcloudapi.com 。
创建预发起合同 通过此接口指定:合同,签署人,填写控件信息,生成预创建合同链接,点击后跳转到web页面完成合同创建并发起 可指定合同信息不可更改,签署人信息不可更改 合同发起后,填写及签署流程与现有操作流程一致 注意:目前仅支持模板发起
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:ChannelCreatePrepareFlow。 |
Version | 是 | String | 公共参数,本接口取值:2021-05-26。 |
Region | 否 | String | 公共参数,此参数为可选参数。 |
ResourceId | 是 | String | 资源id,与ResourceType对应 |
ResourceType | 是 | Integer | 资源类型,与ResourceId对应1:模板 2: 文件 |
FlowInfo | 是 | BaseFlowInfo | 合同流程基础信息 |
Agent | 否 | Agent | 应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 必填 |
FlowOption | 否 | CreateFlowOption | 合同流程配置信息,用于配置发起合同时定制化 |
FlowApproverList.N | 否 | Array of CommonFlowApprover | 合同签署人信息 |
FlowId | 否 | String | 通过flowid快速获得之前成功通过页面发起的合同生成链接 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
PrepareFlowUrl | String | 预发起的合同链接, 可以直接点击进入进行合同发起 |
PreviewFlowUrl | String | 合同发起后预览链接, 注意此时合同并未发起,仅只是展示效果 |
RequestId | String | 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 创建预发起合同链接
创建预发起合同链接-BBC
输入示例
POST / HTTP/1.1
Host: essbasic.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ChannelCreatePrepareFlow
<公共请求参数>
{
"Agent": {
"ProxyOperator": {
"OpenId": "test"
},
"ProxyOrganizationOpenId": "test-open_org_id",
"AppId": "test-channel_app_id"
},
"ResourceId": "test_resource_id",
"ResourceType": 1,
"FlowInfo": {
"FlowName": "无序BBC发起填写全部无法编辑",
"NeedSignReview": true,
"FlowType": "快速生成创建合同链接",
"FlowDescription": "无序BBC发起填写全部无法编辑",
"Deadline": 1708497660,
"FormFields": [
{
"ComponentId": "ComponentId_16",
"ComponentName": "单行文本",
"ComponentValue": "单行文本"
}
]
},
"FlowOption": {
"CanEditFlow": false
},
"FlowApproverList": [
{
"ApproverType": 0,
"OrganizationId": "",
"OrganizationOpenId": "test-open_org_id",
"OrganizationName": "test百货-子公司",
"UserId": "",
"OpenId": "testOpenId",
"ApproverName": "",
"ApproverMobile": "",
"RecipientId": "yDw9XUUgyg3ervqtUrQhCRCfEBQfKtBx",
"PreReadTime": 300,
"IsFullText": true,
"NotifyType": "",
"ApproverOption": {
"CanEditApprover": false
},
"NotChannelOrganization": false
},
{
"ApproverType": 0,
"OrganizationId": "",
"OrganizationOpenId": "",
"OrganizationName": "测试SAAS企业",
"UserId": "",
"OpenId": "",
"ApproverName": "张三",
"ApproverMobile": "18888888888",
"RecipientId": "yDw9XUUgyg3ervqkUrQhCRur6kMcOYn0",
"PreReadTime": 10,
"IsFullText": true,
"NotifyType": "",
"ApproverOption": {
"CanEditApprover": false
},
"NotChannelOrganization": true
},
{
"ApproverType": 1,
"OrganizationId": "",
"OrganizationOpenId": "",
"OrganizationName": "",
"UserId": "",
"OpenId": "",
"ApproverName": "李四",
"ApproverMobile": "15555555555",
"RecipientId": "yDw9XUUgyg3ervq1UrQhCRyWnKMeua1Z",
"PreReadTime": 10,
"IsFullText": true,
"NotifyType": "",
"ApproverOption": {
"CanEditApprover": false
},
"NotChannelOrganization": true
}
]
}
输出示例
{
"Response": {
"PrepareFlowUrl": "https://test.ess.tencent.cn/new-contract-create/template/channel?embed=1&expiredOn=1678073737&code=yDwn2UUgygkpxtidUy5ozz8jhVMwzQNQ&businessId=yDwn2UUgygkpxtigUy5ozzEd7YgDtJTZ&byTemplate=template&channel=PROXYCHANNEL&themeId=channel_web_theme_d69192f65cf1e0da4fcd8024ea34afa5",
"PreviewFlowUrl": "",
"RequestId": "s1678073437432767156"
}
}
5. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
FailedOperation | 操作失败。 |
InvalidParameter.ParamError | 参数错误。 |
InvalidParameterValue | 参数取值错误。 |
OperationDenied | 操作被拒绝。 |
OperationDenied.WhiteListForbid | 接口功能暂未开放,请联系客户经理申请白名单使用 |
ResourceNotFound | 资源不存在。 |
ResourceNotFound.Application | 应用号不存在。 |
ResourceNotFound.Organization | 机构不存在。 |
UnauthorizedOperation.NoPermissionFeature | 请升级到对应版本后即可使用该接口。 |