Docs
Notification
NotificationSMS

SMS

SMS 는 별도의 메시지 서버 구축 없이 다양한 메시지 알람 기능을 구현할 수 있는 서비스입니다.

공통 설정

인증키 발급

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

토큰 발급을 위한 로그인

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

발급 토큰 유효

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

메시지 발송

API URL

MethodRequest URI
POST
/api/v1/sms

요청 헤더

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

요청 파라미터

파라미터 이름타입설명기본값필수 여부
typestring

SMS Type

  • SMS, LMS, MMS (소문자 가능)
SMSY
contentTypestring

메시지 Type

  • COMM: 일반메시지
  • AD: 광고메시지
COMMN
countryCodestring국가번호 (default: 82)82N
fromstring

발신번호

  • 사전 등록된 발신번호만 사용 가능
NY
subjectstring

기본 메시지 제목

  • LMS, MMS에서만 사용 가능
NY
contentstring

기본 메시지 내용

  • SMS: 최대 80byte
  • LMS, MMS: 최대 2000byte
NY
messagesstring

메시지 정보

  • 아래 항목들 참조 (messages.XXX)
  • 최대 1,000개
NY
messages.tostring

수신번호

  • -를 제외한 숫자만 입력 가능
NY
messages.subjectstring

개별 메시지 제목

  • LMS, MMS에서만 사용 가능
NY
messages.contentstring

개별 메시지 내용

  • SMS: 최대 80byte
  • LMS, MMS: 최대 2000byte
NY
files.namestring

파일 이름

  • MMS에서만 사용 가능
  • 공백 사용 불가
  • jpg, jpeg 확장자를 가진 파일 이름
  • 최대 40자
NY
files.bodystring

파일 바디

  • MMS에서만 사용 가능
  • 공백 사용 불가
  • jpg, jpeg 이미지를 Base64로 인코딩한 값
  • 원 파일 기준 최대 300Kbyte
  • 파일 명 최대 40자
  • 해상도 최대 1500 * 1440
NN
reserveTimestring

예약 일시 메시지 발송 예약 일시
(yyyy-MM-dd HH:mm)

NN
reserveTimeZonestring

예약 일시 타임존

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

응답 바디

필드 이름타입설명
requestIdString

요청 아이디
발송시 응답받은 requestId

requestTimeDateTime요청 시간
statusCodeString

요청 상태 코드

  • 202 - 성공
  • 그외 - 실패
    (HTTP Status 규격을 따름)
statusNameString

요청 상태명

  • success - 성공
  • fail - 실패

메시지 발송 요청 조회

API URL

MethodRequest URI
GET
/api/v1/sms

요청 헤더

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

요청 파라미터

파라미터 이름타입설명기본값필수 여부
requestIdstring

요청 아이디

  • 발송시 응답받은 requestId
NY

응답 바디

필드 이름타입설명
requestIdString

요청 아이디
발송시 응답받은 requestId

statusCodeString

요청 상태 코드

  • 202 - 성공
  • 그외 - 실패
    (HTTP Status 규격을 따름)
messages.messageIdString메시지 아이디
messages.requestTimeDateTime발송 요청 시간
messages.messages_contentTypeString

메시지 Type

  • COMM: 일반메시지
  • AD: 광고메시지
messages.messages_countryCodeString국가번호
messages.messages_fromString발신번호
messages.messages_toString수신번호

예약 메시지 상태 조회

API URL

MethodRequest URI
GET
/api/v1/reserve_sms

요청 헤더

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

요청 파라미터

파라미터 이름타입설명기본값필수 여부
reserveIdstring

예약 메시지 아이디

  • 조회 시 반환되는 메시지 식별자(requestId)
NY

응답 바디

필드 이름타입설명
reserveIdString

예약 메시지 아이디

  • 조회 시 반환되는 메시지 식별자(requestId)
reserveTimeString예약 일시 메시지 발송 예약 일시
(yyyy-MM-dd HH:mm)
reserveTimeZoneString

예약 일시 타임존

  • 기본: Asia/Seoul
  • 지원 타임존 목록
    (* TZ database name 값 사용)
reserveStatusDateTime

예약 상태

  • READY - 발송 대기
  • PROCESSING - 발송 요청중
  • CANCELED - 발송 취소
  • FAIL - 발송 요청 실패
  • DONE - 발송 요청 성공
  • STALE - 발송 요청 실패 (시간 초과)

예약 메시지 취소

API URL

MethodRequest URI
DELETE
/api/v1/reserve_sms_del

요청 헤더

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

요청 파라미터

파라미터 이름타입설명기본값필수 여부
reserveIdstring

예약 메시지 아이디

  • 조회 시 반환되는 메시지 식별자(requestId)
NY

수신거부 번호 조회

API URL

MethodRequest URI
GET
/api/v1/unsubscribes_sms_get

요청 헤더

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

요청 파라미터

파라미터 이름타입설명기본값필수 여부
clientTelNostring

수신거부 번호

  • 080 서비스 번호에 등록된 수신거부 번호
NN
pageSizeInteger

페이지 사이즈

  • default: 100
  • 0 ~ 100 사이의 숫자만 입력 가능
100N
pageIndexInteger페이지 인덱스0N
startTimeInteger

조회 시작 시간

  • 수신거부 등록 시간 기준
ALLN
endTimeInteger

조회 종료 시간

  • 수신거부 등록 시간 기준
ALLN

응답 바디

필드 이름타입설명
clientTelNoString

수신거부 번호

  • 080 서비스 번호에 등록된 수신거부 번호
reserveTimeString예약 일시 메시지 발송 예약 일시
(yyyy-MM-dd HH:mm)
registerTypeChar

등록 수단

  • M(manual): 수동 등록
  • C(call): 전화 등록

수신거부 번호 등록

API URL

MethodRequest URI
POST
/api/v1/unsubscribes_sms

요청 헤더

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

요청 파라미터

파라미터 이름타입설명기본값필수 여부
clientTelNostring

수신거부 번호

  • 한번 요청에 1000건까지 요청 가능(List)
NN

응답 바디

필드 이름타입설명
clientTelNoString

수신거부 번호

  • 080 서비스 번호에 등록된 수신거부 번호
reserveTimeString예약 일시 메시지 발송 예약 일시
(yyyy-MM-dd HH:mm)
registerTypeChar

등록 수단

  • M(manual): 수동 등록
  • C(call): 전화 등록

수신거부 번호 삭제

API URL

MethodRequest URI
DELETE
/api/v1/unsubscribes_sms_del

요청 헤더

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

요청 파라미터

파라미터 이름타입설명기본값필수 여부
clientTelNostring

수신거부 번호

  • 한번 요청에 1000건까지 요청 가능(List)
NN

오류 코드

# JSON
 
{
  "error": {
    "errorCode": "300",
    "message": "Not Found Exception"
  }
}
공통 오류
HttpStatusCodeErrorCodeErrorMessageDescription
400100Bad Request Exception

protocol(https), endocing(UTF-8) 등
request 오류

401200Authentication Failed인증실패
401210Permission Denied권한없음
404300Not Found Exception권한없음
429400Quota ExceededQuota 초과
429410Throttle LimitedRate 초과
429420Rate LimitedRate 초과
413430Request Entity Too Largecontent-length 초과 (10MB)
503500Endpoint Error엔드포인트 연결오류
504510Endpoint Timeout엔드포인트 연결시간 초과
500900Unexpected Error예외처리가 안된 오류

Swagger 문서

Swagger 바로가기
Was this helpful?
Docs
© 2024 Ubion, Coursemos, Service Develop Team. All rights reserved.