발신번호 관리
1. CheckSenderNumber - 발신번호 등록여부 확인
섹션 제목: “1. CheckSenderNumber - 발신번호 등록여부 확인” GET
https://popbill-test.linkhub.co.kr/Message/CheckSenderNumber/{senderNumber} - 문자 발신번호 등록여부를 확인합니다.
- 발신번호 상태가 ‘사용’인 경우에만 응답 객체 Response의 변수 ‘code’가 1로 반환됩니다.
Request
요청 헤더
| 순번 | 변수명 | 필수 | 설명 |
|---|---|---|---|
| 1 | Authorization | Y | 인증 토큰 |
| 2 | Accept-Language | N | 응답 언어 설정
|
| 3 | Accept-Encoding | N | 응답 압축 방식
|
| 4 | X-PB-UserID | N | 팝빌회원 아이디 |
Path 파라미터
| 순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
|---|---|---|---|---|---|
| 1 | senderNumber | string | 20 | Y | 발신번호 |
요청 예시
curl --request GET \ --url 'https://{domain}/Message/CheckSenderNumber/{senderNumber}' \ --header 'Authorization: Bearer {token}'Response
응답 본문
| 순번 | 변수명 | 타입 | 길이 | 설명 |
|---|---|---|---|---|
| 1 | code | number | - | API 처리에 대한 응답코드
|
| 2 | message | string | - | API 처리에 대한 응답메시지 |
응답 예시
{ "code": 1, "message": "이미 등록되어 있는 발신번호 입니다."}2. GetSenderNumberMgtURL - 발신번호 등록 팝업 URL
섹션 제목: “2. GetSenderNumberMgtURL - 발신번호 등록 팝업 URL” GET
https://popbill-test.linkhub.co.kr/Message 
발신번호를 등록하는 팝업 URL을 반환합니다.
- 권장 사이즈 : width = 1,200px (최소 1,000px) / height = 800px
- 반환되는 URL은 30초 동안만 사용이 가능합니다.
- 반환되는 URL에서만 유효한 세션을 포함하고 있습니다.
Request
요청 헤더
| 순번 | 변수명 | 필수 | 설명 |
|---|---|---|---|
| 1 | Authorization | Y | 인증 토큰 |
| 2 | Accept-Language | N | 응답 언어 설정
|
| 3 | Accept-Encoding | N | 응답 압축 방식
|
| 4 | X-PB-UserID | N | 팝빌회원 아이디 |
Query 파라미터
| 순번 | 변수명 | 타입 | 길이 | 필수 | 설명 |
|---|---|---|---|---|---|
| 1 | TG | string | - | Y | 고정값 : SENDER |
요청 예시
curl --request GET \ --url 'https://{domain}/Message?TG=SENDER' \ --header 'Authorization: Bearer {token}'Response
응답 본문
| 순번 | 변수명 | 타입 | 길이 | 설명 |
|---|---|---|---|---|
| 1 | url | string | - | 발신번호 등록 팝업 URL |
응답 예시
{ "url": "https://test.popbill.com/App/API?T=IRXSGITDREOTPOIRLPUHCB4BSBC4...NX7BMAR3="}3. GetSenderNumberList - 발신번호 목록 확인
섹션 제목: “3. GetSenderNumberList - 발신번호 목록 확인” GET
https://popbill-test.linkhub.co.kr/Message/SenderNumber - 팝빌에 등록한 연동회원의 문자 발신번호 목록을 확인합니다.
Request
요청 헤더
| 순번 | 변수명 | 필수 | 설명 |
|---|---|---|---|
| 1 | Authorization | Y | 인증 토큰 |
| 2 | Accept-Language | N | 응답 언어 설정
|
| 3 | Accept-Encoding | N | 응답 압축 방식
|
| 4 | X-PB-UserID | N | 팝빌회원 아이디 |
요청 예시
curl --request GET \ --url 'https://{domain}/Message/SenderNumber' \ --header 'Authorization: Bearer {token}'Response
응답 본문
| 순번 | 변수명 | 타입 | 길이 | 설명 |
|---|---|---|---|---|
| 1 | number | string | 20 | 발신번호 |
| 2 | representYN | boolean | - | 대표번호 지정여부
|
| 3 | state | number | 1 | 상태
|
| 4 | memo | string | 200 | 메모 |
응답 예시
[ { "number": "16008536", "representYN": false, "state": 1, "memo": null }]