Index

1. 발신번호 사전등록

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

ㆍ발신번호를 등록하고 내역을 확인하는 문자 발신번호 관리 페이지 팝업 URL을 반환합니다.

ㆍ반환되는 URL은 보안 정책상 30초 동안 유효하며, 시간을 초과한 후에는 해당 URL을 통한 페이지 접근이 불가합니다.

function GetSenderNumberMgtURL($CorpNum, $UserID)

Parameters

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

Return

String - 요청에 대한 응답 URL

Throws

PopbillException

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

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

function GetSenderNumberList($CorpNum, $UserID = null)

Parameters

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

Return

SenderNumber[ ]

Throws

PopbillException

2. 문자전송

접수번호(recieptNum)

  • 작업(접수) 단위를 나타내는 고유한 식별정보로 문자 전송 함수 호출시 팝빌로부터 반환받는 값
  • 예약접수 건을 취소하거나, 전송내역 및 실패사유를 확인하기 위한 값

cf. 다건접수(대량/동보) 경우에도 하나의 접수번호만을 반환

2.1. SendSMS - 단문 전송

ㆍ최대 90byte의 단문(SMS) 메시지 전송을 팝빌에 접수합니다. (최대 1,000건)

ㆍ모든 수신자에게 동일한 내용을 전송하거나(동보전송), 수신자마다 개별 내용을 전송할 수 있습니다(대량전송).

function SendSMS($CorpNum, $Sender, $Content, $Messages = array(), $ReserveDT = null, $adsYN = false, $UserID = null, $SenderName = null, $SystemYN = false, $RequestNum = null)

Parameters

순번 변수명 타입 길이 필수 설명
1 CorpNum String 10 O 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)
2 Sender String 20 - 발신번호
└ 함수 [1.1. GetSenderNumberMgtURL - 발신번호 관리 팝업 URL] 또는 [1.2. GetSenderNumberList - 발신번호 목록 확인] 호출하여 등록 내역 확인 가능
※ 동보전송시 필수, 전송정보에 발신번호 없는 경우 적용
※ 팝빌에 등록되지 않은 번호를 입력하는 경우 오류 메시지 반환
3 Content String 90 - 메시지 내용
└ 한글, 한자, 특수문자 2byte / 영문, 숫자, 공백 1byte
※ 동보전송시 필수, 전송정보에 메시지 내용 없는 경우 적용
4 Messages Message[ ] 1000 O [배열] 전송 정보 (최대 1,000건)
5 ReserveDT String 14 - 전송 예약일시 (형식 : yyyyMMddHHmmss)
※ 미입력시 즉시 전송
6 adsYN Boolean - - 광고메시지 전송여부 : true / false 중 택 1
└ true = 광고, false = 일반 [참고] 광고메시지 전송방법 안내
7 UserID String 50 - 팝빌회원 아이디
8 senderName String 70 - 발신자명
※ 동보전송시 필수, 전송정보에 발신자명 없는 경우 적용
9 SystemYN Boolean - - false
10 requestNum String 36 - 전송요청 번호 : 팝빌이 접수 단위를 식별할 수 있도록 파트너가 할당한 식별번호
└ 영문, 숫자, 하이픈('-') 사용하여 고유값 부여

Return

String - 요청에 대한 접수번호(receiptNum)

Throws

PopbillException

2.2. SendLMS - 장문 전송

ㆍ최대 2,000byte의 장문(LMS) 메시지 전송을 팝빌에 접수합니다. (최대 1,000건)

ㆍ모든 수신자에게 동일한 내용을 전송하거나(동보전송), 수신자마다 개별 내용을 전송할 수 있습니다(대량전송).

function SendLMS($CorpNum, $Sender, $Subject, $Content, $Messages = array(), $ReserveDT = null, $adsYN = false, $UserID = null, $SenderName = null, $SystemYN = false, $RequestNum = null)

Parameters

