Tra cứu chi tiết mẫu phong bì

GET /esignglobal/v1/envelopeTemplates/envelopeTemplateDetail

Mô tả giao diện

Truy vấn các thuộc tính chi tiết của "mẫu phong bì" đã được cấu hình sẵn ở phía giao diện (bao gồm cấu trúc tệp, vai trò người tham gia, và tất cả Key định danh điều khiển được cấu hình sẵn).

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ì

queryComponents

boolean

false

Có cần truy vấn thông tin điều khiển hay không, mặc định là false

true- Có

false- Không

Ví dụ yêu cầu

 {
 	"envelopeTemplateId":"dc4be9641a3145bea97809018d7a9180",
 	"queryComponents":true
 }

Tham số phản hồi

Tên tham số					Kiểu	Mô tả
code					int	Mã nghiệp vụ, 0 biểu thị thành công, khác 0 biểu thị lỗi.
message					string	Thông tin nghiệp vụ Vui lòng dựa vào code để xác định tình trạng lỗi, không nên phụ thuộc vào việc khớp message vì message có thể được điều chỉnh.
data					object	Dữ liệu nghiệp vụ
	envelopeTemplateId				string	ID mẫu phong bì
	envelopeTemplateName				string	Tên mẫu quy trình
	envelopeTemplateStatus				int	Trạng thái khả dụng của mẫu quy trình 1- Bật 0- Tắt
	digitalSignature				boolean	Bật chữ ký số true- Bật false- Tắt
	signFiles				array	Thông tin tệp
		documentId			string	ID tệp
		fileName			string	Tên tập tin
	participants				array	Bên tham gia
		participantId			string	ID bên tham gia
		participantSetMode			string	Yêu cầu tham gia (cách chỉ định người tham gia) presetSigner-chỉ định khi sử dụng mẫu (do người dùng mẫu tự chỉ định) dedicateSigner-thành viên cố định (được gắn cứng vào mẫu và không thể thay đổi) sender-người khởi tạo
		participantInfos			object	Bên tham gia cá nhân
			userEmail		string	Email của người ký
			phoneNumber		object	Số điện thoại, mặc định để trống Tham số bắt buộc khi cần thông báo qua tin nhắn, cần truyền cả countryCode và number
				countryCode	string	Mã quốc tế của quốc gia/khu vực, không cần truyền dấu “+”
				number	string	Không kiểm tra định dạng, chỉ giới hạn độ dài tối đa là 13 ký tự
			userName		string	Họ tên cá nhân
			deliveryMethod		string	Phương thức thông báo auto-gửi thông báo email khi truyền userEmail, gửi thông báo SMS khi truyền phoneNumber none-không gửi thông báo tin nhắn email-gửi thông báo email sms-gửi thông báo SMS WhatsApp-gửi thông báo WhatsApp
			customizeSettings		object	Cấu hình tùy chỉnh
				customizeMessage	string	Tin nhắn riêng biệt Giới hạn ký tự tối đa 1000
				notificationLanguage	string	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 pt-PT Tiếng Bồ Đào Nha th-TH Tiếng Thái id-ID Tiếng Indonesia vi-VN Tiếng Việt ms-MY Tiếng Mã Lai fil-PH Tiếng Philippines de-DE Tiếng Đức fr-FR Tiếng Pháp ru-RU Tiếng Nga it-IT Tiếng Ý ko-KR Tiếng Hàn
		signOrder			int	Thứ tự ký 1-255 Các bên tham gia khác nhau có thể được lặp lại
		willingnessAuthModes			string	Phương thức ý chí của người ký, phân cách bằng dấu phẩy tiếng Anh 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 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 WhatsApp
			accessCode		object	Cài đặt mật khẩu ký, bắt buộc khi authModes=accessCode
				accessCode	string	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	Thông báo nhắc 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	Xác thực OTP SMS, bắt buộc khi authModes=sms
				countryCode	string	Mã quốc tế của quốc gia/vùng, không cần truyền dấu “+”
				number	string	Không kiểm tra định dạng, chỉ giới hạn độ dài tối đa 13 ký tự
			idVerification		object	Cài đặt xác thực giấy tờ tùy thân, bắt buộc khi authModes=idVerification
				name	string	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	Xác thực OTP qua email, bắt buộc khi authModes=emailAuth
				authEmail	string	Địa chỉ email xác thực danh tính của người ký
			digitalId		array	Xác thực danh tính điện tử, bắt buộc khi authModes=digitalId
				authApp	string	Ứng dụng dùng để xác thực danh tính điện tử singpass-Sử dụng Singpass để xác thực danh tính iamsmart-Sử dụng iAM Smart để xác thực
				idNumber	string	Số giấy tờ tùy thân của người ký cần xác thực
			whatsappAuth		object	Xác minh whatsapp OTP, bắt buộc khi authModes=whatsappAuth
				countryCode	string	Mã quốc tế của quốc gia/vùng lãnh thổ, không cần truyền “+”
				number	string	Không kiểm tra định dạng, chỉ giới hạn độ dài tối đa là 13 ký tự
		components			object	Thông tin điều khiển
	copiers				array	Thiết lập người nhận bản sao
		copierId			string	ID bên tham gia
		editable			boolean	Cho phép chỉnh sửa khi khởi tạo không
		CCInfos			object	Thông tin người nhận bản sao
			userEmail		string	Email
			userName		string	Tên cá nhân
			customizeSettings		object	Cấu hình tùy chỉnh
				notificationSettings	object	Cấu hình tùy chỉnh loại thông báo
				notificationLanguage	string	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
	attachments				array	Thông tin tệp đính kèm
		editable			boolean	Có cho phép sửa đổi khi khởi tạo không?
		fileKey			string	filekey của tệp đính kèm
		fileName			string	Tên tệp đính kèm
		downloadUrl			string	Liên kết tải xuống tệp PDF bản nháp, có hiệu lực trong 60 phút.
