봉투 템플릿 상세 정보 조회

GET /esignglobal/v1/envelopeTemplates/envelopeTemplateDetail

인터페이스 설명

페이지 측에서 사전 구성된 '봉투 템플릿'의 상세 속성(파일 구조, 참여자 역할, 모든 사전 설정된 컨트롤 식별자 Key 포함)을 조회합니다.

요청 파라미터

파라미터 이름

타입

필수

설명

envelopeTemplateId

string

true

봉투 템플릿 ID

queryComponents

boolean

false

컨트롤 정보 조회 여부, 기본값 false

true-예

false-아니오

요청 예시

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

응답 파라미터

파라미터 이름					타입	설명
code					int	비즈니스 코드, 0은 성공을 의미하며, 0이 아닌 값은 예외를 의미합니다.
message					string	비즈니스 정보 code를 기준으로 오류 상황을 판단해야 하며, message는 향후 조정될 수 있으므로 message 매칭에 의존해서는 안 됩니다.
data					object	비즈니스 데이터
	envelopeTemplateId				string	봉투 템플릿 ID
	envelopeTemplateName				string	프로세스 템플릿 이름
	envelopeTemplateStatus				int	프로세스 템플릿 사용 가능 상태 1-활성화 0-비활성화
	digitalSignature				boolean	디지털 서명 활성화 true-활성화 false-비활성화
	signFiles				array	파일 정보
		documentId			string	파일 ID
		fileName			string	파일 이름
	participants				array	참여자
		participantId			string	참여자 ID
		participantSetMode			string	참여 요구사항(참여자 지정 방식) presetSigner-템플릿 사용 시 지정(템플릿 사용자가 직접 지정) dedicateSigner-고정 멤버(템플릿에 고정되어 변경 불가) sender-발신자
		participantInfos			object	개인 참여자
			userEmail		string	서명자 이메일
			phoneNumber		object	전화번호, 기본값은 비어 있음 SMS 알림이 필요한 경우 필수 파라미터이며, countryCode와 number를 모두 전달해야 함
				countryCode	string	국가 및 지역 국제 코드, '+' 기호는 불필요
				number	string	형식 검증 없음, 최대 길이는 13자리로 제한
			userName		string	개인 이름
			deliveryMethod		string	알림 방식 auto-userEmail을 지정하면 이메일 알림을 발송하고, phoneNumber를 지정하면 SMS 알림을 발송합니다 none-메시지 알림을 발송하지 않음 email-이메일 알림 발송 sms-SMS 알림 발송 WhatsApp-WhatsApp 알림 발송
			customizeSettings		object	사용자 정의 구성
				customizeMessage	string	전용 메시지 최대 1000자
				notificationLanguage	string	알림 언어, 기본값은 영어입니다 en-US 영어 zh-CN 간체 중국어 zh-Hant 번체 중국어 ja 일본어 es-MX 스페인어 pt-PT 포르투갈어 th-TH 태국어 id-ID 인도네시아어 vi-VN 베트남어 ms-MY 말레이어 fil-PH 필리핀어 de-DE 독일어 fr-FR 프랑스어 ru-RU 러시아어 it-IT 이탈리아어 ko-KR 한국어
		signOrder			int	서명 순서 1-255 참여자 중복 가능
		willingnessAuthModes			string	서명자 선택적 의향 방식, 영문 쉼표로 구분 noAuth-검증 생략 accessCode-서명 비밀번호로 인증 sms-SMS OTP 인증 idVerification-신분증 인증 emailAuth-이메일 OTP 인증 digitalId-전자 신원 인증 whatsappAuth-whatsapp OTP 인증
			accessCode		object	서명 비밀번호 설정, authModes=accessCode일 때 필수
				accessCode	string	비밀번호 내용, 대소문자 구분 없음, 영숫자 포함 가능, 길이 제한 45
				promptInfo	string	액세스 비밀번호 안내 메시지, 액세스 비밀번호를 포함할 수 없음, 길이 제한 30, authModes=1일 때 필수.
			sms		object	SMS OTP 검증, authModes=sms일 때 필수
				countryCode	string	국가/지역 국제 코드, '+' 기호 불필요
				number	string	형식 검증 없음, 최대 길이 13자리로만 제한
			idVerification		object	신분증 인증 설정, authModes=idVerification일 때 필수
				name	string	서명자의 신분증에 기재된 성명 전체, 최대 길이 100자
			emailAuth		object	이메일 OTP 검증, authModes=emailAuth일 때 필수
				authEmail	string	서명자 신원 인증 이메일 주소
			digitalId		array	전자 신분 인증, authModes=digitalId일 때 필수
				authApp	string	전자 신분 인증에 사용되는 앱 singpass-Singpass를 사용한 신분 인증 iamsmart-智方便을 사용한 인증
				idNumber	string	서명자의 검증 대상 신분증 번호
			whatsappAuth		object	whatsapp OTP 검증, authModes=whatsappAuth일 때 필수
				countryCode	string	국가 및 지역 국제 코드, '+' 기호는 입력하지 않음
				number	string	형식 검증은 하지 않으며 길이는 최대 13자리로만 제한
		components			object	컨트롤 정보
	copiers				array	참조자 설정
		copierId			string	참여자 ID
		editable			boolean	생성 시 수정 허용 여부
		CCInfos			object	참조자 정보
			userEmail		string	이메일 주소
			userName		string	개인 이름
			customizeSettings		object	사용자 정의 구성
				notificationSettings	object	알림 유형 사용자 정의 구성
				notificationLanguage	string	알림 언어, 기본값은 영어입니다 en-US 영어 zh-CN 간체 zh-Hant 번체 ja 일본어 ES-MX 스페인어
	attachments				array	첨부 파일 정보
		editable			boolean	시작 시 수정 허용 여부
		fileKey			string	첨부 filekey
		fileName			string	첨부 파일 이름
		downloadUrl			string	파일 초안 PDF 다운로드 링크, 유효 기간은 60분입니다.