순번 변수명 타입 길이 필수 설명
1 CorpNum String 10 O 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)
2 Sender String 20 - 발신번호
└ 함수 [1.1. GetSenderNumberMgtURL - 발신번호 관리 팝업 URL] 또는 [1.2. GetSenderNumberList - 발신번호 목록 확인] 호출하여 등록 내역 확인 가능
※ 동보전송시 필수, 전송정보에 발신번호 없는 경우 적용
※ 팝빌에 등록되지 않은 번호를 입력하는 경우 오류 메시지 반환
3 Subject String 40 - 메시지 제목
※ 동보전송시 필수, 전송정보에 메시지 제목 없는 경우 적용
4 Content String 2000 - 메시지 내용
└ 한글, 한자, 특수문자 2byte / 영문, 숫자, 공백 1byte
※ 동보전송시 필수, 전송정보에 메시지 내용 없는 경우 적용
5 Messages Message[ ] 1000 O [배열] 전송 정보 (최대 1,000건)
6 ReserveDT String 14 - 전송 예약일시 (형식 : yyyyMMddHHmmss)
※ 미입력시 즉시 전송
7 adsYN Boolean - - 광고메시지 전송여부 : true / false 중 택 1
└ true = 광고, false = 일반 [참고] 광고메시지 전송방법 안내
8 UserID String 50 - 팝빌회원 아이디
9 senderName String 70 - 발신자명
※ 동보전송시 필수, 전송정보에 발신자명 없는 경우 적용
10 SystemYN Boolean - - false
11 requestNum String 36 - 전송요청 번호 : 팝빌이 접수 단위를 식별할 수 있도록 파트너가 할당한 식별번호
└ 영문, 숫자, 하이픈('-') 사용하여 고유값 부여

Return

String - 요청에 대한 접수번호(receiptNum)

Throws

PopbillException

2.3. SendMMS - 포토문자 전송

ㆍ최대 2,000byte의 메시지와 이미지로 구성된 포토문자(MMS) 전송을 팝빌에 접수합니다. (최대 1,000건)

ㆍ모든 수신자에게 동일한 내용을 전송하거나(동보전송), 수신자마다 개별 내용을 전송할 수 있습니다(대량전송).

※ 이미지 파일 포맷/규격 : 최대 300Kbyte(JPEG, JPG), 가로/세로 1,000px 이하 권장

function SendMMS($CorpNum, $Sender, $Subject, $Content, $Messages = array(), $FilePaths = array(), $ReserveDT = null, $adsYN = false, $UserID = null, $SenderName = null, $SystemYN = false, $RequestNum = null)

Parameters

순번 변수명 타입 길이 필수 설명
1 CorpNum String 10 O 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)
2 Sender String 20 - 발신번호
└ 함수 [1.1. GetSenderNumberMgtURL - 발신번호 관리 팝업 URL] 또는 [1.2. GetSenderNumberList - 발신번호 목록 확인] 호출하여 등록 내역 확인 가능
※ 동보전송시 필수, 전송정보에 발신번호 없는 경우 적용
※ 팝빌에 등록되지 않은 번호를 입력하는 경우 오류 메시지 반환
3 Subject String 40 - 메시지 제목
※ 동보전송시 필수, 전송정보에 메시지 제목 없는 경우 적용
4 Content String 2000 - 메시지 내용
└ 한글, 한자, 특수문자 2byte / 영문, 숫자, 공백 1byte
※ 동보전송시 필수, 전송정보에 메시지 내용 없는 경우 적용
5 Messages Message[ ] 1000 O [배열] 전송 정보 (최대 1,000건)
6 FilePaths Array 1 O 전송할 이미지 파일 경로
7 ReserveDT String 14 - 전송 예약일시 (형식 : yyyyMMddHHmmss)
※ 미입력시 즉시 전송
8 adsYN Boolean - - 광고메시지 전송여부 : true / false 중 택 1
└ true = 광고, false = 일반 [참고] 광고메시지 전송방법 안내
9 UserID String 50 - 팝빌회원 아이디
10 senderName String 70 - 발신자명
※ 동보전송시 필수, 전송정보에 발신자명 없는 경우 적용
11 SystemYN Boolean - - false
12 requestNum String 36 - 전송요청 번호 : 팝빌이 접수 단위를 식별할 수 있도록 파트너가 할당한 식별번호
└ 영문, 숫자, 하이픈('-') 사용하여 고유값 부여

Return

String - 요청에 대한 접수번호(receiptNum)

Throws

PopbillException

2.4. SendXMS - 단문/장문 자동인식 전송

ㆍ메시지 크기(90byte)에 따라 단문/장문(SMS/LMS)을 자동으로 인식하여 1건의 메시지를 전송을 팝빌에 접수합니다. (최대 1,000건)

ㆍ모든 수신자에게 동일한 내용을 전송하거나(동보전송), 수신자마다 개별 내용을 전송할 수 있습니다(대량전송).