components					array	Danh sách điều khiển
	documentId				string	key của tệp chứa điều khiển
	componentId				string	ID điều khiển
	componentKey				string	Khóa điều khiển (mã định danh điều khiển do người dùng điền khi thiết lập mẫu tài liệu)
	componentName				string	Tên điều khiển
	componentType				string	Loại điều khiển 1, Văn bản 2, Số 3, Ngày tháng 6, Khu vực ký tên thông thường 8, Văn bản nhiều dòng 9, Hộp kiểm 10, Nút chọn đơn 11, Hình ảnh 14, Điều khiển chọn thả xuống 15, Điều khiển hộp kiểm 20, Khu vực con dấu 21, Khu vực phê duyệt 22, Ngày ký 23, Email 100, Nhân dân tệ
	componentDefaultValue				string	Giá trị mặc định của thành phần điều khiển
	componentPosition				object	Vị trí của thành phần điều khiển
		componentPositionX			float	Tọa độ ngang của thành phần điều khiển
		componentPositionY			float	Tọa độ dọc của thành phần điều khiển
		componentPageNum			int	Số trang chứa thành phần điều khiển
	componentSize				object	Kích thước của thành phần điều khiển
		componentWidth			int	Chiều rộng của thành phần điều khiển (khoảng cách lề trái và phải của hình chữ nhật, đơn vị là px)
		componentHeight			int	Chiều cao của thành phần điều khiển (khoảng cách lề trên và dưới của hình chữ nhật, đơn vị là px)
	componentTextFormat				object	Kiểu ký tự của thành phần điều khiển
		font			int	Phông chữ điền, mặc định là 1, 1- Phông Tống, 2- Phông Tống mới, 4- Phông Hắc, 5- Phông Khải
		fontSize			float	Kích thước phông chữ, mặc định 12-小四 42-初号 36-小初 26-一号 24-小一 22-二号 19-小二 16-三号 15-小三 14-四号 12-小四 10.5-五号 9-小五
		textColor			string	Màu phông chữ, mặc định #000000 đen
		bold			boolean	Có in đậm không, mặc định false true-Đúng false-Sai
		italic			boolean	Có in nghiêng không, mặc định false true-Đúng false-Sai
		horizontalAlignment			string	Căn chỉnh ngang, mặc định 1-căn trái LEFT-Căn trái CENTER-Căn giữa RIGHT-Căn phải
		verticalAlignment			string	Căn chỉnh dọc, mặc định 1-căn trên (áp dụng cho văn bản nhiều dòng) TOP-Căn trên MIDDLE-Căn giữa BOTTOM-Căn dưới
		textLineSpacing			float	Khoảng cách dòng, mặc định 1.0 Hỗ trợ tối đa một chữ số thập phân, giá trị tối đa là 2.0 (áp dụng cho văn bản nhiều dòng)
	required				boolean	Có bắt buộc điền không true-Bắt buộc false-Không bắt buộc
	componentMaxLength				string	Giới hạn độ dài tối đa có thể điền cho điều khiển (số ký tự tiếng Trung)
	componentSpecialAttribute				object	Thuộc tính riêng của điều khiển
		numberFormat			string	Định dạng số (điều khiển số) Số nguyên: 0 Giữ một chữ số thập phân: 0.0 Giữ hai chữ số thập phân: 0.00
		dateFormat			string	Định dạng ngày (điều khiển ngày)
		imageType			string	Loại hình ảnh (điều khiển hình ảnh) IDCard_widthwise Căn cước Ngang Khóa tỷ lệ IDCard_longitudinal Căn cước Dọc Khóa tỷ lệ other Khác Không khóa tỷ lệ
		options			array	Tùy chọn (điều khiển chọn thả xuống, điều khiển chọn đơn, điều khiển chọn nhiều)
			optionOrder		int	Thứ tự tùy chọn
			optionContent		string	Nội dung tùy chọn
			selected		boolean	Có chọn mặc định không
			optionPositionX		float	Tọa độ X của phần tử con trong khung viền điều khiển cha
			optionPositionY		float	Tọa độ Y của phần tử con trong khung viền điều khiển cha
			optionWidth		float	Chiều rộng phần tử con
			optionHeight		float	Chiều cao phần tử con
	signField				object	Thuộc tính vùng chữ ký/đóng dấu thường
		fieldStyle			int32	Kiểu vùng chữ ký/đóng dấu 1-Vùng chữ ký/đóng dấu đơn trang 2-Vùng chữ ký/đóng dấu xuyên trang
		sizeRule			int	Quy cách con dấu 1-Đóng dấu theo quy cách thực tế 2-Tùy chỉnh quy cách (tự động điều chỉnh theo chiều rộng và chiều cao vùng ký)
		movable			boolean	true-Có thể di chuyển khi ký false-Không thể di chuyển khi ký
	stampField				object	Thuộc tính khu vực con dấu
		fieldStyle			int	Kiểu vùng ký/đóng dấu 1-Khu vực ký/đóng dấu đơn trang 2-Khu vực ký/đóng dấu qua mép giấy
		sizeRule			int	Quy cách con dấu 1-Đóng dấu theo kích thước thực tế của con dấu 2-Tùy chỉnh quy cách (tự động điều chỉnh theo chiều rộng và chiều cao vùng ký)
		movable			boolean	true-Có thể di chuyển khi ký false-Không thể di chuyển khi ký
	signDateField				object	Thuộc tính ngày ký
		dateFormat			string	Định dạng ngày: yyyy年MM月dd日 yyyy-MM-dd yyyy/MM/dd yyyy-MM-dd HH:mm:ss
	approvalField				object	Thuộc tính khu vực phê duyệt
		allowedOptions			array	Tùy chọn cho phép người ký phê duyệt, áp dụng khi fieldType là approval. Mặc định là ["approve", "decline"] approve-Đồng ý decline-từ chối

