创建签署流程（旧）

文档变更

2022年时，签署流程创建变为创建签署流程（旧），以便开发者更容易理解，仅中文名称变更，其功能保持不变。

接口描述

创建签署流程，一个签署流程目前最多只支持添加300个签署区

注：

（1）一个签署流程目前最多只支持添加300个签署区

（2）因Windows操作系统中文件名称不支持个别特殊字符，现调整businessScene、attachmentName、fileName字段不支持以下9个字符/ \ : * " < > | ？以及所有emoji表情，详见文件名称特殊字符限制

接口地址&请求方式

接口地址：/v2/signflows

请求方式：POST

请求头格式

具体请求头格式结构，请点击查看公共参数说明。

请求参数

展开全部参数参数名称			类型	必选	参数类型	参数说明（左右拖动查看完整描述）
autoArchive			boolean	否	body	全部签章后流程自动完结，默认false。 true - 自动完结 false - 非自动完结如设置为true，则在调用开启签署流程后，当所有签署人签署完毕，系统自动将流程归档，状态变为“已完成”状态；如设置为false，则在调用开启签署流程后，需主动调用【完结签署流程】接口，将流程状态变更为“已完成”；已完成的流程才可下载签署后的文件
businessScene			string	是	body	本次签署流程的文件主题名称注：名称不支持以下9个字符：/ \ : * " < > \| ？
flowConfigInfo			object	否	body	本次签署流程的任务信息配置
	identificationConfig		object	否	body	认证配置项
		personAvailableAuthTypes	list	否	body	个人页面显示实名认证方式 PSN_BANK4_AUTHCODE 个人银行卡四要素认证 PSN_TELECOM_AUTHCODE 个人运营商三要素认证 PSN_FACEAUTH_BYURL 个人刷脸认证注：支持多种可选认证方式，中间用英文逗号分隔
		personAuthAdvancedEnabled	list	否	body	指定通过银行卡认证或运营商认证方式时，是否使用详情版，如指定则核验失败可返回具体不匹配信息，传空默认为普通版。 PSN_BANK4_AUTHCODE 个人银行卡四要素认证 PSN_TELECOM_AUTHCODE 个人运营商三要素认证注：详情版，需要单独购买，具体购买方式请咨询e签宝工作人员普通版，信息比对核验失败，不会返回具体的不匹配信息
orgAvailableAuthTypes		list	否	body	企业页面显示实名认证方式 ORG_BANK_TRANSFER 组织机构对公账户打款认证 ORG_ZM_AUTHORIZE 企业芝麻认证ORG_LEGAL_AUTHORIZE 组织机构法定代表人授权书签署认证
willTypes		list	否	body	页面指定意愿认证方式，可指定类型如下： CODE_SMS 短信验证码 FACE_ZHIMA_XY 支付宝刷脸 FACE_TECENT_CLOUD_H5 腾讯云刷脸 FACE_FACE_LIVENESS_RECOGNITION e签宝刷脸以下三种方式需联系交付顾问开通后方可使用： FACE_WE_CHAT_FACE 微信小程序刷脸 FACE_AUDIO_VIDEO_DUAL 支付宝智能视频认证 VIDEO_WE_CHAT_VIDEO_DUAL 微信智能视频认证
faceVideoTemplate		string	否	body	视频认证模板id，请联系交付提供
notifyConfig		object	否	body	通知配置项
	noticeDeveloperUrl	string	否	body	通知开发者地址。（e签宝服务器主动通过POST方式通知开发者指定服务器的页面路径（http/https））通知说明见【通知回调】模块
	noticeType	string	否	body	签署通知方式，默认方式：1。同时支持多种通知方式，用逗号分割。 1-短信,2-邮件。（如果套餐内带“分项”字样，请确保开通【电子签名流量费（分项）认证】中的子项：【短信服务】，否则短信通知收不到）注：（1）短信或者邮件中的签署链接，有效期为30天；如客户不需要通知，请设置noticeType="" 详细规则【请点击】（2）短信或邮件中的签署链接依然需要登录框。
signConfig		object	否	body	签署配置项
	redirectUrl	string	否	body	签署完成后，重定向跳转地址（http/https）。
	signPlatform	string	否	body	签署平台，默认值1,2。可选择多种签署平台，逗号分割。 1-H5网页版方式进行签署； 2-跳转支付宝(移动端)或支付宝扫码进行签署(PC端)。
	batchDropSeal	boolean	否	body	签署页是否显示“一键落章”按钮，默认显示。关闭显示 - false 显示 - true
	countdown	int32	否	body	签署页提交倒计时，单位为秒，不传默认为0，最大999
	redirectDelayTime	int	否	body	签署完成重定向跳转延迟时间，默认3。 0-不展示签署完成结果页，签署完成直接跳转重定向地址 3-展示签署完成结果页，倒计时3秒后，自动跳转重定向地址注：当redirectUrl不传的情况下，该字段无需传入，默认签署完成结果页不跳转
	mobileShieldWay	string	否	body	是否使用e签盾签署，默认为1. 1-不使用e签盾； 2-使用e签盾注：使用e签盾签署后，签署平台默认提示跳转e签宝app进行签署更新日志：点此了解
contractValidity			int64	否	body	文件有效截止日期,毫秒，默认不失效; 该参数设置的时间若到期，则会触发【流程文件过期通知】
contractRemind			int32	否	body	文件到期前，提前多少小时回调提醒续签，小时（时间区间：1小时——15天），默认不提醒；该参数设置的时间若到期，则会触发【流程文件过期前提醒通知】
signValidity			int64	否	body	签署有效截止日期,毫秒，默认不失效；注：超过签署有效截止时间，则无法继续签署。若该参数设置的时间到期，则会触发【流程结束回调通知】

响应参数

展开全部参数参数名称		类型	必选	参数说明
code		int	是	业务码，0表示成功
message		string	否	业务信息
data		object	否	业务数据
	flowId	string	是	签署流程ID

请求示例

POST https://openapi.esign.cn/v2/signflows

{
    "autoArchive": false,
    "businessScene": "234567",
    "flowConfigInfo": {
        "identificationConfig": {
            "faceVideoTemplate": "",
            "orgAvailableAuthTypes": [
                "ORG_BANK_TRANSFER"
            ],
            "personAuthAdvancedEnabled": [
                "PSN_FACEAUTH_BYURL"
            ],
            "personAvailableAuthTypes": [],
            "willTypes": [
                "FACE_ZHIMA_XY",
                "FACE_TECENT_CLOUD_H5"
            ]
        },
        "notifyConfig": {
            "noticeDeveloperUrl": "http://xx.xx.1.1/notify",
            "noticeType": ""
        },
        "signConfig": {
            "batchDropSeal": true,
            "countdown": 0,
            "mobileShieldWay": 1,
            "redirectDelayTime": 0,
            "redirectUrl": "https://www.xxx.cn/",
            "signPlatform": "1"
        }
    }
}

响应示例

{
    "code":0,
    "message":"成功",
    "data":{
        "flowId":"429b1d3038854cabbcdac0a63d7e4c0d"
    }
}