function SendXMS($CorpNum, $Sender, $Subject, $Content, $Messages = array(), $ReserveDT = null, $adsYN = false, $UserID = null, $SenderName = null, $SystemYN = false, $RequestNum = null)

Parameters

순번 변수명 타입 길이 필수 설명
1 CorpNum String 10 O 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)
2 Sender String 20 - 발신번호
└ 함수 [1.1. GetSenderNumberMgtURL - 발신번호 관리 팝업 URL] 또는 [1.2. GetSenderNumberList - 발신번호 목록 확인] 호출하여 등록 내역 확인 가능
※ 동보전송시 필수, 전송정보에 발신번호 없는 경우 적용
※ 팝빌에 등록되지 않은 번호를 입력하는 경우 오류 메시지 반환
3 Subject String 40 - 메시지 제목
※ 동보전송시 필수, 전송정보에 메시지 제목 없는 경우 적용
4 Content String 90 - 메시지 내용
└ 한글, 한자, 특수문자 2byte / 영문, 숫자, 공백 1byte
※ 동보전송시 필수, 전송정보에 메시지 내용 없는 경우 적용
5 Messages Message[ ] 1000 O [배열] 전송 정보 (최대 1,000건)
7 ReserveDT String 14 - 전송 예약일시 (형식 : yyyyMMddHHmmss)
※ 미입력시 즉시 전송
7 adsYN Boolean - - 광고메시지 전송여부 : true / false 중 택 1
└ true = 광고, false = 일반 [참고] 광고메시지 전송방법 안내
8 UserID String 50 - 팝빌회원 아이디
9 senderName String 70 - 발신자명
※ 동보전송시 필수, 전송정보에 발신자명 없는 경우 적용
10 SystemYN Boolean - - false
11 requestNum String 36 - 전송요청 번호 : 팝빌이 접수 단위를 식별할 수 있도록 파트너가 할당한 식별번호
└ 영문, 숫자, 하이픈('-') 사용하여 고유값 부여

Return

String - 요청에 대한 접수번호(receiptNum)

Throws

PopbillException

2.5. CancelReserve - 예약전송 취소 (접수번호)

ㆍ팝빌에서 반환받은 접수번호를 통해 예약접수된 문자 메시지 전송을 취소합니다. (예약시간 10분 전까지 가능)

function CancelReserve($CorpNum, $ReceiptNum, $UserID = null)

Parameters

순번 변수명 타입 길이 필수 설명
1 CorpNum String 10 O 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)
2 ReceiptNum String 18 O 예약문자 전송요청시 팝빌로부터 반환 받은 접수번호
3 UserID String 50 - 팝빌회원 아이디

Return

Response

Throws

PopbillException

2.6. CancelReserveRN - 예약전송 취소 (전송요청번호)

ㆍ파트너가 할당한 전송요청 번호를 통해 예약접수된 문자 전송을 취소합니다. (예약시간 10분 전까지 가능)

function CancelReserveRN($CorpNum, $RequestNum, $UserID = null)

Parameters

순번 변수명 타입 길이 필수 설명
1 CorpNum String 10 O 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)
2 RequestNum String 36 O 예약문자 전송요청시 파트너가 할당한 전송요청 번호
3 UserID String 50 - 팝빌회원 아이디

Return

Response

Throws

PopbillException

3. 정보확인

3.1. GetMessages - 전송내역 확인 (접수번호)

ㆍ팝빌에서 반환받은 접수번호를 통해 문자 전송상태 및 결과를 확인합니다.

function GetMessages($CorpNum, $ReceiptNum, $UserID = null)

Parameters

순번 변수명 타입 길이 필수 설명
1 CorpNum String 10 O 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)
2 ReceiptNum String 18 O 문자 전송요청시 팝빌로부터 반환 받은 접수번호
3 UserID String 50 - 팝빌회원 아이디

Return

MessageInfo[ ]

Throws

PopbillException

3.2. GetMessagesRN - 전송내역 확인 (전송요청번호)

ㆍ파트너가 할당한 전송요청 번호를 통해 문자 전송상태 및 결과를 확인합니다.

function GetMessagesRN($CorpNum, $RequestNum, $UserID = null)

Parameters

순번 변수명 타입 길이 필수 설명
1 CorpNum String 10 O 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)
2 RequestNum String 36 O 문자 전송요청시 파트너가 할당한 전송요청 번호
3 UserID String 50 - 팝빌회원 아이디

