使用信封模版发起签署

POST /esignglobal/v1/envelopeTemplates/sendEnvelope

接口描述

使用在页面端预配置好的“信封模板”发起签署。

请求参数

参数名称				类型	必填	说明
envelopeTemplateId				string	true	信封模板id
envelopeConfig				object	true	签署流程配置
	contractConfig			boolean	false	合同签署配置
		envelopeRemark		array	false	合同备注
	envelopeSubject			string	true	本次签署流程的主题
	expireAfterSeconds			int	false	本次签署流程的签署截止时间，超过该时间不可再进行签署，Unix时间戳毫秒级，默认和最大有效期90天
	callbackUrl			string	false	接收回调通知的Web地址
	redirectUrl			string	false	需为有效的https地址
	signConfig			object	false	签署配置项
		allowTransfer		boolean	false	是否允许签署人将该信封转交给其他人签署，默认false true-允许信封中的签署人拥有信封转交他人的权力； false-不允许信封中的签署人拥有信封转交他人的权力；
participants				array	false	参与人配置
	participantId			string	true	参与方ID
	authConfig			object	false	认证配置项
		willingnessAuthModes		array	false	签署人可选意愿方式，默认noAuth noAuth-不验证 accessCode-使用签署口令验证 sms-SMS OTP 验证 idVerification-身份证件验证 emailAuth-邮箱OTP验证 digitalId-电子身份验证 whatsappAuth-whatsapp OTP验证
		accessCode		object	false	签署口令设置，当authModes=accessCode时必填
			accessCode	string	false	口令内容，不区分大小写，可以包含字母数字，长度限制45
			promptInfo	string	false	访问口令提示信息，不可以包含访问口令，长度限制30，当authModes=1时必填。
		sms		object	false	SMS OTP校验，当authModes=sms时必填
			countryCode	string	false	国家地区的国际码，无需传入“+”
			number	string	false	不做格式校验，仅限制长度最大为13位
		idVerification		object	false	身份证件验证设置，当authModes=idVerification时必填
			name	string	false	签署人身份证件上的姓名全称，最大长度100个字符
		emailAuth		object	false	邮箱OTP校验，当authModes=emailAuth时必填
			authEmail	string	false	签署人身份验证邮箱地址
		digitalId		array	false	电子身份验证，当authModes=digitalId时必填
			authApp	string	false	电子身份验证使用的APP singpass-使用Singpass进行身份认证 iamsmart-使用智方便进行身份认证
			idNumber	string	false	签署人待验证的身份证件号码
		whatsappAuth		object	false	whatsapp OTP校验，当authModes=whatsappAuth时必填
			countryCode	string	false	国家地区的国际码，无需传入“+”
			number	string	false	不做格式校验，仅限制长度最大为13位
	participantInfos			object	false	个人参与方
		userEmail		string	false	签署人邮箱
		phoneNumber		object	false	电话号码，默认为空当需要进行短信通知时为必填参数，countryCode与number都需要传入
			countryCode	string	false	国家地区的国际码，无需传入“+”
			number	string	false	无格式校验，仅限制长度最大为13位
		userName		string	false	个人姓名
		deliveryMethod		string	false	通知方式 none-不发送消息通知 email-发送邮件通知 sms-发送短信通知 WhatsApp-发送WhatsApp通知
		customizeSettings		object	false	自定义配置
			customizeMessage	object	false	通知类自定义配置
			notificationLanguage	string	false	通知语言，默认为英语 en-US 英语 zh-CN 简体中文 zh-Hant 繁体中文 ja 日语 ES-MX 西班牙语
copiers				array	false	添加抄送方
	copierId			string	true	参与方ID
	CCInfos			object	false	抄送方信息
		userEmail		string	false	邮箱
		userName		string	false	个人姓名
		customizeSettings		object	false	自定义配置
			customizeMessage	object	false	通知类自定义配置
			notificationLanguage	string	false	通知语言，默认为英语 en-US 英语 zh-CN 简体中文 zh-Hant 繁体中文 ja 日语 ES-MX 西班牙语
attchments				array	false	添加附件（无需签名的文件）信息
	documentId			string	false	附件文件ID
	fileName			string	false	附件文件名称
components				array	false	控件列表
	documentId			string	false	控件所属文件ID
	componentId			string	false	控件id
	componentKey			string	false	控件key，（控件id和控件key二选一）
	componentValue			string	false	控件填充值
	editComponentValue			boolean	false	控制该控件的签署方是否可修改预填内容，默认为true true-签署人可修改预填值 false-有预填值时锁定为只读，签署人不可修改

请求示例

{
  "envelopeTemplateId": "dc4be9641a3145b****9018d7a9180",
  "envelopeConfig": {
    "envelopeSubject": "*****"
  },
  "participants": [
    {
      "participantId": "42750b92c7a34******34dd5342",
      "participantInfos": {
        "userEmail": "***",
        "userName": "Preset Signer"
      }
    }
  ],
  "copiers": [],
  "attachments": [],
  "components": [
    {
      "componentValue": "AutoTextValue",
      "documentId": "d559142***2c3b02c3b5c663aa146",
      "componentId": "30c616512991***d68ab930210c",
    },
    {
      "componentValue": "AutoTextValue",
      "documentId": "d559142672c74***2c3b5c663aa146",
      "componentId": "a130c54c1472444f***6c6e83a2f540"
    },
    {
      "componentValue": "123.4444",
      "documentId": "d559142672c***b02c3b5c663aa146",
      "componentId": "42b76dfbf15e4cf1***a409159c35"
    },
    {
      "componentValue": "0",
      "documentId": "d559142672c7***3b02c3b5c663aa146",
      "componentId": "556b60f7bd32442***3bbec8c54"
    },
    {
      "componentValue": "AutoTextValue",
      "documentId": "d559142672c742c***b5c663aa146",
      "componentId": "7929410bb8754***497d6df30cb2"
    },
    {
      "componentValue": "AutoTextValue",
      "documentId": "d559142672c742c3***c663aa146",
      "componentId": "9e92a77b50b24cd***f6ade4b7d9"
    },
    {
      "componentValue": "123",
      "documentId": "d559142672c7402c3***b5c663aa146",
      "componentId": "9600135a35fb4ff***4ce42b6af"
    },
    {
      "componentValue": "0,1",
      "documentId": "d559142672c742c***b5c663aa146",
      "componentId": "d41cea8f288e***4c18c0289a"
    },
    {
      "componentValue": "1",
      "documentId": "d559142672c***b02c3b5c663aa146",
      "componentId": "9edab2c19***08b3c2dcc2d1a78171"
    },
    {
      "componentValue": "0",
      "documentId": "d559142672c74***c3b5c663aa146",
      "componentId": "4a6136cd81c54***01c113fcd30"
    },
    {
      "componentValue": "***",
      "documentId": "d559142672c7***02c3b5c663aa146",
      "componentId": "73d836894fb34***fb90fcd813"
    },
    {
      "componentValue": "***",
      "documentId": "d5591426***b02c3b5c663aa146",
      "componentId": "4e22fe4be9314a8***81d5354b51da4"
    }
  ]
}

响应参数

参数名称	类型	说明
envelopeId	string	信封ID

响应示例

{
  "code": "0",
  "data": {
    "envelopeId": "4e2eb9cc95044a7****a9a81f76397"
  },
  "message": "SUCCESS"
}