발신번호 관리

1. CheckSenderNumber - 발신번호 등록여부 확인

팩스 발신번호 등록여부를 확인합니다.

• 발신번호 상태가 ‘사용’인 경우에만 응답 객체 Response의 변수 ‘code’가 1로 반환됩니다.

def checkSenderNumber(CorpNum, SenderNumber, UserID)

요청

Parameters

순번	변수명	타입	길이	필수	설명
1	CorpNum	str	10	Y	팝빌회원 사업자번호 ('-' 제외)
2	SenderNumber	str	20	Y	확인할 발신번호
3	UserID	str	50	N	팝빌회원 아이디

응답

Response

순번	변수명	타입	길이	설명
1	code	int	-	API 처리에 대한 응답코드 1 성공
2	message	str	-	API 처리에 대한 응답메시지

예외

PopbillException

순번	변수명	타입	길이	설명
1	code	int	-	API 처리 실패에 대한 오류코드 → 음의 정수 8자리 숫자값 [참고] 오류코드
2	message	str	-	API 처리 실패에 대한 오류메시지

2. GetSenderNumberMgtURL - 발신번호 등록 팝업 URL

미리보기

발신번호를 등록하는 팝업 URL을 반환합니다.

• 권장 사이즈 : width = 1,200px (최소 1,000px) / height = 740px
• 반환되는 URL은 30초 동안만 사용이 가능합니다.
• 반환되는 URL에서만 유효한 세션을 포함하고 있습니다.

def getSenderNumberMgtURL(CorpNum, UserID)

요청

Parameters

순번	변수명	타입	길이	필수	설명
1	CorpNum	str	10	Y	팝빌회원 사업자번호 ('-' 제외)
2	UserID	str	50	N	팝빌회원 아이디

응답

str - 요청에 대한 응답 URL

예외

PopbillException

순번	변수명	타입	길이	설명
1	code	int	-	API 처리 실패에 대한 오류코드 → 음의 정수 8자리 숫자값 [참고] 오류코드
2	message	str	-	API 처리 실패에 대한 오류메시지

3. GetSenderNumberList - 발신번호 목록 확인

팝빌에 등록한 연동회원의 팩스 발신번호 목록을 확인합니다.

def getSenderNumberList(CorpNum, UserID=None)

요청

Parameters

순번	변수명	타입	길이	필수	설명
1	CorpNum	str	10	Y	팝빌회원 사업자번호 ('-' 제외)
2	UserID	str	50	N	팝빌회원 아이디

응답

list[SenderNumber]

순번	변수명	타입	길이	설명
1	number	str	20	발신번호
2	representYN	bool	-	대표번호 지정여부 True 대표번호 False 일반번호
3	state	int	1	상태 0 대기 1 사용 3 반려
4	memo	str	200	메모

예외

PopbillException

순번	변수명	타입	길이	설명
1	code	int	-	API 처리 실패에 대한 오류코드 → 음의 정수 8자리 숫자값 [참고] 오류코드
2	message	str	-	API 처리 실패에 대한 오류메시지