通过流程模板创建合同拟定和签署流程

接口描述

使用signTemplateId（流程模板ID）发起合同的拟定（用户填写）和签署流程

接口地址&请求方法

点击下述蓝色字体{host}可跳转至API请求域名说明文档

接口地址：https://{host}/v3/sign-flow/create-by-sign-template

请求方法：POST

请求头格式

具体请求头参数，请查看公共请求头格式。

请求参数

展开全部参数参数名称（点击左侧“+”一键展开参数）					参数类型	必选	参数位置	参数说明（请左右滑动查看完整描述）
signTemplateId					string	是	body	流程模板ID
signFlowInitiator（点击“+”展开详情）					object	否	body	发起方信息（指在平台中发起合同签约的一方，合同的归属方，有权限查看签署的文件，签署通知中展示：“XXX 通知您签署... ”中的XXX即为发起方名字。）发起方企业必须和流程模板ID的拥有企业一致，否则会报错：“流程模板拥有者不匹配”。不传则默认为应用ID所属的企业来发起签署流程。当指定发起方为非应用ID所属企业时，需先经过【用户授权】（代个人/企业用户发起合同签署权限）。
	orgId				string	否	body	机构账号ID 【注】用户在e签宝注册实名后才有账号ID，账号ID获取方式请使用【查询机构认证信息】接口通过组织机构名称/组织机构证件号进行查询
	transactor				object	否	body	机构发起方的经办人【注】模板参与方设置的发起人本人时，必须在这里指定发起方经办人
	psnId			string	否	body	经办人账号ID 【注】用户在e签宝注册实名后才有账号ID，账号ID获取方式请使用【查询个人认证信息】接口通过个人账号标识（手机号或邮箱）/个人用户的证件号进行查询
signFlowConfig（点击“+”展开详情）					object	是	body	签署流程配置项
	signFlowTitle				string	是	body	签署任务主题【注】主题名称不可含有以下9个特殊字符：/ \ : * " < > \| ？以及所有emoji表情
	signFlowExpireTime				int64	否	body	签署截止时间（将展示在发起页面中，页面默认允许用户修改截止时间）【注】Unix时间戳格式（单位：毫秒），默认在签署流程创建后的90天时截止
	autoStart				boolean	否	body	合同拟定完成后是否自动开启签署流程，默认值 true true - 自动开启 false - 非自动开启【注】如果有内部审批等流程需要确认填写内容是否正确，可以设置为非自动开启签署
	autoFinish				boolean	否	body	所有签署方签署完成后签署流程自动完结，默认值 false true - 自动完结 false - 非自动完结，需调用【完结签署流程】接口完结【注】设置了自动完结的流程中不允许再追加签署区、抄送方，点击这里了解更多签署流程状态说明。
	notifyUrl				string	否	body	接收相关回调通知的Web地址，详见【流程模板回调通知接收说明】、【签署回调通知接收说明】
	signConfig				object	否	body	签署配置项
		availableSignClientTypes			string	否	body	签署终端类型，默认值1和2（英文逗号分隔） 1 - 网页（自适配H5/PC样式），2 - 支付宝【注】如果是开发者自己的app或者支付宝小程序等端内嵌e签宝H5/PC，需要传：1（网页端）
		autoFillAndSubmit			boolean	否	body	若参与方需要填写的必填内容已经预填写完成（即控件均已传入预填值），是否自动跳过该参与方的填写步骤，默认值：false true - 是（自动跳过） false - 否（仍需手动提交）【注】参与方控件必须全部填写完成才能跳过
		editComponentValue			boolean	否	body	用户填写页面是否可以修改系统预填内容，默认值：true true - 可修改 false - 不可修改
