通过文件创建签署流程

1. 接口描述

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

接口（ChannelCreateFlowByFiles）用于通过文件创建签署流程。此接口静默签能力不可直接使用，请联系客户经理申请使用

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

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：ChannelCreateFlowByFiles。
Version	是	String	公共参数，本接口取值：2021-05-26。
Region	否	String	公共参数，此参数为可选参数。
Agent	否	Agent	应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 均必填。
FlowName	否	String	签署流程名称，长度不超过200个字符 示例值："xxx"
FlowDescription	否	String	签署流程的描述，长度不超过1000个字符 示例值："xxx"
FlowApprovers.N	否	Array of FlowApproverInfo	签署流程签约方列表，最多不超过50个参与方
FileIds.N	否	Array of String	签署文件资源Id列表，目前仅支持单个文件 示例值：["xxx"]
Components.N	否	Array of Component	签署文件中的发起方的填写控件，需要在发起的时候进行填充
Deadline	否	Integer	签署流程的签署截止时间。 值为unix时间戳,精确到秒,不传默认为当前时间一年后 不能早于当前时间 示例值：1691574041
CallbackUrl	否	String	签署流程回调地址，长度不超过255个字符 如果不传递回调地址， 则默认是配置应用号时候使用的回调地址 示例值："xxx"
Unordered	否	Boolean	合同签署顺序类型 true - 无序签, false - 顺序签， 默认为false，即有序签署。 有序签署时以传入FlowApprovers数组的顺序作为签署顺序 示例值：false
FlowType	否	String	签署流程的类型，长度不超过255个字符 示例值："xxx"
CustomShowMap	否	String	合同显示的页卡模板，说明：只支持{合同名称}, {发起方企业}, {发起方姓名}, {签署方N企业}, {签署方N姓名}，且N不能超过签署人的数量，N从1开始 示例值：合同名称:{合同名称} {发起方企业} {发起方姓名};国家:中国;发起方:{发起方企业};签署方1: {签署方1企业};签署
CustomerData	否	String	业务信息，最大长度1000个字符。 示例值："xxx"
NeedSignReview	否	Boolean	发起方企业的签署人进行签署操作是否需要企业内部审批。 若设置为true,审核结果需通过接口 ChannelCreateFlowSignReview 通知电子签，审核通过后，发起方企业签署人方可进行签署操作，否则会阻塞其签署操作。 注：企业可以通过此功能与企业内部的审批流程进行关联，支持手动、静默签署合同。
ApproverVerifyType	否	String	签署人校验方式 VerifyCheck: 人脸识别（默认） MobileCheck：手机号验证，用户手机号和参与方手机号（ApproverMobile）相同即可查看合同内容（当手写签名方式为OCR_ESIGN时，该校验方式无效，因为这种签名方式依赖实名认证） 参数说明：可选人脸识别或手机号验证两种方式，若选择后者，未实名个人签署方在签署合同时，无需经过实名认证和意愿确认两次人脸识别，该能力仅适用于个人签署方。
SignBeanTag	否	Integer	标识是否允许发起后添加控件。 0为不允许 1为允许。 如果为1，创建的时候不能有签署控件，只能创建后添加。注意发起后添加控件功能不支持添加骑缝章和签批控件 示例值：0
CcInfos.N	否	Array of CcInfo	被抄送人信息列表
CcNotifyType	否	Integer	给关注人发送短信通知的类型， 0-合同发起时通知 1-签署完成后通知
AutoSignScene	否	String	个人自动签场景。发起自动签署时，需设置对应自动签署场景，目前仅支持场景：处方单-E_PRESCRIPTION_AUTO_SIGN 示例值：E_PRESCRIPTION_AUTO_SIGN

3. 输出参数

参数名称	类型	描述
FlowId	String	合同签署流程ID 注意：此字段可能返回 null，表示取不到有效值。 示例值：xxx
Approvers	Array of ApproverItem	签署方信息，如角色ID、角色名称等 注意：此字段可能返回 null，表示取不到有效值。
RequestId	String	唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 使用文件创建签署流程

使用文件创建签署流程

输入示例

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

{
    "FlowName": "name",
    "Agent": {
        "ProxyOrganizationOpenId": "id",
        "ProxyOperator": {
            "OpenId": "id"
        },
        "AppId": "id"
    },
    "CustomShowMap": "合同名称:{合同名称} {发起方企业} {发起方姓名};国家:中国;发起方:{发起方企业};签署方1:  {签署方1企业};签署方2:  {签署方2企业}{签署方2姓名};签署方3:  {签署方3姓名}",
    "FlowApprovers": [
        {
            "OpenId": "id",
            "OrganizationName": "name",
            "Name": "name",
            "ApproverType": "type",
            "Mobile": "mobile",
            "OrganizationOpenId": "id",
            "SignComponents": [
                {
                    "ComponentRecipientId": "id",
                    "ComponentValue": "test",
                    "GenerateMode": "test",
                    "ComponentWidth": 0.0,
                    "FileIndex": 0,
                    "ComponentName": "test",
                    "ComponentDateFontSize": 0,
                    "ComponentExtra": "test",
                    "ComponentType": "test",
                    "ComponentPage": 1,
                    "ComponentDescription": "test",
                    "ComponentRequired": true,
                    "ComponentPosX": 0.0,
                    "ComponentPosY": 0.0,
                    "ComponentId": "test",
                    "DocumentId": "test",
                    "ComponentHeight": 0.0
                }
            ]
        }
    ],
    "Components": [
        {
            "ComponentRecipientId": "test",
            "ComponentValue": "test",
            "GenerateMode": "test",
            "ComponentWidth": 0.0,
            "FileIndex": 0,
            "ComponentName": "test",
            "ComponentDateFontSize": 0,
            "ComponentExtra": "test",
            "ComponentType": "test",
            "ComponentPage": 0,
            "ComponentDescription": "test",
            "ComponentRequired": true,
            "ComponentPosX": 0.0,
            "ComponentPosY": 0.0,
            "ComponentId": "test",
            "DocumentId": "test",
            "ComponentHeight": 0.0
        }
    ],
    "CallbackUrl": "test",
    "ApproverVerifyType": "VerifyCheck",
    "FileIds": [
        "test"
    ]
}

