POPBill Developers
API Reference

1. 발신번호 관리

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

  • 문자 발신번호 등록여부를 확인합니다.
  • 발신번호 상태가 '승인'인 경우에만 리턴값 Response 의 변수 'code'가 1로 반환됩니다.
messageService.checkSenderNumber(CorpNum, SenderNumber, UserID, callback, err)
Parameters
순번변수명타입길이필수설명
CorpNum string 10 Y 팝빌회원 사업자번호 ('-' 제외)
SendrNumber string 20 Y 확인할 발신번호
UserID string 50 N 팝빌회원 아이디
callback function - Y 성공에 대한 콜백 함수
err function - Y 실패에 대한 콜백 함수
Return

Response - code : 0 (미등록) / code : 1 (등록)

Throws

PopbillException

1.2. GetSenderNumberMgtURL - 발신번호 관리 팝업 URL

  • 발신번호를 등록하고 내역을 확인하는 문자 발신번호 관리 페이지 팝업 URL을 반환합니다.
  • 반환되는 URL은 보안 정책상 30초 동안 유효하며, 시간을 초과한 후에는 해당 URL을 통한 페이지 접근이 불가합니다.
messageService.getSenderNumberMgtURL(CorpNum, UserID, callback, err)
Parameters
순번변수명타입길이필수설명
CorpNum string 10 Y 팝빌회원 사업자번호 ('-' 제외)
UserID string 50 N 팝빌회원 아이디
callback function - Y 성공에 대한 콜백 함수
err function - Y 실패에 대한 콜백 함수
Return

string - 요청에 대한 응답 URL

Throws

PopbillException

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

  • 팝빌에 등록한 연동회원의 문자 발신번호 목록을 확인합니다.
messageService.getSenderNumberList(CorpNum, UserID, success, error)
Parameters
순번변수명타입길이필수설명
CorpNum string 10 Y 팝빌회원 사업자번호 ('-' 제외)
UserID string 50 N 팝빌회원 아이디
success function - Y 성공에 대한 콜백 함수
error function - Y 실패에 대한 콜백 함수
Return

SenderNumber[ ]

Throws

PopbillException