Foxit eSign(미리 보기)

Foxit eSign은 온라인으로 문서를 보내고, 서명하고, 관리할 수 있는 전자 서명 솔루션으로 인쇄, 스캔 또는 우편 발송이 필요하지 않습니다. 문서를 업로드하고, 서명 필드를 정의하고, 빠르고 법적 구속력이 있는 eSignatures를 받는 사람에게 보냅니다.

이 커넥터는 다음 제품 및 지역에서 사용할 수 있습니다.

서비스	클래스	Regions
Copilot Studio	Premium	다음을 제외한 모든 Power Automate 지역: - 미국 정부(GCC) - 미국 정부(GCC High) - 21Vianet에서 운영하는 중국 클라우드 - 미국 국방부(DoD)
논리 앱	Standard	다음을 제외한 모든 Logic Apps 지역 : - Azure Government 지역 - Azure 중국 지역 - 미국 국방부(DoD)
Power Apps	Premium	다음을 제외한 모든 Power Apps 지역: - 미국 정부(GCC) - 미국 정부(GCC High) - 21Vianet에서 운영하는 중국 클라우드 - 미국 국방부(DoD)
파워 오토메이트	Premium	다음을 제외한 모든 Power Automate 지역: - 미국 정부(GCC) - 미국 정부(GCC High) - 21Vianet에서 운영하는 중국 클라우드 - 미국 국방부(DoD)

Contact
이름	Foxit eSign 지원
URL	https://www.foxit.com
전자 메일	api@foxit.com

커넥터 메타데이터
Publisher	Foxit Software Inc.
웹 사이트	https://www.foxit.com/esign-pdf/
개인 정보 보호 정책	https://www.foxit.com/company/privacy-policy.html
카테고리	생산력; 콘텐츠 및 파일

Foxit eSign

Foxit eSign은 기업에서 온라인으로 법적 구속력이 있는 문서를 보내고 서명하고 관리할 수 있게 해 주는 엔터프라이즈급 전자 서명 솔루션으로 인쇄, 스캔 또는 우편 발송이 필요하지 않습니다. 문서를 업로드하고, 서명 필드를 정의하고, 빠르고 안전한 eSignatures를 위해 받는 사람에게 보냅니다. Foxit eSign은 ESIGN 및 UETA를 포함한 주요 전자 서명 법률을 완전히 준수하며, 암호화를 사용하여 전송 중 및 미사용 문서를 보호하며, 승인된 서명자만 문서에 액세스하고 서명할 수 있도록 다단계 인증을 지원합니다.

Microsoft Power Automate Foxit eSign 커넥터를 사용하면 봉투를 만들고 서명을 위해 보내는 것부터 상태 추적, 완료된 문서 다운로드, 템플릿 관리 및 봉투 이벤트가 발생할 때 다운스트림 작업을 트리거하는 등 전체 문서 서명 워크플로를 자동화할 수 있습니다.

Publisher: 폭스 코퍼레이션

사전 요구 사항

이 커넥터를 사용하려면 다음이 필요합니다.

사용자 지정 커넥터 또는 프리미엄 커넥터 액세스를 사용하는 Microsoft Power Apps 또는 Power Automate 계획
Foxit eSign 계정 - 여기에서 계정을 만듭니다.
Foxit eSign 계정에서 사용하도록 설정된 API 액세스(아래 자격 증명 가져오기 참조)

자격 증명 가져오기

Foxit eSign 계정이 아직 없는 경우 만듭니다.
Foxit Sales 팀에 문의하여 계정에서 API 액세스를 사용하도록 요청합니다. 승인되면 계정에서 API 액세스가 활성화됩니다.
Power Automate 커넥터 목록에서 Foxit eSign을 검색하고 연결 만들기를 선택합니다.
Foxit eSign 로그인 페이지로 리디렉션됩니다. Foxit eSign 자격 증명으로 로그인하여 연결 권한을 부여합니다.
권한이 부여되면 연결이 흐름에서 사용할 준비가 됩니다.

Getting Started

연결을 만든 후 Foxit eSign 커넥터를 사용하여 흐름 빌드를 시작할 수 있습니다.

봉투 이벤트가 발생할 때(예: 모든 당사자가 서명한 경우) 트리거 를 사용하여 흐름을 자동으로 시작합니다.
작업을 사용하여 봉투를 만들고, 서명 미리 알림을 보내고, 완료된 문서를 다운로드하고, 템플릿을 관리하는 등의 작업을 수행합니다.
여러 작업을 함께 연결합니다. 예를 들어 템플릿에서 봉투를 만들고 완전히 실행된 트리거를 기다린 다음 서명된 문서를 다운로드하여 SharePoint 저장합니다.

지원되는 트리거

Trigger	Description
봉투가 전송되는 경우	받는 사람에게 봉투를 보낼 때 발생합니다. 웹후크 수준을 계정으로 설정해야 합니다.
봉투를 볼 때	받는 사람이 열리고 봉투를 볼 때 발생합니다.
봉투가 서명된 경우	받는 사람이 봉투에 서명하면 발생합니다.
봉투가 취소된 경우	받는 사람 또는 보낸 사람이 봉투를 취소하면 발생합니다.
봉투가 완전히 실행되는 경우	모든 받는 사람이 서명하고 봉투가 완전히 완료되면 발생합니다.
봉투가 삭제되는 경우	봉투가 삭제되면 발생합니다.

지원되는 작업

봉투

작업	Description
URL에서 봉투 만들기	공개적으로 액세스할 수 있는 PDF URL을 사용하여 봉투를 만들고 보냅니다.
Base64에서 봉투 만들기	Base64로 인코딩된 PDF 문서를 사용하여 봉투를 만들고 보냅니다.
서식 파일에서 봉투 만들기	기존 Foxit eSign 템플릿에서 봉투를 만들고 보냅니다.
봉투 세부 정보 가져오기	봉투의 전체 세부 정보 및 현재 상태를 검색합니다.
봉투 ID 가져오기	필터 조건에 따라 봉투 ID 목록을 검색합니다.
서명 미리 알림 보내기	봉투의 보류 중인 서명자에게 미리 알림 알림을 보냅니다.
봉투 파일 다운로드	봉투에 있는 서명된 모든 문서를 zip 파일로 다운로드합니다.
단일 문서 PDF 다운로드	봉투에서 단일 문서를 PDF로 다운로드합니다.
봉투를 휴지통으로 이동	하나 이상의 봉투를 휴지통으로 이동합니다.
봉투 취소	봉투를 취소하고 받는 사람에게 알깁니다.
봉투 삭제	하나 이상의 봉투를 영구적으로 삭제합니다.
봉투 활동 기록 가져오기	봉투에 대한 전체 활동 로그를 검색합니다.
삭제된 봉투 기록 가져오기	계정에서 삭제된 봉투의 기록을 검색합니다.

Templates

작업	Description
URL에서 템플릿 만들기	공개적으로 액세스할 수 있는 PDF URL을 사용하여 재사용 가능한 서명 템플릿을 만듭니다.
Base64에서 템플릿 만들기	Base64로 인코딩된 PDF 문서를 사용하여 재사용 가능한 서명 템플릿을 만듭니다.
템플릿 세부 정보 가져오기	필드 정의를 포함하여 특정 템플릿의 전체 세부 정보를 검색합니다.
템플릿 ID로 템플릿 가져오기	ID로 하나 이상의 템플릿에 대한 세부 정보를 검색합니다.
모든 템플릿 목록 가져오기	계정에서 사용할 수 있는 모든 템플릿을 검색합니다.

Webhooks

작업	Description
모든 웹후크 채널 나열	계정에 구성된 모든 웹후크 채널 목록을 반환합니다.
웹후크 채널 세부 정보 가져오기	특정 웹후크 채널의 세부 정보를 검색합니다.

전자 메일 그룹

작업	Description
전자 메일 그룹 만들기	봉투에 받는 사람으로 사용할 새 전자 메일 그룹을 만듭니다.
전자 메일 그룹 세부 정보 가져오기	전자 메일 그룹의 세부 정보 및 멤버를 검색합니다.

보고서

작업	Description
보고서 다운로드	Microsoft Excel 형식으로 계정 활동 보고서를 다운로드합니다.

알려진 문제 및 제한 사항

속도 제한: Foxit eSign API는 계정당 5분당 최대 4,000개의 요청을 허용합니다. 이 제한을 초과하는 요청은 응답을 받습니다 429 Too Many Requests . 이를 정상적으로 처리하려면 흐름에서 지수 백오프를 사용하여 재시도 논리를 구현하는 것이 좋습니다.
파일 크기 제한: 문서당 최대 파일 크기는 25MB입니다. 이 제한은 총 봉투 크기가 아닌 개별 파일에 적용됩니다.
웹후크 자동 구독 취소: Foxit eSign 웹후크 삭제 API(DELETE 대신 POST 메서드 사용)의 제한으로 인해 트리거 기반 흐름이 삭제되거나 수정될 때 Power Automate 웹후크 채널 구독을 자동으로 정리할 수 없습니다. 모든 웹후크 채널 나열 작업을 사용하여 활성 채널을 식별하고 Foxit eSign 포털을 사용하여 흐름을 서비스 해제할 때 구독을 제거합니다.
봉투가 전송되는 경우 - 계정 수준만: "봉투가 전송되는 경우" 트리거는 웹후크 수준이 계정으로 설정된 경우에만 발생 합니다. API 앱 수준에서 만든 봉투에는 발생하지 않습니다. 이 트리거를 구성할 때 계정 수준을 선택해야 합니다.
지역 가용성: 커넥터는 북아메리카(NA1) 및 EU 지역 계정 모두에 사용할 수 있습니다. 연결을 구성할 때 적절한 서버 지역을 선택합니다. 잘못된 지역에 연결하면 인증 실패가 발생합니다.
Base64 문서 크기: Base64에서 봉투 만들기 또는 Base64 작업에서 템플릿 만들기를 사용하는 경우 Base64로 인코딩된 문자열은 25MB 이하의 원본 파일에 해당해야 합니다.

Support

개발자 지원은 다음에서 Foxit eSign 팀에 문의하세요 devsupport@foxitsoftware.com.

지원 사례를 제출하려면 다음을 방문하세요 https://kb.foxit.com/s/submit-a-case.

제한 한도

Name	호출	갱신 기간
연결당 API 호출	100	60초

actions

Base64에서 봉투 만들기	Base64로 인코딩된 PDF 문서를 사용하여 봉투를 만들고 보냅니다.
Base64에서 템플릿 만들기	Base64로 인코딩된 PDF 문자열을 사용하여 새 템플릿을 만듭니다. PDF 파일을 흐름에서 Base64 문자열로 이미 사용할 수 있는 경우(예: SharePoint 파일 또는 OneDrive 문서에서) 사용합니다.
URL에서 봉투 만들기	공개적으로 액세스할 수 있는 PDF URL을 사용하여 봉투를 만들고 보냅니다. 문서 URL 및 받는 사람 세부 정보를 제공하여 서명 프로세스를 시작합니다.
URL에서 템플릿 만들기	공개적으로 액세스할 수 있는 PDF URL을 사용하여 새 템플릿을 만듭니다.
단일 문서 PDF 다운로드	봉투에서 단일 문서를 PDF 파일로 다운로드합니다.
모든 웹후크 채널 나열	계정에 구성된 모든 웹후크 채널 목록을 반환합니다.
모든 템플릿 목록 가져오기	계정에서 사용할 수 있는 모든 템플릿 목록을 반환합니다.
보고서 다운로드	봉투 활동 보고서를 Microsoft Excel 파일로 다운로드합니다. 필터를 사용하여 상태, 날짜 범위, 봉투 이름, 작성자 또는 서명자별로 결과를 좁힐 수 있습니다.
봉투 ID 가져오기	상태별로 필터링된 봉투 ID 목록을 반환합니다. 이 항목을 사용하여 특정 상태에서 봉투를 찾습니다.
봉투 삭제	하나 이상의 봉투를 영구적으로 삭제합니다.
봉투 세부 정보 가져오기	봉투의 상태, 받는 사람 및 문서를 포함하여 봉투의 전체 세부 정보를 검색합니다.
봉투 취소	보낸 봉투를 취소합니다. 받는 사람은 더 이상 문서에 서명할 수 없습니다.
봉투 파일 다운로드	봉투에서 완성된 문서를 파일로 다운로드합니다.
봉투 활동 기록 가져오기	받는 사람과 보낸 사람이 수행한 모든 작업을 보여 주는 봉투에 대한 전체 활동 로그를 검색합니다.
봉투를 휴지통으로 이동	하나 이상의 봉투를 휴지통으로 이동합니다. 휴지통의 봉투는 영구적으로 삭제되지 않습니다.
삭제된 봉투 기록 가져오기	삭제되었거나 휴지통으로 이동한 봉투의 기록을 검색합니다.
서명 미리 알림 보내기	보류 중인 봉투 받는 사람에게 미리 알림 알림을 보내 서명을 완료하라는 메시지를 표시합니다.
서식 파일에서 봉투 만들기	기존 템플릿을 사용하여 봉투를 만들고 보냅니다. 받는 사람 세부 정보를 사용자 지정할 수 있습니다.
웹후크 채널 세부 정보 가져오기	특정 웹후크 채널의 세부 정보를 검색합니다.
웹후크 트리거 구독 취소	활성 웹후크 채널 구독을 해당 채널 ID로 삭제합니다. 이 작업을 사용하여 더 이상 필요하지 않은 웹후크 구독을 정리합니다.
전자 메일 그룹 만들기	한 번에 여러 받는 사람에게 봉투를 보내는 데 사용할 수 있는 새 전자 메일 그룹을 만듭니다.
전자 메일 그룹 세부 정보 가져오기	기존 전자 메일 그룹의 세부 정보를 검색합니다.
템플릿 ID로 템플릿 가져오기	ID로 하나 이상의 템플릿에 대한 세부 정보를 검색합니다.
템플릿 세부 정보 가져오기	해당 필드 및 받는 사람을 포함하여 특정 템플릿의 전체 세부 정보를 검색합니다.

Base64에서 봉투 만들기

작업 ID:: CreateEnvelopefromBase64

Base64로 인코딩된 PDF 문서를 사용하여 봉투를 만들고 보냅니다.

매개 변수

Name	키	필수	형식	Description
봉투 이름	folderName	True	string	이 봉투의 이름입니다.
입력 형식	inputType		string	문서 원본의 입력 형식입니다. 이 작업에 대해 base64로 수정되었습니다.
Base64 파일 문자열	base64FileString	True	array of string	보낼 Base64로 인코딩된 PDF 문서의 배열입니다.
파일 이름	fileNames	True	array of string	Base64 파일 문자열 배열과 동일한 순서로 각 문서에 대한 표시 이름의 배열입니다.
이름 (First Name)	firstName	True	string	받는 사람의 이름입니다.
성 이름	lastName	True	string	받는 사람의 성입니다.
Email 주소	emailId	True	string	받는 사람의 전자 메일 주소입니다.
permissions	permission	True	string
Sequence	sequence	True	integer	받는 사람 목록의 받는 사람에게 시퀀스 번호를 할당하려면 이 필드를 사용합니다. 1,2,3,4와 같은 1로 시작하는 각 파티의 고유 시퀀스 번호를 사용합니다. 서명 워크플로에 한 사람이 여러 번 나타나는 경우 받는 사람이 반복할 때마다 다른 시퀀스를 할당하세요.
signerAuthLevels	signerAuthLevel		string	서명자가 확인을 위해 활용할 인증 수준
자리 표시자	isPlaceholder		boolean	파티가 자리 표시자임을 시작하려면 이 필드를 사용합니다. 참고: 1. firstName, lastName, emailId 매개 변수의 값은 이 파티의 비어 있어야 합니다. 2. 자리 표시자를 추가하려면 'PARTY_ASSIGNER' 권한으로 한 명의 받는 사람을 다시 지정해야 합니다.
받는 사람 역할	partyRole		string	자리 표시자 역할을 할당하려면 이 필드를 사용합니다.
이름 변경 허용	allowNameChange		string	값은 true이거나 false일 수 있습니다. 서명자가 서명 프로세스를 완료하기 전에 이름과 성을 업데이트할 수 있도록 하려면 이 매개 변수를 사용합니다.
워크플로 시퀀스	workflowSequence		integer	이 받는 사람에게 워크플로 시퀀스 번호를 할당합니다. 로그인 시퀀스를 사용하도록 설정하면 받는 사람은 서명 초대를 오름차순으로 받습니다.
호스트 전자 메일 ID	hostEmailId		string	In-Person 관리자의 전자 메일 주소입니다.
액세스 코드	userDefinedAccessCode		string	"signerAuthLevel" 값이 인증을 위해 "사용자 정의 액세스 코드"로 설정된 경우 매개 변수에 액세스 코드가 포함됩니다. 참고: 1. 코드는 대/소문자를 구분하지 않습니다. 2. 시스템은 이 코드를 보내지 않으므로 서명자와 이 코드를 직접 공유해야 합니다. 3. 액세스 코드에는 알파벳, 숫자 및 @,&{,},,%,(,),~,\|,!,+,^과 같은 특수 문자가 포함될 수 있습니다.
파티가 전자 메일 그룹인 경우	partyIsEmailGroup		boolean	파티를 대량으로 만들 때 이 매개 변수를 사용합니다. 참고: 이 매개 변수가 true이면 이 파티의 firstName, lastName 및 emailId가 무시됩니다.
전자 메일 그룹 ID	emailGroupId		integer	대량 생성에 사용할 그룹 ID를 전자 메일에 전달합니다.
Single Signer Bulk	allowSingleSignerInBulk		boolean	이 매개 변수를 사용하여 한 사람만 전자 메일 그룹에 로그인할 수 있습니다.
전화 걸기 코드	dialingCode		string	이 필드를 사용하여 받는 사람 목록의 받는 사람에게 휴대폰 번호 접두사인 국가 전화 접속 코드를 할당합니다.
휴대폰 번호	mobileNumber		string	받는 사람 목록의 받는 사람에게 휴대폰 번호를 할당하려면 이 필드를 사용합니다.
필드	Fields		object
지금 보내기	sendNow		boolean	사용하도록 설정하면 Foxit eSign은 각 받는 사람의 전자 메일 주소에 고유한 서명 링크를 즉시 보냅니다. 봉투를 초안으로 저장하려면 이 기능을 사용하지 않도록 설정합니다.
포함된 서명 세션 만들기	createEmbeddedSigningSession	True	boolean	서명 세션 토큰은 받는 사람에게 전자 메일을 보내지 않고 생성됩니다.
모든 당사자에 대한 임베디드 서명 세션 만들기	createEmbeddedSigningSessionForAllParties		boolean	true로 설정하면 봉투의 모든 받는 사람에 대해 포함된 서명 URL이 생성됩니다.
텍스트 태그 처리	processTextTags	True	boolean	값은 true 또는 false일 수 있습니다. 이 필드는 Foxit eSign이 텍스트 태그의 문서를 구문 분석하여 Foxit eSign 필드로 변환해야 하는지 여부를 결정하는 데 사용됩니다.
Acro 필드 처리	processAcroFields	True	boolean	이 필드는 Foxit eSign이 AcroFields에 대한 문서를 구문 분석하여 Foxit eSign 필드로 변환해야 하는지 여부를 결정하는 데 사용됩니다.
로그인 시퀀스	signInSequence		boolean	이 필드는 받는 사람이 봉투 문서에 순서대로 서명할지 여부를 결정하는 데 사용됩니다. false이면 모든 받는 사람이 동시에 초대 전자 메일을 받습니다. true이면 이전 받는 사람이 문서 서명 또는 필드 채우기 등과 같은 필수 작업을 완료한 후 각 받는 사람이 연속적으로 초대 전자 메일을 받습니다.
직접 사용	inPersonEnable		boolean	이 필드는 몇 분 안에 모든 디바이스에서 쉽게 완료할 수 있는 직접 서명 프로세스를 시작하고 필요한 경우 이메일 기반 서명을 방지하는 데 사용됩니다. false이면 모든 받는 사람이 동시에 초대 전자 메일을 받습니다. true이면 직접 관리자가 서명자에 대한 서명 프로세스를 시작하기 위한 초대 이메일을 받습니다.
받는 사람 당사자 수정	fixRecipientParties		boolean	true이면 포함된 송신 보기에서 이 요청의 일부로 이미 추가된 봉투의 당사자를 변경할 수 없습니다.
문서 수정	fixDocuments		boolean	true이면 포함된 전송에서 이 요청의 일부로 이미 추가된 봉투의 문서를 변경할 수 없습니다.
성공 URL 보내기	sendSuccessUrl		string	방문 페이지의 절대 URL을 입력합니다. 이 URL은 포함된 송신 보기에서 폴더를 성공적으로 보낸 후 서명자가 리디렉션됩니다.
송신 오류 URL	sendErrorUrl		string	방문 페이지의 절대 URL을 입력합니다. 이 URL은 포함된 송신 보기에서 폴더를 보내는 동안 오류가 발생하면 서명자가 리디렉션됩니다.
포함된 송신 세션 만들기	createEmbeddedSendingSession		boolean	true로 설정하면 포함된 토큰을 생성하여 Foxit eSign의 뷰를 준비하는 문서를 엽니다.
포함된 서명자 전자 메일 ID	embeddedSignersEmailIds		array of string	포함된 서명 세션을 만들어야 하는 받는 사람의 전자 메일 ID 배열입니다. 당사자 목록에 추가된 받는 사람의 전자 메일 ID입니다.
서명 성공 URL	signSuccessUrl		string	포함된 서명 보기에 성공적으로 로그인한 후 리디렉션될 서명자의 절대 URL을 입력합니다.
서명 거부 URL	signDeclineUrl		string	포함된 서명 보기의 로그인을 거부하는 경우 리디렉션될 서명자의 절대 URL을 입력합니다.
나중에 서명 URL	signLaterUrl		string	나중에 포함된 서명 보기에서 서명하도록 선택하는 경우 리디렉션될 서명자의 절대 URL을 입력합니다.
서명 오류 URL	signErrorUrl		string	포함된 서명 보기에서 문서에 서명하는 동안 오류가 발생하면 리디렉션될 서명자의 절대 URL을 입력합니다.
지금 보내기 및 포함된 서명 세션 허용	allowSendNowAndEmbeddedSigningSession		boolean	true로 설정하면 Foxit eSign은 각 받는 사람에게 고유한 서명 링크를 보냅니다. 이는 매개 변수 sendNow 및 createEmbeddedSigningSession이 true인 경우에만 적용됩니다.
고급 전자 메일 유효성 검사	allowAdvancedEmailValidation		boolean	true로 설정된 경우 당사자의 이메일 주소의 유효성을 검사합니다.
서명 성공 URL 모든 당사자	signSuccessUrlAllParties		boolean	true로 설정하면 서명자가 성공적으로 서명한 후 signSuccessUrl에 제공된 URL로 리디렉션됩니다. sendNow가 true인 경우에만 적용됩니다.
전자 메일 템플릿 ID	emailTemplateId		integer	전자 메일 템플릿 ID를 전달하여 기본 전자 메일 템플릿 이외의 전자 메일 템플릿을 보냅니다.
서명자 명령 ID	signerInstructionId		integer	명령 ID를 전달하여 기본 서명자 명령 이외의 서명자 지침을 보냅니다.
확인 명령 ID	confirmationInstructionId		string	기본 확인 지침 이외의 확인 지침을 보내려면 확인 명령 ID를 전달합니다.
테마 색	themeColor		string	CSS 값을 입력하여 테마 색을 설정합니다.
세션 만료	sessionExpire		boolean	포함된 서명 세션의 만료를 시작하려면 true로 설정합니다.
만료	expiry		integer	sessionExpire가 true이면 필수입니다. 포함된 서명 세션에서 만료 기간을 밀리초 단위로 입력합니다.
종속 필드 이름	dependentFieldName	True	string	부모 필드에 의해 표시 유형이 제어되는 필드의 이름입니다.
부모 필드 이름	parentFieldName	True	string	값이 종속 필드의 표시 유형을 제어하는 부모 필드의 이름입니다. 지원되는 부모 필드 유형: 텍스트 필드, 텍스트 상자, 확인란, 라디오 단추, 드롭다운
부모 필드 값	parentFieldValue	True	string	종속 필드가 표시되도록 트리거하는 부모 필드의 값입니다. 확인란 및 라디오 단추 필드의 경우 선택 또는 선택 취소를 사용합니다.
Options	options	True	string	텍스트 기반 부모 필드에 대한 추가 일치 옵션입니다. 허용되는 값: isblank, allowNull, contains.
Metadata	metadata		object	키 값 쌍이어야 합니다. 최대 1,000개의 키 값 쌍이 허용됩니다.
보낸 사람 전자 메일	senderEmail		string	이 문서 폴더를 받는 사람에게 보내는 데 사용할 다른 사용자의 전자 메일을 계정에 입력합니다.
추가 단추 숨기기	hideAddMeButton		boolean	true이면 포함된 송신 세션에서 받는 사람 당사자의 "추가" 단추가 숨겨지게 됩니다.
새로 추가 단추 숨기기	hideAddNewButton		boolean	true이면 포함된 송신 세션에서 받는 사람 당사자의 "새로 추가" 단추가 숨겨지게 됩니다.
그룹 추가 단추 숨기기	hideAddGroupButton		boolean	true이면 포함된 송신 세션에서 받는 사람 당사자의 "그룹 추가" 단추가 숨겨지게 됩니다.
받는 사람의 필드 이름 숨기기	hideFieldNameForRecipients		boolean	데이터 항목 필드 및 고급 필드에 대한 받는 사람의 필드 이름을 숨깁니다. (라디오 단추, 확인란, 이미지 및 하이퍼링크 제외).
확인란 테두리 숨기기	hideCheckboxBorder		boolean	실행된 문서에는 확인란의 테두리가 숨겨집니다.
서명자 선택 옵션 숨기기	hideSignerSelectOption		boolean	true이면 포함된 송신 세션의 받는 사람 당사자에 대한 "기존 서명자 이름/전자 메일" 입력 상자가 숨겨지게 됩니다.
서명자 작업 숨기기	hideSignerActions		boolean	true이면 포함된 송신 세션에서 받는 사람 당사자에 대한 서명자 "편집", "변경" 및 "제거" 작업을 숨깁니다.
보낸 사람 이름 숨기기	hideSenderName		boolean	true이면 포함된 송신 세션에서 받는 사람 당사자의 보낸 사람 이름을 숨깁니다.
폴더 이름 숨기기	hideFolderName		boolean	true이면 포함된 두 세션의 탐색에서 폴더 이름을 숨깁니다.
문서 이름 숨기기	hideDocumentsName		boolean	true이면 포함된 두 세션에서 문서 이름을 숨깁니다.
서명 거부 숨기기	hideDeclineToSign		boolean	true이면 서명자에 대한 "서명 거부" 옵션이 숨겨지게 됩니다.
추가 작업 숨기기	hideMoreAction		boolean	true이면 송신/서명 세션에서 "추가 작업" 단추가 숨겨지게 됩니다. "지금 보내기"의 경우: true이면 아무것도 숨기지 않습니다.
보내기 단추 숨기기	hideSendButton		boolean	true이면 포함된 송신 세션에서 보내기 단추를 숨깁니다.
다음 필수 Fieldbtn 숨기기	hideNextRequiredFieldbtn		boolean	true로 설정하면 서명자를 다음 필수 필드로 이동하는 탐색 단추를 숨깁니다.
포함된 세션 모두 필요	requiredBothEmbeddedSession		boolean	true이면 포함된 송신 및 서명 URL이 함께 생성됩니다.
봉투 암호	folderPassword		string	디지털 서명된 문서를 열려면 서명자/작성자가 이 암호를 입력해야 합니다. 매개 변수를 비워 두면 디지털 서명된 문서를 여는 데 암호가 필요하지 않습니다.
단계별 사용	enableStepByStep		boolean	포함된 송신 세션에서 단계별 작업을 사용하도록 설정합니다.
파티 추가 옵션 숨기기	hideAddPartiesOption		boolean	true이면 초안 및 템플릿 만들기 모드에서 파티 옵션을 추가하는 옵션이 숨겨지게 됩니다.
자체 서명	selfSign		boolean	API를 통해 포함된 Self Sign을 사용하도록 설정합니다. 이 매개 변수는 createEmbeddedSendingSession 매개 변수가 true인 경우에만 적용됩니다.
자체 서명자 성공 URL	selfSignerSuccessUrl		string	웹 사이트/애플리케이션의 방문 페이지에 대한 절대 URL을 입력합니다. 이 URL은 포함된 송신 보기에서 폴더를 보내는 데 성공한 후 사용자가 리디렉션됩니다.

