사용가이드

공통 설정

인증키 발급

인증 토근 발급받기 위한 계정 생성 이름, 이메일, 패스워드 입력 후 계정을 생성 해야만 정상적으로 사용이 가능합니다.

토큰 발급을 위한 로그인

이메일 / 패스워드 입력 토큰 값 발급 후 인증 통해 정상적으로 API 를 이용 하실 수 있습니다.

발급 토큰 유효

토큰은 발급 1시간 후 자동 파기 됩니다. 재 발급 받으셔야 정상 이용 가능하십니다.

메시지 발송

API URL

Method	Request URI
POST	/api/v1/sms

요청 헤더

헤더명	설명
Authorization	로그인 또는 회원 가입 후 발급 받은 토큰키 입력 Bearer {토큰값}
Content-Type	application/json

요청 파라미터

name	type	desc	default	requirement
type	string	SMS Type SMS, LMS, MMS (소문자 가능)	SMS	Y
contentType	string	메시지 Type COMM: 일반메시지 AD: 광고메시지 (default: COMM)	COMM	N
countryCode	string	국가번호 (default: 82)	82	N
from	string	발신번호 사전 등록된 발신번호만 사용 가능	N	Y
subject	string	기본 메시지 제목 LMS, MMS에서만 사용 가능	N	Y
content	string	기본 메시지 내용 SMS: 최대 80byte LMS, MMS: 최대 2000byte	N	Y
messages	string	메시지 정보 아래 항목들 참조 (messages.XXX) 최대 1,000개	N	Y
messages.to	string	수신번호 -를 제외한 숫자만 입력 가능	N	Y
messages.subject	string	개별 메시지 제목 LMS, MMS에서만 사용 가능	N	Y
messages.content	string	개별 메시지 내용 SMS: 최대 80byte LMS, MMS: 최대 2000byte	N	Y
files.name	string	파일 이름 MMS에서만 사용 가능 공백 사용 불가 jpg, jpeg 확장자를 가진 파일 이름 최대 40자	N	Y
files.body	string	파일 바디 MMS에서만 사용 가능 공백 사용 불가 jpg, jpeg 이미지를 Base64로 인코딩한 값 원 파일 기준 최대 300Kbyte 파일 명 최대 40자 해상도 최대 1500 * 1440	N	N
reserveTime	string	예약 일시 메시지 발송 예약 일시 (yyyy-MM-dd HH:mm)	N	N
reserveTimeZone	string	예약 일시 타임존 예약 일시 타임존 (기본: Asia/Seoul) 지원 타임존 목록 * TZ database name 값 사용	N	N
scheduleCode	string	스케줄 코드	N	N

최대 지원 가능한 사이즈 초과 시 잘림 처리되어 발송 됩니다.
메시지(subject, content) 인코딩은 EUC-KR 기준으로 발송되며, 지원하지 않는 이모지 문자 포함 시 발송에 실패합니다.
messages 내에 subject, content를 정의하지 않으면 기본 subject, content로 지정된 값으로 발송 됩니다.
messages 내에 subject, content가 기본 subject, content 보다 우선순위가 높습니다.
type이 MMS인데 첨부하려는 파일이 없는경우 LMS로 발송됩니다.
reserveTime, scheduleCode를 모두 요청하는 경우 예약 발송으로 처리됩니다. (예약발송이 우선순위가 높음)

응답 바디

Field	Type	Desc
requestId	String	요청 아이디 발송시 응답받은 requestId
requestTime	DateTime	요청 시간
statusCode	String	요청 상태 코드 202 - 성공 그외 - 실패 * HTTP Status 규격을 따름
statusName	String	요청 상태명 success - 성공 fail - 실패

메시지 발송 요청 조회

API URL

Method	Request URI
GET	/api/v1/sms

요청 헤더

헤더명	설명
Authorization	로그인 또는 회원 가입 후 발급 받은 토큰키 입력 Bearer {토큰값}
Content-Type	application/json

요청 파라미터

name	type	desc	default	requirement
requestId	string	요청 아이디 발송시 응답받은 requestId	N	Y

응답 바디

Field	Type	Desc
requestId	String	요청 아이디 발송시 응답받은 requestId
statusCode	String	요청 상태 코드 202 - 성공 그외 - 실패 * HTTP Status 규격을 따름
messages.messageId	String	메시지 아이디
messages.requestTime	DateTime	발송 요청 시간
messages.messages_contentType	String	메시지 Type COMM: 일반메시지 AD:광고메시지
messages.messages_countryCode	String	국가번호
messages.messages_from	String	발신번호
messages.messages_to	String	수신번호

메시지 발송 요청 조회

API URL

Method	Request URI
GET	/api/v1/reserve_sms

요청 헤더