noticeConfig				object	否	body	流程整体通知配置项
	noticeTypes			string	否	body	通知类型，通知发起方、签署方、抄送方，默认不通知（值为""空字符串），允许多种通知方式，请使用英文逗号分隔传空 - 不通知（默认值） 1 - 短信通知（如果套餐内带“分项”字样，请确保开通【电子签名流量费（分项）认证】中的子项：【短信服务】，否则短信通知收不到） 2 - 邮件通知【注】个人账号中需要绑定短信/邮件才有对应的通知方式。需要绑定短信/邮件才有对应的通知方式。
	examineNotice			boolean	否	body	通知给企业印章用印审批人员的通知类型，按照账号中的手机号或邮箱的填写情况进行通知。 true - 发送消息（短信+邮件+e签宝官网站内信）（如果套餐内带“分项”字样，请确保开通【电子签名流量费（分项）认证】中的子项：【短信服务】，否则短信通知收不到） false - 不发送消息【注】不传值默认取noticeTypes配置的通知方式
authConfig				object	否	body	流程整体认证配置项
	psnAvailableAuthModes			list	否	body	个人实名认证方式，可选值： PSN_MOBILE3 - 个人运营商三要素认证 PSN_FACE - 刷脸认证 PSN_BANKCARD4 - 个人银行卡四要素认证
	orgAvailableAuthModes			list	否	body	机构实名认证方式，可选值： ORG_BANK_TRANSFER - 组织机构对公账户打款认证 ORG_ALIPAY_CREDIT - 企业支付宝认证 ORG_LEGALREP_AUTHORIZATION - 组织机构授权委托书认证 ORG_LEGALREP - 法定代表人本人认证
contractConfig				boolean	否	body	合同相关配置项
	allowToRescind			boolean	否	body	该签署流程是否允许发起解约，默认true true - 允许 false - 不允许
participants（点击“+”展开详情）					array	否	body	参与方信息如果模板设置页面的参与方配置为：使用模板时指定，则此参数必传，需要用【查询流程模板详情】接口查询参与方ID相关信息进行参与方绑定。如果模板设置页面的参与方配置为：固定成员和发起人本人时，则此参数不要指定，否则接口会报错。
	participantId				string	是	body	参与方ID 补充说明：需要用【查询流程模板详情】接口查询参与方ID 通过参与方ID绑定下述参与方，绑定企业传企业参与方，绑定个人传个人参与方
	orgParticipant				object	否	body	企业参与方
		orgId			string	否	body	企业ID 【注】 orgName与orgId二选一传值用户在e签宝注册实名后才有账号ID，账号ID获取方式请使用【查询机构认证信息】接口通过组织机构名称/组织机构证件号进行查询
orgName			string	否	body	企业名称【注】orgName与orgId二选一传值
transactor			object	否	body	企业参与方经办人
		transactorPsnId		string	否	body	经办人个人ID 【注】当传入orgId时，transactorPsnId必传，transactorPsnAccount和transactorName不能传用户在e签宝注册实名后才有账号ID，账号ID获取方式请使用【查询个人认证信息】接口通过个人账号标识（手机号或邮箱）/个人用户的证件号进行查询
		transactorPsnAccount		string	否	body	经办人手机号/邮箱【注】当传入orgName时，transactorPsnAccount、transactorName必传，transactorPsnId不能传
	transactorName		string	否	body	经办人姓名
psnParticipant				object	否	body	个人参与方
	psnId			string	否	body	个人ID 【注】 psnAccount与psnId二选一传值用户在e签宝注册实名后才有账号ID，账号ID获取方式请使用【查询个人认证信息】接口通过个人账号标识（手机号或邮箱）/个人用户的证件号进行查询
	psnAccount			string	否	body	个人手机号/邮箱【注】psnAccount与psnId二选一传值
	psnName			string	否	body	个人姓名【注】当传入psnAccount时，psnName必传；当传入psnId时，psnName不能传。
addCopiers					array	否	body	添加抄送方支持场景：①抄送给个人 ②抄送给企业的接收人
	copierPsnInfo				object	否	body	个人抄送方信息
		psnId			string	否	body	个人抄送方ID（若已知用户的psnId，请传此参数）
psnAccount			string	否	body	个人抄送方账号，手机号或邮箱（若未知用户的psnId，请传此参数）
psnName			string	否	body	个人抄送方姓名（若未知用户的psnId，请传此参数）
copierOrgInfo				object	否	body	机构抄送方信息
		orgId			string	否	body	机构抄送方ID（若已知机构的orgId，请传此参数）
		orgName			string	否	body	机构抄送方名称（若未知机构的orgId，请传此参数）
