SMS API v1 가이드


기본 정보

API URL

https://api-sens.ncloud.com/v1/sms

SENS SMS API v1 Swagger 바로가기

API Header

SENS의 PUSH, 알림톡 v2 API와 사용하는 Header가 다릅니다. 주의 바랍니다.
추후 SMS API v2 버전 릴리즈시에는 NAVER CLOUD PLATFORM 공통 인증 방식과 Header를 제공할 예정입니다.

항목 Mandatory 설명
Content-Type Mandatory 요청 Body Content Type을 application/json으로 지정 (POST)
x-ncp-auth-key Mandatory 포탈 또는 Sub Account에서 발급받은 Access Key ID
x-ncp-service-secret Mandatory SENS 웹 콘솔에서 발급받은 SMS Service Secret

Auth Key 확인하기

(1) 네이버 클라우드 플랫폼 포털에 접속
(2) 계정 로그인
(3) 상단 메뉴에서 마이페이지 > 인증 키 관리]** 이동
(4) API 인증키 관리의 Access Key ID 사용 (없을 시, 신규 API 인증키 생성을 통해 신규 발급)

Service Secret 발급 가이드 바로가기


메시지

메시지 발송

SMS/LMS 메시지를 발송합니다.

요청 URL

POST https://api-sens.ncloud.com/v1/sms/services/{serviceId}/messages

Content-Type: application/json; charset=utf-8
x-ncp-auth-key: {Sub Account Access Key}
x-ncp-service-secret:  {SMS Service Secret}

Path Variables

항목 Mandatory Type 설명 비고
serviceId Mandatory String 서비스 아이디 프로젝트 등록 시 발급받은 서비스 아이디

Headers

API Header 바로가기

요청 Body