반품

Name	경로	형식	Description
아이디	folder.folderId	integer	새로 만든 봉투의 고유 ID입니다. 이 봉투를 참조하려면 후속 작업에서 이 작업을 사용합니다.
이름	folder.folderName	string	새로 만든 봉투의 이름입니다.
사용자 지정 이름	folder.folderCustomName	string	봉투의 사용자 지정 이름입니다.
Password	folder.folderPassword	string	봉투에 대한 액세스 암호(설정된 경우)입니다.
작성자 ID	folder.folderAuthorId	integer	봉투 작성자의 고유 식별자입니다.
작성자 이름	folder.folderAuthorFirstName	string	봉투 작성자의 이름입니다.
작성자 성	folder.folderAuthorLastName	string	봉투 작성자의 성입니다.
작성자 전자 메일	folder.folderAuthorEmail	string	봉투 작성자의 전자 메일 주소입니다.
작성자 역할	folder.folderAuthorRole	string	봉투 작성자의 역할입니다.
회사 ID	folder.folderCompanyId	integer	봉투를 소유하는 회사의 고유 식별자입니다.
생성 날짜	folder.folderCreationDate	integer	봉투가 만들어진 날짜(Unix 타임스탬프(밀리초)입니다.
보낸 날짜	folder.folderSentDate	integer	봉투가 전송된 날짜(Unix 타임스탬프(밀리초)입니다.
Status	folder.folderStatus	string	봉투의 현재 상태입니다.
사용자 정의 필드 1	folder.custom_field1	string	봉투에 대한 첫 번째 사용자 지정 메타데이터 필드입니다.
사용자 정의 필드 2	folder.custom_field2	string	봉투에 대한 두 번째 사용자 지정 메타데이터 필드입니다.
Metadata	folder.metadata	string	봉투와 연결된 사용자 지정 메타데이터입니다.
문서 ID	folder.folderDocumentIds	array of integer	봉투에 포함된 문서 ID 목록입니다.
문서	folder.documentsList	array of object	봉투에 있는 문서 목록입니다.
문서 ID	folder.documentsList.documentId	integer	문서의 고유 식별자입니다.
계약 ID	folder.documentsList.contractId	integer	계약의 고유 식별자입니다.
회사 ID	folder.documentsList.companyId	integer	회사의 고유 식별자입니다.
작성자	folder.documentsList.contractCreatedBy	integer	계약을 만든 사용자의 사용자 ID입니다.
생성 일자	folder.documentsList.contractCreatedOn	string	계약이 만들어진 날짜 및 시간입니다.
계약 유형	folder.documentsList.contractType	string	계약의 형식입니다.
계약 상태	folder.documentsList.contractStatus	string	계약의 현재 상태입니다.
수정 가능	folder.documentsList.editable	boolean	항목을 편집할 수 있는지 여부를 나타냅니다.
버전 ID	folder.documentsList.contractVersionId	integer	계약 버전의 고유 식별자입니다.
버전 이름	folder.documentsList.contractVersionName	string	계약 버전의 이름입니다.
버전 설명	folder.documentsList.contractVersionDesc	string	계약 버전에 대한 설명입니다.
만든 버전	folder.documentsList.versionCreatedby	integer	이 버전을 만든 사용자의 사용자 ID입니다.
만든 버전	folder.documentsList.versionCreatedOn	string	이 버전을 만든 날짜와 시간입니다.
버전 번호	folder.documentsList.contractVersionNumber	integer	계약의 버전 번호입니다.
트랜잭션 원본	folder.documentsList.contractTransactionSource	string	계약 트랜잭션을 시작한 원본 시스템입니다.
받는 사람	folder.folderRecipientParties	array of object	이 봉투의 받는 사람 파티 목록입니다.
받는 사람 ID	folder.folderRecipientParties.partyId	integer	받는 사람의 고유 식별자입니다.
받는 사람 ID	folder.folderRecipientParties.partyDetails.partyId	integer	받는 사람의 고유 식별자입니다.
이름 (First Name)	folder.folderRecipientParties.partyDetails.firstName	string	받는 사람의 이름입니다.
성 이름	folder.folderRecipientParties.partyDetails.lastName	string	받는 사람의 성입니다.
Email 주소	folder.folderRecipientParties.partyDetails.emailId	string	받는 사람의 전자 메일 주소입니다.
Placeholder	folder.folderRecipientParties.partyDetails.placeholder	boolean	이 파티가 자리 표시자 수신자인지 여부를 나타냅니다.
Address	folder.folderRecipientParties.partyDetails.address	string	받는 사람의 실제 주소입니다.
만든 날짜	folder.folderRecipientParties.partyDetails.dateCreated	integer	레코드가 만들어진 날짜(Unix 타임스탬프(밀리초)입니다.
전자 메일 옵트아웃	folder.folderRecipientParties.partyDetails.optOutEmails	boolean	받는 사람이 전자 메일 알림을 옵트아웃했는지 여부를 나타냅니다.
고유한 받는 사람 ID	folder.folderRecipientParties.partyDetails.uniquePartyId	string	이 받는 사람에 대한 고유한 시스템 식별자입니다.
인증 수준	folder.folderRecipientParties.partyDetails.authenticationLevel	string	이 받는 사람에게 필요한 인증 방법입니다.
암호 업데이트 날짜	folder.folderRecipientParties.partyDetails.passwordUpdateDate	string	암호가 마지막으로 업데이트된 날짜입니다.
암호 업데이트 상태	folder.folderRecipientParties.partyDetails.passwordUpdateStatus	boolean	암호가 업데이트되었는지 여부를 나타냅니다.
회사 ID	folder.folderRecipientParties.partyDetails.companyId	integer	회사의 고유 식별자입니다.
사용자 역할	folder.folderRecipientParties.partyDetails.userRole	string	사용자에게 할당된 역할입니다.
부서	folder.folderRecipientParties.partyDetails.department	string	사용자가 속한 부서입니다.
Title	folder.folderRecipientParties.partyDetails.title	string	사용자의 직위입니다.
진행 중	folder.folderRecipientParties.partyDetails.active	boolean	사용자 또는 레코드가 활성 상태인지 여부를 나타냅니다.
로케일	folder.folderRecipientParties.partyDetails.requestLocale	string	사용자의 로캘 설정입니다.
부서와 공유	folder.folderRecipientParties.partyDetails.share_among_department	boolean	봉투가 부서 간에 공유되는지 여부를 나타냅니다.
전화 걸기 코드	folder.folderRecipientParties.partyDetails.dialingCode	string	전화 번호의 국제 전화 번호입니다.
휴대폰 번호	folder.folderRecipientParties.partyDetails.mobileNumber	string	휴대폰 번호입니다.
상태 필터	folder.folderRecipientParties.partyDetails.docStatusFilter	string	문서 상태에 대한 필터입니다.
날짜 필터	folder.folderRecipientParties.partyDetails.docDateFilter	string	문서 날짜에 대한 필터입니다.
보안 필드 액세스	folder.folderRecipientParties.partyDetails.userSecureFieldAccess	boolean	사용자가 보안 필드에 액세스할 수 있는지 여부를 나타냅니다.
사이드바 확장	folder.folderRecipientParties.partyDetails.expandSidebar	boolean	사이드바가 기본적으로 확장되는지 여부를 나타냅니다.
Adv. 전자 메일 유효성 검사	folder.folderRecipientParties.partyDetails.allowAdvancedEmailValidation	boolean	고급 전자 메일 유효성 검사를 사용할 수 있는지 여부를 나타냅니다.
관리자 ID	folder.folderRecipientParties.partyDetails.managerId	string	사용자 관리자의 고유 식별자입니다.
로그인 수	folder.folderRecipientParties.partyDetails.loginCount	integer	사용자가 로그인한 횟수입니다.
암호 재설정 전자 메일	folder.folderRecipientParties.partyDetails.sendMailForPasswordReset	boolean	암호 재설정 전자 메일을 보낼지 여부를 나타냅니다.
부서 ID	folder.folderRecipientParties.partyDetails.departmentId	string	부서의 고유 식별자입니다.
기본 회사	folder.folderRecipientParties.partyDetails.userPrimaryCompany	integer	사용자와 연결된 기본 회사입니다.
디바이스 유형	folder.folderRecipientParties.partyDetails.deviceType	string	사용되는 디바이스의 유형입니다.
디바이스 토큰	folder.folderRecipientParties.partyDetails.deviceToken	string	디바이스에 대한 푸시 알림 토큰입니다.
하도급자 설명	folder.folderRecipientParties.partyDetails.subcontractorDescription	string	하청업체 또는 외부 서명자에 대한 설명입니다.
하도급업체 조직	folder.folderRecipientParties.partyDetails.subcontractorOrganization	string	하청업체 또는 외부 서명자의 조직 이름입니다.
하도급업체 추가 날짜	folder.folderRecipientParties.partyDetails.subcAddedDate	integer	하청업체가 추가된 날짜(Unix 타임스탬프(밀리초)입니다.
Source	folder.folderRecipientParties.partyDetails.source	string	외부 서명자가 추가된 원본 시스템입니다.
전화 걸기 코드	folder.folderRecipientParties.dialingCode	string	전화 번호의 국제 전화 번호입니다.
휴대폰 번호	folder.folderRecipientParties.mobileNumber	string	휴대폰 번호입니다.
서명 유형	folder.folderRecipientParties.signerSignatureType	string	서명자가 사용할 서명의 형식입니다.
Permissions	folder.folderRecipientParties.contractPermissions	string	계약에 대해 이 당사자에게 부여된 권한입니다.
서명 순서	folder.folderRecipientParties.partySequence	integer	이 받는 사람에 대한 서명 순서 시퀀스 번호입니다.
워크플로 시퀀스	folder.folderRecipientParties.workflowSignSequence	integer	워크플로 서명 시퀀스 번호입니다.
봉투 ID	folder.folderRecipientParties.envelopeId	integer	봉투의 고유 식별자입니다.
받는 사람 회사 ID	folder.folderRecipientParties.partyCompanyId	integer	이 받는 사람과 연결된 회사의 고유 식별자입니다.
공유 모드	folder.folderRecipientParties.sharingMode	string	이 봉투의 공유 모드입니다.
받는 사람 액세스 URL	folder.folderRecipientParties.folderAccessURL	string	받는 사람이 봉투에 액세스하고 서명하는 데 사용할 수 있는 URL입니다.
보안 모드	folder.folderRecipientParties.securityMode	string	이 봉투에 적용되는 보안 모드입니다.
코멘트	folder.folderRecipientParties.extraComments	string	봉투에 추가 설명이 포함되어 있습니다.
이름 변경 허용	folder.folderRecipientParties.allowNameChange	boolean	받는 사람이 이름을 업데이트할 수 있는지 여부를 나타냅니다.
이름이 업데이트됨	folder.folderRecipientParties.signerNameUpdated	boolean	서명자가 이름을 업데이트했는지 여부를 나타냅니다.
서명자 인증 수준	folder.folderRecipientParties.signerAuthenticationLevel	string	서명자에 필요한 인증 수준입니다.
액세스 코드	folder.folderRecipientParties.userDefinedAccessCode	string	서명자에 대해 정의된 사용자 지정 액세스 코드입니다.
서명 ID	folder.folderRecipientParties.signatureId	string	서명의 고유 식별자입니다.
받는 사람 역할	folder.folderRecipientParties.partyRole	string	서명 워크플로에서 이 받는 사람에게 할당된 역할입니다.
회사 필드	folder.folderRecipientParties.companyFieldValue	string	서명에 있는 회사 이름 필드의 값입니다.
제목 필드	folder.folderRecipientParties.titleFieldValue	string	서명에 있는 제목 필드의 값입니다.
서명 이유	folder.folderRecipientParties.reasonSigning	string	받는 사람이 문서에 서명하는 이유입니다.
결제 필드가 추가됨	folder.folderRecipientParties.payFieldAdded	boolean	결제 필드가 추가되었는지 여부를 나타냅니다.
수취인	folder.folderRecipientParties.payee	boolean	이 수신자가 수취인인지 여부를 나타냅니다.
되풀이 결제	folder.folderRecipientParties.recurringFieldExist	boolean	되풀이 결제 필드가 있는지 여부를 나타냅니다.
인쇄 및 서명 완료	folder.folderRecipientParties.printAndSignCompleted	boolean	인쇄 및 서명 프로세스가 완료되었는지 여부를 나타냅니다.
지불	folder.folderRecipientParties.paid	boolean	결제가 완료되었는지 여부를 나타냅니다.
선택적 서명자 허용	folder.folderRecipientParties.allowOptionalSigner	boolean	이 받는 사람이 선택적 서명자인지 여부를 나타냅니다.
선택적 서명자	folder.folderRecipientParties.optionalSigners	array of integer	이 봉투에 대한 선택적 서명자 파티 ID 목록입니다.
작성자 서명 URL	folder.folderAccessURLForAuthor	string	보낸 사람에서 봉투에 액세스하는 데 사용할 수 있는 URL입니다.
초안 액세스 URL	folder.draftFolderAccessURL	string	봉투의 초안 버전에 액세스하는 데 사용되는 URL입니다.
회의실 서명	folder.boardRoomSign	boolean	보드룸 서명 모드를 사용할 수 있는지 여부를 나타냅니다.
로고 포함	folder.includeLogo	boolean	회사 로고가 전자 메일에 포함되는지 여부를 나타냅니다.
단추 배경색	folder.email_btnBgColor	string	전자 메일 단추의 배경색입니다.
단추 텍스트 색	folder.email_btnTxtColor	string	전자 메일 단추의 텍스트 색입니다.
전자 메일 로고	folder.emailTemplateLogo	string	전자 메일 템플릿에 사용되는 로고 URL입니다.
전자 메일 템플릿 ID	folder.emailTemplateId	integer	전자 메일 템플릿의 고유 식별자입니다.
전자 메일 헤더	folder.emailHeader	string	알림 이메일에 사용되는 헤더 텍스트입니다.
전자 메일 바닥글	folder.emailFooter	string	알림 전자 메일에 사용되는 바닥글 텍스트입니다.
예약된 제거	folder.purgeFlag	boolean	봉투가 제거 예약되었는지 여부를 나타냅니다.
시작 날짜 제거	folder.purgeStartDate	string	제거가 시작되도록 예약된 날짜입니다.
종료 날짜 제거	folder.purgeEndDate	string	제거가 완료되도록 예약된 날짜입니다.
대량 보내기 ID	folder.bulkId	integer	대량 보내기 작업의 고유 식별자입니다.
서명 순서 적용	folder.enforceSignWorkflow	boolean	받는 사람이 정의된 시퀀스에 로그인해야 하는지 여부를 나타냅니다.
현재 단계	folder.currentWorkflowStep	integer	서명 워크플로의 현재 단계입니다.
트랜잭션 원본	folder.transactionSource	string	이 트랜잭션을 시작한 원본 시스템입니다.
수정 가능	folder.editable	boolean	항목을 편집할 수 있는지 여부를 나타냅니다.
In-Person 서명	folder.inPersonSignable	boolean	봉투를 직접 로그인할 수 있는지 여부를 나타냅니다.
미리 알림 재정의	folder.overrideAccountReminders	boolean	계정 수준 미리 알림 설정이 재정의되는지 여부를 나타냅니다.
위임 재정의	folder.overrideAccountRecipientDelegation	boolean	계정 수준 위임 설정이 재정의되는지 여부를 나타냅니다.
위임 허용	folder.allowRecipientsToDelegate	boolean	받는 사람이 서명을 위임할 수 있는지 여부를 나타냅니다.
아이디	folder.envelopeId	integer	봉투의 고유 식별자입니다.
이름	folder.envelopeName	string	봉투의 이름입니다.
발신기 ID	folder.envelopeOriginatorId	integer	봉투를 만든 사용자의 고유 식별자입니다.
회사 ID	folder.envelopeCompanyId	integer	봉투를 소유하는 회사의 고유 식별자입니다.
Date	folder.envelopeDate	integer	봉투가 만들어진 날짜(Unix 타임스탬프(밀리초)입니다.
공유 날짜	folder.envelopeSharedDate	integer	봉투가 공유된 날짜(Unix 타임스탬프(밀리초)입니다.
Status	folder.envelopeStatus	string	봉투의 현재 상태입니다.
계약 ID	folder.envelopeContractIds	array of integer	이 봉투와 연결된 계약 ID 목록입니다.
받는 사람 권한	folder.envelopePartyPermissions	array of object	이 봉투에 대한 받는 사람 권한 목록입니다.
받는 사람 ID	folder.envelopePartyPermissions.partyId	integer	받는 사람의 고유 식별자입니다.
받는 사람 ID	folder.envelopePartyPermissions.partyDetails.partyId	integer	받는 사람의 고유 식별자입니다.
이름 (First Name)	folder.envelopePartyPermissions.partyDetails.firstName	string	받는 사람의 이름입니다.
성 이름	folder.envelopePartyPermissions.partyDetails.lastName	string	받는 사람의 성입니다.
Email 주소	folder.envelopePartyPermissions.partyDetails.emailId	string	받는 사람의 전자 메일 주소입니다.
Placeholder	folder.envelopePartyPermissions.partyDetails.placeholder	boolean	이 파티가 자리 표시자 수신자인지 여부를 나타냅니다.
Address	folder.envelopePartyPermissions.partyDetails.address	string	받는 사람의 실제 주소입니다.
만든 날짜	folder.envelopePartyPermissions.partyDetails.dateCreated	integer	레코드가 만들어진 날짜(Unix 타임스탬프(밀리초)입니다.
전자 메일 옵트아웃	folder.envelopePartyPermissions.partyDetails.optOutEmails	boolean	받는 사람이 전자 메일 알림을 옵트아웃했는지 여부를 나타냅니다.
고유한 받는 사람 ID	folder.envelopePartyPermissions.partyDetails.uniquePartyId	string	이 받는 사람에 대한 고유한 시스템 식별자입니다.
인증 수준	folder.envelopePartyPermissions.partyDetails.authenticationLevel	string	이 받는 사람에게 필요한 인증 방법입니다.
암호 업데이트 날짜	folder.envelopePartyPermissions.partyDetails.passwordUpdateDate	string	암호가 마지막으로 업데이트된 날짜입니다.
암호 업데이트 상태	folder.envelopePartyPermissions.partyDetails.passwordUpdateStatus	boolean	암호가 업데이트되었는지 여부를 나타냅니다.
회사 ID	folder.envelopePartyPermissions.partyDetails.companyId	integer	회사의 고유 식별자입니다.
사용자 역할	folder.envelopePartyPermissions.partyDetails.userRole	string	사용자에게 할당된 역할입니다.
부서	folder.envelopePartyPermissions.partyDetails.department	string	사용자가 속한 부서입니다.
Title	folder.envelopePartyPermissions.partyDetails.title	string	사용자의 직위입니다.
진행 중	folder.envelopePartyPermissions.partyDetails.active	boolean	사용자 또는 레코드가 활성 상태인지 여부를 나타냅니다.
로케일	folder.envelopePartyPermissions.partyDetails.requestLocale	string	사용자의 로캘 설정입니다.
부서와 공유	folder.envelopePartyPermissions.partyDetails.share_among_department	boolean	봉투가 부서 간에 공유되는지 여부를 나타냅니다.
전화 걸기 코드	folder.envelopePartyPermissions.partyDetails.dialingCode	string	전화 번호의 국제 전화 번호입니다.
휴대폰 번호	folder.envelopePartyPermissions.partyDetails.mobileNumber	string	휴대폰 번호입니다.
상태 필터	folder.envelopePartyPermissions.partyDetails.docStatusFilter	string	문서 상태에 대한 필터입니다.
날짜 필터	folder.envelopePartyPermissions.partyDetails.docDateFilter	string	문서 날짜에 대한 필터입니다.
보안 필드 액세스	folder.envelopePartyPermissions.partyDetails.userSecureFieldAccess	boolean	사용자가 보안 필드에 액세스할 수 있는지 여부를 나타냅니다.
사이드바 확장	folder.envelopePartyPermissions.partyDetails.expandSidebar	boolean	사이드바가 기본적으로 확장되는지 여부를 나타냅니다.
Adv. 전자 메일 유효성 검사	folder.envelopePartyPermissions.partyDetails.allowAdvancedEmailValidation	boolean	고급 전자 메일 유효성 검사를 사용할 수 있는지 여부를 나타냅니다.
관리자 ID	folder.envelopePartyPermissions.partyDetails.managerId	string	사용자 관리자의 고유 식별자입니다.
로그인 수	folder.envelopePartyPermissions.partyDetails.loginCount	integer	사용자가 로그인한 횟수입니다.
암호 재설정 전자 메일	folder.envelopePartyPermissions.partyDetails.sendMailForPasswordReset	boolean	암호 재설정 전자 메일을 보낼지 여부를 나타냅니다.
부서 ID	folder.envelopePartyPermissions.partyDetails.departmentId	string	부서의 고유 식별자입니다.
기본 회사	folder.envelopePartyPermissions.partyDetails.userPrimaryCompany	integer	사용자와 연결된 기본 회사입니다.
디바이스 유형	folder.envelopePartyPermissions.partyDetails.deviceType	string	사용되는 디바이스의 유형입니다.
디바이스 토큰	folder.envelopePartyPermissions.partyDetails.deviceToken	string	디바이스에 대한 푸시 알림 토큰입니다.
하도급자 설명	folder.envelopePartyPermissions.partyDetails.subcontractorDescription	string	하청업체 또는 외부 서명자에 대한 설명입니다.
하도급업체 조직	folder.envelopePartyPermissions.partyDetails.subcontractorOrganization	string	하청업체 또는 외부 서명자의 조직 이름입니다.
하도급업체 추가 날짜	folder.envelopePartyPermissions.partyDetails.subcAddedDate	integer	하청업체가 추가된 날짜(Unix 타임스탬프(밀리초)입니다.
Source	folder.envelopePartyPermissions.partyDetails.source	string	외부 서명자가 추가된 원본 시스템입니다.
전화 걸기 코드	folder.envelopePartyPermissions.dialingCode	string	전화 번호의 국제 전화 번호입니다.
휴대폰 번호	folder.envelopePartyPermissions.mobileNumber	string	휴대폰 번호입니다.
서명 유형	folder.envelopePartyPermissions.signerSignatureType	string	서명자가 사용할 서명의 형식입니다.
Permissions	folder.envelopePartyPermissions.contractPermissions	string	계약에 대해 이 당사자에게 부여된 권한입니다.
서명 순서	folder.envelopePartyPermissions.partySequence	integer	이 받는 사람에 대한 서명 순서 시퀀스 번호입니다.
워크플로 시퀀스	folder.envelopePartyPermissions.workflowSignSequence	integer	워크플로 서명 시퀀스 번호입니다.
봉투 ID	folder.envelopePartyPermissions.envelopeId	integer	봉투의 고유 식별자입니다.
받는 사람 회사 ID	folder.envelopePartyPermissions.partyCompanyId	integer	이 받는 사람과 연결된 회사의 고유 식별자입니다.
공유 모드	folder.envelopePartyPermissions.sharingMode	string	이 봉투의 공유 모드입니다.
받는 사람 액세스 URL	folder.envelopePartyPermissions.folderAccessURL	string	받는 사람이 봉투에 액세스하고 서명하는 데 사용할 수 있는 URL입니다.
보안 모드	folder.envelopePartyPermissions.securityMode	string	이 봉투에 적용되는 보안 모드입니다.
코멘트	folder.envelopePartyPermissions.extraComments	string	봉투에 추가 설명이 포함되어 있습니다.
이름 변경 허용	folder.envelopePartyPermissions.allowNameChange	boolean	받는 사람이 이름을 업데이트할 수 있는지 여부를 나타냅니다.
이름이 업데이트됨	folder.envelopePartyPermissions.signerNameUpdated	boolean	서명자가 이름을 업데이트했는지 여부를 나타냅니다.
서명자 인증 수준	folder.envelopePartyPermissions.signerAuthenticationLevel	string	서명자에 필요한 인증 수준입니다.
액세스 코드	folder.envelopePartyPermissions.userDefinedAccessCode	string	서명자에 대해 정의된 사용자 지정 액세스 코드입니다.
서명 ID	folder.envelopePartyPermissions.signatureId	string	서명의 고유 식별자입니다.
받는 사람 역할	folder.envelopePartyPermissions.partyRole	string	서명 워크플로에서 이 받는 사람에게 할당된 역할입니다.
회사 필드	folder.envelopePartyPermissions.companyFieldValue	string	서명에 있는 회사 이름 필드의 값입니다.
제목 필드	folder.envelopePartyPermissions.titleFieldValue	string	서명에 있는 제목 필드의 값입니다.
서명 이유	folder.envelopePartyPermissions.reasonSigning	string	받는 사람이 문서에 서명하는 이유입니다.
결제 필드가 추가됨	folder.envelopePartyPermissions.payFieldAdded	boolean	결제 필드가 추가되었는지 여부를 나타냅니다.
수취인	folder.envelopePartyPermissions.payee	boolean	이 수신자가 수취인인지 여부를 나타냅니다.
되풀이 결제	folder.envelopePartyPermissions.recurringFieldExist	boolean	되풀이 결제 필드가 있는지 여부를 나타냅니다.
인쇄 및 서명 완료	folder.envelopePartyPermissions.printAndSignCompleted	boolean	인쇄 및 서명 프로세스가 완료되었는지 여부를 나타냅니다.
지불	folder.envelopePartyPermissions.paid	boolean	결제가 완료되었는지 여부를 나타냅니다.
인증 수준	folder.envelopeAuthenticationLevel	string	봉투에 필요한 인증 수준입니다.
Single Signer Bulk	folder.allowSingleSignerInBulk	boolean	단일 서명자가 대량 송신 모드에서 허용되는지 여부를 나타냅니다.
File-Based 이름 지정	folder.folderNameBasedOnFileNaming	boolean	폴더 이름이 파일 이름을 기반으로 하는지 여부를 나타냅니다.
문서 File-Based 이름	folder.documentNameBasedOnFileNaming	boolean	문서 이름이 파일 이름을 기반으로 하는지 여부를 나타냅니다.
인증서 File-Based 이름	folder.certificateNameBasedOnFileNaming	boolean	인증서 이름이 파일 이름을 기반으로 하는지 여부를 나타냅니다.
Pre-Exec 파일 이름 지정	folder.enableFileNamingBeforeExecution	boolean	문서 실행 전에 파일 이름을 사용할 수 있는지 여부를 나타냅니다.
추가된 수취인	folder.payeeAddedd	boolean	수취인을 추가했는지 여부를 나타냅니다.
Self-Signing 사용	folder.selfSignerEnabled	boolean	자체 서명 모드를 사용할 수 있는지 여부를 나타냅니다.
공증 사용	folder.notaryEnabled	boolean	공증 서명이 사용되는지 여부를 나타냅니다.
제한된 표시 유형	folder.limitedVisibilityFlag	boolean	이 봉투에 대해 제한된 표시 유형을 사용할 수 있는지 여부를 나타냅니다.
사후 서명 표시 유형	folder.postSigningVisibility	boolean	서명 후 표시 유형을 사용할 수 있는지 여부를 나타냅니다.
젖은 서명	folder.wetSignatureEnabled	boolean	습식 서명을 사용할 수 있는지 여부를 나타냅니다.
병합 사용	folder.mergeEnabled	boolean	문서 병합을 사용할 수 있는지 여부를 나타냅니다.
포함된 서명 세션	embeddedSigningSessions	array of object	포함된 서명 세션의 목록으로, 받는 사람당 하나씩. createEmbeddedSigningSession이 true인 경우에만 존재합니다.
서명자 전자 메일	embeddedSigningSessions.emailIdOfSigner	string	이 포함된 서명 세션에 대한 받는 사람의 전자 메일 주소입니다.
서명 토큰	embeddedSigningSessions.embeddedToken	string	이 받는 사람의 포함된 서명 세션에 대한 고유 토큰입니다.
서명 세션 URL	embeddedSigningSessions.embeddedSessionURL	string	이 받는 사람이 문서에 서명할 수 있도록 열거나 포함할 URL입니다.
포함된 전송 토큰	embeddedToken	string	포함된 송신 세션에 대한 토큰입니다. createEmbeddedSendingSession이 true인 경우에만 존재합니다.
세션 URL 보내기	embeddedSessionURL	string	봉투 작성자가 봉투를 준비하고 보낼 수 있도록 열거나 포함할 URL입니다. createEmbeddedSendingSession이 true인 경우에만 존재합니다.
Result	result	string	작업의 결과입니다.
Message	message	string	작업 결과를 설명하는 메시지입니다.

Base64에서 템플릿 만들기

작업 ID:: CreateTemplatefromBase64

Base64로 인코딩된 PDF 문자열을 사용하여 새 템플릿을 만듭니다. PDF 파일을 흐름에서 Base64 문자열로 이미 사용할 수 있는 경우(예: SharePoint 파일 또는 OneDrive 문서에서) 사용합니다.

매개 변수

Name	키	필수	형식	Description
템플릿 이름	templateName	True	string	템플릿의 이름입니다. .pdf 확장(예: onboarding.pdf)으로 끝나야 합니다.
Base64 파일 문자열	base64FileString	True	string	템플릿을 만들기 위한 PDF의 BASE64 문자열입니다. 템플릿을 만들 때 공개적으로 액세스할 수 있어야 합니다.
입력 형식	inputType	True	string	문서의 입력 메서드입니다. 이 작업에 대해 항상 'base64'로 설정합니다.
텍스트 태그 처리	processTextTags	True	boolean	사용하도록 설정하면 Foxit eSign은 문서에서 텍스트 태그를 검색하고 자동으로 서명 필드로 변환합니다.
Acro 필드 처리	processAcroFields	True	boolean	사용하도록 설정하면 Foxit eSign은 문서를 AcroFields로 검색하고 자동으로 서명 필드로 변환합니다.
모두 공유	shareAll	True	boolean	계정의 모든 사용자와 이 템플릿을 공유합니다.
파티 수	numberOfParties	True	integer	이 서식 파일의 받는 사람 수입니다. 20 미만이어야 합니다.
테마 색	themeColor		string	포함된 템플릿 세션의 테마를 사용자 지정하는 CSS 색 값입니다(예: #42caf4).
작성자 Email	authorEmail		string	이 템플릿의 작성자로 설정할 계정의 다른 사용자의 전자 메일 주소입니다.
포함된 템플릿 세션 만들기	createEmbeddedTemplateSession		boolean	true로 설정하면 포함된 템플릿 세션이 만들어지므로 Foxit eSign 템플릿 편집기를 직접 열고 필드를 템플릿으로 끌어서 놓을 수 있습니다.
리디렉션 URL	redirectURL		string	포함된 템플릿 만들기 세션이 true이면 포함된 템플릿 편집기에서 저장 및 닫기를 클릭한 후 사용자를 리디렉션할 URL입니다.
보내기 템플릿 숨기기	hideSendTemplate		boolean	true이면 포함된 템플릿 편집기에서 보내기 단추가 숨겨집니다.
받는 사람 당사자 수정	fixRecipientParties		boolean	true이면 포함된 템플릿 편집기에서 이미 추가된 받는 사람을 변경할 수 없습니다.
필드	Fields		object
permissions	permission	True	string
Sequence	sequence	True	integer	1부터 시작하는 이 파티의 고유 시퀀스 번호입니다. 로그인 시퀀스를 사용하는 경우 서명 순서를 정의합니다.
받는 사람 역할	partyRole	True	string	템플릿에서 이 파티에 할당된 역할입니다.
추가 작업 숨기기	hideMoreAction		boolean	true이면 포함된 템플릿 세션에서 추가 작업 단추가 숨겨집니다.
모두와 공유 숨기기	hideShareWithAll		boolean	true이면 포함된 템플릿 세션에서 모두와 공유 옵션이 숨겨집니다.
파티 추가 숨기기	hideAddParty		boolean	true이면 포함된 템플릿 세션에서 모든 파티 추가 옵션이 숨겨집니다.
숨기기 단추	hideMeButton		boolean	true이면 수신자 파티의 Me 단추가 포함된 템플릿 세션에서 숨겨집니다.
다른 항목 숨기기 단추	hideOthersButton		boolean	true이면 받는 사람 당사자의 기타 단추가 포함된 템플릿 세션에서 숨겨집니다.
받는 사람의 필드 이름 숨기기	hideFieldNameForRecipients		boolean	true이면 데이터 입력 및 고급 필드에 대해 받는 사람으로부터 필드 이름이 숨겨집니다.
확인란 테두리 숨기기	hideCheckboxBorder		boolean	true이면 실행된 문서에 확인란 테두리가 숨겨집니다.

반품

Name	경로	형식	Description
Result	result	string	작업이 성공했는지 여부를 나타냅니다(예: '성공').
Message	message	string	작업 결과에 대한 설명입니다.
아이디	template.templateId	integer	만든 템플릿의 고유 ID입니다. 이 템플릿에서 봉투를 만들려면 이 방법을 사용합니다.
이름	template.templateName	string	템플릿의 이름입니다.
Description	template.templateDesc	string	템플릿에 대한 설명입니다.
Type	template.templateType	string	템플릿의 형식입니다.
만든 날짜	template.templateCreationDate	string	템플릿을 만든 날짜입니다.
마지막 업데이트 날짜	template.templateLastUpdateDate	string	템플릿이 마지막으로 업데이트된 날짜입니다.
수정 가능	template.editable	boolean	템플릿을 편집할 수 있는지 여부를 나타냅니다.
파티 수	template.numberOfParties	integer	템플릿에 정의된 받는 사람 수입니다.
총 페이지 수	template.totalPages	integer	서식 파일 문서의 총 페이지 수입니다.
회사 ID	template.companyId	integer	이 템플릿이 속한 회사의 ID입니다.
모두와 공유	template.shareAll	boolean	이 템플릿이 계정의 모든 사용자와 공유되는지 여부를 나타냅니다.
파티 사용 권한	template.templatePartyPermissions	array of object	이 템플릿에 정의된 받는 사람 역할 및 사용 권한 목록입니다.
파티 ID	template.templatePartyPermissions.template_party_id	integer	이 템플릿 파티 항목의 고유 ID입니다.
아이디	template.templatePartyPermissions.templateId	integer	이 파티가 속한 템플릿의 ID입니다.
Permissions	template.templatePartyPermissions.templatePermissions	string	이 당사자에 대한 서명 권한(예: FILL_FIELDS_AND_SIGN)입니다.
서명 순서	template.templatePartyPermissions.partySequence	integer	이 파티의 서명 순서 위치입니다.
파티 역할	template.templatePartyPermissions.templatePartyRole	string	템플릿에서 이 파티에 할당된 역할 이름입니다. 템플릿에서 봉투를 만들 때 사용합니다.
사용자 ID	template.templateCreatedBy.partyId	integer	사용자의 고유 ID입니다.
이름 (First Name)	template.templateCreatedBy.firstName	string	사용자의 이름입니다.
성 이름	template.templateCreatedBy.lastName	string	사용자의 성입니다.
전자 메일	template.templateCreatedBy.emailId	string	사용자의 전자 메일 주소입니다.
템플릿 필드	allfields	array of object	템플릿에 정의된 모든 서명 및 양식 필드 목록입니다.
필드 ID	allfields.fieldTagId	integer	필드의 고유 식별자입니다.
템플릿 아이디	allfields.templateId	integer	이 필드가 속한 템플릿의 ID입니다.
회사 ID	allfields.companyId	integer	이 필드가 속한 회사 계정입니다.
필드 유형	allfields.fieldType	string	필드의 형식(예: signfield, initialfield, textfield, datefield, checkboxfield, securedfield, attachmentfield)입니다.
페이지 번호	allfields.documentPageNumber	integer	이 필드가 배치된 문서의 페이지 번호입니다.
책임 당사자	allfields.partyResponsible	integer	이 필드를 채우는 파티 시퀀스 번호입니다.
파티 시퀀스	allfields.partyResponsibleSequence	integer	책임 당사자의 시퀀스 위치입니다.
필드 문서 ID	allfields.docFieldId	string	이 필드의 문서 수준 식별자입니다.
종속성	allfields.dependent	boolean	이 필드의 표시 유형이 다른 필드의 값에 따라 달라지는지 여부를 나타냅니다.
탭 순서	allfields.tabOrder	integer	필드 간 탐색을 위한 탭 순서입니다.
필수	allfields.required	boolean	문서에 서명하기 전에 이 필드를 채워야 하는지 여부를 나타냅니다.
사용자 지정 필드 이름	allfields.customFieldName	string	이 필드에 할당된 사용자 지정 이름입니다.
모두 공유	allfields.shareAll	boolean	이 필드가 모든 사용자와 공유되는지 여부를 나타냅니다.
편집 허용	allfields.allowEdit	boolean	받는 사람이 이 필드를 편집할 수 있는지 여부를 나타냅니다.
텍스트 필드 이름	allfields.textfieldName	string	텍스트 필드의 레이블입니다(fieldType이 'textfield'인 경우 적용 가능).
가치	allfields.value	string	필드의 미리 채워지거나 입력한 값입니다.
글꼴 크기	allfields.fontSize	integer	이 필드의 텍스트에 사용되는 글꼴 크기입니다.
글꼴 색	allfields.fontColor	string	이 필드의 텍스트에 사용되는 글꼴 색(예: #000000)입니다.
읽기 전용	allfields.readOnly	boolean	필드가 읽기 전용이고 받는 사람이 편집할 수 없는지 여부를 나타냅니다.
여러 줄	allfields.multiLine	boolean	텍스트 필드가 여러 줄의 입력을 허용하는지 여부를 나타냅니다(fieldType이 'textfield'인 경우 적용 가능).
문자 제한	allfields.characterLimit	integer	필드에 허용되는 최대 문자 수입니다(fieldType이 'textfield'인 경우 적용 가능).
날짜 필드 이름	allfields.datefieldName	string	날짜 필드의 레이블입니다(fieldType이 'datefield'인 경우 적용 가능).
날짜 형식	allfields.dateFormat	string	이 필드에 사용되는 날짜 형식(예: MM/DD/YYYY)입니다(fieldType이 'datefield'인 경우 적용 가능).
확인란 이름	allfields.cbname	string	확인란 필드의 레이블입니다(fieldType이 'checkboxfield'인 경우 적용 가능).
확인란 그룹	allfields.cbgroup	string	이 확인란의 그룹 이름입니다(fieldType이 'checkboxfield'인 경우 적용 가능).
체크됨	allfields.checked	boolean	확인란이 기본적으로 선택되어 있는지 여부를 나타냅니다(fieldType이 'checkboxfield'인 경우 적용 가능).
보안 필드 이름	allfields.securedfieldName	string	보안 필드의 레이블입니다(fieldType이 'securedfield'인 경우 적용 가능).
표시할 문자	allfields.charToDisplay	integer	보안 필드 값의 끝에 표시할 마스크되지 않은 문자 수입니다(fieldType이 'securedfield'인 경우 적용 가능).
서명 ID	allfields.signatureId	string	이 기호 필드에 적용된 서명의 ID입니다(fieldType이 'signfield'인 경우 적용 가능).
초기 이미지	allfields.initialImage	string	이 필드에 적용된 이니셜의 이미지 데이터입니다(fieldType이 'initialfield'인 경우 적용 가능).
첨부 파일 필드 이름	allfields.attachmentfieldName	string	첨부 파일 필드의 이름입니다(fieldType이 'attachmentfield'인 경우 적용 가능).
첨부 파일 설명	allfields.attachmentfieldDescription	string	연결할 항목에 대한 설명입니다(fieldType이 'attachmentfield'인 경우 적용 가능).

URL에서 봉투 만들기

작업 ID:: CreateEnvelopefromURL

공개적으로 액세스할 수 있는 PDF URL을 사용하여 봉투를 만들고 보냅니다. 문서 URL 및 받는 사람 세부 정보를 제공하여 서명 프로세스를 시작합니다.

매개 변수

Name	키	필수	형식	Description
봉투 이름	folderName	True	string	이 봉투의 이름입니다.
입력 형식	inputType		string	문서 원본 형식을 지정합니다. 파일 URL을 제공하려면 URL로 설정하거나 Base64로 인코딩된 파일 콘텐츠를 제공하려면 base64로 설정합니다.
파일 URL	fileUrls	True	array of string	이 봉투에 추가할 문서를 가리키는 공개적으로 액세스할 수 있는 URL 배열입니다.
파일 이름	fileNames	True	array of string	파일 URL과 동일한 순서로 각 문서에 대한 표시 이름의 배열입니다.
이름 (First Name)	firstName	True	string	받는 사람의 이름입니다.
성 이름	lastName	True	string	받는 사람의 성입니다.
Email 주소	emailId	True	string	받는 사람의 전자 메일 주소입니다.
permissions	permission	True	string
Sequence	sequence	True	integer	받는 사람 목록의 받는 사람에게 시퀀스 번호를 할당하려면 이 필드를 사용합니다. 1,2,3,4와 같은 1로 시작하는 각 파티의 고유 시퀀스 번호를 사용합니다. 서명 워크플로에 한 사람이 여러 번 나타나는 경우 받는 사람이 반복할 때마다 다른 시퀀스를 할당하세요.
signerAuthLevels	signerAuthLevel		string	서명자가 확인을 위해 활용할 인증 수준
자리 표시자	isPlaceholder		boolean	파티가 자리 표시자임을 시작하려면 이 필드를 사용합니다. 참고: 1. firstName, lastName, emailId 매개 변수의 값은 이 파티의 비어 있어야 합니다. 2. 자리 표시자를 추가하려면 'PARTY_ASSIGNER' 권한으로 한 명의 받는 사람을 다시 지정해야 합니다.
받는 사람 역할	partyRole		string	자리 표시자 역할을 할당하려면 이 필드를 사용합니다.
이름 변경 허용	allowNameChange		string	값은 true이거나 false일 수 있습니다. 서명자가 서명 프로세스를 완료하기 전에 이름과 성을 업데이트할 수 있도록 허용하려면 이 매개 변수를 사용합니다.
워크플로 시퀀스	workflowSequence		integer	이 받는 사람에게 워크플로 시퀀스 번호를 할당합니다. 로그인 시퀀스를 사용하도록 설정하면 받는 사람은 서명 초대를 오름차순으로 받습니다.
호스트 전자 메일 ID	hostEmailId		string	In-Person 관리자의 전자 메일 주소입니다.
액세스 코드	userDefinedAccessCode		string	"signerAuthLevel" 값이 인증을 위해 "사용자 정의 액세스 코드"로 설정된 경우 매개 변수에 액세스 코드가 포함됩니다. 참고: 1. 코드는 대/소문자를 구분하지 않습니다. 2. 시스템은 이 코드를 보내지 않으므로 서명자와 이 코드를 직접 공유해야 합니다. 3. 액세스 코드에는 알파벳, 숫자 및 @,&{,},,%,(,),~,\|,!,+,^과 같은 특수 문자가 포함될 수 있습니다.
파티가 전자 메일 그룹인 경우	partyIsEmailGroup		boolean	파티를 대량으로 만들 때 이 매개 변수를 사용합니다. 참고: 이 매개 변수가 true이면 이 파티의 firstName, lastName 및 emailId가 무시됩니다.
전자 메일 그룹 ID	emailGroupId		integer	대량 생성에 사용할 그룹 ID를 전자 메일에 전달합니다.
Single Signer Bulk	allowSingleSignerInBulk		boolean	이 매개 변수를 사용하여 한 사람만 전자 메일 그룹에 로그인할 수 있습니다.
전화 걸기 코드	dialingCode		string	이 필드를 사용하여 받는 사람 목록의 받는 사람에게 휴대폰 번호 접두사인 국가 전화 접속 코드를 할당합니다.
휴대폰 번호	mobileNumber		string	받는 사람 목록의 받는 사람에게 휴대폰 번호를 할당하려면 이 필드를 사용합니다.
필드	Fields		object
지금 보내기	sendNow		boolean	사용하도록 설정하면 Foxit eSign은 각 받는 사람의 전자 메일 주소에 고유한 서명 링크를 즉시 보냅니다. 봉투를 초안으로 저장하려면 이 기능을 사용하지 않도록 설정합니다.
포함된 서명 세션 만들기	createEmbeddedSigningSession	True	boolean	서명 세션 토큰은 받는 사람에게 전자 메일을 보내지 않고 생성됩니다.
모든 당사자에 대한 임베디드 서명 세션 만들기	createEmbeddedSigningSessionForAllParties		boolean	true로 설정하면 봉투의 모든 받는 사람에 대해 포함된 서명 URL이 생성됩니다.
텍스트 태그 처리	processTextTags	True	boolean	값은 true 또는 false일 수 있습니다. 이 필드는 Foxit eSign이 텍스트 태그의 문서를 구문 분석하여 Foxit eSign 필드로 변환해야 하는지 여부를 결정하는 데 사용됩니다.
Acro 필드 처리	processAcroFields	True	boolean	이 필드는 Foxit eSign이 AcroFields에 대한 문서를 구문 분석하여 Foxit eSign 필드로 변환해야 하는지 여부를 결정하는 데 사용됩니다.
로그인 시퀀스	signInSequence		boolean	이 필드는 받는 사람이 봉투 문서에 순서대로 서명할지 여부를 결정하는 데 사용됩니다. false이면 모든 받는 사람이 동시에 초대 전자 메일을 받습니다. true이면 이전 받는 사람이 문서 서명 또는 필드 채우기 등과 같은 필수 작업을 완료한 후 각 받는 사람이 연속적으로 초대 전자 메일을 받습니다.
직접 사용	inPersonEnable		boolean	이 필드는 몇 분 안에 모든 디바이스에서 쉽게 완료할 수 있는 직접 서명 프로세스를 시작하고 필요한 경우 이메일 기반 서명을 방지하는 데 사용됩니다. false이면 모든 받는 사람이 동시에 초대 전자 메일을 받습니다. true이면 직접 관리자가 서명자에 대한 서명 프로세스를 시작하기 위한 초대 이메일을 받습니다.
받는 사람 당사자 수정	fixRecipientParties		boolean	true이면 포함된 송신 보기에서 이 요청의 일부로 이미 추가된 봉투의 당사자를 변경할 수 없습니다.
문서 수정	fixDocuments		boolean	true이면 포함된 전송에서 이 요청의 일부로 이미 추가된 봉투의 문서를 변경할 수 없습니다.
성공 URL 보내기	sendSuccessUrl		string	방문 페이지의 절대 URL을 입력합니다. 이 URL은 포함된 송신 보기에서 폴더를 성공적으로 보낸 후 서명자가 리디렉션됩니다.
송신 오류 URL	sendErrorUrl		string	방문 페이지의 절대 URL을 입력합니다. 이 URL은 포함된 송신 보기에서 폴더를 보내는 동안 오류가 발생하면 서명자가 리디렉션됩니다.
포함된 송신 세션 만들기	createEmbeddedSendingSession		boolean	true로 설정하면 포함된 토큰을 생성하여 Foxit eSign의 뷰를 준비하는 문서를 엽니다.
포함된 서명자 전자 메일 ID	embeddedSignersEmailIds		array of string	포함된 서명 세션을 만들어야 하는 받는 사람의 전자 메일 ID 배열입니다. 당사자 목록에 추가된 받는 사람의 전자 메일 ID입니다.
서명 성공 URL	signSuccessUrl		string	포함된 서명 보기에 성공적으로 로그인한 후 리디렉션될 서명자의 절대 URL을 입력합니다.
서명 거부 URL	signDeclineUrl		string	포함된 서명 보기의 로그인을 거부하는 경우 리디렉션될 서명자의 절대 URL을 입력합니다.
나중에 서명 URL	signLaterUrl		string	나중에 포함된 서명 보기에서 서명하도록 선택하는 경우 리디렉션될 서명자의 절대 URL을 입력합니다.
서명 오류 URL	signErrorUrl		string	포함된 서명 보기에서 문서에 서명하는 동안 오류가 발생하면 리디렉션될 서명자의 절대 URL을 입력합니다.
지금 보내기 및 포함된 서명 세션 허용	allowSendNowAndEmbeddedSigningSession		boolean	true로 설정하면 Foxit eSign은 각 받는 사람에게 고유한 서명 링크를 보냅니다. 이는 매개 변수 sendNow 및 createEmbeddedSigningSession이 true인 경우에만 적용됩니다.
고급 전자 메일 유효성 검사	allowAdvancedEmailValidation		boolean	true로 설정된 경우 당사자의 이메일 주소의 유효성을 검사합니다.
서명 성공 URL 모든 당사자	signSuccessUrlAllParties		boolean	true로 설정하면 서명자가 성공적으로 서명한 후 signSuccessUrl에 제공된 URL로 리디렉션됩니다. sendNow가 true인 경우에만 적용됩니다.
전자 메일 템플릿 ID	emailTemplateId		integer	전자 메일 템플릿 ID를 전달하여 기본 전자 메일 템플릿 이외의 전자 메일 템플릿을 보냅니다.
서명자 명령 ID	signerInstructionId		integer	명령 ID를 전달하여 기본 서명자 명령 이외의 서명자 지침을 보냅니다.
확인 명령 ID	confirmationInstructionId		string	기본 확인 지침 이외의 확인 지침을 보내려면 확인 명령 ID를 전달합니다.
테마 색	themeColor		string	CSS 값을 입력하여 테마 색을 설정합니다.
세션 만료	sessionExpire		boolean	포함된 서명 세션의 만료를 시작하려면 true로 설정합니다.
만료	expiry		integer	sessionExpire가 true이면 필수입니다. 포함된 서명 세션에서 만료 기간을 밀리초 단위로 입력합니다.
종속 필드 이름	dependentFieldName	True	string	부모 필드에 의해 표시 유형이 제어되는 필드의 이름입니다.
부모 필드 이름	parentFieldName	True	string	값이 종속 필드의 표시 유형을 제어하는 부모 필드의 이름입니다. 지원되는 부모 필드 유형: 텍스트 필드, 텍스트 상자, 확인란, 라디오 단추, 드롭다운
부모 필드 값	parentFieldValue	True	string	종속 필드가 표시되도록 트리거하는 부모 필드의 값입니다. 확인란 및 라디오 단추 필드의 경우 선택 또는 선택 취소를 사용합니다.
Options	options	True	string	텍스트 기반 부모 필드에 대한 추가 일치 옵션입니다. 허용되는 값: isblank, allowNull, contains.
Metadata	metadata		object	키 값 쌍이어야 합니다. 최대 1,000개의 키 값 쌍이 허용됩니다.
보낸 사람 전자 메일	senderEmail		string	이 문서 폴더를 받는 사람에게 보내는 데 사용할 다른 사용자의 전자 메일을 계정에 입력합니다.
추가 단추 숨기기	hideAddMeButton		boolean	true이면 포함된 송신 세션에서 받는 사람 당사자의 "추가" 단추가 숨겨지게 됩니다.
새로 추가 단추 숨기기	hideAddNewButton		boolean	true이면 포함된 송신 세션에서 받는 사람 당사자의 "새로 추가" 단추가 숨겨지게 됩니다.
그룹 추가 단추 숨기기	hideAddGroupButton		boolean	true이면 포함된 송신 세션에서 받는 사람 당사자의 "그룹 추가" 단추가 숨겨지게 됩니다.
받는 사람의 필드 이름 숨기기	hideFieldNameForRecipients		boolean	데이터 항목 필드 및 고급 필드에 대한 받는 사람의 필드 이름을 숨깁니다. (라디오 단추, 확인란, 이미지 및 하이퍼링크 제외).
확인란 테두리 숨기기	hideCheckboxBorder		boolean	실행된 문서에는 확인란의 테두리가 숨겨집니다.
서명자 선택 옵션 숨기기	hideSignerSelectOption		boolean	true이면 포함된 송신 세션에서 받는 사람 당사자의 "기존 서명자 이름/전자 메일" 입력 상자가 숨겨지게 됩니다.
서명자 작업 숨기기	hideSignerActions		boolean	true이면 포함된 송신 세션에서 받는 사람 당사자에 대한 서명자 "편집", "변경" 및 "제거" 작업을 숨깁니다.
보낸 사람 이름 숨기기	hideSenderName		boolean	true이면 포함된 송신 세션에서 받는 사람 당사자의 보낸 사람 이름을 숨깁니다.
폴더 이름 숨기기	hideFolderName		boolean	true이면 포함된 두 세션의 탐색에서 폴더 이름을 숨깁니다.
문서 이름 숨기기	hideDocumentsName		boolean	true이면 포함된 두 세션에서 문서 이름을 숨깁니다.
서명 거부 숨기기	hideDeclineToSign		boolean	true이면 서명자에 대한 "서명 거부" 옵션이 숨겨지게 됩니다.
추가 작업 숨기기	hideMoreAction		boolean	true이면 송신/서명 세션에서 "추가 작업" 단추가 숨겨지게 됩니다. "지금 보내기"의 경우: true이면 아무것도 숨기지 않습니다.
보내기 단추 숨기기	hideSendButton		boolean	true이면 포함된 송신 세션에서 보내기 단추를 숨깁니다.
다음 필수 Fieldbtn 숨기기	hideNextRequiredFieldbtn		boolean	true로 설정하면 서명자를 다음 필수 필드로 이동하는 탐색 단추를 숨깁니다.
포함된 세션 모두 필요	requiredBothEmbeddedSession		boolean	true이면 포함된 송신 및 서명 URL이 함께 생성됩니다.
봉투 암호	folderPassword		string	디지털 서명된 문서를 열려면 서명자/작성자가 이 암호를 입력해야 합니다. 매개 변수를 비워 두면 디지털 서명된 문서를 여는 데 암호가 필요하지 않습니다.
단계별 사용	enableStepByStep		boolean	포함된 송신 세션에서 단계별 작업을 사용하도록 설정합니다.
파티 추가 옵션 숨기기	hideAddPartiesOption		boolean	true이면 초안 및 템플릿 만들기 모드에서 파티 옵션을 추가하는 옵션이 숨겨지게 됩니다.
자체 서명	selfSign		boolean	API를 통해 포함된 Self Sign을 사용하도록 설정합니다. 이 매개 변수는 createEmbeddedSendingSession 매개 변수가 true인 경우에만 적용됩니다.
자체 서명자 성공 URL	selfSignerSuccessUrl		string	웹 사이트/애플리케이션의 방문 페이지에 대한 절대 URL을 입력합니다. 이 URL은 포함된 송신 보기에서 폴더를 보내는 데 성공한 후 사용자가 리디렉션됩니다.

반품

Name	경로	형식	Description
아이디	folder.folderId	integer	새로 만든 봉투의 고유 ID입니다. 이 봉투를 참조하려면 후속 작업에서 이 작업을 사용합니다.
이름	folder.folderName	string	새로 만든 봉투의 이름입니다.
사용자 지정 이름	folder.folderCustomName	string	봉투의 사용자 지정 이름입니다.
Password	folder.folderPassword	string	봉투에 대한 액세스 암호(설정된 경우)입니다.
작성자 ID	folder.folderAuthorId	integer	봉투 작성자의 고유 식별자입니다.
작성자 이름	folder.folderAuthorFirstName	string	봉투 작성자의 이름입니다.
작성자 성	folder.folderAuthorLastName	string	봉투 작성자의 성입니다.
작성자 전자 메일	folder.folderAuthorEmail	string	봉투 작성자의 전자 메일 주소입니다.
작성자 역할	folder.folderAuthorRole	string	봉투 작성자의 역할입니다.
회사 ID	folder.folderCompanyId	integer	봉투를 소유하는 회사의 고유 식별자입니다.
생성 날짜	folder.folderCreationDate	integer	봉투가 만들어진 날짜(Unix 타임스탬프(밀리초)입니다.
보낸 날짜	folder.folderSentDate	integer	봉투가 전송된 날짜(Unix 타임스탬프(밀리초)입니다.
Status	folder.folderStatus	string	봉투의 현재 상태입니다.
사용자 정의 필드 1	folder.custom_field1	string	봉투에 대한 첫 번째 사용자 지정 메타데이터 필드입니다.
사용자 정의 필드 2	folder.custom_field2	string	봉투에 대한 두 번째 사용자 지정 메타데이터 필드입니다.
Metadata	folder.metadata	string	봉투와 연결된 사용자 지정 메타데이터입니다.
문서 ID	folder.folderDocumentIds	array of integer	봉투에 포함된 문서 ID 목록입니다.
문서	folder.documentsList	array of object	봉투에 있는 문서 목록입니다.
문서 ID	folder.documentsList.documentId	integer	문서의 고유 식별자입니다.
계약 ID	folder.documentsList.contractId	integer	계약의 고유 식별자입니다.
회사 ID	folder.documentsList.companyId	integer	회사의 고유 식별자입니다.
작성자	folder.documentsList.contractCreatedBy	integer	계약을 만든 사용자의 사용자 ID입니다.
생성 일자	folder.documentsList.contractCreatedOn	string	계약이 만들어진 날짜 및 시간입니다.
계약 유형	folder.documentsList.contractType	string	계약의 형식입니다.
계약 상태	folder.documentsList.contractStatus	string	계약의 현재 상태입니다.
수정 가능	folder.documentsList.editable	boolean	항목을 편집할 수 있는지 여부를 나타냅니다.
버전 ID	folder.documentsList.contractVersionId	integer	계약 버전의 고유 식별자입니다.
버전 이름	folder.documentsList.contractVersionName	string	계약 버전의 이름입니다.
버전 설명	folder.documentsList.contractVersionDesc	string	계약 버전에 대한 설명입니다.
만든 버전	folder.documentsList.versionCreatedby	integer	이 버전을 만든 사용자의 사용자 ID입니다.
만든 버전	folder.documentsList.versionCreatedOn	string	이 버전을 만든 날짜와 시간입니다.
버전 번호	folder.documentsList.contractVersionNumber	integer	계약의 버전 번호입니다.
트랜잭션 원본	folder.documentsList.contractTransactionSource	string	계약 트랜잭션을 시작한 원본 시스템입니다.
받는 사람	folder.folderRecipientParties	array of object	이 봉투의 받는 사람 파티 목록입니다.
받는 사람 ID	folder.folderRecipientParties.partyId	integer	받는 사람의 고유 식별자입니다.
받는 사람 ID	folder.folderRecipientParties.partyDetails.partyId	integer	받는 사람의 고유 식별자입니다.
이름 (First Name)	folder.folderRecipientParties.partyDetails.firstName	string	받는 사람의 이름입니다.
성 이름	folder.folderRecipientParties.partyDetails.lastName	string	받는 사람의 성입니다.
Email 주소	folder.folderRecipientParties.partyDetails.emailId	string	받는 사람의 전자 메일 주소입니다.
Placeholder	folder.folderRecipientParties.partyDetails.placeholder	boolean	이 파티가 자리 표시자 수신자인지 여부를 나타냅니다.
Address	folder.folderRecipientParties.partyDetails.address	string	받는 사람의 실제 주소입니다.
만든 날짜	folder.folderRecipientParties.partyDetails.dateCreated	integer	레코드가 만들어진 날짜(Unix 타임스탬프(밀리초)입니다.
전자 메일 옵트아웃	folder.folderRecipientParties.partyDetails.optOutEmails	boolean	받는 사람이 전자 메일 알림을 옵트아웃했는지 여부를 나타냅니다.
고유한 받는 사람 ID	folder.folderRecipientParties.partyDetails.uniquePartyId	string	이 받는 사람에 대한 고유한 시스템 식별자입니다.
인증 수준	folder.folderRecipientParties.partyDetails.authenticationLevel	string	이 받는 사람에게 필요한 인증 방법입니다.
암호 업데이트 날짜	folder.folderRecipientParties.partyDetails.passwordUpdateDate	string	암호가 마지막으로 업데이트된 날짜입니다.
암호 업데이트 상태	folder.folderRecipientParties.partyDetails.passwordUpdateStatus	boolean	암호가 업데이트되었는지 여부를 나타냅니다.
회사 ID	folder.folderRecipientParties.partyDetails.companyId	integer	회사의 고유 식별자입니다.
사용자 역할	folder.folderRecipientParties.partyDetails.userRole	string	사용자에게 할당된 역할입니다.
부서	folder.folderRecipientParties.partyDetails.department	string	사용자가 속한 부서입니다.
Title	folder.folderRecipientParties.partyDetails.title	string	사용자의 직위입니다.
진행 중	folder.folderRecipientParties.partyDetails.active	boolean	사용자 또는 레코드가 활성 상태인지 여부를 나타냅니다.
로케일	folder.folderRecipientParties.partyDetails.requestLocale	string	사용자의 로캘 설정입니다.
부서와 공유	folder.folderRecipientParties.partyDetails.share_among_department	boolean	봉투가 부서 간에 공유되는지 여부를 나타냅니다.
전화 걸기 코드	folder.folderRecipientParties.partyDetails.dialingCode	string	전화 번호의 국제 전화 번호입니다.
휴대폰 번호	folder.folderRecipientParties.partyDetails.mobileNumber	string	휴대폰 번호입니다.
상태 필터	folder.folderRecipientParties.partyDetails.docStatusFilter	string	문서 상태에 대한 필터입니다.
날짜 필터	folder.folderRecipientParties.partyDetails.docDateFilter	string	문서 날짜에 대한 필터입니다.
보안 필드 액세스	folder.folderRecipientParties.partyDetails.userSecureFieldAccess	boolean	사용자가 보안 필드에 액세스할 수 있는지 여부를 나타냅니다.
사이드바 확장	folder.folderRecipientParties.partyDetails.expandSidebar	boolean	사이드바가 기본적으로 확장되는지 여부를 나타냅니다.
Adv. 전자 메일 유효성 검사	folder.folderRecipientParties.partyDetails.allowAdvancedEmailValidation	boolean	고급 전자 메일 유효성 검사를 사용할 수 있는지 여부를 나타냅니다.
관리자 ID	folder.folderRecipientParties.partyDetails.managerId	string	사용자 관리자의 고유 식별자입니다.
로그인 수	folder.folderRecipientParties.partyDetails.loginCount	integer	사용자가 로그인한 횟수입니다.
암호 재설정 전자 메일	folder.folderRecipientParties.partyDetails.sendMailForPasswordReset	boolean	암호 재설정 전자 메일을 보낼지 여부를 나타냅니다.
부서 ID	folder.folderRecipientParties.partyDetails.departmentId	string	부서의 고유 식별자입니다.
기본 회사	folder.folderRecipientParties.partyDetails.userPrimaryCompany	integer	사용자와 연결된 기본 회사입니다.
디바이스 유형	folder.folderRecipientParties.partyDetails.deviceType	string	사용되는 디바이스의 유형입니다.
디바이스 토큰	folder.folderRecipientParties.partyDetails.deviceToken	string	디바이스에 대한 푸시 알림 토큰입니다.
하도급자 설명	folder.folderRecipientParties.partyDetails.subcontractorDescription	string	하청업체 또는 외부 서명자에 대한 설명입니다.
하도급업체 조직	folder.folderRecipientParties.partyDetails.subcontractorOrganization	string	하청업체 또는 외부 서명자의 조직 이름입니다.
하도급업체 추가 날짜	folder.folderRecipientParties.partyDetails.subcAddedDate	integer	하청업체가 추가된 날짜(Unix 타임스탬프(밀리초)입니다.
Source	folder.folderRecipientParties.partyDetails.source	string	외부 서명자가 추가된 원본 시스템입니다.
전화 걸기 코드	folder.folderRecipientParties.dialingCode	string	전화 번호의 국제 전화 번호입니다.
휴대폰 번호	folder.folderRecipientParties.mobileNumber	string	휴대폰 번호입니다.
서명 유형	folder.folderRecipientParties.signerSignatureType	string	서명자가 사용할 서명의 형식입니다.
Permissions	folder.folderRecipientParties.contractPermissions	string	계약에 대해 이 당사자에게 부여된 권한입니다.
서명 순서	folder.folderRecipientParties.partySequence	integer	이 받는 사람에 대한 서명 순서 시퀀스 번호입니다.
워크플로 시퀀스	folder.folderRecipientParties.workflowSignSequence	integer	워크플로 서명 시퀀스 번호입니다.
봉투 ID	folder.folderRecipientParties.envelopeId	integer	봉투의 고유 식별자입니다.
받는 사람 회사 ID	folder.folderRecipientParties.partyCompanyId	integer	이 받는 사람과 연결된 회사의 고유 식별자입니다.
공유 모드	folder.folderRecipientParties.sharingMode	string	이 봉투의 공유 모드입니다.
받는 사람 액세스 URL	folder.folderRecipientParties.folderAccessURL	string	받는 사람이 봉투에 액세스하고 서명하는 데 사용할 수 있는 URL입니다.
보안 모드	folder.folderRecipientParties.securityMode	string	이 봉투에 적용되는 보안 모드입니다.
코멘트	folder.folderRecipientParties.extraComments	string	봉투에 추가 설명이 포함되어 있습니다.
이름 변경 허용	folder.folderRecipientParties.allowNameChange	boolean	받는 사람이 이름을 업데이트할 수 있는지 여부를 나타냅니다.
이름이 업데이트됨	folder.folderRecipientParties.signerNameUpdated	boolean	서명자가 이름을 업데이트했는지 여부를 나타냅니다.
서명자 인증 수준	folder.folderRecipientParties.signerAuthenticationLevel	string	서명자에 필요한 인증 수준입니다.
액세스 코드	folder.folderRecipientParties.userDefinedAccessCode	string	서명자에 대해 정의된 사용자 지정 액세스 코드입니다.
서명 ID	folder.folderRecipientParties.signatureId	string	서명의 고유 식별자입니다.
받는 사람 역할	folder.folderRecipientParties.partyRole	string	서명 워크플로에서 이 받는 사람에게 할당된 역할입니다.
회사 필드	folder.folderRecipientParties.companyFieldValue	string	서명에 있는 회사 이름 필드의 값입니다.
제목 필드	folder.folderRecipientParties.titleFieldValue	string	서명에 있는 제목 필드의 값입니다.
서명 이유	folder.folderRecipientParties.reasonSigning	string	받는 사람이 문서에 서명하는 이유입니다.
결제 필드가 추가됨	folder.folderRecipientParties.payFieldAdded	boolean	결제 필드가 추가되었는지 여부를 나타냅니다.
수취인	folder.folderRecipientParties.payee	boolean	이 수신자가 수취인인지 여부를 나타냅니다.
되풀이 결제	folder.folderRecipientParties.recurringFieldExist	boolean	되풀이 결제 필드가 있는지 여부를 나타냅니다.
인쇄 및 서명 완료	folder.folderRecipientParties.printAndSignCompleted	boolean	인쇄 및 서명 프로세스가 완료되었는지 여부를 나타냅니다.
지불	folder.folderRecipientParties.paid	boolean	결제가 완료되었는지 여부를 나타냅니다.
선택적 서명자 허용	folder.folderRecipientParties.allowOptionalSigner	boolean	이 받는 사람이 선택적 서명자인지 여부를 나타냅니다.
선택적 서명자	folder.folderRecipientParties.optionalSigners	array of integer	이 봉투에 대한 선택적 서명자 파티 ID 목록입니다.
작성자 서명 URL	folder.folderAccessURLForAuthor	string	보낸 사람에서 봉투에 액세스하는 데 사용할 수 있는 URL입니다.
초안 액세스 URL	folder.draftFolderAccessURL	string	봉투의 초안 버전에 액세스하는 데 사용되는 URL입니다.
회의실 서명	folder.boardRoomSign	boolean	보드룸 서명 모드를 사용할 수 있는지 여부를 나타냅니다.
로고 포함	folder.includeLogo	boolean	회사 로고가 전자 메일에 포함되는지 여부를 나타냅니다.
단추 배경색	folder.email_btnBgColor	string	전자 메일 단추의 배경색입니다.
단추 텍스트 색	folder.email_btnTxtColor	string	전자 메일 단추의 텍스트 색입니다.
전자 메일 로고	folder.emailTemplateLogo	string	전자 메일 템플릿에 사용되는 로고 URL입니다.
전자 메일 템플릿 ID	folder.emailTemplateId	integer	전자 메일 템플릿의 고유 식별자입니다.
전자 메일 헤더	folder.emailHeader	string	알림 이메일에 사용되는 헤더 텍스트입니다.
전자 메일 바닥글	folder.emailFooter	string	알림 전자 메일에 사용되는 바닥글 텍스트입니다.
예약된 제거	folder.purgeFlag	boolean	봉투가 제거 예약되었는지 여부를 나타냅니다.
시작 날짜 제거	folder.purgeStartDate	string	제거가 시작되도록 예약된 날짜입니다.
종료 날짜 제거	folder.purgeEndDate	string	제거가 완료되도록 예약된 날짜입니다.
대량 보내기 ID	folder.bulkId	integer	대량 보내기 작업의 고유 식별자입니다.
서명 순서 적용	folder.enforceSignWorkflow	boolean	받는 사람이 정의된 시퀀스에 로그인해야 하는지 여부를 나타냅니다.
현재 단계	folder.currentWorkflowStep	integer	서명 워크플로의 현재 단계입니다.
트랜잭션 원본	folder.transactionSource	string	이 트랜잭션을 시작한 원본 시스템입니다.
수정 가능	folder.editable	boolean	항목을 편집할 수 있는지 여부를 나타냅니다.
In-Person 서명	folder.inPersonSignable	boolean	봉투를 직접 로그인할 수 있는지 여부를 나타냅니다.
미리 알림 재정의	folder.overrideAccountReminders	boolean	계정 수준 미리 알림 설정이 재정의되는지 여부를 나타냅니다.
위임 재정의	folder.overrideAccountRecipientDelegation	boolean	계정 수준 위임 설정이 재정의되는지 여부를 나타냅니다.
위임 허용	folder.allowRecipientsToDelegate	boolean	받는 사람이 서명을 위임할 수 있는지 여부를 나타냅니다.
아이디	folder.envelopeId	integer	봉투의 고유 식별자입니다.
이름	folder.envelopeName	string	봉투의 이름입니다.
발신기 ID	folder.envelopeOriginatorId	integer	봉투를 만든 사용자의 고유 식별자입니다.
회사 ID	folder.envelopeCompanyId	integer	봉투를 소유하는 회사의 고유 식별자입니다.
Date	folder.envelopeDate	integer	봉투가 만들어진 날짜(Unix 타임스탬프(밀리초)입니다.
공유 날짜	folder.envelopeSharedDate	integer	봉투가 공유된 날짜(Unix 타임스탬프(밀리초)입니다.
Status	folder.envelopeStatus	string	봉투의 현재 상태입니다.
계약 ID	folder.envelopeContractIds	array of integer	이 봉투와 연결된 계약 ID 목록입니다.
받는 사람 권한	folder.envelopePartyPermissions	array of object	이 봉투에 대한 받는 사람 권한 목록입니다.
받는 사람 ID	folder.envelopePartyPermissions.partyId	integer	받는 사람의 고유 식별자입니다.
받는 사람 ID	folder.envelopePartyPermissions.partyDetails.partyId	integer	받는 사람의 고유 식별자입니다.
이름 (First Name)	folder.envelopePartyPermissions.partyDetails.firstName	string	받는 사람의 이름입니다.
성 이름	folder.envelopePartyPermissions.partyDetails.lastName	string	받는 사람의 성입니다.
Email 주소	folder.envelopePartyPermissions.partyDetails.emailId	string	받는 사람의 전자 메일 주소입니다.
Placeholder	folder.envelopePartyPermissions.partyDetails.placeholder	boolean	이 파티가 자리 표시자 수신자인지 여부를 나타냅니다.
Address	folder.envelopePartyPermissions.partyDetails.address	string	받는 사람의 실제 주소입니다.
만든 날짜	folder.envelopePartyPermissions.partyDetails.dateCreated	integer	레코드가 만들어진 날짜(Unix 타임스탬프(밀리초)입니다.
전자 메일 옵트아웃	folder.envelopePartyPermissions.partyDetails.optOutEmails	boolean	받는 사람이 전자 메일 알림을 옵트아웃했는지 여부를 나타냅니다.
고유한 받는 사람 ID	folder.envelopePartyPermissions.partyDetails.uniquePartyId	string	이 받는 사람에 대한 고유한 시스템 식별자입니다.
인증 수준	folder.envelopePartyPermissions.partyDetails.authenticationLevel	string	이 받는 사람에게 필요한 인증 방법입니다.
암호 업데이트 날짜	folder.envelopePartyPermissions.partyDetails.passwordUpdateDate	string	암호가 마지막으로 업데이트된 날짜입니다.
암호 업데이트 상태	folder.envelopePartyPermissions.partyDetails.passwordUpdateStatus	boolean	암호가 업데이트되었는지 여부를 나타냅니다.
회사 ID	folder.envelopePartyPermissions.partyDetails.companyId	integer	회사의 고유 식별자입니다.
사용자 역할	folder.envelopePartyPermissions.partyDetails.userRole	string	사용자에게 할당된 역할입니다.
부서	folder.envelopePartyPermissions.partyDetails.department	string	사용자가 속한 부서입니다.
Title	folder.envelopePartyPermissions.partyDetails.title	string	사용자의 직위입니다.
진행 중	folder.envelopePartyPermissions.partyDetails.active	boolean	사용자 또는 레코드가 활성 상태인지 여부를 나타냅니다.
로케일	folder.envelopePartyPermissions.partyDetails.requestLocale	string	사용자의 로캘 설정입니다.
부서와 공유	folder.envelopePartyPermissions.partyDetails.share_among_department	boolean	봉투가 부서 간에 공유되는지 여부를 나타냅니다.
전화 걸기 코드	folder.envelopePartyPermissions.partyDetails.dialingCode	string	전화 번호의 국제 전화 번호입니다.
휴대폰 번호	folder.envelopePartyPermissions.partyDetails.mobileNumber	string	휴대폰 번호입니다.
상태 필터	folder.envelopePartyPermissions.partyDetails.docStatusFilter	string	문서 상태에 대한 필터입니다.
날짜 필터	folder.envelopePartyPermissions.partyDetails.docDateFilter	string	문서 날짜에 대한 필터입니다.
보안 필드 액세스	folder.envelopePartyPermissions.partyDetails.userSecureFieldAccess	boolean	사용자가 보안 필드에 액세스할 수 있는지 여부를 나타냅니다.
사이드바 확장	folder.envelopePartyPermissions.partyDetails.expandSidebar	boolean	사이드바가 기본적으로 확장되는지 여부를 나타냅니다.
Adv. 전자 메일 유효성 검사	folder.envelopePartyPermissions.partyDetails.allowAdvancedEmailValidation	boolean	고급 전자 메일 유효성 검사를 사용할 수 있는지 여부를 나타냅니다.
관리자 ID	folder.envelopePartyPermissions.partyDetails.managerId	string	사용자 관리자의 고유 식별자입니다.
로그인 수	folder.envelopePartyPermissions.partyDetails.loginCount	integer	사용자가 로그인한 횟수입니다.
암호 재설정 전자 메일	folder.envelopePartyPermissions.partyDetails.sendMailForPasswordReset	boolean	암호 재설정 전자 메일을 보낼지 여부를 나타냅니다.
부서 ID	folder.envelopePartyPermissions.partyDetails.departmentId	string	부서의 고유 식별자입니다.
기본 회사	folder.envelopePartyPermissions.partyDetails.userPrimaryCompany	integer	사용자와 연결된 기본 회사입니다.
디바이스 유형	folder.envelopePartyPermissions.partyDetails.deviceType	string	사용되는 디바이스의 유형입니다.
디바이스 토큰	folder.envelopePartyPermissions.partyDetails.deviceToken	string	디바이스에 대한 푸시 알림 토큰입니다.
하도급자 설명	folder.envelopePartyPermissions.partyDetails.subcontractorDescription	string	하청업체 또는 외부 서명자에 대한 설명입니다.
하도급업체 조직	folder.envelopePartyPermissions.partyDetails.subcontractorOrganization	string	하청업체 또는 외부 서명자의 조직 이름입니다.
하도급업체 추가 날짜	folder.envelopePartyPermissions.partyDetails.subcAddedDate	integer	하청업체가 추가된 날짜(Unix 타임스탬프(밀리초)입니다.
Source	folder.envelopePartyPermissions.partyDetails.source	string	외부 서명자가 추가된 원본 시스템입니다.
전화 걸기 코드	folder.envelopePartyPermissions.dialingCode	string	전화 번호의 국제 전화 번호입니다.
휴대폰 번호	folder.envelopePartyPermissions.mobileNumber	string	휴대폰 번호입니다.
서명 유형	folder.envelopePartyPermissions.signerSignatureType	string	서명자가 사용할 서명의 형식입니다.
Permissions	folder.envelopePartyPermissions.contractPermissions	string	계약에 대해 이 당사자에게 부여된 권한입니다.
서명 순서	folder.envelopePartyPermissions.partySequence	integer	이 받는 사람에 대한 서명 순서 시퀀스 번호입니다.
워크플로 시퀀스	folder.envelopePartyPermissions.workflowSignSequence	integer	워크플로 서명 시퀀스 번호입니다.
봉투 ID	folder.envelopePartyPermissions.envelopeId	integer	봉투의 고유 식별자입니다.
받는 사람 회사 ID	folder.envelopePartyPermissions.partyCompanyId	integer	이 받는 사람과 연결된 회사의 고유 식별자입니다.
공유 모드	folder.envelopePartyPermissions.sharingMode	string	이 봉투의 공유 모드입니다.
받는 사람 액세스 URL	folder.envelopePartyPermissions.folderAccessURL	string	받는 사람이 봉투에 액세스하고 서명하는 데 사용할 수 있는 URL입니다.
보안 모드	folder.envelopePartyPermissions.securityMode	string	이 봉투에 적용되는 보안 모드입니다.
코멘트	folder.envelopePartyPermissions.extraComments	string	봉투에 추가 설명이 포함되어 있습니다.
이름 변경 허용	folder.envelopePartyPermissions.allowNameChange	boolean	받는 사람이 이름을 업데이트할 수 있는지 여부를 나타냅니다.
이름이 업데이트됨	folder.envelopePartyPermissions.signerNameUpdated	boolean	서명자가 이름을 업데이트했는지 여부를 나타냅니다.
서명자 인증 수준	folder.envelopePartyPermissions.signerAuthenticationLevel	string	서명자에 필요한 인증 수준입니다.
액세스 코드	folder.envelopePartyPermissions.userDefinedAccessCode	string	서명자에 대해 정의된 사용자 지정 액세스 코드입니다.
서명 ID	folder.envelopePartyPermissions.signatureId	string	서명의 고유 식별자입니다.
받는 사람 역할	folder.envelopePartyPermissions.partyRole	string	서명 워크플로에서 이 받는 사람에게 할당된 역할입니다.
회사 필드	folder.envelopePartyPermissions.companyFieldValue	string	서명에 있는 회사 이름 필드의 값입니다.
제목 필드	folder.envelopePartyPermissions.titleFieldValue	string	서명에 있는 제목 필드의 값입니다.
서명 이유	folder.envelopePartyPermissions.reasonSigning	string	받는 사람이 문서에 서명하는 이유입니다.
결제 필드가 추가됨	folder.envelopePartyPermissions.payFieldAdded	boolean	결제 필드가 추가되었는지 여부를 나타냅니다.
수취인	folder.envelopePartyPermissions.payee	boolean	이 수신자가 수취인인지 여부를 나타냅니다.
되풀이 결제	folder.envelopePartyPermissions.recurringFieldExist	boolean	되풀이 결제 필드가 있는지 여부를 나타냅니다.
인쇄 및 서명 완료	folder.envelopePartyPermissions.printAndSignCompleted	boolean	인쇄 및 서명 프로세스가 완료되었는지 여부를 나타냅니다.
지불	folder.envelopePartyPermissions.paid	boolean	결제가 완료되었는지 여부를 나타냅니다.
인증 수준	folder.envelopeAuthenticationLevel	string	봉투에 필요한 인증 수준입니다.
Single Signer Bulk	folder.allowSingleSignerInBulk	boolean	단일 서명자가 대량 송신 모드에서 허용되는지 여부를 나타냅니다.
File-Based 이름 지정	folder.folderNameBasedOnFileNaming	boolean	폴더 이름이 파일 이름을 기반으로 하는지 여부를 나타냅니다.
문서 File-Based 이름	folder.documentNameBasedOnFileNaming	boolean	문서 이름이 파일 이름을 기반으로 하는지 여부를 나타냅니다.
인증서 File-Based 이름	folder.certificateNameBasedOnFileNaming	boolean	인증서 이름이 파일 이름을 기반으로 하는지 여부를 나타냅니다.
Pre-Exec 파일 이름 지정	folder.enableFileNamingBeforeExecution	boolean	문서 실행 전에 파일 이름을 사용할 수 있는지 여부를 나타냅니다.
추가된 수취인	folder.payeeAddedd	boolean	수취인을 추가했는지 여부를 나타냅니다.
Self-Signing 사용	folder.selfSignerEnabled	boolean	자체 서명 모드를 사용할 수 있는지 여부를 나타냅니다.
공증 사용	folder.notaryEnabled	boolean	공증 서명이 사용되는지 여부를 나타냅니다.
제한된 표시 유형	folder.limitedVisibilityFlag	boolean	이 봉투에 대해 제한된 표시 유형을 사용할 수 있는지 여부를 나타냅니다.
사후 서명 표시 유형	folder.postSigningVisibility	boolean	서명 후 표시 유형을 사용할 수 있는지 여부를 나타냅니다.
젖은 서명	folder.wetSignatureEnabled	boolean	습식 서명을 사용할 수 있는지 여부를 나타냅니다.
병합 사용	folder.mergeEnabled	boolean	문서 병합을 사용할 수 있는지 여부를 나타냅니다.
포함된 서명 세션	embeddedSigningSessions	array of object	포함된 서명 세션의 목록으로, 받는 사람당 하나씩. createEmbeddedSigningSession이 true인 경우에만 존재합니다.
서명자 전자 메일	embeddedSigningSessions.emailIdOfSigner	string	이 포함된 서명 세션에 대한 받는 사람의 전자 메일 주소입니다.
서명 토큰	embeddedSigningSessions.embeddedToken	string	이 받는 사람의 포함된 서명 세션에 대한 고유 토큰입니다.
서명 세션 URL	embeddedSigningSessions.embeddedSessionURL	string	이 받는 사람이 문서에 서명할 수 있도록 열거나 포함할 URL입니다.
포함된 전송 토큰	embeddedToken	string	포함된 송신 세션에 대한 토큰입니다. createEmbeddedSendingSession이 true인 경우에만 존재합니다.
세션 URL 보내기	embeddedSessionURL	string	봉투 작성자가 봉투를 준비하고 보낼 수 있도록 열거나 포함할 URL입니다. createEmbeddedSendingSession이 true인 경우에만 존재합니다.
Result	result	string	작업의 결과입니다.
Message	message	string	작업 결과를 설명하는 메시지입니다.

URL에서 템플릿 만들기

작업 ID:: CreateTemplatefromURL

공개적으로 액세스할 수 있는 PDF URL을 사용하여 새 템플릿을 만듭니다.

매개 변수

Name	키	필수	형식	Description
템플릿 이름	templateName	True	string	템플릿의 이름입니다. .pdf 확장(예: onboarding.pdf)으로 끝나야 합니다.
템플릿 URL	templateUrl	True	string	서식 파일로 사용할 PDF 문서의 공개적으로 액세스할 수 있는 URL입니다.
입력 형식	inputType	True	string	문서의 입력 메서드입니다. 이 작업에 대해 항상 'url'로 설정합니다.
텍스트 태그 처리	processTextTags	True	boolean	사용하도록 설정하면 Foxit eSign은 문서에서 텍스트 태그를 검색하고 자동으로 서명 필드로 변환합니다.
Acro 필드 처리	processAcroFields	True	boolean	사용하도록 설정하면 Foxit eSign은 문서를 AcroFields로 검색하고 자동으로 서명 필드로 변환합니다.
모두 공유	shareAll	True	boolean	계정의 모든 사용자와 이 템플릿을 공유합니다.
파티 수	numberOfParties	True	integer	템플릿에 파티 수를 추가합니다. 이 매개 변수의 값은 20 미만이어야 합니다.
테마 색	themeColor		string	색에 대한 css 값을 입력하여 createEmbeddedTemplateSession의 테마를 변경합니다.
작성자 Email	authorEmail		string	이 템플릿의 작성자로 사용할 계정에 다른 사용자의 전자 메일을 입력합니다.
포함된 템플릿 세션 만들기	createEmbeddedTemplateSession		boolean	true로 설정하면 포함된 템플릿 세션이 Foxit eSign 템플릿 준비 보기를 직접 엽니다. 템플릿에서 다양한 필드를 끌어서 놓을 수 있습니다.
리디렉션 URL	redirectURL		string	createEmbeddedTemplateSession이 true이면 모든 웹 사이트/애플리케이션의 방문 페이지에 대한 절대 URL을 입력할 수 있습니다. 이 URL은 포함된 템플릿 보기에서 "저장 및 닫기"를 클릭한 후 리디렉션됩니다.
보내기 템플릿 숨기기	hideSendTemplate		boolean	true이면 포함된 템플릿 보기에서 보내기 단추를 숨깁니다.
받는 사람 당사자 수정	fixRecipientParties		boolean	true이면 포함된 템플릿 보기에서 이미 추가된 봉투의 당사자를 변경할 수 없습니다.
필드	Fields		object
permissions	permission	True	string
Sequence	sequence	True	integer	1부터 시작하는 이 파티의 고유 시퀀스 번호입니다. 로그인 시퀀스를 사용하는 경우 서명 순서를 정의합니다.
받는 사람 역할	partyRole	True	string	템플릿에서 이 파티에 할당된 역할입니다.
추가 작업 숨기기	hideMoreAction		boolean	true이면 템플릿 세션에서 "추가 작업" 단추를 숨깁니다.
모두와 공유 숨기기	hideShareWithAll		boolean	true이면 템플릿 세션에서 "모두와 공유" 옵션이 숨겨지게 됩니다.
파티 추가 숨기기	hideAddParty		boolean	true이면 포함된 템플릿 세션에서 파티 추가 옵션을 모두 숨깁니다.
숨기기 단추	hideMeButton		boolean	true이면 포함된 템플릿 세션에서 받는 사람 당사자의 "나" 단추가 숨겨지게 됩니다.
다른 항목 숨기기 단추	hideOthersButton		boolean	true이면 포함된 템플릿 세션에서 받는 사람 당사자의 "기타" 단추를 숨깁니다.
기존 연락처 선택 옵션 숨기기	hideExistingContactSelectOption		boolean	true이면 포함된 템플릿 세션에서 받는 사람 당사자의 "기존 연락처 찾기 및 추가" 입력 상자가 숨겨지게 됩니다.
받는 사람의 필드 이름 숨기기	hideFieldNameForRecipients		boolean	데이터 항목 필드 및 고급 필드에 대한 받는 사람의 필드 이름을 숨깁니다. (라디오 단추, 확인란, 이미지 및 하이퍼링크 제외).
확인란 테두리 숨기기	hideCheckboxBorder		boolean	실행된 문서에는 확인란의 테두리가 숨겨집니다.

반품

Name	경로	형식	Description
Result	result	string	작업이 성공했는지 여부를 나타냅니다(예: '성공').
Message	message	string	작업 결과에 대한 설명입니다.
아이디	template.templateId	integer	만든 템플릿의 고유 ID입니다. 이 템플릿에서 봉투를 만들려면 이 방법을 사용합니다.
이름	template.templateName	string	템플릿의 이름입니다.
Description	template.templateDesc	string	템플릿에 대한 설명입니다.
Type	template.templateType	string	템플릿의 형식입니다.
만든 날짜	template.templateCreationDate	string	템플릿을 만든 날짜입니다.
마지막 업데이트 날짜	template.templateLastUpdateDate	string	템플릿이 마지막으로 업데이트된 날짜입니다.
수정 가능	template.editable	boolean	템플릿을 편집할 수 있는지 여부를 나타냅니다.
파티 수	template.numberOfParties	integer	템플릿에 정의된 받는 사람 수입니다.
총 페이지 수	template.totalPages	integer	서식 파일 문서의 총 페이지 수입니다.
회사 ID	template.companyId	integer	이 템플릿이 속한 회사의 ID입니다.
모두와 공유	template.shareAll	boolean	이 템플릿이 계정의 모든 사용자와 공유되는지 여부를 나타냅니다.
사용자 지정 이름 패턴	template.templateCustomName	string	이 템플릿에서 만든 봉투에 적용되는 사용자 지정 이름 패턴입니다.
파티 사용 권한	template.templatePartyPermissions	array of object	이 템플릿에 정의된 받는 사람 역할 및 사용 권한 목록입니다.
파티 ID	template.templatePartyPermissions.template_party_id	integer	이 템플릿 파티 항목의 고유 ID입니다.
아이디	template.templatePartyPermissions.templateId	integer	이 파티가 속한 템플릿의 ID입니다.
Permissions	template.templatePartyPermissions.templatePermissions	string	이 당사자에 대한 서명 권한(예: FILL_FIELDS_AND_SIGN)입니다.
서명 순서	template.templatePartyPermissions.partySequence	integer	이 파티의 서명 순서 위치입니다.
파티 역할	template.templatePartyPermissions.templatePartyRole	string	템플릿에서 이 파티에 할당된 역할 이름입니다. 템플릿에서 봉투를 만들 때 사용합니다.
파티 ID	template.templatePartyPermissions.partyId	integer	미리 할당된 경우 이 역할에 할당된 파티의 ID입니다.
사용자 ID	template.templateCreatedBy.partyId	integer	사용자의 고유 ID입니다.
이름 (First Name)	template.templateCreatedBy.firstName	string	사용자의 이름입니다.
성 이름	template.templateCreatedBy.lastName	string	사용자의 성입니다.
전자 메일	template.templateCreatedBy.emailId	string	사용자의 전자 메일 주소입니다.
회사 ID	template.templateCreatedBy.companyId	integer	사용자가 속한 회사의 ID입니다.
사용자 역할	template.templateCreatedBy.userRole	string	조직 내에서 사용자의 역할입니다.
진행 중	template.templateCreatedBy.active	boolean	사용자의 계정이 활성 상태인지 여부를 나타냅니다.
사용자 ID	template.templateLastUpdatedBy.partyId	integer	사용자의 고유 ID입니다.
이름 (First Name)	template.templateLastUpdatedBy.firstName	string	사용자의 이름입니다.
성 이름	template.templateLastUpdatedBy.lastName	string	사용자의 성입니다.
전자 메일	template.templateLastUpdatedBy.emailId	string	사용자의 전자 메일 주소입니다.
회사 ID	template.templateLastUpdatedBy.companyId	integer	사용자가 속한 회사의 ID입니다.
사용자 역할	template.templateLastUpdatedBy.userRole	string	조직 내에서 사용자의 역할입니다.
진행 중	template.templateLastUpdatedBy.active	boolean	사용자의 계정이 활성 상태인지 여부를 나타냅니다.
템플릿 필드	allfields	array of object	템플릿에 정의된 모든 서명 및 양식 필드 목록입니다.
필드 ID	allfields.fieldTagId	integer	필드의 고유 식별자입니다.
템플릿 아이디	allfields.templateId	integer	이 필드가 속한 템플릿의 ID입니다.
회사 ID	allfields.companyId	integer	이 필드가 속한 회사 계정입니다.
필드 유형	allfields.fieldType	string	필드의 형식(예: signfield, initialfield, textfield, datefield, checkboxfield, securedfield, attachmentfield)입니다.
페이지 번호	allfields.documentPageNumber	integer	이 필드가 배치된 문서의 페이지 번호입니다.
책임 당사자	allfields.partyResponsible	integer	이 필드를 채우는 파티 시퀀스 번호입니다.
파티 시퀀스	allfields.partyResponsibleSequence	integer	책임 당사자의 시퀀스 위치입니다.
필드 문서 ID	allfields.docFieldId	string	이 필드의 문서 수준 식별자입니다.
종속성	allfields.dependent	boolean	이 필드의 표시 유형이 다른 필드의 값에 따라 달라지는지 여부를 나타냅니다.
탭 순서	allfields.tabOrder	integer	필드 간 탐색을 위한 탭 순서입니다.
필수	allfields.required	boolean	문서에 서명하기 전에 이 필드를 채워야 하는지 여부를 나타냅니다.
사용자 지정 필드 이름	allfields.customFieldName	string	이 필드에 할당된 사용자 지정 이름입니다.
모두 공유	allfields.shareAll	boolean	이 필드가 모든 사용자와 공유되는지 여부를 나타냅니다.
편집 허용	allfields.allowEdit	boolean	받는 사람이 이 필드를 편집할 수 있는지 여부를 나타냅니다.
텍스트 필드 이름	allfields.textfieldName	string	텍스트 필드의 레이블입니다(fieldType이 'textfield'인 경우 적용 가능).
가치	allfields.value	string	필드의 미리 채워지거나 입력한 값입니다.
글꼴 크기	allfields.fontSize	integer	이 필드의 텍스트에 사용되는 글꼴 크기입니다.
글꼴 색	allfields.fontColor	string	이 필드의 텍스트에 사용되는 글꼴 색(예: #000000)입니다.
읽기 전용	allfields.readOnly	boolean	필드가 읽기 전용이고 받는 사람이 편집할 수 없는지 여부를 나타냅니다.
여러 줄	allfields.multiLine	boolean	텍스트 필드가 여러 줄의 입력을 허용하는지 여부를 나타냅니다(fieldType이 'textfield'인 경우 적용 가능).
문자 제한	allfields.characterLimit	integer	필드에 허용되는 최대 문자 수입니다(fieldType이 'textfield'인 경우 적용 가능).
날짜 필드 이름	allfields.datefieldName	string	날짜 필드의 레이블입니다(fieldType이 'datefield'인 경우 적용 가능).
날짜 형식	allfields.dateFormat	string	이 필드에 사용되는 날짜 형식(예: MM/DD/YYYY)입니다(fieldType이 'datefield'인 경우 적용 가능).
확인란 이름	allfields.cbname	string	확인란 필드의 레이블입니다(fieldType이 'checkboxfield'인 경우 적용 가능).
확인란 그룹	allfields.cbgroup	string	이 확인란의 그룹 이름입니다(fieldType이 'checkboxfield'인 경우 적용 가능).
체크됨	allfields.checked	boolean	확인란이 기본적으로 선택되어 있는지 여부를 나타냅니다(fieldType이 'checkboxfield'인 경우 적용 가능).
보안 필드 이름	allfields.securedfieldName	string	보안 필드의 레이블입니다(fieldType이 'securedfield'인 경우 적용 가능).
표시할 문자	allfields.charToDisplay	integer	보안 필드 값의 끝에 표시할 마스크되지 않은 문자 수입니다(fieldType이 'securedfield'인 경우 적용 가능).
서명 ID	allfields.signatureId	string	이 기호 필드에 적용된 서명의 ID입니다(fieldType이 'signfield'인 경우 적용 가능).
초기 이미지	allfields.initialImage	string	이 필드에 적용된 이니셜의 이미지 데이터입니다(fieldType이 'initialfield'인 경우 적용 가능).
첨부 파일 필드 이름	allfields.attachmentfieldName	string	첨부 파일 필드의 이름입니다(fieldType이 'attachmentfield'인 경우 적용 가능).
첨부 파일 설명	allfields.attachmentfieldDescription	string	연결할 항목에 대한 설명입니다(fieldType이 'attachmentfield'인 경우 적용 가능).

단일 문서 PDF 다운로드

작업 ID:: DownloadSingleDocumentPDF

봉투에서 단일 문서를 PDF 파일로 다운로드합니다.

매개 변수

Name	키	필수	형식	Description
봉투 ID	folderId	True	string	다운로드할 문서가 포함된 봉투의 고유 식별자입니다.
문서 번호	docNumber	True	string	1부터 다운로드할 문서의 인덱스입니다.

반품

response: binary

모든 웹후크 채널 나열

작업 ID:: ListallWebhookChannels

계정에 구성된 모든 웹후크 채널 목록을 반환합니다.

반품

Name	경로	형식	Description
Result	result	string	요청이 성공했는지 여부를 나타냅니다.
총 채널	total_channel	integer	계정에 구성된 총 웹후크 채널 수입니다.
웹후크 채널	templatesList	array of object	계정의 모든 웹후크 채널 목록입니다.
채널 ID	templatesList.channelId	integer	웹후크 채널의 고유 식별자입니다.
회사 ID	templatesList.companyId	integer	이 채널이 속한 회사 계정입니다.
채널 이름	templatesList.channelName	string	웹후크 채널의 이름입니다.
웹후크 URL	templatesList.webhookUrl	string	구독된 이벤트가 발생할 때 Foxit eSign이 호출하는 URL입니다.
웹후크 비밀	templatesList.webhookSecret	string	웹후크 페이로드를 확인하는 데 사용되는 비밀 키입니다.
만든 날짜	templatesList.dateCreated	integer	채널이 만들어진 날짜(Unix 밀리초)입니다.
업데이트된 날짜	templatesList.dateUpdated	integer	채널이 마지막으로 업데이트된 날짜(Unix 밀리초)입니다.
웹후크 수준	templatesList.webhookLevel	string	웹후크 채널의 범위입니다. '계정'(모든 봉투에 대한 트리거) 또는 'API 앱'(API를 통해 만든 봉투에 대해서만 트리거).
Status	templatesList.status	string	채널의 현재 상태입니다. '활성' 또는 '비활성화'.
보낸 봉투	templatesList.eventsSubscribedMap.folder_sent	boolean	받는 사람에게 봉투를 보낼 때 트리거됩니다.
봉투가 표시됨	templatesList.eventsSubscribedMap.folder_viewed	boolean	받는 사람이 봉투를 열 때 트리거됩니다.
봉투 서명됨	templatesList.eventsSubscribedMap.folder_signed	boolean	받는 사람이 봉투에 서명할 때 트리거됩니다.
봉투 취소됨	templatesList.eventsSubscribedMap.folder_cancelled	boolean	봉투가 취소될 때 트리거됩니다.
봉투 실행됨	templatesList.eventsSubscribedMap.folder_executed	boolean	모든 당사자가 서명하고 봉투가 완전히 실행될 때 트리거됩니다.
봉투 삭제됨	templatesList.eventsSubscribedMap.folder_deleted	boolean	봉투가 삭제될 때 트리거됩니다.

모든 템플릿 목록 가져오기

작업 ID:: GetalistofallTemplates

계정에서 사용할 수 있는 모든 템플릿 목록을 반환합니다.

반품

Name	경로	형식	Description
Result	result	string	요청이 성공했는지 여부를 나타냅니다.
총 서식 파일	total_templates	integer	계정의 총 템플릿 수입니다.
템플릿 목록	templatesList	array of object	계정에서 사용할 수 있는 모든 템플릿 목록입니다.
템플릿 아이디	templatesList.templateId	integer	템플릿의 고유 식별자입니다. 서식 파일에서 봉투 만들기와 함께 이 ID를 사용하여 서명할 템플릿을 보냅니다.
템플릿 이름	templatesList.templateName	string	템플릿의 이름입니다.
템플릿 설명	templatesList.templateDesc	string	템플릿에 대한 설명입니다.
템플릿 유형	templatesList.templateType	string	템플릿의 형식 또는 범주입니다.
생성 날짜	templatesList.templateCreationDate	integer	템플릿을 만든 날짜(Unix 밀리초)입니다.
마지막 업데이트 날짜	templatesList.templateLastUpdateDate	integer	템플릿이 마지막으로 업데이트된 날짜(Unix 밀리초)입니다.
수정 가능	templatesList.editable	boolean	템플릿을 편집할 수 있는지 여부를 나타냅니다.
파티 수	templatesList.numberOfParties	integer	템플릿에 정의된 서명 당사자 수입니다.
회사 ID	templatesList.companyId	integer	템플릿이 속한 회사 계정입니다.
모두와 공유	templatesList.shareAll	boolean	템플릿이 계정의 모든 사용자와 공유되는지 여부를 나타냅니다.
파티 ID	templatesList.templateCreatedBy.partyId	integer	사용자의 고유 식별자입니다.
이름 (First Name)	templatesList.templateCreatedBy.firstName	string	사용자의 이름입니다.
성 이름	templatesList.templateCreatedBy.lastName	string	사용자의 성입니다.
전자 메일	templatesList.templateCreatedBy.emailId	string	사용자의 전자 메일 주소입니다.
파티 ID	templatesList.templateLastUpdatedBy.partyId	integer	사용자의 고유 식별자입니다.
이름 (First Name)	templatesList.templateLastUpdatedBy.firstName	string	사용자의 이름입니다.
성 이름	templatesList.templateLastUpdatedBy.lastName	string	사용자의 성입니다.
전자 메일	templatesList.templateLastUpdatedBy.emailId	string	사용자의 전자 메일 주소입니다.

보고서 다운로드

작업 ID:: DownloadReport

봉투 활동 보고서를 Microsoft Excel 파일로 다운로드합니다. 필터를 사용하여 상태, 날짜 범위, 봉투 이름, 작성자 또는 서명자별로 결과를 좁힐 수 있습니다.

매개 변수

Name	키	형식	Description
envelopeStatus	status	string	보고서를 필터링할 폴더의 상태입니다.
만든 날짜	creationDateFrom	string	생성 날짜 범위의 시작입니다. 허용되는 형식: YYYY-MM-DD.
만든 날짜	creationDateTo	string	생성 날짜 범위의 끝입니다. 허용되는 형식: YYYY-MM-DD.
봉투 이름	folderName	string	이 문자열을 포함하는 모든 폴더입니다.
필드 포함	includeFields	string	보고서에 봉투 필드 값을 포함하려면 'true'로 설정합니다. 기본값은 'false'입니다.
작성자 Email	authorEmail	string	이 작성자 전자 메일 주소에서 만든 봉투만 포함하도록 보고서를 필터링합니다.
서명자 전자 메일	signerEmail	string	이 전자 메일 주소가 서명자인 봉투만 포함하도록 보고서를 필터링합니다.

반품

보고서 파일: binary

봉투 ID 가져오기

작업 ID:: GetEnvelopeIds

상태별로 필터링된 봉투 ID 목록을 반환합니다. 이 항목을 사용하여 특정 상태에서 봉투를 찾습니다.

매개 변수

Name	키	필수	형식	Description
날짜 지정 날짜	dateFrom	True	string	봉투 생성 날짜 범위의 시작입니다. 허용되는 형식: YYYY-MM-DD.
날짜/날짜	dateTo	True	string	봉투 생성 날짜 범위의 끝입니다. 허용되는 형식: YYYY-MM-DD. dateTo 값은 dateFrom 값의 6개월 이내여야 합니다.
Status	status		string	봉투를 상태별로 필터링합니다. 허용되는 값: EXECUTED, SHARED, DRAFT, PARTIALLY SIGNED, CANCELLED, EXPIRED, DELETED. 생략하면 상태가 있는 봉투가 반환됩니다.

반품

Name	경로	형식	Description
Result	result	string	요청이 성공했는지 여부를 나타냅니다.
Message	message	string	반환된 봉투 ID 수를 나타내는 요약 메시지입니다.
봉투 ID	allFolderIds	array of integer	필터 조건과 일치하는 봉투 ID 목록입니다. 봉투 정보 가져오기와 함께 이러한 ID를 사용하여 전체 봉투 정보를 검색합니다.

봉투 삭제

작업 ID:: DeleteEnvelopes

하나 이상의 봉투를 영구적으로 삭제합니다.

매개 변수

Name	키	필수	형식	Description
폴더 ID	folderIds	True	array of integer	작업할 봉투 ID의 배열입니다.

반품

Name	경로	형식	Description
Result	result	string	작업이 성공했는지 여부를 나타냅니다.

봉투 세부 정보 가져오기

작업 ID:: GetEnvelopeDetails

봉투의 상태, 받는 사람 및 문서를 포함하여 봉투의 전체 세부 정보를 검색합니다.

매개 변수

Name	키	필수	형식	Description
봉투 ID	folderId	True	integer	검색할 봉투의 고유 식별자입니다.
액세스 토큰	access_token		string	인증을 위한 OAuth 2.0 액세스 토큰입니다.

반품

Name	경로	형식	Description
Result	result	string	작업이 성공했는지 여부를 나타냅니다(예: '성공').
아이디	folder.folderId	integer	봉투의 고유 ID입니다.
이름	folder.folderName	string	봉투의 이름입니다.
작성자 ID	folder.folderAuthorId	integer	봉투를 만든 사용자의 고유 ID입니다.
작성자 이름	folder.folderAuthorFirstName	string	봉투 작성자의 이름입니다.
작성자 성	folder.folderAuthorLastName	string	봉투 작성자의 성입니다.
작성자 Email	folder.folderAuthorEmail	string	봉투 작성자의 전자 메일 주소입니다.
작성자 역할	folder.folderAuthorRole	string	봉투 작성자의 계정 역할입니다.
회사 ID	folder.folderCompanyId	integer	봉투가 속한 회사의 고유 ID입니다.
만든 날짜	folder.folderCreationDate	integer	봉투가 만들어진 날짜와 시간(Unix 밀리초)입니다.
보낸 날짜	folder.folderSentDate	integer	봉투를 받는 사람에게 보낸 날짜와 시간(Unix 밀리초)입니다. 아직 보내지 않은 경우 Null입니다.
Status	folder.folderStatus	string	봉투의 현재 상태(예: SHARED, EXECUTED, DRAFT, CANCELLED)입니다.
문서 ID	folder.folderDocumentIds	array of integer	이 봉투에 포함된 문서 ID 목록입니다.
문서	folder.documentsList	array of object	봉투에 포함된 각 문서의 세부 정보입니다.
문서 ID	folder.documentsList.documentId	integer	문서의 고유 식별자입니다.
계약 ID	folder.documentsList.contractId	integer	이 문서와 연결된 계약의 고유 식별자입니다.
회사 ID	folder.documentsList.companyId	integer	이 문서가 속한 회사의 고유 ID입니다.
작성자	folder.documentsList.contractCreatedBy	integer	계약을 만든 사용자의 사용자 ID입니다.
생성 일자	folder.documentsList.contractCreatedOn	integer	계약이 생성된 날짜(Unix 밀리초)입니다.
계약 유형	folder.documentsList.contractType	string	계약의 형식 또는 범주입니다.
문서 상태	folder.documentsList.contractStatus	string	문서의 현재 서명 상태(예: WAITING_FOR_SIGNATURE, EXECUTED)입니다.
수정 가능	folder.documentsList.editable	boolean	문서를 편집할 수 있는지 여부를 나타냅니다.
버전 ID	folder.documentsList.contractVersionId	integer	현재 문서 버전의 고유 ID입니다.
버전 이름	folder.documentsList.contractVersionName	string	현재 문서 버전의 이름입니다.
버전 설명	folder.documentsList.contractVersionDesc	string	현재 문서 버전에 대한 설명입니다.
만든 버전	folder.documentsList.versionCreatedby	integer	이 문서 버전을 만든 사용자의 사용자 ID입니다.
만든 버전	folder.documentsList.versionCreatedOn	integer	이 문서 버전을 만든 날짜(Unix 밀리초)입니다.
버전 번호	folder.documentsList.contractVersionNumber	integer	문서의 버전 번호입니다.
받는 사람	folder.folderRecipientParties	array of object	서명 상태 및 액세스 링크를 포함하여 이 봉투의 받는 사람 목록입니다.
받는 사람 ID	folder.folderRecipientParties.partyId	integer	받는 사람의 고유 식별자입니다.
받는 사람 ID	folder.folderRecipientParties.partyDetails.partyId	integer	받는 사람의 고유 식별자입니다.
이름 (First Name)	folder.folderRecipientParties.partyDetails.firstName	string	받는 사람의 이름입니다.
성 이름	folder.folderRecipientParties.partyDetails.lastName	string	받는 사람의 성입니다.
전자 메일	folder.folderRecipientParties.partyDetails.emailId	string	받는 사람의 이메일 주소입니다.
Address	folder.folderRecipientParties.partyDetails.address	string	받는 사람의 주소입니다.
계정 생성 날짜	folder.folderRecipientParties.partyDetails.dateCreated	integer	받는 사람의 계정이 만들어진 날짜(Unix 밀리초)입니다.
Permissions	folder.folderRecipientParties.contractPermissions	string	이 받는 사람에게 부여된 서명 권한(예: FILL_FIELDS_AND_SIGN)입니다.
서명 순서	folder.folderRecipientParties.partySequence	integer	서명 순서에서 이 받는 사람의 위치입니다.
워크플로 시퀀스	folder.folderRecipientParties.workflowSignSequence	integer	이 받는 사람의 워크플로 서명 시퀀스 번호입니다.
봉투 ID	folder.folderRecipientParties.envelopeId	integer	받는 사람이 속한 봉투의 ID입니다.
공유 모드	folder.folderRecipientParties.sharingMode	string	이 받는 사람과 문서를 공유하는 데 사용되는 메서드(예: 전자 메일)입니다.
서명 URL	folder.folderRecipientParties.folderAccessURL	string	이 받는 사람에 대한 고유한 서명 URL입니다. 봉투가 이미 완료되었거나 취소된 경우 Null입니다.
보안 모드	folder.folderRecipientParties.securityMode	string	이 받는 사람의 액세스에 적용되는 보안 모드입니다.
추가 설명	folder.folderRecipientParties.extraComments	string	이 받는 사람에 대한 서명 초대에 포함된 추가 설명입니다.
작성자 액세스 URL	folder.folderAccessURLForAuthor	string	문서에 액세스할 봉투 작성자의 URL입니다. 해당하지 않는 경우 Null입니다.
대량 ID	folder.bulkId	integer	이 봉투가 속한 대량 보내기 일괄 처리의 ID(있는 경우)입니다.
서명 순서 적용	folder.enforceSignWorkflow	boolean	받는 사람이 지정된 순서로 로그인해야 하는지 여부를 나타냅니다.
현재 워크플로 단계	folder.currentWorkflowStep	integer	서명 워크플로의 현재 단계입니다.
트랜잭션 원본	folder.transactionSource	string	이 봉투 트랜잭션을 시작한 소스입니다.
수정 가능	folder.editable	boolean	봉투를 계속 편집할 수 있는지 여부를 나타냅니다.
In-Person 서명	folder.inPersonSignable	boolean	봉투를 직접 로그인할 수 있는지 여부를 나타냅니다.
미리 알림 재정의	folder.overrideAccountReminders	boolean	이 봉투에 대해 계정 수준 미리 알림 설정이 재정의되는지 여부를 나타냅니다.
아이디	folder.envelopeId	integer	봉투의 고유 ID입니다. Envelope ID(folderId)와 동일한 값입니다.
이름	folder.envelopeName	string	봉투의 이름입니다. Envelope Name(folderName)과 동일한 값입니다.
발신기 ID	folder.envelopeOriginatorId	integer	봉투를 만든 사용자의 사용자 ID입니다.
회사 ID	folder.envelopeCompanyId	integer	봉투가 속한 회사의 ID입니다.
Date	folder.envelopeDate	integer	봉투가 만들어진 날짜와 시간(Unix 밀리초)입니다.
공유 날짜	folder.envelopeSharedDate	integer	봉투가 받는 사람과 공유된 날짜 및 시간(Unix 밀리초)입니다. 아직 공유되지 않은 경우 Null입니다.
Status	folder.envelopeStatus	string	봉투의 현재 상태입니다. Envelope 상태(folderStatus)와 동일한 값입니다.
계약 ID	folder.envelopeContractIds	array of integer	이 봉투와 연결된 계약 ID 목록입니다.
파티 사용 권한	folder.envelopePartyPermissions	array of object	받는 사람 및 해당 서명 권한 목록입니다. 받는 사람과 동일한 구조입니다.
받는 사람 ID	folder.envelopePartyPermissions.partyId	integer	받는 사람의 고유 식별자입니다.
이름 (First Name)	folder.envelopePartyPermissions.partyDetails.firstName	string	받는 사람의 이름입니다.
성 이름	folder.envelopePartyPermissions.partyDetails.lastName	string	받는 사람의 성입니다.
전자 메일	folder.envelopePartyPermissions.partyDetails.emailId	string	받는 사람의 이메일 주소입니다.
Permissions	folder.envelopePartyPermissions.contractPermissions	string	이 받는 사람에 대한 서명 권한입니다.
서명 순서	folder.envelopePartyPermissions.partySequence	integer	서명 순서에서 이 받는 사람의 위치입니다.
서명 URL	folder.envelopePartyPermissions.folderAccessURL	string	이 받는 사람에 대한 고유한 서명 URL입니다.
모든 필드	allFields	array of object	봉투의 문서에 배치된 모든 서명 및 양식 필드 목록입니다.
필드 ID	allFields.fieldTagId	integer	필드의 고유 식별자입니다.
문서 ID	allFields.contractId	integer	이 필드가 속한 문서의 ID입니다.
버전 ID	allFields.versionId	integer	이 필드가 속한 문서의 버전 ID입니다.
필드 유형	allFields.fieldType	string	필드의 형식입니다(예: signfield, textfield, datefield, checkboxfield, dropdownfield, initialfield).
페이지 번호	allFields.documentPageNumber	integer	이 필드가 배치되는 페이지 번호입니다.
필드 문서 ID	allFields.docFieldId	string	이 필드의 문서 수준 식별자입니다.
책임 당사자	allFields.partyResponsible	integer	이 필드를 채우는 데 책임이 있는 파티 ID입니다.
종속성	allFields.dependent	boolean	이 필드의 표시 유형이 다른 필드의 값에 따라 달라지는지 여부를 나타냅니다.
필수	allFields.required	boolean	문서를 제출하기 전에 이 필드를 채워야 하는지 여부를 나타냅니다.
필드 값	allFields.value	string	채워진 경우 필드의 현재 값입니다.
필드 값	allFieldsNameValue	array of object	모든 필드 이름과 해당 현재 값의 간소화된 목록입니다. 서명된 봉투에서 채워진 필드 데이터를 읽는 데 사용합니다.
필드 ID	allFieldsNameValue.fieldId	integer	필드의 고유 식별자입니다.
문서 ID	allFieldsNameValue.documentId	integer	이 필드가 속한 문서의 ID입니다.
버전 ID	allFieldsNameValue.documentVersionId	integer	이 필드가 속한 문서의 버전 ID입니다.
필드 유형	allFieldsNameValue.fieldType	string	필드의 형식입니다(예: textfield, signfield, datefield, checkboxfield, dropdownfield).
필드 이름	allFieldsNameValue.name	string	템플릿에 정의된 필드의 레이블 또는 이름입니다.
필드 값	allFieldsNameValue.value	string	이 필드에 대해 입력하거나 선택한 값입니다.
봉투 기록	Folder History	array of object	이 봉투에 대해 수행된 모든 작업의 감사 내역(시간순)입니다.
이름 (First Name)	Folder History.firstName	string	작업을 수행한 사람의 이름입니다.
성 이름	Folder History.lastName	string	작업을 수행한 사람의 성입니다.
전자 메일	Folder History.email	string	작업을 수행한 사용자의 전자 메일 주소입니다.
봉투 ID	Folder History.envelopeId	integer	작업이 수행된 봉투의 ID입니다.
Date	Folder History.dateChanged	integer	작업이 발생한 날짜 및 시간(Unix 밀리초)입니다.
파티 ID	Folder History.changeDoneByParty	integer	작업을 수행한 사용자의 파티 ID입니다.
작업	Folder History.action	string	봉투에 대해 수행된 작업(예: Created, InviteSentTo, InviteAccepted, Signed, Executed).

봉투 취소

작업 ID:: CancelEnvelope

보낸 봉투를 취소합니다. 받는 사람은 더 이상 문서에 서명할 수 없습니다.

매개 변수

Name	키	필수	형식	Description
봉투 ID	folderId	True	integer	취소할 봉투의 ID입니다.
취소 이유	reason_for_cancellation	True	string	이 봉투를 취소하는 이유입니다. 봉투 활동 기록에 기록됩니다.

반품

Name	경로	형식	Description
Result	result	string	요청이 성공했는지 여부를 나타냅니다.
취소된 봉투 ID	folders cancelled	array of integer	성공적으로 취소된 봉투 ID 목록입니다.

봉투 파일 다운로드

작업 ID:: DownloadEnvelopeFiles

봉투에서 완성된 문서를 파일로 다운로드합니다.

매개 변수

Name	키	필수	형식	Description
봉투 ID	folderId	True	string	문서를 다운로드하려는 봉투의 고유 식별자입니다.

반품

response: binary

봉투 활동 기록 가져오기

작업 ID:: GetEnvelopeActivityHistory

받는 사람과 보낸 사람이 수행한 모든 작업을 보여 주는 봉투에 대한 전체 활동 로그를 검색합니다.

매개 변수

Name	키	필수	형식	Description
봉투 ID	folderId	True	integer	활동 기록을 검색하려는 봉투의 고유 식별자입니다.

반품

Name	경로	형식	Description
Result	result	string	요청이 성공했는지 여부를 나타냅니다.
봉투 ID	details.folderId	integer	봉투의 고유 식별자입니다.
묶은 문서	details.enclosedDocuments	string	봉투에 묶인 문서의 이름입니다.
받는 사람	details.envelopeRecipients	string	봉투에 있는 모든 받는 사람의 이름입니다.
저자	details.author	string	봉투를 만든 사용자의 이름입니다.
Status	details.status	string	봉투의 현재 상태(예: SHARED, EXECUTED, CANCELLED)입니다.
최신 활동 날짜	details.latestActivityDate	string	봉투에 대한 가장 최근 활동의 날짜 및 시간입니다.
만든 날짜	details.dateCreated	string	봉투를 만든 날짜와 시간입니다.
보낸 날짜	details.dateSent	string	봉투를 받는 사람에게 보낸 날짜와 시간입니다.
Activities	details.activities	array of object	이 봉투에 대해 수행된 모든 작업의 시간순 목록입니다.
Activity	details.activities.activity	string	발생한 작업에 대한 사람이 읽을 수 있는 설명입니다.
작업	details.activities.action	string	수행된 작업 유형(예: 생성됨, 초대 보내기, 열기, 보기, 서명됨)입니다.
사용자	details.activities.user	string	작업을 수행한 사용자의 이름입니다.
봉투 상태	details.activities.folderStatus	string	이 작업이 발생한 시점의 봉투 상태입니다.
시간	details.activities.time	string	작업이 발생한 날짜 및 시간입니다.
Source	details.activities.source	string	작업이 수행된 원본(예: 웹)입니다.
IP 주소	details.activities.ipAddress	string	사용 가능한 경우 작업이 수행된 IP 주소입니다.

봉투를 휴지통으로 이동

작업 ID:: MoveEnvelopestoRecycleBin

하나 이상의 봉투를 휴지통으로 이동합니다. 휴지통의 봉투는 영구적으로 삭제되지 않습니다.

매개 변수

Name	키	필수	형식	Description
폴더 ID	folderIds	True	array of integer	작업할 봉투 ID의 배열입니다.

반품

Name	경로	형식	Description
Result	result	string	작업이 성공했는지 여부를 나타냅니다.

삭제된 봉투 기록 가져오기

작업 ID:: GetDeletedEnvelopeHistory

삭제되었거나 휴지통으로 이동한 봉투의 기록을 검색합니다.

매개 변수

Name	키	필수	형식	Description
봉투 ID	folderId	True	string	삭제 기록을 검색하려는 봉투의 고유 식별자입니다.

반품

Name	경로	형식	Description
Result	result	string	요청이 성공했는지 여부를 나타냅니다.
삭제된 봉투 정보	Deleted Folder Log Info	array of object	삭제된 봉투에 대한 요약 정보입니다.
봉투 ID	Deleted Folder Log Info.folderId	integer	삭제된 봉투의 고유 식별자입니다.
봉투 이름	Deleted Folder Log Info.folderName	string	삭제된 봉투의 이름입니다.
문서 이름	Deleted Folder Log Info.documentName	string	삭제된 봉투에 있는 문서의 이름입니다.
문서 ID	Deleted Folder Log Info.documentId	string	삭제된 봉투에 있는 문서의 고유 식별자입니다.
삭제 날짜	Deleted Folder Log Info.deletionDate	integer	봉투가 삭제된 날짜와 시간(Unix 밀리초)입니다.
삭제한 작성자	Deleted Folder Log Info.deletedBy	string	봉투를 삭제한 사용자의 이름입니다.
삭제 로그 기록	Deleted Folder Log History	array of object	봉투에 대해 수행된 모든 삭제 작업의 단계별 로그입니다.
수행자:	Deleted Folder Log History.partiesName	string	삭제 단계를 수행한 사용자의 이름입니다.
Source	Deleted Folder Log History.source	string	삭제가 시작된 원본(예: 웹, API)입니다.
Event	Deleted Folder Log History.event	string	수행된 특정 삭제 작업(예: 폴더 삭제, 폴더에서 모든 당사자 삭제).

서명 미리 알림 보내기

작업 ID:: SendSignatureReminder

보류 중인 봉투 받는 사람에게 미리 알림 알림을 보내 서명을 완료하라는 메시지를 표시합니다.

매개 변수

Name	키	필수	형식	Description
봉투 ID	folderId	True	integer	봉투의 ID입니다.

반품

Name	경로	형식	Description
Result	result	string	요청이 성공했는지 여부를 나타냅니다.
봉투 ID	reminder sent	integer	미리 알림을 보낸 봉투의 ID입니다.

서식 파일에서 봉투 만들기

작업 ID:: CreateEnvelopefromTemplate

기존 템플릿을 사용하여 봉투를 만들고 보냅니다. 받는 사람 세부 정보를 사용자 지정할 수 있습니다.

매개 변수

Name	키	필수	형식	Description
봉투 이름	folderName		string	문서 폴더의 이름입니다. 이 값을 제공하지 않으면 문서 폴더 이름이 템플릿 이름과 동일하게 유지됩니다.
템플릿 ID	templateIds	True	array of integer	이 폴더에 대한 문서를 만드는 데 사용할 템플릿 ID의 배열입니다.
필드	fields		object	템플릿에서 만든 문서에 미리 채우기 위해 템플릿에 사용되는 필드 값을 전달할 수 있습니다. FIELD_NAME 템플릿에 사용되는 필드의 이름입니다. FIELD_VALUE 문서 필드 값입니다.
고급 전자 메일 유효성 검사	allowAdvancedEmailValidation		boolean	true로 설정된 경우 당사자의 이메일 주소에 대한 유효성을 검사합니다.
이름 (First Name)	firstName	True	string	받는 사람의 이름입니다.
성 이름	lastName	True	string	받는 사람의 성입니다.
Email 주소	emailId	True	string	받는 사람의 전자 메일 주소입니다.
permissions	permission	True	string
Sequence	sequence	True	integer	받는 사람 목록의 받는 사람에게 시퀀스 번호를 할당하려면 이 필드를 사용합니다. 1,2,3,4와 같은 1로 시작하는 각 파티의 고유 시퀀스 번호를 사용합니다. 서명 워크플로에 한 사람이 여러 번 나타나는 경우 받는 사람이 반복할 때마다 다른 시퀀스를 할당하세요.
signerAuthLevels	signerAuthLevel		string	서명자가 확인을 위해 활용할 인증 수준
자리 표시자	isPlaceholder		boolean	파티가 자리 표시자임을 시작하려면 이 필드를 사용합니다. 참고: 1. firstName, lastName, emailId 매개 변수의 값은 이 파티의 비어 있어야 합니다. 2. 자리 표시자를 추가하려면 'PARTY_ASSIGNER' 권한으로 한 명의 받는 사람을 다시 지정해야 합니다.
받는 사람 역할	partyRole		string	자리 표시자 역할을 할당하려면 이 필드를 사용합니다.
이름 변경 허용	allowNameChange		string	값은 true이거나 false일 수 있습니다. 서명자가 서명 프로세스를 완료하기 전에 이름과 성을 업데이트할 수 있도록 하려면 이 매개 변수를 사용합니다.
워크플로 시퀀스	workflowSequence		integer	이 받는 사람에게 워크플로 시퀀스 번호를 할당합니다. 로그인 시퀀스를 사용하도록 설정하면 받는 사람은 서명 초대를 오름차순으로 받습니다.
호스트 전자 메일 ID	hostEmailId		string	In-Person 관리자의 전자 메일 주소입니다.
액세스 코드	userDefinedAccessCode		string	"signerAuthLevel" 값이 인증을 위해 "사용자 정의 액세스 코드"로 설정된 경우 매개 변수에 액세스 코드가 포함됩니다. 참고: 1. 코드는 대/소문자를 구분하지 않습니다. 2. 시스템은 이 코드를 보내지 않으므로 서명자와 이 코드를 직접 공유해야 합니다. 3. 액세스 코드에는 알파벳, 숫자 및 @,&{,},,%,(,),~,\|,!,+,^과 같은 특수 문자가 포함될 수 있습니다.
파티가 전자 메일 그룹인 경우	partyIsEmailGroup		boolean	파티를 대량으로 만들 때 이 매개 변수를 사용합니다. 참고: 이 매개 변수가 true이면 이 파티의 firstName, lastName 및 emailId가 무시됩니다.
전자 메일 그룹 ID	emailGroupId		integer	대량 생성에 사용할 그룹 ID를 전자 메일에 전달합니다.
Single Signer Bulk	allowSingleSignerInBulk		boolean	이 매개 변수를 사용하여 한 사람만 전자 메일 그룹에 로그인할 수 있습니다.
전화 걸기 코드	dialingCode		string	이 필드를 사용하여 받는 사람 목록의 받는 사람에게 휴대폰 번호 접두사인 국가 전화 접속 코드를 할당합니다.
휴대폰 번호	mobileNumber		string	받는 사람 목록의 받는 사람에게 휴대폰 번호를 할당하려면 이 필드를 사용합니다.
봉투 암호	folderPassword		string	디지털 서명된 문서를 열려면 서명자/작성자가 이 암호를 입력해야 합니다. 매개 변수를 비워 두면 디지털 서명된 문서를 여는 데 암호가 필요하지 않습니다.
로그인 시퀀스	signInSequence		boolean	이 필드는 받는 사람이 봉투 문서에 순서대로 서명할지 여부를 결정하는 데 사용됩니다. false이면 모든 받는 사람이 동시에 초대 전자 메일을 받습니다. true이면 이전 받는 사람이 문서 서명 또는 필드 채우기 등과 같은 필수 작업을 완료한 후 각 받는 사람이 연속적으로 초대 전자 메일을 받습니다.
직접 사용	inPersonEnable		boolean	이 필드는 몇 분 안에 모든 디바이스에서 쉽게 완료할 수 있는 직접 서명 프로세스를 시작하고 필요한 경우 이메일 기반 서명을 방지하는 데 사용됩니다. false이면 모든 받는 사람이 동시에 초대 전자 메일을 받습니다. true이면 직접 관리자가 서명자에 대한 서명 프로세스를 시작하기 위한 초대 이메일을 받습니다.
지금 보내기	sendNow		boolean	사용하도록 설정하면 Foxit eSign은 각 받는 사람의 전자 메일 주소에 고유한 서명 링크를 즉시 보냅니다. 봉투를 초안으로 저장하려면 이 기능을 사용하지 않도록 설정합니다.
서명 성공 URL 모든 당사자	signSuccessUrlAllParties		boolean	true로 설정하면 서명자가 성공적으로 서명한 후 signSuccessUrl에 제공된 URL로 리디렉션됩니다. sendNow가 true인 경우에만 적용됩니다.
포함된 송신 세션 만들기	createEmbeddedSendingSession		boolean	true로 설정하면 포함된 URL을 생성하여 Foxit eSign의 뷰를 준비하는 문서를 엽니다.
받는 사람 당사자 수정	fixRecipientParties		boolean	true이면 포함된 송신 보기에서 이 요청의 일부로 이미 추가된 봉투의 당사자를 변경할 수 없습니다.
문서 수정	fixDocuments		boolean	true이면 포함된 전송에서 이 요청의 일부로 이미 추가된 봉투의 문서를 변경할 수 없습니다.
성공 URL 보내기	sendSuccessUrl		string	방문 페이지의 절대 URL을 입력합니다. 이 URL은 포함된 송신 보기에서 폴더를 성공적으로 보낸 후 서명자가 리디렉션됩니다.
송신 오류 URL	sendErrorUrl		string	방문 페이지의 절대 URL을 입력합니다. 이 URL은 포함된 송신 보기에서 폴더를 보내는 동안 오류가 발생하면 서명자가 리디렉션됩니다.
서명자 선택 옵션 숨기기	hideSignerSelectOption		boolean	true이면 포함된 송신 세션에서 받는 사람 당사자의 "기존 서명자 이름/전자 메일" 입력 상자가 숨겨지게 됩니다.
서명자 작업 숨기기	hideSignerActions		boolean	true이면 포함된 송신 세션에서 받는 사람 당사자에 대한 서명자 "편집", "변경" 및 "제거" 작업을 숨깁니다.
보낸 사람 이름 숨기기	hideSenderName		boolean	true이면 포함된 송신 세션에서 받는 사람 당사자의 보낸 사람 이름을 숨깁니다.
보내기 단추 숨기기	hideSendButton		boolean	true이면 포함된 송신 세션에서 보내기 단추를 숨깁니다.
폴더 이름 숨기기	hideFolderName		boolean	true이면 포함된 두 세션의 탐색에서 폴더 이름을 숨깁니다.
문서 이름 숨기기	hideDocumentsName		boolean	true이면 포함된 두 세션에서 문서 이름을 숨깁니다.
추가 단추 숨기기	hideAddMeButton		boolean	true이면 포함된 송신 세션에서 받는 사람 당사자의 "추가" 단추가 숨겨지게 됩니다.
새로 추가 단추 숨기기	hideAddNewButton		boolean	true이면 포함된 송신 세션에서 받는 사람 당사자의 "새로 추가" 단추가 숨겨지게 됩니다.
그룹 추가 단추 숨기기	hideAddGroupButton		boolean	true이면 포함된 송신 세션에서 받는 사람 당사자의 "그룹 추가" 단추가 숨겨지게 됩니다.
포함된 서명 세션 만들기	createEmbeddedSigningSession		boolean	서명 세션 토큰은 받는 사람에게 전자 메일을 보내지 않고 생성됩니다.
모든 당사자에 대한 임베디드 서명 세션 만들기	createEmbeddedSigningSessionForAllParties		boolean	true로 설정하면 봉투의 모든 받는 사람에 대해 포함된 서명 URL이 생성됩니다. false이면 포함된 서명자 전자 메일 ID에 나열된 받는 사람만 포함된 세션을 받습니다.
포함된 서명자 전자 메일 ID	embeddedSignersEmailIds		array of string	포함된 서명 세션을 만들어야 하는 받는 사람의 전자 메일 ID 배열입니다. 당사자 목록에 추가된 받는 사람의 전자 메일 ID입니다.
서명 성공 URL	signSuccessUrl		string	포함된 서명 보기에 성공적으로 로그인한 후 리디렉션될 서명자의 절대 URL을 입력합니다.
서명 거부 URL	signDeclineUrl		string	포함된 서명 보기의 로그인을 거부하는 경우 리디렉션될 서명자의 절대 URL을 입력합니다.
나중에 서명 URL	signLaterUrl		string	나중에 포함된 서명 보기에서 서명하도록 선택하는 경우 리디렉션될 서명자의 절대 URL을 입력합니다.
서명 오류 URL	signErrorUrl		string	포함된 서명 보기에서 문서에 서명하는 동안 오류가 발생하면 리디렉션될 서명자의 절대 URL을 입력합니다.
다음 필수 필드 Btn 숨기기	hideNextRequiredFieldBtn		boolean	true로 설정하면 서명자를 다음 필수 필드로 이동하는 탐색 단추를 숨깁니다.
테마 색	themeColor		string	CSS 값을 입력하여 테마 색을 설정합니다.
서명 거부 숨기기	hideDeclineToSign		boolean	true로 설정하면 서명 화면에서 서명 거부 옵션을 숨깁니다.
추가 작업 숨기기	hideMoreAction		boolean	true로 설정하면 보내기 및 서명 세션에서 추가 작업 단추를 숨깁니다. 지금 보내기가 true이면 아무런 효과가 없습니다.
파티 추가 옵션 숨기기	hideAddPartiesOption		boolean	true로 설정하면 초안 및 템플릿 만들기 모드에서 파티를 추가하는 옵션을 숨깁니다.
세션 만료	sessionExpire		boolean	포함된 서명 세션의 만료를 시작하려면 true로 설정합니다.
만료	expiry		integer	sessionExpire가 true이면 필수입니다. 포함된 서명 세션에서 만료 기간을 밀리초 단위로 입력합니다.
보낸 사람 전자 메일	senderEmail		string	이 문서 폴더를 받는 사람에게 보내는 데 사용할 다른 사용자의 전자 메일을 계정에 입력합니다.
지금 보내기 및 포함된 서명 세션 허용	allowSendNowAndEmbeddedSigningSession		boolean	true로 설정하면 Foxit eSign은 각 받는 사람에게 서명 초대 전자 메일을 보내고 포함된 서명자 전자 메일에 전자 메일이 포함된 받는 사람에 대한 포함된 서명 링크도 생성합니다. 전자 메일과 포함된 링크는 모두 동시에 활성화됩니다.
단계별 사용	enableStepByStep		boolean	포함된 송신 세션에서 단계별 작업을 사용하도록 설정합니다.

반품

Name	경로	형식	Description
Result	result	string	작업이 성공했는지 여부를 나타냅니다(예: '성공').
Message	message	string	작업 결과에 대한 설명입니다.
포함된 서명 세션	embeddedSigningSessions	array of object	포함된 서명 세션의 목록으로, 받는 사람당 하나씩. createEmbeddedSigningSession이 true인 경우에만 존재합니다.
서명자 전자 메일	embeddedSigningSessions.emailIdOfSigner	string	이 포함된 서명 세션에 대한 받는 사람의 전자 메일 주소입니다.
서명 토큰	embeddedSigningSessions.embeddedToken	string	이 받는 사람의 포함된 서명 세션에 대한 고유 토큰입니다.
서명 세션 URL	embeddedSigningSessions.embeddedSessionURL	string	이 받는 사람이 문서에 서명할 수 있도록 열거나 포함할 URL입니다.
포함된 전송 토큰	embeddedToken	string	포함된 송신 세션에 대한 토큰입니다. createEmbeddedSendingSession이 true인 경우에만 존재합니다.
세션 URL 보내기	embeddedSessionURL	string	봉투 작성자가 봉투를 준비하고 보낼 수 있도록 열거나 포함할 URL입니다. createEmbeddedSendingSession이 true인 경우에만 존재합니다.
아이디	folder.folderId	integer	만든 봉투의 고유 ID입니다. 이 값을 사용하여 후속 작업에서 봉투를 참조합니다.
이름	folder.folderName	string	봉투의 이름입니다.
사용자 지정 이름	folder.folderCustomName	string	봉투에 할당된 사용자 지정 이름입니다.
Password	folder.folderPassword	string	봉투에 설정된 암호(있는 경우)입니다.
작성자 ID	folder.folderAuthorId	integer	봉투를 만든 사용자의 고유 ID입니다.
작성자 이름	folder.folderAuthorFirstName	string	봉투 작성자의 이름입니다.
작성자 성	folder.folderAuthorLastName	string	봉투 작성자의 성입니다.
작성자 Email	folder.folderAuthorEmail	string	봉투 작성자의 전자 메일 주소입니다.
작성자 역할	folder.folderAuthorRole	string	봉투 작성자의 계정 역할입니다.
회사 ID	folder.folderCompanyId	integer	봉투가 속한 회사의 고유 ID입니다.
만든 날짜	folder.folderCreationDate	integer	봉투가 만들어진 날짜와 시간(Unix 밀리초)입니다.
보낸 날짜	folder.folderSentDate	integer	봉투를 받는 사람에게 보낸 날짜와 시간(Unix 밀리초)입니다.
Status	folder.folderStatus	string	봉투의 현재 상태(예: SHARED, EXECUTED, DRAFT, CANCELLED)입니다.
사용자 정의 필드 1	folder.custom_field1	string	봉투에 설정된 사용자 지정 필드 1의 값입니다.
사용자 정의 필드 2	folder.custom_field2	string	봉투에 설정된 사용자 지정 필드 2의 값입니다.
Metadata	folder.metadata	string	봉투와 연결된 모든 추가 메타데이터입니다.
문서 ID	folder.folderDocumentIds	array of integer	이 봉투에 포함된 문서 ID 목록입니다.
문서	folder.documentsList	array of object	봉투에 포함된 각 문서의 세부 정보입니다.
문서 ID	folder.documentsList.documentId	integer	문서의 고유 식별자입니다.
계약 ID	folder.documentsList.contractId	integer	이 문서와 연결된 계약의 고유 식별자입니다.
회사 ID	folder.documentsList.companyId	integer	이 문서가 속한 회사의 고유 ID입니다.
작성자	folder.documentsList.contractCreatedBy	integer	계약을 만든 사용자의 사용자 ID입니다.
생성 일자	folder.documentsList.contractCreatedOn	string	계약이 만들어진 날짜입니다.
계약 유형	folder.documentsList.contractType	string	계약의 형식입니다.
문서 상태	folder.documentsList.contractStatus	string	문서의 현재 서명 상태(예: WAITING_FOR_SIGNATURE, EXECUTED)입니다.
수정 가능	folder.documentsList.editable	boolean	문서를 편집할 수 있는지 여부를 나타냅니다.
버전 ID	folder.documentsList.contractVersionId	integer	현재 문서 버전의 고유 ID입니다.
버전 이름	folder.documentsList.contractVersionName	string	현재 문서 버전의 이름입니다.
버전 설명	folder.documentsList.contractVersionDesc	string	현재 문서 버전에 대한 설명입니다.
만든 버전	folder.documentsList.versionCreatedby	integer	이 문서 버전을 만든 사용자의 사용자 ID입니다.
만든 버전	folder.documentsList.versionCreatedOn	string	이 문서 버전을 만든 날짜입니다.
버전 번호	folder.documentsList.contractVersionNumber	integer	문서의 버전 번호입니다.
트랜잭션 원본	folder.documentsList.contractTransactionSource	string	계약 트랜잭션의 원본입니다.
받는 사람	folder.folderRecipientParties	array of object	개별 서명 링크를 포함하여 이 봉투의 받는 사람 목록입니다.
받는 사람 ID	folder.folderRecipientParties.partyId	integer	받는 사람의 고유 식별자입니다.
받는 사람 ID	folder.folderRecipientParties.partyDetails.partyId	integer	받는 사람의 고유 식별자입니다.
이름 (First Name)	folder.folderRecipientParties.partyDetails.firstName	string	받는 사람의 이름입니다.
성 이름	folder.folderRecipientParties.partyDetails.lastName	string	받는 사람의 성입니다.
전자 메일	folder.folderRecipientParties.partyDetails.emailId	string	받는 사람의 이메일 주소입니다.
자리 표시자	folder.folderRecipientParties.partyDetails.placeholder	boolean	이 받는 사람이 자리 표시자인지 여부를 나타냅니다.
Address	folder.folderRecipientParties.partyDetails.address	string	받는 사람의 주소입니다.
계정 생성 날짜	folder.folderRecipientParties.partyDetails.dateCreated	integer	받는 사람의 계정이 만들어진 날짜(Unix 밀리초)입니다.
전자 메일 옵트아웃	folder.folderRecipientParties.partyDetails.optOutEmails	boolean	받는 사람이 전자 메일 알림을 옵트아웃했는지 여부를 나타냅니다.
고유 파티 ID	folder.folderRecipientParties.partyDetails.uniquePartyId	string	받는 사람에 대한 고유 문자열 식별자입니다.
인증 수준	folder.folderRecipientParties.partyDetails.authenticationLevel	string	이 받는 사람에게 필요한 인증 수준입니다.
회사 ID	folder.folderRecipientParties.partyDetails.companyId	integer	받는 사람이 속한 회사의 ID입니다.
사용자 역할	folder.folderRecipientParties.partyDetails.userRole	string	조직 내에서 받는 사람의 역할입니다.
부서	folder.folderRecipientParties.partyDetails.department	string	받는 사람의 부서입니다.
Title	folder.folderRecipientParties.partyDetails.title	string	받는 사람의 직호입니다.
진행 중	folder.folderRecipientParties.partyDetails.active	boolean	받는 사람의 계정이 활성 상태인지 여부를 나타냅니다.
전화 걸기 코드	folder.folderRecipientParties.partyDetails.dialingCode	string	받는 사람의 전화 번호에 대한 국가 전화 걸기 코드입니다.
휴대폰 번호	folder.folderRecipientParties.partyDetails.mobileNumber	string	받는 사람의 휴대폰 번호입니다.
하도급자 설명	folder.folderRecipientParties.partyDetails.subcontractorDescription	string	해당하는 경우 하도급업체에 대한 설명입니다.
하도급업체 조직	folder.folderRecipientParties.partyDetails.subcontractorOrganization	string	해당하는 경우 하도급 업체의 조직 이름입니다.
하도급업체 추가 날짜	folder.folderRecipientParties.partyDetails.subcAddedDate	integer	하청업체가 추가된 날짜(Unix 밀리초)입니다.
Source	folder.folderRecipientParties.partyDetails.source	string	받는 사람이 추가된 원본입니다.
전화 걸기 코드	folder.folderRecipientParties.dialingCode	string	받는 사람의 휴대폰 번호에 대한 국가 전화 걸기 코드입니다.
휴대폰 번호	folder.folderRecipientParties.mobileNumber	string	받는 사람의 휴대폰 번호입니다.
서명 유형	folder.folderRecipientParties.signerSignatureType	string	이 받는 사람에게 허용되는 서명 유형입니다.
Permissions	folder.folderRecipientParties.contractPermissions	string	이 받는 사람에게 부여된 서명 권한(예: FILL_FIELDS_AND_SIGN)입니다.
서명 순서	folder.folderRecipientParties.partySequence	integer	서명 순서에서 이 받는 사람의 위치입니다.
워크플로 시퀀스	folder.folderRecipientParties.workflowSignSequence	integer	이 받는 사람의 워크플로 서명 시퀀스 번호입니다.
봉투 ID	folder.folderRecipientParties.envelopeId	integer	받는 사람이 속한 봉투의 ID입니다.
파티 회사 ID	folder.folderRecipientParties.partyCompanyId	integer	받는 사람이 속한 회사의 ID입니다.
공유 모드	folder.folderRecipientParties.sharingMode	string	이 받는 사람과 문서를 공유하는 데 사용되는 메서드(예: 전자 메일)입니다.
서명 URL	folder.folderRecipientParties.folderAccessURL	string	이 받는 사람에 대한 고유한 서명 URL입니다. 서명 링크를 직접 공유하려면 이 방법을 사용합니다.
보안 모드	folder.folderRecipientParties.securityMode	string	이 받는 사람의 액세스에 적용되는 보안 모드입니다.
추가 설명	folder.folderRecipientParties.extraComments	string	이 받는 사람에 대한 서명 초대에 포함된 추가 설명입니다.
이름 변경 허용	folder.folderRecipientParties.allowNameChange	boolean	서명하기 전에 받는 사람이 이름을 변경할 수 있는지 여부를 나타냅니다.
이름이 업데이트됨	folder.folderRecipientParties.signerNameUpdated	boolean	받는 사람이 표시 이름을 업데이트했는지 여부를 나타냅니다.
인증 수준	folder.folderRecipientParties.signerAuthenticationLevel	string	이 받는 사람이 문서에 액세스하는 데 필요한 인증 방법입니다.
액세스 코드	folder.folderRecipientParties.userDefinedAccessCode	string	이 받는 사람이 문서를 여는 데 필요한 사용자 지정 액세스 코드입니다.
서명 ID	folder.folderRecipientParties.signatureId	string	이 받는 사람이 사용하는 저장된 서명의 ID입니다.
받는 사람 역할	folder.folderRecipientParties.partyRole	string	봉투에서 이 받는 사람에게 할당된 역할입니다.
회사 필드 값	folder.folderRecipientParties.companyFieldValue	string	이 받는 사람에 대해 미리 채워진 회사 필드 값입니다.
제목 필드 값	folder.folderRecipientParties.titleFieldValue	string	이 받는 사람에 대해 미리 채워진 제목 필드 값입니다.
서명 이유	folder.folderRecipientParties.reasonSigning	string	이 받는 사람이 제공한 서명 이유입니다.
추가된 지불 필드	folder.folderRecipientParties.payFieldAdded	boolean	이 받는 사람에 대한 결제 필드가 추가되었는지 여부를 나타냅니다.
Payee인가요?	folder.folderRecipientParties.payee	boolean	이 수신자가 수취인인지 여부를 나타냅니다.
되풀이 필드가 있음	folder.folderRecipientParties.recurringFieldExist	boolean	이 받는 사람에 대한 되풀이 결제 필드가 있는지 여부를 나타냅니다.
인쇄 및 서명 완료	folder.folderRecipientParties.printAndSignCompleted	boolean	받는 사람이 인쇄 및 서명 작업을 완료했는지 여부를 나타냅니다.
선택적 서명자 허용	folder.folderRecipientParties.allowOptionalSigner	boolean	이 받는 사람을 선택적 서명자로 건너뛸 수 있는지 여부를 나타냅니다.
선택적 서명자	folder.folderRecipientParties.optionalSigners	string	이 받는 사람과 연결된 선택적 서명자 목록(있는 경우)입니다.
지불	folder.folderRecipientParties.paid	boolean	이 받는 사람이 결제를 완료했는지 여부를 나타냅니다.
작성자 액세스 URL	folder.folderAccessURLForAuthor	string	문서에 액세스할 봉투 작성자의 URL입니다.
초안 액세스 URL	folder.draftFolderAccessURL	string	봉투가 초안 상태인 동안 봉투에 액세스할 URL입니다.
보드룸 기호	folder.boardRoomSign	boolean	이 봉투에 대해 보드룸 서명을 사용할 수 있는지 여부를 나타냅니다.
로고 포함	folder.includeLogo	boolean	회사 로고가 이메일 알림에 포함되는지 여부를 나타냅니다.
전자 메일 단추 색	folder.email_btnBgColor	string	서명 전자 메일에 있는 작업 단추의 배경색입니다.
전자 메일 단추 텍스트 색	folder.email_btnTxtColor	string	서명 전자 메일에 있는 작업 단추의 텍스트 색입니다.
전자 메일 로고	folder.emailTemplateLogo	string	전자 메일 템플릿에 사용되는 로고 이미지입니다.
전자 메일 템플릿 ID	folder.emailTemplateId	integer	서명 알림에 사용되는 전자 메일 템플릿의 ID입니다.
전자 메일 헤더	folder.emailHeader	string	서명 알림 전자 메일의 사용자 지정 헤더 텍스트입니다.
전자 메일 바닥글	folder.emailFooter	string	서명 알림 전자 메일의 사용자 지정 바닥글 텍스트입니다.
예약된 제거	folder.purgeFlag	boolean	이 봉투가 자동 제거로 예약되었는지 여부를 나타냅니다.
시작 날짜 제거	folder.purgeStartDate	string	제거 기간이 시작되는 날짜입니다.
종료 날짜 제거	folder.purgeEndDate	string	봉투를 제거할 날짜입니다.
대량 ID	folder.bulkId	integer	이 봉투가 속한 대량 보내기 일괄 처리의 ID(있는 경우)입니다.
서명 순서 적용	folder.enforceSignWorkflow	boolean	받는 사람이 지정된 순서로 로그인해야 하는지 여부를 나타냅니다.
현재 워크플로 단계	folder.currentWorkflowStep	integer	서명 워크플로의 현재 단계입니다.
트랜잭션 원본	folder.transactionSource	string	이 봉투 트랜잭션을 시작한 소스입니다.
수정 가능	folder.editable	boolean	봉투를 계속 편집할 수 있는지 여부를 나타냅니다.
In-Person 서명	folder.inPersonSignable	boolean	봉투를 직접 로그인할 수 있는지 여부를 나타냅니다.
미리 알림 재정의	folder.overrideAccountReminders	boolean	이 봉투에 대해 계정 수준 미리 알림 설정이 재정의되는지 여부를 나타냅니다.
위임 재정의	folder.overrideAccountRecipientDelegation	boolean	이 봉투에 대해 계정 수준 위임 설정이 재정의되는지 여부를 나타냅니다.
위임 허용	folder.allowRecipientsToDelegate	boolean	받는 사람이 다른 사람에게 서명을 위임할 수 있는지 여부를 나타냅니다.
아이디	folder.envelopeId	integer	봉투의 고유 ID입니다. Envelope ID(folderId)와 동일한 값입니다.
이름	folder.envelopeName	string	봉투의 이름입니다. Envelope Name(folderName)과 동일한 값입니다.
발신기 ID	folder.envelopeOriginatorId	integer	봉투를 만든 사용자의 사용자 ID입니다.
회사 ID	folder.envelopeCompanyId	integer	봉투가 속한 회사의 ID입니다.
Date	folder.envelopeDate	integer	봉투가 만들어진 날짜와 시간(Unix 밀리초)입니다.
공유 날짜	folder.envelopeSharedDate	integer	봉투가 받는 사람과 공유된 날짜 및 시간(Unix 밀리초)입니다.
Status	folder.envelopeStatus	string	봉투의 현재 상태입니다. Envelope 상태(folderStatus)와 동일한 값입니다.
계약 ID	folder.envelopeContractIds	array of integer	이 봉투와 연결된 계약 ID 목록입니다.
파티 사용 권한	folder.envelopePartyPermissions	array of object	받는 사람 및 해당 서명 권한 목록입니다. 받는 사람과 동일한 구조입니다.
받는 사람 ID	folder.envelopePartyPermissions.partyId	integer	받는 사람의 고유 식별자입니다.
서명 URL	folder.envelopePartyPermissions.folderAccessURL	string	이 받는 사람에 대한 고유한 서명 URL입니다.
Permissions	folder.envelopePartyPermissions.contractPermissions	string	이 받는 사람에 대한 서명 권한입니다.
서명 순서	folder.envelopePartyPermissions.partySequence	integer	서명 순서에서 이 받는 사람의 위치입니다.
인증 수준	folder.envelopeAuthenticationLevel	string	전체 봉투에 적용되는 인증 수준입니다.
Single Signer 대량 허용	folder.allowSingleSignerInBulk	boolean	단일 서명자가 대량 송신 모드에서 허용되는지 여부를 나타냅니다.
파일 기반 이름	folder.folderNameBasedOnFileNaming	boolean	봉투 이름이 파일 이름에서 파생되는지 여부를 나타냅니다.
파일 기반 문서 이름	folder.documentNameBasedOnFileNaming	boolean	문서 이름이 파일 이름에서 파생되는지 여부를 나타냅니다.
파일 기반 인증서 이름	folder.certificateNameBasedOnFileNaming	boolean	인증서 이름이 파일 이름에서 파생되는지 여부를 나타냅니다.
파일 이름 지정 사용	folder.enableFileNamingBeforeExecution	boolean	봉투를 보내기 전에 파일 이름을 묻는 메시지가 표시되는지 여부를 나타냅니다.
추가된 수취인	folder.payeeAddedd	boolean	수신자가 봉투에 추가되었는지 여부를 나타냅니다.
셀프 서명자	folder.selfSignerEnabled	boolean	보낸 사람도 이 봉투의 서명자인지 여부를 나타냅니다.
공증 사용	folder.notaryEnabled	boolean	이 봉투에 대해 표기 표시를 사용할 수 있는지 여부를 나타냅니다.
제한된 표시 유형	folder.limitedVisibilityFlag	boolean	제한된 문서 표시 유형을 사용할 수 있는지 여부를 나타냅니다.
서명 후 표시 유형	folder.postSigningVisibility	boolean	완료 후 받는 사람이 서명된 문서를 볼 수 있는지 여부를 나타냅니다.
습식 서명 사용	folder.wetSignatureEnabled	boolean	이 봉투에 대해 젖은(필기) 서명을 사용할 수 있는지 여부를 나타냅니다.
병합 사용	folder.mergeEnabled	boolean	이 봉투에 대해 문서 병합을 사용할 수 있는지 여부를 나타냅니다.

웹후크 채널 세부 정보 가져오기

작업 ID:: GetWebhookChannelDetails

특정 웹후크 채널의 세부 정보를 검색합니다.

매개 변수

Name	키	필수	형식	Description
채널 ID	channelId	True	string	검색할 웹후크 채널의 고유 식별자입니다.

반품

Name	경로	형식	Description
Result	result	string	요청이 성공했는지 여부를 나타냅니다.
아이디	channel.channelId	integer	웹후크 채널의 고유 식별자입니다.
회사 ID	channel.companyId	integer	이 채널이 속한 회사 계정입니다.
이름	channel.channelName	string	웹후크 채널의 이름입니다.
웹후크 URL	channel.webhookUrl	string	구독된 이벤트가 발생할 때 Foxit eSign이 호출하는 URL입니다.
웹후크 비밀	channel.webhookSecret	string	웹후크 페이로드를 확인하는 데 사용되는 비밀 키입니다.
만든 날짜	channel.dateCreated	integer	채널이 만들어진 날짜(Unix 밀리초)입니다.
업데이트된 날짜	channel.dateUpdated	integer	채널이 마지막으로 업데이트된 날짜(Unix 밀리초)입니다.
웹후크 수준	channel.webhookLevel	string	웹후크 채널의 범위입니다. '계정'(모든 봉투에 대한 트리거) 또는 'API 앱'(API를 통해 만든 봉투에 대해서만 트리거).
Status	channel.status	string	채널의 현재 상태입니다. '활성' 또는 '비활성화'.
보낸 봉투	channel.eventsSubscribedMap.folder_sent	boolean	받는 사람에게 봉투를 보낼 때 트리거됩니다.
봉투가 표시됨	channel.eventsSubscribedMap.folder_viewed	boolean	받는 사람이 봉투를 열 때 트리거됩니다.
봉투 서명됨	channel.eventsSubscribedMap.folder_signed	boolean	받는 사람이 봉투에 서명할 때 트리거됩니다.
봉투 취소됨	channel.eventsSubscribedMap.folder_cancelled	boolean	봉투가 취소될 때 트리거됩니다.
봉투 실행됨	channel.eventsSubscribedMap.folder_executed	boolean	모든 당사자가 서명하고 봉투가 완전히 실행될 때 트리거됩니다.
봉투 삭제됨	channel.eventsSubscribedMap.folder_deleted	boolean	봉투가 삭제될 때 트리거됩니다.

웹후크 트리거 구독 취소

작업 ID:: DeleteTriggerWebhookChannel

활성 웹후크 채널 구독을 해당 채널 ID로 삭제합니다. 이 작업을 사용하여 더 이상 필요하지 않은 웹후크 구독을 정리합니다.

매개 변수

Name	키	필수	형식	Description
채널 ID	channelId	True	integer	삭제할 웹후크 채널의 ID입니다.

전자 메일 그룹 만들기

작업 ID:: CreateEmailGroup

한 번에 여러 받는 사람에게 봉투를 보내는 데 사용할 수 있는 새 전자 메일 그룹을 만듭니다.

매개 변수

Name	키	필수	형식	Description
그룹 이름	emailGroupName	True	string	새 전자 메일 그룹의 이름입니다.
그룹 설명	emailGroupDescription		string	전자 메일 그룹에 대한 선택적 설명입니다.
고급 전자 메일 유효성 검사 허용	allowAdvancedEmailValidation		boolean	사용하도록 설정하면 Foxit eSign은 보내기 전에 그룹의 모든 전자 메일 주소에 연결할 수 있는지 확인합니다.
이름 (First Name)	firstName	True	string	받는 사람의 이름입니다.
성 이름	lastName	True	string	받는 사람의 성입니다.
전자 메일	emailId	True	string	받는 사람의 전자 메일 주소입니다.

반품

Name	경로	형식	Description
Result	result	string	요청이 성공했는지 여부를 나타냅니다.
Message	message	string	수행된 작업에 대한 확인 메시지입니다.
그룹 아이디	emailGroup.groupId	integer	전자 메일 그룹의 고유 식별자입니다. 그룹에 봉투를 보낼 때 이 ID를 사용합니다.
그룹 이름	emailGroup.groupName	string	전자 메일 그룹의 이름입니다.
그룹 설명	emailGroup.groupDesc	string	전자 메일 그룹에 대한 설명입니다.
만든 날짜	emailGroup.dateCreated	integer	전자 메일 그룹을 만든 날짜(Unix 밀리초)입니다.
회사 ID	emailGroup.companyId	integer	이 전자 메일 그룹이 속한 회사 계정입니다.
Parties	emailGroup.parties	array of object	전자 메일 그룹의 받는 사람 목록입니다.
이름 (First Name)	emailGroup.parties.firstName	string	받는 사람의 이름입니다.
성 이름	emailGroup.parties.lastName	string	받는 사람의 성입니다.
전자 메일	emailGroup.parties.emailId	string	받는 사람의 전자 메일 주소입니다.

전자 메일 그룹 세부 정보 가져오기

작업 ID:: GetEmailGroupDetails

기존 전자 메일 그룹의 세부 정보를 검색합니다.

매개 변수

Name	키	필수	형식	Description
전자 메일 그룹 이름	emailGroupNames	True	array of string	그룹을 식별하는 데 사용되는 전자 메일 그룹 이름의 배열입니다.

반품

Name	경로	형식	Description
전자 메일 그룹	allEmailGroups	array of object	요청된 그룹 이름과 일치하는 전자 메일 그룹 목록입니다.
그룹 아이디	allEmailGroups.groupId	integer	전자 메일 그룹의 고유 식별자입니다.
그룹 이름	allEmailGroups.groupName	string	전자 메일 그룹의 이름입니다.
그룹 설명	allEmailGroups.groupDesc	string	전자 메일 그룹에 대한 설명입니다.
만든 날짜	allEmailGroups.dateCreated	integer	전자 메일 그룹을 만든 날짜(Unix 밀리초)입니다.
회사 ID	allEmailGroups.companyId	integer	이 전자 메일 그룹이 속한 회사 계정입니다.
Parties	allEmailGroups.parties	array of object	이 전자 메일 그룹의 받는 사람 목록입니다.
이름 (First Name)	allEmailGroups.parties.firstName	string	받는 사람의 이름입니다.
성 이름	allEmailGroups.parties.lastName	string	받는 사람의 성입니다.
전자 메일	allEmailGroups.parties.emailId	string	받는 사람의 전자 메일 주소입니다.

템플릿 ID로 템플릿 가져오기

작업 ID:: GetTemplatesbyTemplateIds

ID로 하나 이상의 템플릿에 대한 세부 정보를 검색합니다.

매개 변수

Name	키	필수	형식	Description
템플릿 ID	templateIds	True	array of integer	검색할 템플릿 ID의 배열입니다.

반품

Name	경로	형식	Description
Result	result	string	요청이 성공했는지 여부를 나타냅니다.
총 서식 파일	total_templates	integer	반환된 템플릿의 총 수입니다.
템플릿 목록	templateIdList	object	템플릿 ID로 키가 지정된 템플릿 데이터의 맵입니다. 각 항목에는 템플릿 세부 정보 및 해당 필드가 포함됩니다.

템플릿 세부 정보 가져오기

작업 ID:: GetTemplateDetails

해당 필드 및 받는 사람을 포함하여 특정 템플릿의 전체 세부 정보를 검색합니다.

매개 변수

Name	키	필수	형식	Description
템플릿 아이디	templateId	True	string	검색할 템플릿의 고유 식별자입니다.

반품

Name	경로	형식	Description
Result	result	string	요청이 성공했는지 여부를 나타냅니다.
아이디	template.templateId	integer	템플릿의 고유 식별자입니다.
이름	template.templateName	string	템플릿의 이름입니다.
Description	template.templateDesc	string	템플릿에 대한 설명입니다.
Type	template.templateType	string	템플릿의 형식입니다.
생성 날짜	template.templateCreationDate	integer	템플릿을 만든 날짜(Unix 밀리초)입니다.
마지막 업데이트 날짜	template.templateLastUpdateDate	integer	템플릿이 마지막으로 업데이트된 날짜(Unix 밀리초)입니다.
수정 가능	template.editable	boolean	템플릿을 편집할 수 있는지 여부를 나타냅니다.
파티 수	template.numberOfParties	integer	템플릿에 정의된 서명 당사자 수입니다.
총 페이지 수	template.totalPages	integer	서식 파일 문서의 총 페이지 수입니다.
회사 ID	template.companyId	integer	템플릿이 속한 회사 계정입니다.
모두와 공유	template.shareAll	boolean	템플릿이 계정의 모든 사용자와 공유되는지 여부를 나타냅니다.
사용자 지정 이름 패턴	template.templateCustomName	string	이 템플릿에서 만든 봉투에 적용되는 사용자 지정 이름 패턴입니다.
파티 사용 권한	template.templatePartyPermissions	array of object	이 템플릿에 정의된 받는 사람 역할 및 해당 서명 권한 목록입니다.
파티 ID	template.templatePartyPermissions.template_party_id	integer	이 템플릿 파티 항목의 고유 ID입니다.
아이디	template.templatePartyPermissions.templateId	integer	이 파티가 속한 템플릿의 ID입니다.
Permissions	template.templatePartyPermissions.templatePermissions	string	이 당사자에 대한 서명 권한(예: FILL_FIELDS_AND_SIGN)입니다.
서명 순서	template.templatePartyPermissions.partySequence	integer	이 파티의 서명 순서 위치입니다.
파티 역할	template.templatePartyPermissions.templatePartyRole	string	이 파티에 할당된 역할 이름입니다. 이 템플릿에서 봉투를 만들 때 이 값을 사용합니다.
파티 ID	template.templatePartyPermissions.partyId	integer	미리 할당된 경우 이 역할에 할당된 파티의 ID입니다.
파티 ID	template.templateCreatedBy.partyId	integer	사용자의 고유 식별자입니다.
이름 (First Name)	template.templateCreatedBy.firstName	string	사용자의 이름입니다.
성 이름	template.templateCreatedBy.lastName	string	사용자의 성입니다.
전자 메일	template.templateCreatedBy.emailId	string	사용자의 전자 메일 주소입니다.
부서	template.templateCreatedBy.department	string	사용자의 부서입니다.
Title	template.templateCreatedBy.title	string	사용자의 직위입니다.
진행 중	template.templateCreatedBy.active	boolean	사용자 계정이 활성 상태인지 여부를 나타냅니다.
파티 ID	template.templateLastUpdatedBy.partyId	integer	사용자의 고유 식별자입니다.
이름 (First Name)	template.templateLastUpdatedBy.firstName	string	사용자의 이름입니다.
성 이름	template.templateLastUpdatedBy.lastName	string	사용자의 성입니다.
전자 메일	template.templateLastUpdatedBy.emailId	string	사용자의 전자 메일 주소입니다.
부서	template.templateLastUpdatedBy.department	string	사용자의 부서입니다.
Title	template.templateLastUpdatedBy.title	string	사용자의 직위입니다.
진행 중	template.templateLastUpdatedBy.active	boolean	사용자 계정이 활성 상태인지 여부를 나타냅니다.
모든 필드	allfields	array of object	이 템플릿에 정의된 모든 필드 목록입니다.
필드 태그 ID	allfields.fieldTagId	integer	필드의 고유 식별자입니다.
템플릿 아이디	allfields.templateId	integer	이 필드가 속한 템플릿의 ID입니다.
회사 ID	allfields.companyId	integer	이 필드가 속한 회사 계정입니다.
필드 유형	allfields.fieldType	string	필드의 형식(예: signfield, initialfield, textfield, datefield, checkboxfield, securedfield, attachmentfield)입니다.
페이지 번호	allfields.documentPageNumber	integer	이 필드가 배치된 문서의 페이지 번호입니다.
당사자 책임	allfields.partyResponsible	integer	이 필드를 완료하는 파티 시퀀스 번호입니다.
파티 시퀀스	allfields.partyResponsibleSequence	integer	책임 당사자의 시퀀스 위치입니다.
Doc 필드 ID	allfields.docFieldId	string	문서 내에서 이 필드의 식별자입니다.
종속	allfields.dependent	boolean	이 필드의 표시 유형이 다른 필드의 값에 따라 달라지는지 여부를 나타냅니다.
탭 순서	allfields.tabOrder	integer	필드 간 탐색을 위한 탭 순서입니다.
필수	allfields.required	boolean	문서에 서명하기 전에 이 필드를 완료해야 하는지 여부를 나타냅니다.
사용자 지정 필드 이름	allfields.customFieldName	string	이 필드에 할당된 사용자 지정 이름입니다.
모두 공유	allfields.shareAll	boolean	이 필드가 모든 사용자와 공유되는지 여부를 나타냅니다.
편집 허용	allfields.allowEdit	boolean	받는 사람이 이 필드를 편집할 수 있는지 여부를 나타냅니다.
텍스트 필드 이름	allfields.textfieldName	string	텍스트 필드의 레이블입니다(fieldType이 'textfield'인 경우 적용 가능).
가치	allfields.value	string	필드의 미리 채워지거나 입력한 값입니다.
글꼴 크기	allfields.fontSize	integer	이 필드의 텍스트에 사용되는 글꼴 크기입니다.
글꼴 색	allfields.fontColor	string	이 필드의 텍스트에 사용되는 글꼴 색(예: #000000)입니다.
읽기 전용	allfields.readOnly	boolean	필드가 읽기 전용이고 받는 사람이 편집할 수 없는지 여부를 나타냅니다.
여러 줄	allfields.multiLine	boolean	텍스트 필드가 여러 줄의 입력을 허용하는지 여부를 나타냅니다(fieldType이 'textfield'인 경우 적용 가능).
문자 제한	allfields.characterLimit	integer	필드에 허용되는 최대 문자 수입니다(fieldType이 'textfield'인 경우 적용 가능).
날짜 필드 이름	allfields.datefieldName	string	날짜 필드의 레이블입니다(fieldType이 'datefield'인 경우 적용 가능).
날짜 형식	allfields.dateFormat	string	이 필드에 사용되는 날짜 형식(예: MM/DD/YYYY)입니다(fieldType이 'datefield'인 경우 적용 가능).
확인란 이름	allfields.cbname	string	확인란 필드의 레이블입니다(fieldType이 'checkboxfield'인 경우 적용 가능).
확인란 그룹	allfields.cbgroup	string	여러 확인란을 연결할 때 사용되는 이 확인란의 그룹 이름입니다(fieldType이 'checkboxfield'인 경우 적용 가능).
체크됨	allfields.checked	boolean	확인란이 기본적으로 선택되어 있는지 여부를 나타냅니다(fieldType이 'checkboxfield'인 경우 적용 가능).
보안 필드 이름	allfields.securedfieldName	string	보안 필드의 레이블입니다(fieldType이 'securedfield'인 경우 적용 가능).
표시할 문자	allfields.charToDisplay	integer	보안 필드 값의 끝에 표시할 마스크되지 않은 문자 수입니다(fieldType이 'securedfield'인 경우 적용 가능).
서명 ID	allfields.signatureId	string	이 기호 필드에 적용된 서명의 ID입니다(fieldType이 'signfield'인 경우 적용 가능).
초기 이미지	allfields.initialImage	string	이 필드에 적용된 이니셜의 이미지 데이터입니다(fieldType이 'initialfield'인 경우 적용 가능).
첨부 파일 필드 이름	allfields.attachmentfieldName	string	첨부 파일 필드의 이름입니다(fieldType이 'attachmentfield'인 경우 적용 가능).
첨부 파일 설명	allfields.attachmentfieldDescription	string	연결할 항목에 대한 설명입니다(fieldType이 'attachmentfield'인 경우 적용 가능).

트리거

봉투가 삭제되는 경우	봉투가 삭제될 때 트리거됩니다.
봉투가 서명된 경우	받는 사람이 봉투에 서명할 때 트리거됩니다.
봉투가 완전히 실행되는 경우	모든 받는 사람이 서명하고 봉투가 완전히 실행될 때 트리거됩니다.
봉투가 전송되는 경우	받는 사람에게 봉투를 보낼 때 트리거됩니다. 이 이벤트는 웹후크 수준이 '계정'으로 설정된 경우에만 발생합니다.
봉투가 취소된 경우	받는 사람 또는 보낸 사람이 봉투를 취소할 때 트리거됩니다.
봉투를 볼 때	받는 사람이 열리고 봉투를 볼 때 트리거됩니다.

봉투가 삭제되는 경우

작업 ID:: TriggerEnvelopeDeleted

봉투가 삭제될 때 트리거됩니다.

매개 변수

Name	키	필수	형식	Description
채널 이름	channelName	True	string	계정에서 이 웹후크 구독을 식별하는 이름입니다.
웹후크 수준	webhookLevel	True	string	계정: 모든 봉투(웹 및 API)에 대해 발생합니다. API 앱: API를 통해 만든 봉투에 대해서만 발생합니다.
웹후크 비밀	webhookSecret		string	Optional. Foxit eSign은 확인을 위해 이 비밀을 사용하여 HMAC-SHA-256으로 각 웹후크 페이로드에 서명합니다.

반품

웹후크 이벤트가 발생할 때 Foxit eSign에서 받은 이벤트 데이터입니다.

WebhookEventPayload: WebhookEventPayload

봉투가 서명된 경우

작업 ID:: TriggerEnvelopeSigned

받는 사람이 봉투에 서명할 때 트리거됩니다.

매개 변수

Name	키	필수	형식	Description
채널 이름	channelName	True	string	계정에서 이 웹후크 구독을 식별하는 이름입니다.
웹후크 수준	webhookLevel	True	string	계정: 모든 봉투(웹 및 API)에 대해 발생합니다. API 앱: API를 통해 만든 봉투에 대해서만 발생합니다.
웹후크 비밀	webhookSecret		string	Optional. Foxit eSign은 확인을 위해 이 비밀을 사용하여 HMAC-SHA-256으로 각 웹후크 페이로드에 서명합니다.

반품

웹후크 이벤트가 발생할 때 Foxit eSign에서 받은 이벤트 데이터입니다.

WebhookEventPayload: WebhookEventPayload

봉투가 완전히 실행되는 경우

작업 ID:: TriggerEnvelopeExecuted

모든 받는 사람이 서명하고 봉투가 완전히 실행될 때 트리거됩니다.

매개 변수

Name	키	필수	형식	Description
채널 이름	channelName	True	string	계정에서 이 웹후크 구독을 식별하는 이름입니다.
웹후크 수준	webhookLevel	True	string	계정: 모든 봉투(웹 및 API)에 대해 발생합니다. API 앱: API를 통해 만든 봉투에 대해서만 발생합니다.
웹후크 비밀	webhookSecret		string	Optional. Foxit eSign은 확인을 위해 이 비밀을 사용하여 HMAC-SHA-256으로 각 웹후크 페이로드에 서명합니다.

반품

웹후크 이벤트가 발생할 때 Foxit eSign에서 받은 이벤트 데이터입니다.

WebhookEventPayload: WebhookEventPayload

봉투가 전송되는 경우

작업 ID:: TriggerEnvelopeSent

받는 사람에게 봉투를 보낼 때 트리거됩니다. 이 이벤트는 웹후크 수준이 '계정'으로 설정된 경우에만 발생합니다.

매개 변수

Name	키	필수	형식	Description
채널 이름	channelName	True	string	계정에서 이 웹후크 구독을 식별하는 이름입니다.
웹후크 수준	webhookLevel	True	string	계정: 웹 또는 API를 통해 보낸 봉투에 대해 발생합니다. API 앱: API를 통해 만든 봉투에 대해서만 발생합니다. folder_sent 이벤트는 계정 수준에서만 발생합니다.
웹후크 비밀	webhookSecret		string	Optional. Foxit eSign은 확인을 위해 이 비밀을 사용하여 HMAC-SHA-256으로 각 웹후크 페이로드에 서명합니다.

반품

웹후크 이벤트가 발생할 때 Foxit eSign에서 받은 이벤트 데이터입니다.

WebhookEventPayload: WebhookEventPayload

봉투가 취소된 경우

작업 ID:: TriggerEnvelopeCancelled

받는 사람 또는 보낸 사람이 봉투를 취소할 때 트리거됩니다.

매개 변수

Name	키	필수	형식	Description
채널 이름	channelName	True	string	계정에서 이 웹후크 구독을 식별하는 이름입니다.
웹후크 수준	webhookLevel	True	string	계정: 모든 봉투(웹 및 API)에 대해 발생합니다. API 앱: API를 통해 만든 봉투에 대해서만 발생합니다.
웹후크 비밀	webhookSecret		string	Optional. Foxit eSign은 확인을 위해 이 비밀을 사용하여 HMAC-SHA-256으로 각 웹후크 페이로드에 서명합니다.

반품

웹후크 이벤트가 발생할 때 Foxit eSign에서 받은 이벤트 데이터입니다.

WebhookEventPayload: WebhookEventPayload

봉투를 볼 때

작업 ID:: TriggerEnvelopeViewed

받는 사람이 열리고 봉투를 볼 때 트리거됩니다.

매개 변수

Name	키	필수	형식	Description
채널 이름	channelName	True	string	계정에서 이 웹후크 구독을 식별하는 이름입니다.
웹후크 수준	webhookLevel	True	string	계정: 모든 봉투(웹 및 API)에 대해 발생합니다. API 앱: API를 통해 만든 봉투에 대해서만 발생합니다.
웹후크 비밀	webhookSecret		string	Optional. Foxit eSign은 확인을 위해 이 비밀을 사용하여 HMAC-SHA-256으로 각 웹후크 페이로드에 서명합니다.

반품

웹후크 이벤트가 발생할 때 Foxit eSign에서 받은 이벤트 데이터입니다.

WebhookEventPayload: WebhookEventPayload

정의

WebhookEventPayload

웹후크 이벤트가 발생할 때 Foxit eSign에서 받은 이벤트 데이터입니다.

Name	경로	형식	Description
이벤트 이름	event_name	string	발생한 이벤트의 이름입니다(예: folder_sent, folder_signed, folder_executed).
이벤트 날짜	event_date	integer	이벤트가 발생한 날짜 및 시간(Unix 타임스탬프(밀리초)입니다.
아이디	data.folder.folderId	integer	봉투의 고유 ID입니다.
이름	data.folder.folderName	string	봉투의 이름입니다.
사용자 지정 이름	data.folder.folderCustomName	string	봉투에 할당된 사용자 지정 이름입니다.
Password	data.folder.folderPassword	string	봉투에 대한 액세스 암호(설정된 경우)입니다.
작성자 ID	data.folder.folderAuthorId	integer	봉투 작성자의 사용자 ID입니다.
작성자 이름	data.folder.folderAuthorFirstName	string	봉투 작성자의 이름입니다.
작성자 성	data.folder.folderAuthorLastName	string	봉투 작성자의 성입니다.
작성자 전자 메일	data.folder.folderAuthorEmail	string	봉투 작성자의 전자 메일 주소입니다.
작성자 역할	data.folder.folderAuthorRole	string	봉투 작성자의 계정 역할입니다.
회사 ID	data.folder.folderCompanyId	integer	봉투를 소유하는 회사 ID입니다.
생성 날짜	data.folder.folderCreationDate	integer	봉투가 만들어진 날짜(Unix 타임스탬프(밀리초)입니다.
보낸 날짜	data.folder.folderSentDate	integer	봉투가 전송된 날짜(Unix 타임스탬프(밀리초)입니다.
Status	data.folder.folderStatus	string	봉투의 현재 상태입니다.
사용자 정의 필드 1	data.folder.custom_field1	string	첫 번째 사용자 지정 메타데이터 필드입니다.
사용자 정의 필드 2	data.folder.custom_field2	string	두 번째 사용자 지정 메타데이터 필드입니다.
Metadata	data.folder.metadata	string	봉투와 연결된 사용자 지정 메타데이터입니다.
문서 ID	data.folder.folderDocumentIds	array of integer	봉투에 있는 문서 ID 목록입니다.
문서	data.folder.documentsList	array of object	봉투에 있는 문서 목록입니다.
문서 ID	data.folder.documentsList.documentId	integer	문서의 고유 식별자입니다.
계약 ID	data.folder.documentsList.contractId	integer	이 문서의 계약 ID입니다.
회사 ID	data.folder.documentsList.companyId	integer	이 문서의 회사 ID입니다.
작성자	data.folder.documentsList.contractCreatedBy	integer	계약을 만든 사용자의 사용자 ID입니다.
생성 일자	data.folder.documentsList.contractCreatedOn	integer	계약이 만들어진 날짜(Unix 타임스탬프(밀리초)입니다.
계약 유형	data.folder.documentsList.contractType	string	계약의 형식입니다.
계약 상태	data.folder.documentsList.contractStatus	string	계약의 현재 상태입니다.
수정 가능	data.folder.documentsList.editable	boolean	문서를 편집할 수 있는지 여부를 나타냅니다.
버전 ID	data.folder.documentsList.contractVersionId	integer	계약의 버전 ID입니다.
버전 이름	data.folder.documentsList.contractVersionName	string	계약 버전의 이름입니다.
버전 설명	data.folder.documentsList.contractVersionDesc	string	계약 버전에 대한 설명입니다.
만든 버전	data.folder.documentsList.versionCreatedby	integer	이 버전을 만든 사용자의 사용자 ID입니다.
만든 버전	data.folder.documentsList.versionCreatedOn	integer	이 버전을 만든 날짜(Unix 타임스탬프(밀리초)입니다.
버전 번호	data.folder.documentsList.contractVersionNumber	integer	계약의 버전 번호입니다.
트랜잭션 원본	data.folder.documentsList.contractTransactionSource	string	계약을 시작한 원본 시스템입니다.
받는 사람	data.folder.folderRecipientParties	array of object	이 봉투의 받는 사람 목록입니다.
받는 사람 ID	data.folder.folderRecipientParties.partyId	integer	받는 사람의 고유 식별자입니다.
받는 사람 ID	data.folder.folderRecipientParties.partyDetails.partyId	integer	받는 사람의 고유 ID입니다.
이름 (First Name)	data.folder.folderRecipientParties.partyDetails.firstName	string	받는 사람의 이름입니다.
성 이름	data.folder.folderRecipientParties.partyDetails.lastName	string	받는 사람의 성입니다.
전자 메일	data.folder.folderRecipientParties.partyDetails.emailId	string	받는 사람의 이메일 주소입니다.
Placeholder	data.folder.folderRecipientParties.partyDetails.placeholder	boolean	자리 표시자 수신자인지 여부입니다.
Address	data.folder.folderRecipientParties.partyDetails.address	string	받는 사람의 주소입니다.
만든 날짜	data.folder.folderRecipientParties.partyDetails.dateCreated	integer	받는 사람 레코드가 만들어진 날짜(Unix 타임스탬프(밀리초)입니다.
전자 메일 옵트아웃	data.folder.folderRecipientParties.partyDetails.optOutEmails	boolean	받는 사람이 전자 메일을 옵트아웃했는지 여부입니다.
고유 ID	data.folder.folderRecipientParties.partyDetails.uniquePartyId	string	이 받는 사람에 대한 고유한 시스템 식별자입니다.
인증 수준	data.folder.folderRecipientParties.partyDetails.authenticationLevel	string	이 받는 사람에 대한 인증 방법입니다.
암호 업데이트 날짜	data.folder.folderRecipientParties.partyDetails.passwordUpdateDate	string	암호가 마지막으로 업데이트된 날짜입니다.
암호 상태	data.folder.folderRecipientParties.partyDetails.passwordUpdateStatus	boolean	암호가 업데이트되었는지 여부입니다.
전화 걸기 코드	data.folder.folderRecipientParties.dialingCode	string	국제 전화 걸기 코드입니다.
Mobile	data.folder.folderRecipientParties.mobileNumber	string	받는 사람의 휴대폰 번호입니다.
서명 유형	data.folder.folderRecipientParties.signerSignatureType	string	서명자가 사용할 서명의 형식입니다.
Permissions	data.folder.folderRecipientParties.contractPermissions	string	이 받는 사람에게 부여된 권한입니다.
서명 순서	data.folder.folderRecipientParties.partySequence	integer	이 받는 사람의 서명 순서입니다.
워크플로 시퀀스	data.folder.folderRecipientParties.workflowSignSequence	integer	워크플로 서명 시퀀스 번호입니다.
봉투 ID	data.folder.folderRecipientParties.envelopeId	integer	이 받는 사람과 연결된 봉투 ID입니다.
받는 사람 회사 ID	data.folder.folderRecipientParties.partyCompanyId	integer	이 받는 사람의 회사 ID입니다.
공유 모드	data.folder.folderRecipientParties.sharingMode	string	이 받는 사람에 대한 공유 모드입니다.
받는 사람 서명 URL	data.folder.folderRecipientParties.folderAccessURL	string	이 받는 사람이 봉투에 액세스하고 서명할 URL입니다.
보안 모드	data.folder.folderRecipientParties.securityMode	string	이 받는 사람에 대한 보안 모드입니다.
코멘트	data.folder.folderRecipientParties.extraComments	string	받는 사람에 대한 추가 설명입니다.
이름 변경 허용	data.folder.folderRecipientParties.allowNameChange	boolean	받는 사람이 이름을 업데이트할 수 있는지 여부입니다.
이름이 업데이트됨	data.folder.folderRecipientParties.signerNameUpdated	boolean	서명자가 이름을 업데이트했는지 여부입니다.
서명자 인증 수준	data.folder.folderRecipientParties.signerAuthenticationLevel	string	서명자에 필요한 인증 수준입니다.
액세스 코드	data.folder.folderRecipientParties.userDefinedAccessCode	string	서명자에 대한 사용자 지정 액세스 코드입니다.
서명 ID	data.folder.folderRecipientParties.signatureId	string	적용된 서명의 ID입니다.
역할	data.folder.folderRecipientParties.partyRole	string	서명 워크플로에서 이 받는 사람의 역할입니다.
회사 필드	data.folder.folderRecipientParties.companyFieldValue	string	회사 이름 필드 값입니다.
제목 필드	data.folder.folderRecipientParties.titleFieldValue	string	제목 필드 값입니다.
서명 이유	data.folder.folderRecipientParties.reasonSigning	string	서명에 지정된 이유입니다.
결제 필드가 추가됨	data.folder.folderRecipientParties.payFieldAdded	boolean	결제 필드가 추가되었는지 여부입니다.
수취인	data.folder.folderRecipientParties.payee	boolean	이 수신자가 수취인인지 여부입니다.
되풀이 결제	data.folder.folderRecipientParties.recurringFieldExist	boolean	되풀이 결제 필드가 있는지 여부입니다.
인쇄 및 서명 완료	data.folder.folderRecipientParties.printAndSignCompleted	boolean	인쇄 및 서명이 완료되었는지 여부입니다.
선택적 서명자	data.folder.folderRecipientParties.allowOptionalSigner	boolean	이 받는 사람이 선택적 서명자인지 여부입니다.
선택적 서명자	data.folder.folderRecipientParties.optionalSigners	array of integer	선택적 서명자 파티 ID입니다.
지불	data.folder.folderRecipientParties.paid	boolean	결제가 완료되었는지 여부입니다.
작성자 액세스 URL	data.folder.folderAccessURLForAuthor	string	봉투 작성자가 봉투에 액세스할 URL입니다.
초안 액세스 URL	data.folder.draftFolderAccessURL	string	초안 상태의 봉투에 액세스할 URL입니다.
회의실 서명	data.folder.boardRoomSign	boolean	회의실 서명 모드를 사용할 수 있는지 여부입니다.
로고 포함	data.folder.includeLogo	boolean	회사 로고가 전자 메일에 포함되는지 여부입니다.
단추 배경색	data.folder.email_btnBgColor	string	전자 메일 작업 단추의 배경색입니다.
단추 텍스트 색	data.folder.email_btnTxtColor	string	전자 메일 작업 단추의 텍스트 색입니다.
전자 메일 로고	data.folder.emailTemplateLogo	string	전자 메일 템플릿에 사용되는 로고 URL입니다.
전자 메일 템플릿 ID	data.folder.emailTemplateId	integer	사용된 전자 메일 템플릿의 ID입니다.
전자 메일 헤더	data.folder.emailHeader	string	알림 전자 메일의 헤더 텍스트입니다.
전자 메일 바닥글	data.folder.emailFooter	string	알림 전자 메일의 바닥글 텍스트입니다.
예약된 제거	data.folder.purgeFlag	boolean	봉투가 제거될 예정인지 여부입니다.
시작 날짜 제거	data.folder.purgeStartDate	string	제거 일정의 시작 날짜입니다.
종료 날짜 제거	data.folder.purgeEndDate	string	제거 일정의 종료 날짜입니다.
대량 ID	data.folder.bulkId	integer	해당하는 경우 대량 보내기 작업 ID입니다.
서명 순서 적용	data.folder.enforceSignWorkflow	boolean	받는 사람이 정의된 순서로 로그인해야 하는지 여부입니다.
현재 워크플로 단계	data.folder.currentWorkflowStep	integer	서명 워크플로의 현재 단계입니다.
트랜잭션 원본	data.folder.transactionSource	string	이 트랜잭션을 시작한 원본 시스템입니다.
수정 가능	data.folder.editable	boolean	봉투를 편집할 수 있는지 여부입니다.
In-Person 서명	data.folder.inPersonSignable	boolean	봉투가 직접 서명을 지원하는지 여부입니다.
미리 알림 재정의	data.folder.overrideAccountReminders	boolean	계정 수준 미리 알림 설정이 재정의되는지 여부입니다.
위임 재정의	data.folder.overrideAccountRecipientDelegation	boolean	계정 수준 위임 설정이 재정의되는지 여부입니다.
위임 허용	data.folder.allowRecipientsToDelegate	boolean	받는 사람이 서명을 위임할 수 있는지 여부입니다.
아이디	data.folder.envelopeId	integer	고유한 봉투 ID(folderId의 별칭)입니다.
이름	data.folder.envelopeName	string	봉투 이름(folderName의 별칭)입니다.
발신기 ID	data.folder.envelopeOriginatorId	integer	봉투를 시작한 사용자 ID입니다.
회사 ID	data.folder.envelopeCompanyId	integer	봉투를 소유하는 회사 ID입니다.
Date	data.folder.envelopeDate	integer	봉투가 만들어진 날짜(Unix 타임스탬프(밀리초)입니다.
공유 날짜	data.folder.envelopeSharedDate	integer	봉투가 공유된 날짜(Unix 타임스탬프(밀리초)입니다.
Status	data.folder.envelopeStatus	string	봉투의 현재 상태입니다.
계약 ID	data.folder.envelopeContractIds	array of integer	이 봉투와 연결된 계약 ID입니다.
파티 사용 권한	data.folder.envelopePartyPermissions	array of object	받는 사람 권한 목록(받는 사람과 동일한 구조)입니다.
받는 사람 ID	data.folder.envelopePartyPermissions.partyId	integer	받는 사람의 고유 식별자입니다.
받는 사람 ID	data.folder.envelopePartyPermissions.partyDetails.partyId	integer
이름 (First Name)	data.folder.envelopePartyPermissions.partyDetails.firstName	string
성 이름	data.folder.envelopePartyPermissions.partyDetails.lastName	string
전자 메일	data.folder.envelopePartyPermissions.partyDetails.emailId	string
Placeholder	data.folder.envelopePartyPermissions.partyDetails.placeholder	boolean
Address	data.folder.envelopePartyPermissions.partyDetails.address	string
만든 날짜	data.folder.envelopePartyPermissions.partyDetails.dateCreated	integer
전자 메일 옵트아웃	data.folder.envelopePartyPermissions.partyDetails.optOutEmails	boolean
고유 ID	data.folder.envelopePartyPermissions.partyDetails.uniquePartyId	string
인증 수준	data.folder.envelopePartyPermissions.partyDetails.authenticationLevel	string
암호 업데이트 날짜	data.folder.envelopePartyPermissions.partyDetails.passwordUpdateDate	string
암호 상태	data.folder.envelopePartyPermissions.partyDetails.passwordUpdateStatus	boolean
전화 걸기 코드	data.folder.envelopePartyPermissions.dialingCode	string
Mobile	data.folder.envelopePartyPermissions.mobileNumber	string
서명 유형	data.folder.envelopePartyPermissions.signerSignatureType	string
Permissions	data.folder.envelopePartyPermissions.contractPermissions	string
서명 순서	data.folder.envelopePartyPermissions.partySequence	integer
워크플로 시퀀스	data.folder.envelopePartyPermissions.workflowSignSequence	integer
봉투 ID	data.folder.envelopePartyPermissions.envelopeId	integer
받는 사람 회사 ID	data.folder.envelopePartyPermissions.partyCompanyId	integer
공유 모드	data.folder.envelopePartyPermissions.sharingMode	string
받는 사람 서명 URL	data.folder.envelopePartyPermissions.folderAccessURL	string
보안 모드	data.folder.envelopePartyPermissions.securityMode	string
코멘트	data.folder.envelopePartyPermissions.extraComments	string
이름 변경 허용	data.folder.envelopePartyPermissions.allowNameChange	boolean
이름이 업데이트됨	data.folder.envelopePartyPermissions.signerNameUpdated	boolean
서명자 인증 수준	data.folder.envelopePartyPermissions.signerAuthenticationLevel	string
액세스 코드	data.folder.envelopePartyPermissions.userDefinedAccessCode	string
서명 ID	data.folder.envelopePartyPermissions.signatureId	string
역할	data.folder.envelopePartyPermissions.partyRole	string
회사 필드	data.folder.envelopePartyPermissions.companyFieldValue	string
제목 필드	data.folder.envelopePartyPermissions.titleFieldValue	string
서명 이유	data.folder.envelopePartyPermissions.reasonSigning	string
결제 필드가 추가됨	data.folder.envelopePartyPermissions.payFieldAdded	boolean
수취인	data.folder.envelopePartyPermissions.payee	boolean
되풀이 결제	data.folder.envelopePartyPermissions.recurringFieldExist	boolean
인쇄 및 서명 완료	data.folder.envelopePartyPermissions.printAndSignCompleted	boolean
선택적 서명자	data.folder.envelopePartyPermissions.allowOptionalSigner	boolean
선택적 서명자	data.folder.envelopePartyPermissions.optionalSigners	array of integer
지불	data.folder.envelopePartyPermissions.paid	boolean
인증 수준	data.folder.envelopeAuthenticationLevel	string	봉투에 필요한 인증 수준입니다.
Single Signer Bulk	data.folder.allowSingleSignerInBulk	boolean	단일 서명자가 대량 모드에서 허용되는지 여부입니다.
File-Based 폴더 이름	data.folder.folderNameBasedOnFileNaming	boolean
File-Based 문서 이름	data.folder.documentNameBasedOnFileNaming	boolean
File-Based 인증서 이름	data.folder.certificateNameBasedOnFileNaming	boolean
Pre-Exec 파일 이름 지정	data.folder.enableFileNamingBeforeExecution	boolean
추가된 수취인	data.folder.payeeAddedd	boolean
Self-Signing 사용	data.folder.selfSignerEnabled	boolean
공증 사용	data.folder.notaryEnabled	boolean
제한된 표시 유형	data.folder.limitedVisibilityFlag	boolean
사후 서명 표시 유형	data.folder.postSigningVisibility	boolean
젖은 서명	data.folder.wetSignatureEnabled	boolean
병합 사용	data.folder.mergeEnabled	boolean

binary

이것은 기본 데이터 유형인 '바이너리'입니다.