Return

MessageInfo[ ]

Throws

PopbillException

3.3. GetStates - 전송내역 요약정보 확인

ㆍ팝빌에서 반환받은 접수번호를 통해 문자 전송상태 및 결과에 대한 요약정보를 확인합니다.

function GetStates($CorpNum, $ReceiptNumList = array(), $UserID = null)

Parameters

순번 변수명 타입 길이 필수 설명
1 CorpNum String 10 O 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)
2 ReceiptNumList Array 1000 O [배열] 문자 전송요청시 팝빌로부터 반환받은 접수번호 배열 (최대 1,000건)
3 UserID String 50 - 팝빌회원 아이디

Return

MessageBriefInfo[ ]

Throws

PopbillException

3.4. Search - 전송내역 목록 조회

ㆍ파트너가 지정한 검색조건에 해당하는 문자 전송내역을 조회합니다. (최대 검색기간 : 6개월)

※ 1년 이상된 전송내역은 지원하지 않습니다.

function Search($CorpNum, $SDate, $EDate, $State = array(), $Item = array(), $ReserveYN = false, $SenderYN = false, $Page, $PerPage, $Order, $UserID = null, $QString = null)

ㆍ페이지 관련 항목(Page, PerPage, Order)을 활용하여 문자 전송내역 목록을 구현할 수 있습니다.

Parameters

순번 변수명 타입 길이 필수 설명
1 CorpNum String 10 O 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)
2 SDate String 8 O 조회 기간의 시작일자 (형식 : yyyyMMdd)
3 EDate String 8 O 조회 기간의 종료일자 (형식 : yyyyMMdd)
4 State Array - - [배열] 전송상태 : "1" / "2" / "3" / "4" 중 선택 (다중 선택 가능)
└ 1 = 대기, 2 = 성공, 3 = 실패, 4 = 취소
※ 미입력시 전체조회
5 Item Array - - [배열] 검색대상 : "SMS" / "LMS" / "MMS" 중 선택 (다중 선택 가능)
└ SMS = 단문, LMS = 장문, MMS = 포토문자
※ 미입력시 전체조회
6 ReserveYN Boolean - - 예약여부 : true / false 중 택 1
└ true = 예약전송건, false = 전체조회
※ 미입력시 기본값 false 처리
7 SenderYN Boolean - - 개인조회 여부 : true / false 중 택 1
└ true = 해당 담당자 계정으로 접수한 문자만 조회 (개인권한), false = 접수한 문자 전체 조회 (관리자권한)
※ 미입력시 기본값 false 처리
8 Page Integer - - 목록 페이지번호 (기본값 1)
9 PerPage Integer - - 페이지당 표시할 목록 개수 (기본값 500, 최대 1,000)
10 Order String 1 - 문자 접수일시를 기준으로 하는 목록 정렬 방향 : "D" / "A" 중 택 1
└ D = 내림차순(기본값), A = 오름차순
11 UserID String 50 - 팝빌회원 아이디
12 QString String - - 조회하고자 하는 발신자명 또는 수신자명
※ 미입력시 전체조회

Return

MsgSearchResult[ ]

Throws

PopbillException

3.5. GetSentListURL - 문자 전송내역 팝업 URL

ㆍ팝빌 사이트와 동일한 문자 전송내역 확인 페이지의 팝업 URL을 반환합니다.

ㆍ반환되는 URL은 보안 정책상 30초 동안 유효하며, 시간을 초과한 후에는 해당 URL을 통한 페이지 접근이 불가합니다.

function GetSentListURL($CorpNum, $UserID)

Parameters

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

Return

String - 요청에 대한 응답 URL

Throws

PopbillException

3.6. GetAutoDenyList - 080 수신거부 목록 확인

ㆍ전용 080 번호에 등록된 수신거부 목록을 반환합니다.

function GetAutoDenyList($CorpNum)

Parameters

순번 변수명 타입 길이 필수 설명
1 CorpNum String 10 O 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)

Return

AutoDeny[ ]

Throws

PopbillException

4. 포인트 관리

4.1. GetBalance - 연동회원 잔여포인트 확인

ㆍ연동회원의 잔여포인트를 확인합니다.

function GetBalance($CorpNum)

Parameters

순번 변수명 타입 길이 필수 설명
1 CorpNum String 10 O 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)

Return

String - 연동회원 잔여포인트

Throws

PopbillException

