SMS API

Prev Next
https://sens.apigw.fin-ntruss.com/sms/v2
HTTP
참고

네이버 클라우드 플랫폼에서 제공되는 Simple & Easy Notification Service 의 API는 금융 보안 요건에 따라 인터넷을 통합 접근이 불가능합니다. 인터넷을 통한 접근이 필요할 경우 SSL VPN을 통해서만 접근할 수 있습니다. SSL VPN 접속에 대한 자세한 설명은 네이버 클라우드 플랫폼 포털 이용 안내를 참조해 주십시오.

SENS SMS API Swagger 바로가기

항목 Mandatory 설명
Content-Type Mandatory 요청 Body Content Type을 application/json으로 지정 (POST)
x-ncp-apigw-timestamp Mandatory 1970년 1월 1일 00:00:00 협정 세계시(UTC)부터의 경과 시간을 밀리초(Millisecond)로 나타낸 것이다.
API Gateway 서버와 시간차가 5분 이상 나는 경우 유효하지 않은 요청으로 간주
x-ncp-iam-access-key Mandatory 포탈 또는 Sub Account에서 발급받은 Access Key ID
x-ncp-apigw-signature-v2 Mandatory 위 예제의 Body를 Access Key Id와 맵핑되는 SecretKey로 암호화한 서명
HMAC 암호화 알고리즘은 HmacSHA256 사용

NAVER Cloud Platform 인증키 및 Signature 생성 가이드 바로가기

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

요청 URL

POST https://sens.apigw.fin-ntruss.com/sms/v2/services/{serviceId}/messages

Content-Type: application/json; charset=utf-8
x-ncp-apigw-timestamp: {Timestamp}
x-ncp-iam-access-key: {Sub Account Access Key}
x-ncp-apigw-signature-v2: {API Gateway Signature}
HTTP

Path Variables

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

Headers

요청 Body

{
    "type":"(SMS | LMS | MMS)",
    "contentType":"(COMM | AD)",
    "countryCode":"string",
    "from":"string",
    "subject":"string",
    "content":"string",
    "messages":[
        {
            "to":"string",
            "subject":"string",
            "content":"string"
        }
    ],
    "files":[
        {
            "fileId": "string"
        }
    ],
    "reserveTime": "yyyy-MM-dd HH:mm",
    "reserveTimeZone": "string"
}
JSON
항목 Mandatory Type 설명 비고
type Mandatory String SMS Type SMS, LMS, MMS (소문자 가능)
contentType Optional String 메시지 Type COMM: 일반메시지
AD: 광고메시지
(default: COMM)
countryCode Optional String 국가번호 SENS에서 제공하는 국가로의 발송만 가능
(default: 82)
국제 SMS 발송 국가 목록
from Mandatory String 발신번호 사전 등록된 발신번호만 사용 가능
subject Optional String 기본 메시지 제목 LMS, MMS에서만 사용 가능
- LMS, MMS: 최대 40byte
content Mandatory String 기본 메시지 내용 SMS: 최대 90byte
LMS, MMS: 최대 2000byte
messages Mandatory Object 메시지 정보 아래 항목들 참조 (messages.XXX)
최대 100개
messages.to Mandatory String 수신번호 - 를 제외한 숫자만 입력 가능
messages.subject Optional String 개별 메시지 제목 LMS, MMS에서만 사용 가능
- LMS, MMS: 최대 40byte
messages.content Optional String 개별 메시지 내용 SMS: 최대 90byte
LMS, MMS: 최대 2000byte
files.fileId Optional String 파일 아이디 MMS에서만 사용 가능
파일 업로드 참조
reserveTime Optional String 예약 일시 메시지 발송 예약 일시 (yyyy-MM-dd HH:mm)
reserveTimeZone Optional String 예약 일시 타임존 예약 일시 타임존 (기본: Asia/Seoul)
* 지원 타임존 목록
* TZ database name 값 사용
  • 최대 지원 가능한 사이즈 초과 시 잘림 처리되어 발송 됩니다.
  • 메시지(subject, content) 인코딩은 EUC-KR 기준으로 발송되며, 지원하지 않는 이모지 문자 포함 시 발송에 실패합니다.
  • messages 내에 subject, content를 정의하지 않으면 기본 subject, content로 지정된 값으로 발송 됩니다.
  • messages 내에 subject, content가 기본 subject, content 보다 우선순위가 높습니다.
  • type이 MMS인데 첨부하려는 파일이 없는경우 LMS로 발송됩니다.