输出示例

{
    "Response": {
        "FlowId": "id",
        "RequestId": "id"
    }
}

5. 错误码

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

错误码	描述
FailedOperation	操作失败。
FailedOperation.AgeNotAchieveNormalLegal	签署人未达到合法年龄。
InternalError	内部错误。
InternalError.Db	数据库错误。
InternalError.DbConnection	数据库连接出错。
InternalError.Decryption	解密错误。
InternalError.Encryption	加密错误。
InternalError.GenerateId	生成唯一ID错误。
InternalError.Pdf	Pdf合成错误。
InternalError.System	系统错误。
InternalError.ThirdParty	第三方错误。
InvalidParameter	参数错误。
InvalidParameter.Application	应用号不存在。
InvalidParameter.ApproverType	参数错误，不合法的签署人类型，请修改后重试。
InvalidParameter.ApproverVerifyType	ApproverVerifyType参数值非法
InvalidParameter.BizApproverAlreadyExists	重复添加签署人。
InvalidParameter.CardType	证件类型错误。
InvalidParameter.ComponentValue	参数错误,控件内容无效。
InvalidParameter.CustomShowMap	参数错误，无效的自定义页卡模板，仅支持{合同名称}{发起方姓名}{发起方企业}{签署方N姓名}{签署方N企业}，请修改后重试。
InvalidParameter.CustomerData	参数错误，UserData长度非法，请修改后重试。
InvalidParameter.DataNotFound	数据不存在。
InvalidParameter.FlowApproverInfos	参数错误，不合法的备选签署人数量，请检查后重试。
InvalidParameter.FlowApprovers	参数错误，参与者数量不能为空且不能超过数量限制，请修改后重试。
InvalidParameter.FlowCallbackUrl	参数错误，不合法的签署流程回调链接，请修改后重试。
InvalidParameter.FlowDeadLine	参数错误，不合法的签署流程截止日期，请修改后重试。
InvalidParameter.FlowDescription	参数错误，不合法的签署流程描述，请修改后重试。
InvalidParameter.FlowFileIds	参数错误，目前仅支持单个文件发起，请修改后重试。
InvalidParameter.FlowName	参数错误，不合法的签署流程名称，请修改后重试。
InvalidParameter.FlowType	参数错误，不合法的FlowType，请修改后重试。
InvalidParameter.Mobile	手机号码不正确。
InvalidParameter.Name	姓名不符合要求。
InvalidParameter.NonsupportMobile	不支持的手机号。
InvalidParameter.OrganizationName	企业名称不合法。
InvalidParameter.ParamError	参数错误。
InvalidParameter.SignComponentType	参数错误，不合法的签署控件类型，请修改后重试。
InvalidParameter.SignComponents	类型不支持。
InvalidParameter.Unordered	参数错误，不合法的签署顺序，请检查后重试。
InvalidParameter.UnsupportedComponentType	参数错误，不支持的控件类型，请检查后重试。
InvalidParameterValue	参数取值错误。
LimitExceeded	超过配额限制。
MissingParameter	缺少参数错误。
MissingParameter.MissComponentName	缺少控件名称参数，请检查后重试。
MissingParameter.SealId	印章ID为空。
MissingParameter.SignComponents	签署人缺少签署控件。
OperationDenied	操作被拒绝。
OperationDenied.ByFilesServerSignForbid	文件发起静默签未开通白名单。
OperationDenied.ErrNoResourceAccess	无资源访问权限。
OperationDenied.InvalidApproverAge	签署人未达到合法年龄。
OperationDenied.NoApproverMobileCheckPermission	企业暂未开通手机号验证身份的服务，请在企业中心开通再使用
OperationDenied.NoIdentityVerify	未通过个人实名。
OperationDenied.NoQuota	流程配额不足。
OperationDenied.OverseaAbilityNotOpen	当前企业员工没有开通境外签署能力。
OperationDenied.PersonNoOpenServerSign	该用户已关闭或者未开启自动签服务
OperationDenied.RequiredComponentNotFill	必填控件未填
OperationDenied.UserNotInOrganization	用户不归属于当前企业，无法操作，请检查后重试。
ResourceNotFound	资源不存在。
ResourceNotFound.Application	应用号不存在。
ResourceNotFound.Resource	资源不存在。
ResourceNotFound.Seal	印章不存在，请检查后重试。
ResourceNotFound.User	用户信息不存在。
ResourceUnavailable	资源不可用。
UnauthorizedOperation.NoPermissionFeature	请升级到对应版本后即可使用该接口。