4.2. GetChargeURL - 연동회원 포인트 충전 팝업 URL

ㆍ연동회원 포인트 충전을 위한 페이지의 팝업 URL을 반환합니다.

ㆍ반환되는 URL은 보안 정책상 30초 동안 유효하며, 시간을 초과한 후에는 해당 URL을 통한 페이지 접근이 불가합니다.

function GetChargeURL($CorpNum, $UserID)

Parameters

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

Return

String - 요청에 대한 응답 URL

Throws

PopbillException

4.3. GetPartnerBalance - 파트너 잔여포인트 확인

ㆍ파트너의 잔여포인트를 확인합니다.

function GetPartnerBalance($CorpNum)

Parameters

순번 변수명 타입 길이 필수 설명
1 CorpNum String 10 O 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)

Return

String - 파트너 잔여포인트

Throws

PopbillException

4.4. GetPartnerURL - 파트너 포인트충전 팝업 URL

ㆍ파트너 포인트 충전을 위한 페이지의 팝업 URL을 반환합니다.

ㆍ반환되는 URL은 보안 정책상 30초 동안 유효하며, 시간을 초과한 후에는 해당 URL을 통한 페이지 접근이 불가합니다.

function GetPartnerURL($CorpNum, $TOGO)

Parameters

순번 변수명 타입 길이 필수 설명
1 CorpNum String 10 O 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)
2 TOGO String - O "CHRG" 입력

Return

String - 요청에 대한 응답 URL

Throws

PopbillException

4.5. GetUnitCost - 전송 단가 확인

ㆍ문자 전송시 과금되는 포인트 단가를 확인합니다.

function GetUnitCost($CorpNum, $ENumMessageType)

Parameters

순번 변수명 타입 길이 필수 설명
1 CorpNum String 10 O 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)
2 MsgType ENumMessageType - O 문자전송 유형 : SMS / LMS / MMS 중 택 1
└ SMS = 단문, LMS = 장문, MMS = 포토문자

Return

String - 문자 전송 단가

Throws

PopbillException

4.6. GetChargeInfo - 과금정보 확인

ㆍ팝빌 문자 API 서비스 과금정보를 확인합니다.

function GetChargeInfo($CorpNum, $ENumMessageType, $UserID = null)

Parameters

순번 변수명 타입 길이 필수 설명
1 CorpNum String 10 O 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)
2 MsgType ENumMessageType - O 문자전송 유형 : SMS / LMS / MMS 중 택 1
└ SMS = 단문, LMS = 장문, MMS = 포토문자
3 UserID String 50 - 팝빌회원 아이디

Return

ChargeInfo

Throws

PopbillException

5. 회원정보

5.1. CheckIsMember - 연동회원 가입여부 확인

ㆍ사업자번호를 조회하여 연동회원 가입여부를 확인합니다.

function CheckIsMember($CorpNum, $LinkID)

Parameters

순번 변수명 타입 길이 필수 설명
1 CorpNum String 10 O 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)
2 LinkID String - O 연동신청시 팝빌에서 발급받은 링크아이디

Return

Response

Throws

PopbillException

5.2. CheckID - 아이디 중복 확인

ㆍ사용하고자 하는 아이디의 중복여부를 확인합니다.

function CheckID($ID)

Parameters

순번 변수명 타입 길이 필수 설명
1 ID String 20 O 중복여부 확인 할 아이디

Return

Response - code : 0 (미사용중) / code : 1 (사용중)

Throws

PopbillException

5.3. JoinMember - 연동회원 신규가입

ㆍ사용자를 연동회원으로 가입처리합니다.

function JoinMember($JoinForm)

Parameters

순번 변수명 타입 길이 필수 설명
1 JoinInfo JoinForm - O 연동회원 객체정보

Return

Response

Throws

PopbillException

5.4. GetAccessURL - 팝빌 로그인 팝업 URL

ㆍ팝빌 사이트에 로그인 상태로 접근할 수 있는 페이지의 팝업 URL을 반환합니다.

ㆍ반환되는 URL은 보안 정책상 30초 동안 유효하며, 시간을 초과한 후에는 해당 URL을 통한 페이지 접근이 불가합니다.

function GetAccessURL($CorpNum, $UserID)

Parameters

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

Return

String - 요청에 대한 응답 URL

Throws

PopbillException

5.5. GetCorpInfo - 회사정보 확인

ㆍ연동회원의 회사정보를 확인합니다.

