跳到主要内容

获取发起合同嵌入链接

1. 接口描述​

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

通过此接口指定合同、签署人、填写控件等信息，生成嵌入式链接，此链接可以嵌入到其他网页或者直接打开，打开后进入发起页面。在此页面上，合同信息和签署人信息均不可更改。

注意：

  1. 仅支持在PC浏览器上进行操作和使用。
  2. 在使用模板发起合同时，需指定RecipientId以明确参与方在模板中所扮演的角色。

嵌入式签署人-各种场景传参说明:

场景编号可作为签署方的类型签署方传参说明
场景一第三方子企业员工OpenId、OrganizationName、OrganizationOpenId必传 ,ApproverType设置为0
场景二SaaS平台企业员工Name、Mobile、OrganizationName必传，NotChannelOrganization=True。 ApproverType设置为0
场景三个人/自然人Name、Mobile必传, ApproverType设置为1

嵌入的页面样式如下： image

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

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

2. 输入参数​

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

参数名称必选类型描述
Action是String公共参数，本接口取值：ChannelCreatePrepareFlow。
Version是String公共参数，本接口取值：2021-05-26。
Region否String公共参数，此参数为可选参数。
ResourceType是Integer资源类型，取值有：
  • 1：模板
  • 2：文件（默认值）
FlowInfo是BaseFlowInfo要创建的合同信息
Agent否Agent关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。

此接口下面信息必填。

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


第三方平台子客企业和员工必须已经经过实名认证
ResourceId否String资源id，与ResourceType相对应，取值范围：

  • 文件Id（通过UploadFiles获取文件资源Id）
  • 模板Id（通过控制台创建模板后获取模板Id）


注意：需要同时设置 ResourceType 参数指定资源类型
FlowOption否CreateFlowOption合同流程配置信息，用于配置发起合同时定制化如是否允许修改，某些按钮的隐藏等逻辑
FlowApproverList.N否Array of CommonFlowApprover合同签署人信息
FlowId否String合同Id：用于通过一个已发起的合同快速生成一个发起流程web链接
注: 该参数必须是一个待发起审核的合同id，并且还未审核通过

3. 输出参数​

参数名称类型描述
PrepareFlowUrlString发起的合同嵌入链接， 可以直接点击进入进行合同发起， 有效期为5分钟
PreviewFlowUrlString合同发起后预览链接， 注意此时合同并未发起，仅只是展示效果， 有效期为5分钟
FlowIdString发起的合同临时Id， 只有当点击进入链接，成功发起合同后， 此Id才有效
RequestIdString唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例​

示例1 文件发起-跳过文件上传​

输入示例​

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

{
    "Agent": {
        "ProxyOperator": {
            "OpenId": "5d18c1c4c8926cd11"
        },
        "ProxyOrganizationOpenId": "572c69xxxxxx245e4",
        "AppId": "yDRsbUUgxxxx7ZfBvipOMJ"
    },
    "ResourceId": "yDwqFUUckp3em41rUwWPgIBjsYgG5bba",
    "ResourceType": 2,
    "FlowInfo": {
        "FlowName": "第三方预发起合同-跳过文件上传",
        "FlowType": "第三方嵌入式文件发起合同",
        "FlowDescription": "",
        "Deadline": 0,
        "Unordered": false,
        "IntelligentStatus": "CLOSE",
        "FormFields": [],
        "NeedCreateReview": false,
        "NeedSignReview": false,
        "UserData": "",
        "CcInfos": []
    },
    "FlowOption": {
        "CanEditFlow": true,
        "HideShowFlowName": false,
        "HideShowFlowType": false,
        "HideShowDeadline": false,
        "ForbidEditFillComponent": false,
        "SkipUploadFile": true,
        "CustomCreateFlowDescription": ""
    },
    "FlowApproverList": [
        {
            "ApproverType": 0,
            "NotChannelOrganization": false,
            "OrganizationOpenId": "org_dianziqian",
            "OrganizationName": "典子谦示例企业",
            "OpenId": "n131517",
            "ApproverOption": {
                "CanEditApprover": true
            },
            "IsFullText": true,
            "PreReadTime": 0
        },
        {
            "ApproverType": 1,
            "ApproverIdCardType": "",
            "ApproverName": "里斯",
            "NotChannelOrganization": false,
            "ApproverMobile": "13312312312",
            "IsFullText": true,
            "PreReadTime": 0
        }
    ]
}

输出示例​

{
    "Response": {
        "PrepareFlowUrl": "https://embed.beta.qian.tencent.cn/contract-create?embed=1&expiredOn=1700819911&code=yDSL6UUQEjIKK&businessId=yDSL6U3iY7&channel=PROXYCHANNEL&operateSource=byTemplate&themeId=channel_web_theme_yDwi3UAR2Yb",
        "PreviewFlowUrl": "",
        "FlowId": "yDC54UUckpyr7yh4UEfZcRRy3XMQvLvT",
        "RequestId": "c52aaa17-3f81-4640-be03-fca0a553d2e3"
    }
}