응답 Body

{
    "requestId":"string",
    "requestTime":"string",
    "statusCode":"string",
    "statusName":"string"
}
JSON
항목 Mandatory Type 설명 비고
requestId Mandatory String 요청 아이디
requestTime Mandatory DateTime 요청 시간 yyyy-MM-dd'T'HH:mm:ss.SSS
statusCode Mandatory String 요청 상태 코드 202 - 성공
그외 - 실패
* HTTP Status 규격을 따름
statusName Mandatory String 요청 상태명 success - 성공
fail - 실패

응답 Status

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

MMS 발송을 위한 파일을 업로드합니다.

요청 URL

POST https://sens.apigw.fin-ntruss.com/sms/v2/services/{serviceId}/files

Content-Type: application/json; charset=utf-8
x-ncp-apigw-timestamp: {Timestamp}
x-ncp-iam-access-key: {Sub Account Access Key}
x-ncp-apigw-signature-v2: {API Gateway Signature}
HTTP

Path Variables

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

Headers

요청 Body

{
    "fileName":"string",
    "fileBody":"string"
}
JSON
항목 Mandatory Type 설명 비고
fileName Mandatory String 파일 이름 - .jpg, .jpeg 확장자를 가진 파일 이름
- 최대 40자
fileBody Mandatory String 파일 바디 - .jpg, .jpeg 이미지를 Base64로 인코딩한 값
- 원 파일 기준 최대 300Kbyte
- 해상도 최대 1500 * 1440
참고

업로드하려는 파일명과 파일크기와 동일한 파일이 이미 존재하는 경우, 동일한 파일로 인지하여 파일을 재사용 합니다. (6일 보관)

응답 Body

{
    "fileId":"string",
    "createTime":"string",
    "expireTime":"string"
}
JSON
항목 Mandatory Type 설명 비고
fileId Mandatory String 파일 아이디 MMS 메시지 발송 시 활용
createTime Mandatory DateTime 파일 업로드 시간
expireTime Mandatory DateTime 파일 만료 시간

응답 Status

HTTP Status Desc
200 OK (업로드 완료)
400 Bad Request
401 Unauthorized
403 Forbidden
404 Not Found
429 Too Many Requests
500 Internal Server Error

메시지 발송 요청을 조회합니다.

요청 URL

GET https://sens.apigw.fin-ntruss.com/sms/v2/services/{serviceId}/messages

x-ncp-apigw-timestamp: {Timestamp}
x-ncp-iam-access-key: {Sub Account Access Key}
x-ncp-apigw-signature-v2: {API Gateway Signature}

HTTP

Path Variables

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

Parameters