function GetCorpInfo($CorpNum, $UserID = null)

Parameters

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

Return

CorpInfo

Throws

PopbillException

5.6. UpdateCorpInfo - 회사정보 수정

ㆍ연동회원의 회사정보를 수정합니다.

function UpdateCorpInfo($CorpNum, $CorpInfo, $UserID = null)

Parameters

순번 변수명 타입 길이 필수 설명
1 CorpNum String 10 O 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)
2 CorpInfo CorpInfo - O 회사 객체정보
3 UserID String 50 - 팝빌회원 아이디

Return

Response

Throws

PopbillException

5.7. RegistContact - 담당자 추가

ㆍ연동회원 사업자번호에 담당자(팝빌 로그인 계정)를 추가합니다.

function RegistContact($CorpNum, $ContactInfo, $UserID = null)

Parameters

순번 변수명 타입 길이 필수 설명
1 CorpNum String 10 O 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)
2 ContactInfo ContactInfo - O 담당자 객체정보
3 UserID String 50 - 팝빌회원 아이디

Return

Response

Throws

PopbillException

5.8. ListContact - 담당자 목록 확인

ㆍ연동회원 사업자번호에 등록된 담당자(팝빌 로그인 계정) 목록을 확인합니다.

function ListContact($CorpNum, $UserID = null)

Parameters

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

Return

ContactInfo[ ]

Throws

PopbillException

5.9. UpdateContact - 담당자 정보 수정

ㆍ연동회원 사업자번호에 등록된 담당자(팝빌 로그인 계정) 정보를 수정합니다.

function UpdateContact($CorpNum, $ContactInfo, $UserID)

Parameters

순번 변수명 타입 길이 필수 설명
1 CorpNum String 10 O 팝빌회원 사업자번호 (하이픈 '-' 제외 10 자리)
2 ContactInfo ContactInfo - O 담당자 객체정보
3 UserID String 50 - 팝빌회원 아이디

Return

Response

Throws

PopbillException

A. 객체정보

A.1. Response

순번 변수명 항목명 타입 길이 비고
1 code 코드 Interger - API 처리에 대한 응답코드
2 message 메시지 String - API 처리에 대한 응답메시지

A.2. PopbillException

순번 변수명 항목명 타입 길이 비고
1 code 코드 Integer - API 처리 실패에 대한 오류코드("-"로 시작하는 8자리 숫자값)
[참고] 오류코드
2 message 메시지 String - API 처리 실패에 대한 오류메시지

A.3. SenderNumber

순번 변수명 항목명 타입 길이 비고
1 number 발신번호 String 20
2 representYN 대표번호 지정여부 Boolean - true : (대표번호) / false : (일반번호) 중 반환
3 state 등록상태 Integer 1 0 : (대기) / 1 : (승인) / 2 : (취소) 중 반환
4 memo 메모 String -

A.4. ENumMessageType

순번 변수명 항목명 타입 길이 비고
1 SMS 단문 String -
2 LMS 장문 String -
3 MMS 포토 String -
4 XMS 단문/장문 String -

A.5. Message

순번 변수명 항목명 타입 길이 필수 비고
1 snd 발신번호 String 20 - 수신자마다 개별 발신번호 사용시 입력
2 sndnm 발신자명 String 70 -
3 rcv 수신번호 String 20 O
4 rcvnm 수신자명 String 70 -
5 msg 메시지 내용 String 90/2000 - 단문 : 90byte 이하, 장문 : 2,000byte 이하
└ 한글, 한자, 특수문자 2byte / 영문, 숫자, 공백 1byte
6 sjt 메시지 제목 String 40 - ※ SMS 사용 불가, 미입력시 팝빌에서 설정한 기본값 사용

A.6. MsgSearchResult

순번 변수명 항목명 타입 길이 비고
1 code 코드 Integer - API 처리에 대한 응답코드
2 message 메시지 String - API 처리에 대한 응답메시지
3 total 총 검색결과 건수 String -
4 perPage 페이지당 검색개수 String -
5 pageNum 페이지 번호 String -
6 pageCount 페이지 개수 String -
7 list 전송결과 정보 MessageInfo[ ] [배열] 최대 1,000개
[3.1. GetMessages - 전송내역 확인 (접수번호)][3.1. GetMessagesRN - 전송내역 확인 (전송요청번호)]의 리턴값과 동일한 객체

A.7. MessageInfo