addAttachments（点击“+”展开详情）					array	否	body	添加合同附件信息（指无需签名的文件，仅用于查看）通过接口预设置的合同附件，发起签署页面仅限预览，无法修改删除
	fileId				string	否	body	合同附件的文件ID 【注】附件上传接口：上传本地文件
	fileName				string	否	body	合同附件名称【注】名称不可含有以下9个特殊字符：/ \ : * " < > \| ？以及所有emoji表情
components（点击“+”展开详情）					array	否	body	控件列表【注】用于模板控件的开发者预填内容
	fileId				string	否	body	控件所属文件ID 【注】可以用【查询流程模板详情】接口查询控件所属的文件ID
	componentId				string	否	body	控件ID（控件ID和控件key二选一）
	componentKey				string	否	body	控件key（控件ID和控件key二选一）
	componentValue				string	否	body	控件填充值【注】不同类型的控件填充值示例：请点击跳转

响应参数

展开全部参数参数名称		参数类型	必选	参数说明
code		int32	是	业务码，0表示成功，非0表示异常。
message		string	否	业务信息请根据 code 来判断错误情况，不应该依赖 message匹配，因为 message 可能会调整。
data（点击“+”展开详情）		object	否	业务数据
	signFlowId	string	否	签署流程ID

请求示例

{
  "signTemplateId": "请传入流程模板ID：11***087ee0",
  "signFlowConfig": {
    "signFlowTitle": "请传入本次签署任务的主题",
    "autoFinish": true,
    "autoStart": true,
    "noticeConfig": {
      "noticeTypes": "1"
    },
    "notifyUrl": "请传入回调通知推送地址（http或者https开头）：http://xx.xx.xx/notify",
    "signConfig": {
      "availableSignClientTypes": "1",
      "autoFillAndSubmit": true,
      "editComponentValue": false
    },
    "authConfig": {
      "psnAvailableAuthModes": [
        "PSN_MOBILE3",
        "PSN_FACE",
        "PSN_BANKCARD4"
      ],
      "orgAvailableAuthModes": [
        "ORG_BANK_TRANSFER",
        "ORG_LEGALREP",
        "ORG_LEGALREP_AUTHORIZATION",
        "ORG_ALIPAY_CREDIT"
      ]
    }
  },
  "participants": [
    {
      "participantId": "签署方是使用模板时指定必须传，通过【查询流程模板详情】接口查询参与方ID：7f***debe8fa",
      "orgParticipant": {
        "orgName": "企业签署方的企业名称：***有限公司",
        "transactor": {
          "transactorPsnAccount": "经办人联系方式：153***1110",
          "transactorName": "经办人姓名：张三"
        }
      }
    },
    {
      "participantId": "签署方是使用模板时指定必须传，通过【查询流程模板详情】接口查询参与方ID：1e9211****6",
      "psnParticipant": {
        "psnAccount": "个人签署方的联系方式：139****3333",
        "psnName": "个人姓名：李四"
      }
    }
  ],
  "components": [
    {
      "fileId": "通过【查询流程模板详情】接口查询文件底稿ID：b68a****12fg",
      "componentId": "dfdb9d7b84ba111112dd922ded7",
      "componentValue": "填充值001"
    },
    {
      "fileId": "通过【查询流程模板详情】接口查询文件底稿ID：b68a****12fg",
      "componentId": "27312dd3f0911111e581a18dba34",
      "componentValue": "填充值002"
    },
    {
      "fileId": "通过【查询流程模板详情】接口查询文件底稿ID：b68a****12fg",
      "componentId": "0a1fca39cbb1111f8f4c56c1a80c48",
      "componentValue": "填充值003"
    }
  ]
}

响应示例

{
    "code": 0,
    "message": "成功",
    "data": {
        "signFlowId": "ae87ca*******0d3e25d"
    }
}

流程模板签署服务API

通过流程模板创建合同拟定和签署流程

接口描述

接口地址&请求方法

请求头格式

请求参数

响应参数

请求示例

响应示例