components					array	컨트롤 목록
	documentId				string	컨트롤이 속한 파일 key
	componentId				string	컨트롤 ID
	componentKey				string	컨트롤 키(파일 템플릿 설정 시 사용자가 입력하는 컨트롤 식별자)
	componentName				string	컨트롤 이름
	componentType				string	컨트롤 유형 1, 텍스트 2, 숫자 3, 날짜 6, 일반 서명 영역 8, 여러 줄 텍스트 9, 체크박스 10, 단일 선택 11, 이미지 14, 드롭다운 선택 컨트롤 15, 체크박스 컨트롤 20, 도장 영역 21, 승인 영역 22, 서명일 23, 이메일 주소 100, 인민폐
	componentDefaultValue				string	컨트롤 기본값
	componentPosition				object	컨트롤 위치
		componentPositionX			float	컨트롤 위치 가로 좌표
		componentPositionY			float	컨트롤 위치 세로 좌표
		componentPageNum			int	컨트롤 페이지 번호
	componentSize				object	컨트롤 크기
		componentWidth			int	컨트롤 너비(사각형의 좌우 여백 거리, 단위: px)
		componentHeight			int	컨트롤 높이(사각형의 상하 여백 거리, 단위: px)
	componentTextFormat				object	컨트롤 문자 스타일
		font			int	글꼴 채우기, 기본값 1, 1-송체, 2-신흥송체, 4-흑체, 5-해체
		fontSize			float	글꼴 크기, 기본값 12-소사 42-초호 36-소초 26-일호 24-소일 22-이호 19-소이 16-삼호 15-소삼 14-사호 12-소사 10.5-오호 9-소오
		textColor			string	글꼴 색상, 기본값 #000000 검정색
		bold			boolean	굵게 여부, 기본값 false true-예 false-아니오
		italic			boolean	기울임꼴 여부, 기본값 false true-예 false-아니오
		horizontalAlignment			string	수평 정렬, 기본값 1-왼쪽 정렬 LEFT-왼쪽 정렬 CENTER-가운데 정렬 RIGHT-오른쪽 정렬
		verticalAlignment			string	수직 정렬, 기본값 1-상단 정렬(다중 줄 텍스트용) TOP-상단 정렬 MIDDLE-가운데 정렬 BOTTOM-하단 정렬
		textLineSpacing			float	줄 간격, 기본값 1.0 소수점 첫째 자리까지만 지원, 최대값 2.0(다중 줄 텍스트용)
	required				boolean	필수 입력 여부 true-필수 입력 false-선택 입력
	componentMaxLength				string	컨트롤 최대 입력 길이(중국어 문자 수)
	componentSpecialAttribute				object	컨트롤 고유 속성
		numberFormat			string	숫자 형식(숫자 컨트롤) 정수: 0 소수점 1자리: 0.0 소수점 2자리: 0.00
		dateFormat			string	날짜 형식(날짜 컨트롤)
		imageType			string	이미지 유형(이미지 컨트롤) IDCard_widthwise 신분증 가로 방향 비율 고정 IDCard_longitudinal 신분증 세로 방향 비율 고정 other 기타 비율 고정 안 함
		options			array	옵션(드롭다운 선택 컨트롤, 단일 선택 컨트롤, 다중 선택 컨트롤)
			optionOrder		int	옵션 순서
			optionContent		string	옵션 내용
			selected		boolean	기본 선택 여부
			optionPositionX		float	부모 컨트롤 경계 기준 자식 요소 X 좌표
			optionPositionY		float	부모 컨트롤 경계 기준 자식 요소 Y 좌표
			optionWidth		float	자식 요소 너비
			optionHeight		float	자식 요소 높이
	signField				object	일반 서명·인감 영역 속성
		fieldStyle			int32	서명·인감 영역 스타일 1-단일 페이지 서명·인감 영역 2-페이지 경계 서명·인감 영역
		sizeRule			int	인감 규격 1-실제 인감 규격으로 도장 2-사용자 지정 규격(서명 영역 너비/높이 맞춤)
		movable			boolean	true-서명 시 이동 가능 false-서명 시 이동 불가
	stampField				object	도장 영역 속성
		fieldStyle			int	도장 영역 스타일 1-단일 페이지 도장 영역 2-이음매 도장 영역
		sizeRule			int	도장 규격 1-실제 도장 규격으로 도장 2-사용자 지정 규격(서명 영역 너비 및 높이에 맞춤)
		movable			boolean	true-서명 시 이동 가능 false-서명 시 이동 불가
	signDateField				object	서명 날짜 속성
		dateFormat			string	날짜 형식: yyyy년 MM월 dd일 yyyy-MM-dd yyyy/MM/dd yyyy-MM-dd HH:mm:ss
	approvalField				object	승인 영역 속성
		allowedOptions			array	fieldType이 approval일 때 적용되는 서명자 승인 옵션. 기본값은 ["approve", "decline"]입니다. approve-승인 decline-거절

응답 예시

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