{
    "type":"(SMS | LMS)",
    "contentType":"(COMM | AD)",
    "countryCode":"string",
    "from":"string",
    "to":[
        "string"
    ],
    "subject":"string",
    "content":"string"
}
항목 Mandatory Type 설명 비고
type Madantory String SMS Type SMS, LMS (소문자 가능)
contentType Optional String 메시지 Type COMM: 일반메시지
AD: 광고메시지
(default: COMM)
countryCode Optional String 국가번호 SENS에서 제공하는 국가`로의 발송만 가능
(default: 82)
from Mandatory String 발신번호 사전 등록된 발신번호만 사용 가능
to Mandatory Array of String 수신번호 - 를 제외한 숫자만 입력 가능
subject Optional String 메시지 제목 LMS에서만 사용 가능
content Mandatory String 메시지 내용 SMS: 최대 80byte
LMS: 최대 2000byte

응답 Body

{
    "status":"200",
    "messages":[
        {
            "messageId":"string",
            "requestTime":"string",
            "contentType":"string",
            "from":"string",
            "countryCode":"string",
            "to":"string"
        }
    ]
}
항목 Mandatory Type 설명 비고
status Madantory String 메시징 서버로의 발송 요청 상태 200: 성공
그외: 실패
messages.messageId Madantory String 메시지 아이디
messages.requestTime Madantory DateTime 요청 시간
messages.contentType Madantory String 메시지 Type COMM: 일반메시지
AD: 광고메시지
messages.from Madantory String 발신번호
messages.countryCode Madantory String 수신 국가번호
messages.to Madantory String 수신번호

응답 Status

HTTP Status Desc
202 Accept (요청 완료)
400 Bad Request
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

메시지 발송 결과 조회

메시지 발송 결과를 조회합니다.

요청 URL

GET https://api-sens.ncloud.com/v1/sms/services/{serviceId}/messages/{messageId}

x-ncp-auth-key: {Sub Account Access Key}
x-ncp-service-secret:  {SMS Service Secret}

Path Variables

항목 Mandatory Type 설명 비고
serviceId Mandatory String 서비스 아이디 프로젝트 등록 시 발급받은 서비스 아이디
messageId Mandatory String 메시지 아이디 메시지 발송시 반환되는 메시지 식별자

Headers

API Header 바로가기

요청 Body

없음

응답 Body

{
    "status":"string",
    "errorMessage":"string",
    "messages":[
        {
            "messageId":"string",
            "requestTime":"string",
            "contentType":"string",
            "from":"string",
            "countryCode":"string",
            "to":"string",
            "statusCode":"string",
            "statusMessage":"string",
            "statusName":"string",
            "status":"string",
            "completeTime":"string",
            "content":"string",
            "telcoCode":"string"
        }
    ]
}
항목 Mandatory Type 설명 비고
status Madantory String 메시징 서버로의 발송 요청 상태 200: 성공
그외: 실패
errorMessage Optional String 발송 요청 실패 메시지 요청 실패시
messages.messageId Madantory String 메시지 아이디
messages.requestTime Madantory DateTime 요청 시간
messages.contentType Madantory String 메시지 Type COMM: 일반메시지
AD: 광고메시지
messages.from Madantory String 발신번호
messages.countryCode Madantory String 국가번호
messages.to Madantory String 수신번호
messages.statusCode Madantory String 단말 수신 상태 결과 코드 오류 코드 표 참고
messages.statusMessage Madantory String 단말 수신 상태 결과 메시지
messages.statusName Madantory String 단말 수신 상태 결과명
messages.status Madantory String 메시징 서버에서의 발송 처리 상태 READY: 대기
PROCESSING: 처리 중
COMPLETED: 처리 완료
messages.completeTime Madantory DateTime 발송 완료 시간
messages.content Madantory String 메시지 내용 발송 요청했던 content가 그대로 조회되지만,
실제 발송시에는 type별 길이 제한에 맞춰 발송
messages.telcoCode Madantory String 통신사코드

응답 Status

HTTP Status Desc
200 OK (요청 완료)
400 Bad Request
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

 

오류 코드

EMMA v.3 수신 결과 코드

  • EMMA Version : EMMA V3.5.1 이상
  • IB G/W Report Code : 이통사 전송 후 받은 결과코드
  • IB G/W Response Code : Infobank G/W가 메시지 수신후 주는 결과코드
  • IB EMMA : EMMA가 메시지 전송 요청에 대해 처리한 에러코드

IB G/W Report Code

코드 분류 의미
0 success 성공
2000 failure 전송 시간 초과
2001 failure 전송 실패 (무선망단)
2002 failure 전송 실패 (무선망 -> 단말기단)
2003 failure 단말기 전원 꺼짐
2004 failure 단말기 메시지 버퍼 풀
2005 failure 음영지역
2006 failure 메시지 삭제됨
2007 failure 일시적인 단말 문제
3000 Invalid 전송할 수 없음
3001 Invalid 가입자 없음
3002 Invalid 성인 인증 실패
3003 Invalid 수신번호 형식 오류
3004 Invalid 단말기 서비스 일시 정지
3005 Invalid 단말기 호 처리 상태
3006 Invalid 착신 거절
3007 Invalid Callback URL을 받을 수 없는 폰
3008 Invalid 기타 단말기 문제
3009 Invalid 메시지 형식 오류
3010 Invalid MMS 미지원 단말
3011 Invalid 서버 오류
3012 Invalid 스팸
3013 Invalid 서비스 거부
3014 Invalid 기타
3015 Invalid 전송 경로 없음
3016 Invalid 첨부파일 사이즈 제한 실패
3017 Invalid 발신번호 변작 방지 세칙 위반
3018 Invalid 발신번호 변작 방지 서비스에 가입된 휴대폰 개인가입자 번호
3019 Invalid KISA 또는 미래부에서 모든 고객사에 대하여 차단 처리 요청한 발신번호
3022 Invalid Charset Conversion Error
3023 Invalid 발신번호 사전등록제를 통해 등록되지 않은 번호

IB G/W Response Code

코드 의미
1001 Server Busy (RS 내부 저장 Queue Full)
1002 수신번호 형식 오류
1003 회신번호 형식 오류
1004 SPAM
1005 사용 건수 초과
1006 첨부 파일 없음
1007 첨부 파일 있음
1008 첨부 파일 저장 실패
1009 CLIENT_MSG_KEY 없음
1010 CONTENT 없음
1011 CALLBACK 없음
1012 RECIPIENT_INFO 없음
1013 SUBJECT 없음
1014 첨부 파일 KEY 없음
1015 첨부 파일 NAME 없음
1016 첨부 파일 크기 없음
1017 첨부 파일 Content 없음
1018 전송 권한 없음
1019 TTL 초과
1020 charset conversion error

IB EMMA

코드 의미
E900 Invalid-IB 전송키가 없는 경우
E901 수신번호가 없는 경우
E902 동보인 경우) 수신번호순번이 없는 경우
E903 제목 없는 경우
E904 메시지가 없는 경우
E905 회신번호가 없는 경우
E906 메시지키가 없는 경우
E907 동보 여부가 없는 경우
E908 서비스 타입이 없는 경우
E909 전송요청시각이 없는 경우
E910 TTL 타임이 없는 경우
E911 서비스 타입이 MMS MT인 경우, 첨부파일 확장자가 없는 경우
E912 서비스 타입이 MMS MT인 경우, attach_file 폴더에 첨부파일이 없는 경우
E913 서비스 타입이 MMS MT인 경우, 첨부파일 사이즈가 0인 경우
E914 서비스 타입이 MMS MT인 경우, 메시지 테이블에는 파일그룹키가 있는데 파일 테이 블에 데이터가 없는 경우
E915 중복메시지
E916 인증서버 차단번호
E917 고객DB 차단번호
E918 USER CALLBACK FAIL
E919 발송 제한 시간인 경우, 메시지 재발송 처리가 금지 된 경우
E920 서비스 타입이 LMS MT인 경우, 메시지 테이블에 파일그룹키가 있는 경우
E921 서비스 타입이 MMS MT인 경우, 메시지 테이블에 파일그룹키가 없는 경우
E922 동보단어 제약문자 사용 오류
E999 기타오류
아쉬운 점이 있다면 이야기해 주세요.
0/5000
내용을 입력해 주세요
의견 보내기