Ví dụ phản hồi

{
  "code": "0",
  "data": {
    "envelopeTemplateName": "test",
    "signFiles": [
      {
        "fileDownloadUrl": "https://******",
        "fileName": "***.pdf",
        "documentId": "$eac****-d6f8-4b6b-bafe-******$3328404894"
      }
    ],
    "attachments": [],
    "digitalSignature": false,
    "envelopeTemplateStatus": 1,
    "independentComponents": [],
    "envelopeCategoryId": null,
    "envelopeTemplateId": "dc4be9641a3145bea97809018d7a9180",
    "participants": [
      {
        "participantFlag": "",
        "idVerification": null,
        "components": [
          {
            "componentType": "10",
            "componentId": "556b60f7bd324428908b41f3bbec8c54",
            "componentMaxLength": null,
            "signField": null,
            "componentPosition": {
              "componentPositionY": 485.42538,
              "componentPositionX": 35.96627,
              "componentPageNum": "1"
            },
            "componentSpecialAttribute": {
              "options": [
                {
                  "optionContent": "***",
                  "optionHeight": 32.923893,
                  "optionOrder": 0,
                  "optionPositionY": 85.0,
                  "optionPositionX": 10.0,
                  "optionWidth": 124.0,
                  "selected": false
                },
                {
                  "optionContent": "选项二",
                  "optionHeight": 15.0,
                  "optionOrder": 1,
                  "optionPositionY": 60.0,
                  "optionPositionX": 10.0,
                  "optionWidth": 124.0,
                  "selected": false
                },
                {
                  "optionContent": "选项三",
                  "optionHeight": 15.0,
                  "optionOrder": 2,
                  "optionPositionY": 35.0,
                  "optionPositionX": 10.0,
                  "optionWidth": 124.0,
                  "selected": false
                },
                {
                  "optionContent": "选项四",
                  "optionHeight": 15.0,
                  "optionOrder": 3,
                  "optionPositionY": 10.0,
                  "optionPositionX": 10.0,
                  "optionWidth": 124.0,
                  "selected": false
                }
              ],
              "numberFormat": "{}",
              "dateFormat": null,
              "imageType": null
            },
            "componentDefaultValue": null,
            "componentSize": {
              "componentHeight": 128,
              "componentWidth": 144
            },
            "signDateField": null,
            "required": true,
            "stampField": null,
            "documentId": "d559142672c742c3b02c3b5c663aa146",
            "componentName": "单选1",
            "componentKey": null,
            "approvalField": null,
            "componentTextFormat": {
              "textLineSpacing": null,
              "horizontalAlignment": "LEFT",
              "fontSize": 12.0,
              "bold": false,
              "textColor": "#000",
              "italic": false,
              "verticalAlignment": "TOP",
              "font": 1
            }
          },
        ],
        "digitalId": null,
        "participantInfos": {
          "userEmail": "***",
          "phoneNumber": null,
          "userName": "****",
          "deliveryMethod": "email",
          "customizeSettings": {
            "customizeMessage": null,
            "notificationSettings": {
              "notificationLanguage": null
            }
          }
        },
        "willingnessAuthModes": "noAuth",
        "signOrder": 1,
        "participantId": "42750b92c7a***05134dd5342",
        "accessCode": null,
        "sms": null,
        "participantSetMode": "presetSigner",
        "emailAuth": null
      },
      {
        "participantFlag": "***",
        "idVerification": null,
        "components": [
          {
            "componentType": "20",
            "componentId": "7c401b43cdc94b61a7813aa58ac82bbf",
            "componentMaxLength": null,
            "signField": null,
            "componentPosition": {
              "componentPositionY": 327.15793,
              "componentPositionX": 109.17395,
              "componentPageNum": "2"
            },
            "componentSpecialAttribute": {
              "options": null,
              "numberFormat": "{}",
              "dateFormat": null,
              "imageType": null
            },
            "componentDefaultValue": null,
            "componentSize": {
              "componentHeight": 150,
              "componentWidth": 150
            },
            "signDateField": null,
            "required": true,
            "stampField": {
              "movable": false,
              "sizeRule": 1,
              "fieldStyle": 1
            },
            "documentId": "d559142672c742c3b02c3b5c663aa146",
            "componentName": "图章区",
            "componentKey": null,
            "approvalField": null,
            "componentTextFormat": {
              "textLineSpacing": null,
              "horizontalAlignment": "LEFT",
              "fontSize": 12.0,
              "bold": false,
              "textColor": "#000",
              "italic": false,
              "verticalAlignment": "TOP",
              "font": 1
            }
          }
        ],
        "digitalId": null,
        "participantInfos": {
          "userEmail": "***",
          "phoneNumber": null,
          "userName": "***",
          "deliveryMethod": "email",
          "customizeSettings": {
            "customizeMessage": null,
            "notificationSettings": {
              "notificationLanguage": null
            }
          }
        },
        "willingnessAuthModes": "noAuth",
        "signOrder": 1,
        "participantId": "b055dfce00c5******40cdabb23822ea4",
        "accessCode": null,
        "sms": null,
        "participantSetMode": "dedicateSigner",
        "emailAuth": null
      }
    ],
    "copiers": []
  },
  "message": "SUCCESS"
}