示例2 创建发起合同签署链接-模板发起（固定一个参与方）​

1.这是一个B2C的合同模板， 创建发起合同签署链接，只指定一个子企业的参与方 2.FlowApproverList参数指定的参与方不能更改， 未指定的参与方可以修改

输入示例​

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

{
    "Agent": {
        "AppId": "yDwhxUUckp3gl8j5UuFX33LSNozpRsbi",
        "ProxyOrganizationOpenId": "org_dianziqian",
        "ProxyOperator": {
            "OpenId": "zhansan"
        }
    },
    "ResourceId": "yDSL6UUckpo6ynynUx47m3cSKQavf88Q",
    "ResourceType": 1,
    "FlowInfo": {
        "FlowName": "2024典子谦入职合同",
        "FlowType": "入职合同",
        "FlowDescription": "2024典子谦入职合同",
        "Deadline": 1706335491
    },
    "FlowApproverList": [
        {
            "NotChannelOrganization": false,
            "ApproverType": 0,
            "OrganizationOpenId": "org_dianziqian",
            "OrganizationName": "典子谦示例企业",
            "OpenId": "n9527",
            "RecipientId": "yDSL6UUckpo6am9jUuRHYOWRfZbRAhm6"
        }
    ]
}

输出示例​

{
    "Response": {
        "PrepareFlowUrl": "https://embed.beta.qian.tencent.cn/contract-create?code=yDCNBUUckpvlzt0sUypjGZRCTkEHyRh6",
        "PreviewFlowUrl": "",
        "FlowId": "yDC54UUckpyr7yh4UEfZcRRy3XMQvLvT",
        "RequestId": "296e3cfb-504e-494d-a86c-75101a87c09e"
    }
}

示例3 创建发起合同签署链接-模板发起（固定所有的参与方）​

1.创建发起合同签署链接， 提前定义两个签署人， 分别是 B端渠道子客企业的员工和C端为张三这个自然人 2.FlowApproverList参数指定的参与方不能更改

输入示例​

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

{
    "ResourceId": "yDSL6UUckpo6ynynUx47m3cSKQavf88Q",
    "ResourceType": 1,
    "FlowInfo": {
        "FlowName": "典子谦入职合同(17:53:30)",
        "FlowType": "入职合同",
        "FlowDescription": "2024典子谦入职合同",
        "Deadline": 1701679610
    },
    "Agent": {
        "AppId": "yDwhxUUckp3gl8j5UuFX33LSNozpRsbi",
        "ProxyOrganizationOpenId": "org_dianziqian",
        "ProxyOperator": {
            "OpenId": "110101200610116558"
        }
    },
    "FlowApproverList": [
        {
            "NotChannelOrganization": false,
            "OrganizationOpenId": "org_dianziqian",
            "OrganizationName": "典子谦示例企业",
            "OpenId": "n131517",
            "RecipientId": "yDSL6UUckpo6am9jUuRHYOWRfZbRAhm6"
        },
        {
            "ApproverType": 1,
            "NotChannelOrganization": false,
            "ApproverName": "张三",
            "ApproverMobile": "1850000000",
            "RecipientId": "yDSL6UUckpo6am9qUuRHYOWwmX5rZGCX"
        }
    ]
}

输出示例​

{
    "Response": {
        "PrepareFlowUrl": "https://embed.beta.qian.tencent.cn/contract-create?embed=1&expiredOn=1700819911&code=yDSL6UUQEjIKK&businessId=yDSL6U3iY7&channel=PROXYCHANNEL&operateSource=byTemplate&themeId=channel_web_theme_yDwi3UAR2Yb",
        "PreviewFlowUrl": "",
        "FlowId": "yDC54UUckpyr7yh4UEfZcRRy3XMQvLvT",
        "RequestId": "c52aaa17-3f81-4640-be03-fca0a553d2e3"
    }
}

5. 错误码​

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

错误码描述
FailedOperation操作失败。
InvalidParameter.ComponentValue参数错误,控件内容无效。
InvalidParameter.ParamError参数错误。
InvalidParameterValue参数取值错误。
OperationDenied操作被拒绝。
OperationDenied.WhiteListForbid接口功能暂未开放，请联系客户经理申请白名单使用
ResourceNotFound资源不存在。
ResourceNotFound.Application应用号不存在。
ResourceNotFound.Organization机构不存在。
UnauthorizedOperation.NoPermissionFeature请升级到对应版本后即可使用该接口。
更多开发者交流反馈
购买咨询
微信客服
4006-808-062
4006-808-062