항목 Mandatory Type 설명 비고
requestId Mandatory String 요청 아이디 발송 요청 아이디
requestStartTime Mandatory String 조회 시간 시작 시각 yyyy-MM-dd HH:mm:ss
requestEndTime Mandatory String 조회 시간 종료 시각 yyyy-MM-dd HH:mm:ss
completeStartTime Mandatory String 발송 완료 시작 시간 yyyy-MM-dd HH:mm:ss
completeEndTime Mandatory String 발송 완료 종료 시간 yyyy-MM-dd HH:mm:ss
messageId Optional String 메시지 아이디
type Optional String 메세지 타입 SMS, LMS, MMS
contentType Optional String 콘텐츠 타입 - COMM: 일반 메시지
- AD: 광고 메시지
countryCode Optional String 국가 코드
status Optional String 발송 요청 상태 - READY: 대기
- PROCESSING: 처리 중
- COMPLETED: 처리 완료
from Optional String 메세지 발신 번호 붙임표 (-)를 제외한 번호
to Optional String 메세지 수신 번호 붙임표 (-)를 제외한 번호
statusName Optional String 단말 수신 상태 - SUCCESS: 성공
- FAIL: 실패
nextToken Optional String 다음 페이지 토큰 아래 참고 내용 참조
pageSize Optional Integer 페이지 크기 default: 20, max: 100
requestId를 포함한 조회시, default: 1000
참고
  • 메시지 발송 이력은 최근 90일 이내의 이력만 조회할 수 있습니다.
  • requestId 또는 requestStartTime + requestEndTime 또는 completeStartTime + completeEndTime 중에 하나는 필수입니다.
  • requestStartTime + requestEndTime과 completeStartTime + completeEndTime은 동시에 사용할 수 없습니다.
  • requestStartTime ~ requestEndTime의 조회 범위는 최대 30일로 제한됩니다.
  • completeStartTime ~ completeEndTime의 조회 범위는 최대 24시간으로 제한됩니다.
  • nextToken
    • 이전 요청에서 nextToken 응답을 받은 경우에만 유효하며, 다음 페이지의 결과를 요청할 수 있음을 나타냅니다. 추가 결과가 있는 경우, 이전 응답의 nextToken 값을 이 Parameter에 설정하면 다음 페이지의 결과를 조회할 수 있습니다.

Headers

API Header 바로가기

요청 Body

없음
JSON

응답 Body

