使用信封模版發起簽署

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"
}