대용량 문자 발송 - kth-apistore/docs GitHub Wiki
대용량 문자 서비스 API
문서 버전
소개
- 문자메시지 등 다양한 타입의 메시지를 인터넷이나 전용선으로 연결된 클라이언트의 컴퓨터에서 발송 시 각 이동통신망을 통해 사용자에게 전송하는 시스템입니다.
- 본 규격서는 HTTP 프로토콜을 기반으로 작성되었습니다.
- 본 규격서는 Message 전송에 대한 규격을 정의하고 있습니다.
공통
API 사용 시 필요 사항
- {client_id} 는 API스토어에 가입한 후 해당 API를 사용(구매) 신청한 ID
- {apiVersion} : 1 (발신번호 인증 시 2)
- {type}: 등록-save, 조회-list
API 공통헤더
Content-Type:application/x-www-form-urlencoded; charset=UTF-8
x-waple-authorization:ZS3x4zY4NjY24T6yDk0LTA28WE4ZDgyLTZhZmMtNGU5OS05YThkLTgyNmFmYzVlO7kzZ4==
API 주의사항
EUC-KR에 포함되지 않은 문자는 발송되지 않습니다.
- API 호출환경이 UTF-8인 경우 Apistore는 euc-kr로 변경 후 통신사에 보냅니다.
- UTF-8은 EUC-KR보다 더 많은 문자를 생성할 수 있으므로, EUC-KR 변환시 실패 할 수 있습니다.
API 목록
문자발송 API 목록
| 종류 |
API |
기능 |
| SMS |
{Base URL} + /message/sms/{client_id} |
SMS 전송 기능 |
| LMS |
{Base URL} + /message/lms/{client_id} |
LMS 전송 기능 |
| MMS |
{Base URL} + /message/mms/{client_id} |
MMS 전송 기능 |
문자관리 API 목록
| 종류 |
API |
기능 |
| 전송결과 |
{Base URL} + /message/report/{client_id} |
전송에 대한 결과 조회 |
| 잔액조회 |
{Base URL} + /message/balance/{client_id}/{balance_date} |
잔액 조회 |
| 충전금액 조회 |
{Base URL} + /message/deposit_date/{client_id} |
충전금액 조회 |
발신번호인증 API 목록
| 종류 |
API |
기능 |
| 발신번호등록 |
{Base URL} + /sendnumber/save/{client_id} |
|
| 발신번호조회 |
{Base URL} + /sendnumber/list/{client_id} |
등록한 발신번호 리스트 조회 기능 |
에러코드
API Response 응답중 result_code에 대한 정의 테이블
| result_code |
설명 |
해결 방법 |
| 100 |
가입되지 않은 사용자 |
ID확인 및 API스토어 가입확인 |
| 200 |
성공 |
|
| 300 |
사용자 파라미터 에러 |
필수 파라미터 확인 |
| 400 |
시스템에러 |
관리자 문의 |
| 500 |
발신번호 사전등록필요 |
별도 링크제공 |
Test Summary
TEST는 실제로 메시지 전송은 되지 않으며, 요청한 데이터에 대한 처리 결과만 확인 가능합니다.
| Method |
종류 |
API |
기능 |
| POST |
SMS |
{Base URL} + /sms/{client_id} |
SMS 전송 테스트 |
| POST |
LMS |
{Base URL} + /lms/{client_id} |
LMS 전송 테스트 |
| POST |
MMS |
{Base URL} + /mms/{client_id} |
MMS 전송 테스트 |
| GET |
REPORT |
{Base URL} + /report/{client_id} |
MMS 전송 테스트 |
| TEST KEY (택1) |
| MS0xMzY1NjY2MTAyNDk0LTA2MWE4ZDgyLTZhZmMtNGU5OS05YThkLTgyNmFmYzVlOTkzZQ== |
| MzkxLTEzNjU2NjcxMjgwNjEtYTZlNjZjZjEtY2I2Ny00ZTAxLWE2NmMtZjFjYjY3NmUwMTIz |
| MTItMTM2NTc1MzA4MjQ3Ni1lNzIxOWQzNy1jZTlmLTRiM2QtYTE5ZC0zN2NlOWZlYjNkMjg= |
발신번호 등록 규칙
- 기본 : 8자리 ~ 11자리 발신번호
- 유선 전화번호 : 지역 번호를 포함
- 이동통신 전화번호
- 대표 전화번호: 15xx, 16xx, 18xx(번호 앞에 지역번호 사용금지)
코드 및 메시지 정의
Appendix Report Code