Sử dụng mẫu phong bì để khởi tạo ký kết

POST /esignglobal/v1/envelopeTemplates/sendEnvelope

Mô tả giao diện

Sử dụng "mẫu phong bì" đã được cấu hình sẵn ở phía trang để khởi tạo ký kết.

Tham số yêu cầu

Tên tham số				Kiểu	Bắt buộc	Mô tả
envelopeTemplateId				string	true	ID mẫu phong bì
envelopeConfig				object	true	Cấu hình quy trình ký kết
	contractConfig			boolean	false	Cấu hình ký kết hợp đồng
		envelopeRemark		array	false	Ghi chú hợp đồng
	envelopeSubject			string	true	Chủ đề của quy trình ký kết này
	expireAfterSeconds			int	false	Thời hạn cuối cùng để ký kết cho quy trình này, sau thời gian này không thể tiếp tục ký kết, dấu thời gian Unix tính bằng mili giây, giá trị mặc định và tối đa là 90 ngày
	callbackUrl			string	false	Địa chỉ Web nhận thông báo gọi lại
	redirectUrl			string	false	Phải là địa chỉ https hợp lệ
	signConfig			object	false	Cấu hình ký
		allowTransfer		boolean	false	Có cho phép người ký chuyển phong bì này cho người khác ký hay không, mặc định là false true-Cho phép người ký trong phong bì có quyền chuyển giao phong bì cho người khác; false-Không cho phép người ký trong phong bì có quyền chuyển giao phong bì cho người khác;
participants				array	false	Cấu hình người tham gia
	participantId			string	true	ID bên tham gia
	authConfig			object	false	Cấu hình xác thực
		willingnessAuthModes		array	false	Phương thức xác nhận ý chí tùy chọn của người ký, mặc định noAuth noAuth-Không xác thực accessCode-Xác thực bằng mật khẩu ký sms-Xác thực OTP qua SMS idVerification-Xác thực giấy tờ tùy thân emailAuth-Xác thực OTP qua email digitalId-Xác thực danh tính điện tử whatsappAuth-Xác thực OTP qua WhatsApp
		accessCode		object	false	Cài đặt mật khẩu ký, bắt buộc khi authModes=accessCode
			accessCode	string	false	Nội dung mật khẩu, không phân biệt chữ hoa thường, có thể chứa chữ cái và số, giới hạn độ dài 45
			promptInfo	string	false	Thông báo nhắc nhở mật khẩu truy cập, không được chứa mật khẩu truy cập, giới hạn độ dài 30, bắt buộc khi authModes=1.
		sms		object	false	Xác thực OTP qua SMS, bắt buộc khi authModes=sms
			countryCode	string	false	Mã quốc tế của quốc gia/khu vực, không cần truyền dấu '+'
			number	string	false	Không kiểm tra định dạng, chỉ giới hạn độ dài tối đa 13 ký tự
		idVerification		object	false	Cài đặt xác minh giấy tờ tùy thân, bắt buộc khi authModes=idVerification
			name	string	false	Tên đầy đủ trên giấy tờ tùy thân của người ký, độ dài tối đa 100 ký tự
		emailAuth		object	false	Xác thực OTP qua email, bắt buộc khi authModes=emailAuth
			authEmail	string	false	Địa chỉ email xác thực danh tính của người ký
		digitalId		array	false	Xác thực danh tính điện tử, bắt buộc khi authModes=digitalId
			authApp	string	false	Ứng dụng APP dùng cho xác thực danh tính điện tử singpass-Xác thực danh tính bằng Singpass iamsmart-Xác thực danh tính bằng SmartID
			idNumber	string	false	Số giấy tờ tùy thân của người ký cần xác thực
		whatsappAuth		object	false	Xác thực OTP WhatsApp, bắt buộc khi authModes=whatsappAuth
			countryCode	string	false	Mã quốc gia/khu vực, không cần truyền dấu "+"
			number	string	false	Không kiểm tra định dạng, chỉ giới hạn độ dài tối đa 13 ký tự
	participantInfos			object	false	Cá nhân tham gia
		userEmail		string	false	Email của người ký
		phoneNumber		object	false	Số điện thoại, mặc định để trống Tham số bắt buộc khi cần thông báo tin nhắn SMS, cần truyền cả countryCode và number
			countryCode	string	false	Mã quốc gia/khu vực, không cần truyền dấu "+"
			number	string	false	Không kiểm tra định dạng, chỉ giới hạn độ dài tối đa 13 ký tự
		userName		string	false	Tên cá nhân
		deliveryMethod		string	false	Phương thức thông báo none-Không gửi thông báo tin nhắn email-Gửi thông báo qua email sms-Gửi thông báo qua tin nhắn SMS WhatsApp-Gửi thông báo qua WhatsApp
		customizeSettings		object	false	Cấu hình tùy chỉnh
			customizeMessage	object	false	Cấu hình tùy chỉnh loại thông báo
			notificationLanguage	string	false	Ngôn ngữ thông báo, mặc định là tiếng Anh en-US Tiếng Anh zh-CN Tiếng Trung giản thể zh-Hant Tiếng Trung phồn thể ja Tiếng Nhật ES-MX Tiếng Tây Ban Nha
copiers				array	false	Thêm người nhận sao chép
	copierId			string	true	ID bên tham gia
	CCInfos			object	false	Thông tin người nhận sao chép
		userEmail		string	false	Email
		userName		string	false	Tên cá nhân
		customizeSettings		object	false	Cấu hình tùy chỉnh
			customizeMessage	object	false	Cấu hình tùy chỉnh loại thông báo
			notificationLanguage	string	false	Ngôn ngữ thông báo, mặc định là tiếng Anh en-US Tiếng Anh zh-CN Tiếng Trung giản thể zh-Hant Tiếng Trung phồn thể ja Tiếng Nhật ES-MX Tiếng Tây Ban Nha
attchments				array	false	Thông tin thêm tệp đính kèm (tệp không cần chữ ký)
	documentId			string	false	ID tệp đính kèm
	fileName			string	false	Tên tệp đính kèm
components				array	false	Danh sách thành phần điều khiển
	documentId			string	false	ID tệp chứa thành phần điều khiển
	componentId			string	false	ID thành phần điều khiển
	componentKey			string	false	key của thành phần điều khiển, (chọn một trong hai: ID hoặc key của thành phần điều khiển)
	componentValue			string	false	Giá trị điền vào thành phần điều khiển
	editComponentValue			boolean	false	Quy định xem bên ký của thành phần điều khiển này có được phép sửa đổi nội dung điền sẵn hay không, mặc định là true true-Người ký có thể sửa giá trị điền sẵn false-Khi có giá trị điền sẵn, khóa ở chế độ chỉ đọc, người ký không thể sửa

Ví dụ yêu cầu

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

Tham số phản hồi

Tên tham số	Kiểu	Mô tả
envelopeId	string	ID phong bì

Ví dụ phản hồi

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