签署流程创建

接口地址 /v1/signflows

请求方式 POST

接口描述 创建签署流程

请求参数

参数名		说明	请求方式	是否必填	参数类型
autoArchive		是否自动归档，默认false 如设置为true，则在调用7.1.3签署流程开启后，当所有签署人签署完毕，系统自动将流程归档，状态变为“已完成”状态，在流程状态为“已完成”前，可随时添加签署人；如设置为false，则在调用7.1.3流程开启后，需主动调用签署流程归档接口，将流程状态变更为“已完成”，归档前可随时添加签署人；已完成的流程才可下载签署后的文件	body	false	boolean
businessScene		文件主题	body	TRUE	string
configInfo		任务配置信息	body	FALSE	流程配置
	noticeDeveloperUrl	回调通知地址 ,默认取项目配置通知地址	body	FALSE	string
	noticeType	通知方式，逗号分割，1-短信，2-邮件。默认值1，请务必请选择一个通知方式，否则客户将接收不到流程的签署通知和审批通知，如果流程需要审批，将导致审批无法完成；如果客户需要不通知，可以设置noticeType=""	body	FALSE	string
	redirectUrl	签署完成重定向地址,默认签署完成停在当前页面	body	FALSE	string
	signPlatform	签署平台，逗号分割，1-开放服务h5，2-支付宝签，默认值1	body	FALSE	string
contractValidity		文件有效截止日期,毫秒，默认不失效	body	FALSE	int64
contractRemind		文件到期前，提前多少小时回调提醒续签，小时（时间区间：1小时——15天），默认不提醒	body	FALSE	int32
signValidity		签署有效截止日期,毫秒，默认不失效	body	FALSE	int64
initiatorAccountId		发起人账户id，即发起本次签署的操作人个人账号id；如不传，默认由对接平台发起	body	FALSE	string
initiatorAuthorizedAccountId		发起方主体id，如存在个人代机构发起签约，则需传入机构id；如不传，则默认是对接平台	body	FALSE	string

请求示例

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

{
    "autoArchive":false,
    "businessScene":"合同名称",
    "configInfo":{
        "noticeDeveloperUrl":"http://127.0.0.1:9110/notice",
        "noticeType":"1,2",
        "redirectUrl":"http://127.0.0.1:8110/h5/forword",
        "signPlatform":"1"
    },
    "contractRemind":360,
    "contractValidity":1592386042000,
    "signValidity":1592386042000,
    "initiatorAccountId":"40eb61714d9e49088bac7a3c56d69d66",
    "initiatorAuthorizedAccountId":"40eb61714d9e49088bac7a3c56d69d66"
}

响应参数

参数名称	说明	类型
flowId	流程id	string

响应示例

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

错误码

错误码	错误信息	错误原因
1435102	查询项目开发者账户失败	项目无效或项目开发者oid不存在.
1437123	发起方账号不存在-XXXX	发起方账号无效
1437124	付费账号不存在-XXXX	付费方账号无效

签署流程创建

签署流程创建

results matching ""

No results matching ""