순번 변수명 항목명 타입 길이 비고
1 subject 메시지 제목 String 40
2 content 메시지 내용 String 90/2000 단문 : 90byte 이하, 장문 : 2,000byte 이하
3 sendNum 발신번호 String 20
4 senderName 발신자명 String 70
5 receiveNum 수신번호 String 20
6 receiveName 수신자명 String 70
7 receiptDT 접수일시 String 14 형식 : yyyyMMddHHmmss
8 sendDT 전송일시 String 14 형식 : yyyyMMddHHmmss
9 resultDT 전송결과 수신일시 String 14 형식 : yyyyMMddHHmmss
10 reserveDT 예약일시 String 14 형식 : yyyyMMddHHmmss
11 state 전송 상태코드 String 1 [참고] 전송 상태 및 결과 코드
12 result 전송 결과코드 String 3
13 type 메시지 타입 String 3
14 tranNet 전송처리 이동통신사명 String 3
15 receiptNum 접수번호 String 18
16 requestNum 요청번호 String 36

A.8. MessageBriefInfo

순번 변수명 항목명 타입 길이 비고
1 sn 일련번호 String -
2 rNum 접수번호 String 18
3 stat 전송 상태코드 String 1 [참고] 전송 상태 및 결과 코드
4 sDT 전송일시 String 14 형식 : yyyyMMddHHmmss
5 rDT 전송결과 수신일시 String 14 형식 : yyyyMMddHHmmss
6 rlt 전송 결과코드 String 3 [참고] 전송 상태 및 결과 코드
7 net 전송 이동통신사명 String -

A.9. AutoDeny

순번 변수명 항목명 타입 길이 비고
1 number 수신거부번호 String 20
2 regDT 등록일시 String 14

A.10. ChargeInfo

순번 변수명 항목명 타입 길이 비고
1 unitCost 전송단가 String -
2 chargeMethod 과금유형 String - "연동" / "파트너" 중 반환
3 rateSystem 과금제도 String - "종량제" 반환

A.11. JoinForm

순번 변수명 항목명 타입 길이 필수 비고
1 ID 아이디 String 50 O 6자 이상 50자 미만
2 PWD 비밀번호 String 20 O 6자 이상 20자 미만
3 LinkID 파트너 링크아이디 String 20 O 연동신청시 팝빌에서 발급받은 링크아이디
4 CorpNum 사업자번호 String 10 O 하이픈 '-' 제외 10자리 숫자값
5 CEOName 대표자 성명 String 100 O
6 CorpName 회사명 String 200 O
7 Addr 사업장 주소 String 300 O
8 BizType 업태 String 100 O
9 BizClass 종목 String 100 O
10 ContactName 담당자 성명 String 100 O
11 ContactEmail 담당자 이메일 String 100 O
12 ContactTEL 담당자 연락처(전화번호) String 20 O
13 ContactHP 담당자 휴대폰번호 String 20 -
14 ContactFAX 담당자 팩스번호 String 20 -

A.12. CorpInfo

순번 변수명 항목명 타입 길이 필수 비고
1 ceoname 대표자 성명 String 100 O
2 corpName 회사명 String 200 O
3 addr 주소 String 300 O
4 bizType 업태 String 100 O
5 bizClass 종목 String 100 O

A.13. ContactInfo

순번 변수명 항목명 타입 길이 필수 비고
1 id 아이디 String 50 O 6자 이상 50자 미만
2 pwd 비밀번호 String 20 담당자 추가시 필수, 6자 이상 20자 미만
3 personName 담당자 성명 String 100 O
4 tel 담당자 연락처(전화번호) String 20 O
5 hp 담당자 휴대폰번호 String 20 -
6 fax 담당자 팩스번호 String 20 -
7 email 담당자 이메일 String 100 O
8 regDT 등록일시 String 14 미입력
9 searchAllAllowYN 담당자 조회권한 설정 Boolean - - true : (회사권한 - 모든 문자 관리 가능) / false : (개인권한 - 해당 계정으로 접수한 문자 관리기능) 중 반환
※ 미입력시 기본값 false 처리
10 mgrYN 관리자 여부 Boolean - 미입력 true : (관리자) / false : (비관리자) 중 반환
※ 팝빌 사이트 [마이페이지] > [회사정보] > [담당자 관리]에서 수정 가능
11 state 계정상태 Integer 1 미입력 0 : (승인대기 - 관리자의 승인 후 이용가능) / 1 : (사용중) 중 반환