헤더명	설명
Authorization	로그인 또는 회원 가입 후 발급 받은 토큰키 입력 Bearer {토큰값}
Content-Type	application/json

요청 파라미터

name	type	desc	default	requirement
reserveId	string	예약 메시지 아이디 예약 발송 요청 조회 시 반환되는 메시지 식별자(requestId)	N	Y

응답 바디

Field	Type	Desc
reserveId	String	예약 메시지 아이디 예약 발송 요청 조회 시 반환되는 메시지 식별자(requestId)
reserveTime	String	예약 일시 메시지 발송 예약 일시 (yyyy-MM-dd HH:mm)
reserveTimeZone	String	예약 일시 타임존 예약 일시 타임존 (기본: Asia/Seoul) 지원 타임존 목록 * TZ database name 값 사용
reserveStatus	DateTime	예약 상태 READY - 발송 대기 PROCESSING - 발송 요청중 CANCELED - 발송 취소 FAIL - 발송 요청 실패 DONE - 발송 요청 성공 STALE - 발송 요청 실패 (시간 초과)

예약 메시지 취소

API URL

Method	Request URI
DELETE	/api/v1/reserve_sms_del

요청 헤더

헤더명	설명
Authorization	로그인 또는 회원 가입 후 발급 받은 토큰키 입력 Bearer {토큰값}
Content-Type	application/json

요청 파라미터

name	type	desc	default	requirement
reserveId	string	예약 메시지 아이디 예약 발송 요청 조회 시 반환되는 메시지 식별자(requestId)	N	Y

080 수신거부 번호

수신거부 번호 조회

API URL

Method	Request URI
GET	/api/v1/unsubscribes_sms_get

요청 헤더

헤더명	설명
Authorization	로그인 또는 회원 가입 후 발급 받은 토큰키 입력 Bearer {토큰값}
Content-Type	application/json

요청 파라미터

name	type	desc	default	requirement
clientTelNo	string	수신거부 번호 080 서비스 번호에 등록된 수신거부 번호	N	N
pageSize	Integer	페이지 사이즈 default: 100 0 ~ 100 사이의 숫자만 입력 가능	100	N
pageIndex	Integer	페이지 인덱스 default: 0	0	N
startTime	Integer	조회 시작 시간 수신거부 등록 시간 기준 default: 전체	ALL	N
endTime	Integer	조회 종료 시간 수신거부 등록 시간 기준 default: 전체	ALL	N

응답 바디

Field	Type	Desc
clientTelNo	String	수신거부 번호 080 서비스 번호에 등록된 수신거부 번호
reserveTime	String	예약 일시 메시지 발송 예약 일시 (yyyy-MM-dd HH:mm)
registerType	Char	등록 수단 M(manual): 수동 등록 C(call): 전화 등록

수신거부 번호 등록

API URL

Method	Request URI
POST	/api/v1/unsubscribes_sms

요청 헤더

헤더명	설명
Authorization	로그인 또는 회원 가입 후 발급 받은 토큰키 입력 Bearer {토큰값}
Content-Type	application/json

요청 파라미터

name	type	desc	default	requirement
clientTelNo	string	수신거부 번호 한번 요청에 1000건까지 요청 가능(List)	N	N

응답 바디

Field	Type	Desc
clientTelNo	String	수신거부 번호 080 서비스 번호에 등록된 수신거부 번호
reserveTime	String	예약 일시 메시지 발송 예약 일시 (yyyy-MM-dd HH:mm)
registerType	Char	등록 수단 M(manual): 수동 등록 C(call): 전화 등록

수신거부 번호 삭제

API URL

Method	Request URI
DELETE	/api/v1/unsubscribes_sms_del

요청 헤더

헤더명	설명
Authorization	로그인 또는 회원 가입 후 발급 받은 토큰키 입력 Bearer {토큰값}
Content-Type	application/json

요청 파라미터

name	type	desc	default	requirement
clientTelNo	string	수신거부 번호 한번 요청에 1000건까지 요청 가능(List)	N	N

오류 코드

공통 오류

HttpStatusCode	ErrorCode	ErrorMessage	Description
400	100	Bad Request Exception	protocol(https), endocing(UTF-8) 등 request 오류
401	200	Authentication Failed	인증실패
401	210	Permission Denied	권한없음
404	300	Not Found Exception	권한없음
429	400	Quota Exceeded	Quota 초과
429	410	Throttle Limited	Rate 초과
429	420	Rate Limited	Rate 초과
413	430	Request Entity Too Large	content-length 초과 (10MB)
503	500	Endpoint Error	엔드포인트 연결오류
504	510	Endpoint Timeout	엔드포인트 연결시간 초과
500	900	Unexpected Error	예외처리가 안된 오류