봉투 상세 정보 조회

GET /esignglobal/v1/envelope/envelopeDetail

인터페이스 설명

서명 진행률, 봉투 상태 등 봉투에 대한 자세한 정보를 쿼리합니다.

요청 매개변수

매개변수 이름	유형	필수	설명
envelopeId	string	true	봉투 ID

요청 예시

GET https://……/esignglobal/v1/envelope/envelopeDetail?envelopeId=flow1234567890

응답 매개변수

매개변수 이름				유형	설명
envelopeId				string	봉투 ID
envelopeStatus				int	봉투 상태 0-생성됨(초안) 1-서명 중 2-완료됨 3-만료됨 4-거부됨 5-취소됨
envelopeEndTime				timestamp	봉투 종료 시간
envelopeCreateTime				timestamp	봉투 시작 시간
subject				string	봉투 제목
remark				string	봉투 메모(길이 1000)
redirectUrl				string	서명 완료 리디렉션 주소(길이 500)
CCInfos				array	참조인 정보 모음
	userEmail			string	참조인 이메일 주소
	userName			string	참조인 이름
initiatorInfo				object	발신인 정보 모음
	userName			string	발신인 이름, 기본적으로 개방형 애플리케이션 APPID 소유 생성자 이름
signFiles				array	서명 파일 정보 모음
	fileKey			string	서명 파일 fileKey
attachments				array	봉투 첨부 파일 모음
	fileKey			string	봉투 fileKey
signerInfos				array	서명자 정보
	businessId			string	개발자 정의 비즈니스 번호 (길이 500)
	userName			string	서명자 이름
	userEmail			string	서명자 이메일 주소
	phoneNumber			object	서명자가 SMS를 수신할 주소
		countryCode		string	국가/지역의 국제 코드
		number		string	서명자가 서명 메시지를 수신할 휴대폰 번호
	signOrder			int	서명자의 서명 순서, 최소 1.
	digitalSignature			boolean	디지털 서명을 활성화할지 여부, 기본값은 false true-활성화, false-비활성화
	authConfig			object	인증 방식
		accessCode		object	액세스 암호
			accessCode	string	액세스 암호
			promptInfo	string	액세스 암호 힌트 정보
		sms		object	SMS OTP 인증
			countryCode	string	국가/지역 국제 코드
			number	string	신원 인증 휴대폰 번호
		idVerification		object	신원 확인
			name	string	서명인 신분증의 전체 이름
		emailAuth		object	이메일 OTP 인증
			authEmail	string	서명인 신원 확인 이메일 주소
		digitalId		object	전자 신원 확인
			authApp	string	전자 신원 확인에 사용되는 앱
			idNumber	string	서명인이 확인해야 할 신분증 번호
		whatsappAuth		object	WhatsApp OTP 인증
			countryCode	string	국가 지역 국제 코드
			number	string	신원 인증 휴대폰 번호
	signerStatus			int	서명자 상태 0-서명 대기 1-서명 중 2-서명 완료
	signDate			timestamp	서명 시간
	declinedReason			string	거절 사유, envelopeStatus가 거절됨으로 표시될 때 표시됩니다.
canceledReason				string	취소 사유, envelopeStatus가 취소됨으로 표시될 때 표시됩니다.

응답 예시

{
    "code": "0",
    "data": {
        "signerInfos": [
            {
                "signerStatus": 0,
                "rejectedReason": null,
                "authConfig": {
                    "accessCode": {
                        "accessCode": "1234567",
                        "promptInfo": "test"
                    }
                },
                "accessCode": null,
                "userEmail": "muyantest2@tsign.cn",
                "userName": "muyantest2222",
                "signDate": null,
                "signOrder": "1"
            },
            {
                "signerStatus": 0,
                "rejectedReason": null,
                "accessCode": null,
                "userEmail": "muyan@tsign.cn",
                "userName": "muyant",
                "signDate": null,
                "signOrder": "1"
            }
        ],
        "envelopeExpireTime": 1724055000193,
        "signFiles": [
            {
                "fileKey": "4150a67c-d4f0-45e6-88e9-541ce6d0c73c"
            }
        ],
        "envelopeCreateTime": null,
        "redirectUrl": "https://www.baidu.com",
        "attachments": [

        ],
        "canceledReason": null,
        "subject": "api create envelope hxqibLJpBD",
        "envelopeEndTime": null,
        "remark": "api remark",
        "CCInfos": null,
        "initiatorInfo": {
            "userName": "muyantest2"
        },
        "expireTime": 1724055000193,
        "envelopeId": "4a97d269d48642bb8b9d4878cde843a3",
        "envelopeStatus": 0
    },
    "message": "success"
}