{
    "statusCode": "string",
    "statusName": "string",
    "messages": [
        {
            "requestId": "string",
            "messageId": "string",
            "requestTime": "string",
            "contentType": "string",
            "type": "string",
            "countryCode": "string",
            "from": "string",
            "to": "string",
            "completeTime": "string",
            "telcoCode": "string",
            "status": "string",
            "statusCode": "string",
            "statusName": "string",
            "statusMessage": "string"
        }
    ],
    "pageSize": "integer",
    "nextToken": "string",
    "itemCount": "integer",
    "hasMore": "boolean"
}
JSON
항목 Mandatory Type 설명 비고
statusCode Mandatory String 메시징 서버로의 발송 요청 상태 - 202: 성공
- 그 외: 실패
- HTTP Status 규격을 따름
statusName Mandatory String 메시징 서버로의 발송 요청 상태명 - success: 성공
- reserved: 예약 중
- fail: 실패
messages.requestId Mandatory String 메시지 요청 아이디
messages.messageId Mandatory String 메시지 아이디
messages.requestTime Mandatory String 발송 요청 시간 yyyy-MM-dd HH:mm:ss
messages.contentType Mandatory String 메시지 Type - COMM: 일반 메시지
- AD: 광고 메시지
messages.countryCode Mandatory String 국가 번호
messages.from Mandatory String 발신번호
messages.to Mandatory String 수신번호
messages.status Mandatory String 발송 요청 상태 - READY: 대기
- PROCESSING: 처리 중
- COMPLETED: 처리 완료
messages.statusCode Optional String 단말 수신 상태 결과 코드 - 0: 성공
- 그 외: 실패 (오류 코드 표 참고
messages.statusName Optional String 단말 수신 상태 결과명 - success: 성공
- fail: 실패
messages.statusMessage Optional String 단말 수신 상태 결과 메시지
messages.completeTime Optional String 발송 완료 시간 yyyy-MM-dd HH:mm:ss
messages.telcoCode Optional String 통신사코드
pageSize Mandatory Integer 페이지 사이즈
nextToken Optional String 다음 페이지 토큰 아래 참고 내용 참조
itemCount Mandatory Integer 조회한 페이지 내의 메시지 수
hasMore Mandatory Boolean 다음 페이지 존재 여부
참고

요청 상태가 완료(status: COMPLETED)가 되기 전에는 수신 결과에 해당하는 아래 필드들은 조회되지 않습니다.

  • statusCode
  • statusName
  • statusMessage
  • completeTime
  • telcoCode

메시징 서버로의 발송 요청 상태명이 reserved(예약중)인 경우에는, messages 필드들은 조회되지 않습니다.

  • nextToken
    • 조회된 결과의 다음 페이지가 존재하는 경우에만 nextToken 이 응답에 포함됩니다. nextToken 값을 요청 조회 API Parameter에 설정하면 다음 페이지의 결과를 조회할 수 있습니다.

응답 Status

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

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

요청 URL

GET https://sens.apigw.fin-ntruss.com/sms/v2/services/{serviceId}/messages/{messageId}

x-ncp-apigw-timestamp: {Timestamp}
x-ncp-iam-access-key: {Sub Account Access Key}
x-ncp-apigw-signature-v2: {API Gateway Signature}
HTTP

Path Variables

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

Headers

요청 Body

없음
JSON

응답 Body

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

메시지 발송 결과 이력은 최근 90일 이내의 이력만 조회할 수 있습니다.

응답 Status

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

메시지 발송 예약 상태를 조회합니다.

GET https://sens.apigw.fin-ntruss.com/sms/v2/services/{serviceId}/reservations/{reserveId}/reserve-status

x-ncp-apigw-timestamp: {Timestamp}
x-ncp-iam-access-key: {Sub Account Access Key}
x-ncp-apigw-signature-v2: {API Gateway Signature}
HTTP

Path Variables

항목 Mandatory Type 설명 비고
serviceId Mandatory String 서비스 아이디 프로젝트 등록 시 발급받은 서비스 아이디
reserveId Mandatory String 예약 메시지 아이디 예약 발송 요청 조회 시 반환되는 메시지 식별자(requestId)

Headers

요청 Body

없음
JSON

응답 Body

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

메시지 발송 예약을 취소합니다.

DELETE https://sens.apigw.fin-ntruss.com/sms/v2/services/{serviceId}/reservations/{reserveId}

x-ncp-apigw-timestamp: {Timestamp}
x-ncp-iam-access-key: {Sub Account Access Key}
x-ncp-apigw-signature-v2: {API Gateway Signature}
HTTP

Path Variables

항목 Mandatory Type 설명 비고
serviceId Mandatory String 서비스 아이디 프로젝트 등록 시 발급받은 서비스 아이디
reserveId Mandatory String 예약 메시지 아이디 예약 발송 요청 조회시 반환되는 메시지 식별자(requestId)

Headers

요청 Body

없음
JSON

응답 Body

없음
JSON

응답 Status

HTTP Status Desc
204 No Content (삭제 완료)
400 Bad Request
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

수신거부된 번호를 조회합니다.

요청 URL

GET https://sens.apigw.fin-ntruss.com/sms/v2/services/{serviceId}/unsubscribes

Content-Type: application/json; charset=utf-8
x-ncp-apigw-timestamp: {Timestamp}
x-ncp-iam-access-key: {Sub Account Access Key}
x-ncp-apigw-signature-v2: {API Gateway Signature}
HTTP

Path Variables

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

Parameters

항목 Mandatory Type 설명 비고
clientTelNo Optional String 수신거부 번호 080 서비스 번호에 등록된 수신거부 번호
pageSize Optional Integer 페이지 사이즈 default: 100
0 ~ 100 사이의 숫자만 입력 가능
pageIndex Optional Integer 페이지 인덱스 default: 0
startTime Optional Integer 조회 시작 시간 수신거부 등록 시간 기준
default: 전체
endTime Optional Integer 조회 종료 시간 수신거부 등록 시간 기준
default: 전체

Headers

요청 Body

없음
JSON

응답 Body

[
    {
     "clientTelNo": "string",
     "registerTime": "string",
     "registerType": "char"
    }
]
JSON
항목 Mandatory Type 설명 비고
clientTelNo Mandatory String 수신거부 번호
registerTime Mandatory String 등록 시간 foramt: LocalDateTime
registerType Mandatory Char 등록 수단 M(manual): 수동 등록
C(call): 전화 등록

응답 Status

HTTP Status Desc
200 OK
400 Bad Request
401 Unauthorized
403 Forbidden
404 Not Found
429 Too Many Requests
500 Internal Server Error

수신거부할 번호를 등록합니다.

요청 URL

POST https://sens.apigw.fin-ntruss.com/sms/v2/services/{serviceId}/unsubscribes

Content-Type: application/json; charset=utf-8
x-ncp-apigw-timestamp: {Timestamp}
x-ncp-iam-access-key: {Sub Account Access Key}
x-ncp-apigw-signature-v2: {API Gateway Signature}
HTTP

Path Variables

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

Parameters

없음
Plain text

Headers

요청 Body

[
    {
        "clientTelNo":"string"
    }
]
JSON
항목 Mandatory Type 설명 비고
clientTelNo Mandatory String 수신거부 번호 한번 요청에 1000건까지 요청 가능(List)

응답 Body

[
    {
        "clientTelNo": "string",
        "registerTime": "string",
        "registerType": "char"
    }
]
JSON
항목 Mandatory Type 설명 비고
clientTelNo Mandatory String 수신거부 번호
registerTime Mandatory String 등록 시간 foramt: LocalDateTime
registerType Mandatory Char 등록 수단 M(manual): 수동 등록
C(call): 전화 등록

응답 Status

HTTP Status Desc
200 OK
400 Bad Request
401 Unauthorized
403 Forbidden
404 Not Found
429 Too Many Requests
500 Internal Server Error

수신거부된 번호를 삭제합니다.

요청 URL

DELETE https://sens.apigw.fin-ntruss.com/sms/v2/services/{serviceId}/unsubscribes

Content-Type: application/json; charset=utf-8
x-ncp-apigw-timestamp: {Timestamp}
x-ncp-iam-access-key: {Sub Account Access Key}
x-ncp-apigw-signature-v2: {API Gateway Signature}
HTTP

Path Variables

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

Parameters

없음
Plain text

Headers

요청 Body

[
    {
        "clientTelNo":"string"
    }
]
JSON
항목 Mandatory Type 설명 비고
clientTelNo Mandatory String 수신거부 번호 한번 요청에 1000건까지 요청 가능(List)

응답 Body

없음
JSON

응답 Status

HTTP Status Desc
204 No Content(삭제 완료)
400 Bad Request
401 Unauthorized
403 Forbidden
404 Not Found
429 Too Many Requests
500 Internal Server Error

일반 메시지

{
    "type":"SMS",
    "contentType":"COMM",
    "countryCode":"82",
    "from":"01012345678",
    "content":"내용",
    "messages":[
        {
            "to":"01012345678",
            "content":"위의 content와 별도로 해당 번호로만 보내는 내용(optional)"
        }
    ]
}
JSON

예약 메시지

{
    "reserveTime":"2019-07-25 17:09",
    "type":"SMS",
    "contentType":"COMM",
    "countryCode":"82",
    "from":"01012345678",
    "content":"내용",
    "messages":[
        {
            "to":"01012345678",
            "content":"위의 content와 별도로 해당 번호로만 보내는 내용(optional)"
        }
    ]
}
JSON

광고 메시지

{
    "type":"SMS",
    "contentType":"AD",
    "countryCode":"82",
    "from":"01012345678",
    "content":"(광고) 업체명 내용 [무료 수신거부]08012345678",
    "messages":[
        {
            "to":"01012345678",
            "content":"(광고) 업체명 위의 content와 별도로 해당 번호로만 보내는 내용(optional) [무료 수신거부]08012345678"
        }
    ]
}
JSON

일반 메시지

{
    "type":"LMS",
    "contentType":"COMM",
    "from":"01012345678",
    "subject":"제목",
    "content":"내용",
    "messages":[
        {
            "to":"01012345678",
            "subject":"위의 content와 별도로 해당 번호로만 보내는 제목(optional)",
            "content":"위의 content와 별도로 해당 번호로만 보내는 내용(optional)"
        }
    ]
}
JSON

예약 메시지

{
    "reserveTime":"2019-07-25 17:09",
    "type":"LMS",
    "contentType":"COMM",
    "from":"01012345678",
    "subject":"제목",
    "content":"내용",
    "messages":[
        {
            "to":"01012345678",
            "subject":"위의 content와 별도로 해당 번호로만 보내는 제목(optional)",
            "content":"위의 content와 별도로 해당 번호로만 보내는 내용(optional)"
        }
    ]
}
JSON

광고 메시지

{
    "type":"LMS",
    "contentType":"AD",
    "from":"01012345678",
    "subject":"제목",
    "content":"(광고) 업체명 내용 [무료 수신거부]08012345678",
    "messages":[
        {
            "to":"01012345678",
            "subject":"위의 content와 별도로 해당 번호로만 보내는 제목(optional)",
            "content":"(광고) 업체명 위의 content와 별도로 해당 번호로만 보내는 내용(optional) [무료 수신거부]08012345678"
        }
    ]
}
JSON

일반 메시지

{
    "type":"MMS",
    "contentType":"COMM",
    "from":"01012345678",
    "subject":"제목",
    "content":"내용",
    "messages":[
        {
            "to":"01012345678",
            "subject":"위의 content와 별도로 해당 번호로만 보내는 제목(optional)",
            "content":"위의 content와 별도로 해당 번호로만 보내는 내용(optional)"
        }
    ],
    "files":[
        {
            "fileId": "4fe2078b-5926-42f2-b6b3-0c7bab9b8c5a"
        }
    ]
}
JSON

예약 메시지

{
    "reserveTime":"2019-07-25 17:09",
    "type":"MMS",
    "contentType":"COMM",
    "from":"01012345678",
    "subject":"제목",
    "content":"내용",
    "messages":[
        {
            "to":"01012345678",
            "subject":"위의 content와 별도로 해당 번호로만 보내는 제목(optional)",
            "content":"위의 content와 별도로 해당 번호로만 보내는 내용(optional)"
        }
    ],
    "files":[
        {
            "fileId": "4fe2078b-5926-42f2-b6b3-0c7bab9b8c5a"
        }
    ]
}
JSON

광고 메시지

{
    "type":"MMS",
    "contentType":"AD",
    "from":"01012345678",
    "subject":"제목",
    "content":"(광고) 업체명 내용 [무료 수신거부]08012345678",
    "messages":[
        {
            "to":"01012345678",
            "subject":"위의 content와 별도로 해당 번호로만 보내는 제목(optional)",
            "content":"(광고) 업체명 위의 content와 별도로 해당 번호로만 보내는 내용(optional) [무료 수신거부]08012345678"
        }
    ],
    "files":[
        {
            "fileId": "4fe2078b-5926-42f2-b6b3-0c7bab9b8c5a"
        }
    ]
}
JSON
  • EMMA Version : EMMA V3.5.1 이상
  • IB G/W Report Code : 이통사 전송 후 받은 결과코드
  • IB G/W Response Code : 중계사 G/W가 메시지 수신후 주는 결과코드
  • IB EMMA : EMMA가 메시지 전송 요청에 대해 처리한 에러코드
코드 분류 의미
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 발신번호 사전등록제를 통해 등록되지 않은 번호
코드 의미
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
S000 중계사 요청 실패 (서버 에러)
S001 중계사 요청 실패 (서버 에러)
S002 중계사 요청 실패 (잘못된 요청)
S003 중계사 요청 실패 (스팸 처리)
S004 쿼터 초과
S005 잘못된 MMS 파일
S006 MMS 파일을 찾을 수 없음
S007 MMS 파일 만료
S008 MMS 파일 크기 초과
S009 MMS 파일 해상도 초과
S010 MMS 파일 업로드 쿼터 초과
S011 MMS 파일 업로드 실패
S012 발신번호 세칙 오류
S998 예기치 못한 서버 오류
S999 기타 오류
코드 의미
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 기타오류