✉️
megabird 연동 API 사용 가이드
  • 개발 가이드
    • 시작하기
      • 연동 API 서비스 신청
      • API Key 발급
      • 템플릿 작성
        • 문자 템플릿 작성
        • 알림톡 템플릿 작성
        • 친구톡 템플릿 작성
    • API 가이드
      • 공통
      • 문자
        • 문자 발송
        • MMS 이미지 업로드
        • 문자 수신자 엑셀 업로드
      • 국제 SMS
        • 국제 SMS 발송 정책
        • 국제 SMS 발송
        • 국제 SMS 수신자 결과 상세 조회
      • 카카오톡
        • 발신채널 관리
        • 알림톡
          • 알림톡 템플릿 관리
            • 알림톡 템플릿 등록
            • 알림톡 템플릿 수정
            • 알림톡 템플릿 삭제
            • 알림톡 템플릿 검수
          • 알림톡 발송
          • 알림톡 수신자 엑셀 업로드
        • 친구톡
          • 친구톡 발송
          • 친구톡 이미지 업로드
          • 친구톡 수신자 엑셀 업로드
      • 주소록
        • 그룹 관리
        • 상세 관리
      • 조회
        • 전체 발송내역 조회
        • 발송내역 상세 조회
        • 발송결과 상세 조회
        • 실시간 발송 사용량 조회
        • 발신번호 및 템플릿 조회
    • 웹훅 가이드
      • 발송 결과 내역
Powered by GitBook
On this page
  • API 목록
  • 1. 발송내역 상세 조회 API 요청
  • 1.1 Headers
  • 1.2 Path Parameters
  • 1.3 Query String Parameters
  • 1.4 요청 예시
  • 2. 발송내역 상세 조회 API 응답
  • 2.1 Response Body Parameters
  • 2.2 응답 예시
  • 2.3 발송 결과 코드
  1. 개발 가이드
  2. API 가이드
  3. 국제 SMS

국제 SMS 수신자 결과 상세 조회

국제 SMS의 발송 수신자 상세 결과가 조회 가능한 API

Previous국제 SMS 발송Next카카오톡

Last updated 4 months ago

와 는 공통 조회 API를 사용하시면 됩니다.

API 목록

NO
Method
API
설명

1

GET

/v1/openapi/globalsms/receiver/{msgGrpNo}

발송내역 상세 조회 API

1. 발송내역 상세 조회 API 요청

GEThttps://api.megabird.co.kr:8080/v1/openapi/globalsms/receiver/{msgGrpNo}

1.1 Headers

헤더명
타입
설명

Authorization*

String

발급받은 API Key

Content-Type*

String

application/json

1.2 Path Parameters

파라미터명
타입
필수여부
설명
예시

msgGrpNo

String

필수

메시지그룹번호

12341

1.3 Query String Parameters

파라미터명
타입
필수여부
설명
예시

mblnum

String

수신자번호

811012341234

sndStsCd

String

발송상태코드 MTC(발송완료), MTF(발송실패), MTN(확인불가)

MTC

page

Integer

페이지번호 ( Default : 1 )

1

offset

Integer

페이지별 행 건수 ( Default : 10 )

20

1.4 요청 예시

https://api.megabird.co.kr:8080/v1/openapi/globalsms/receiver/{12345}?mblnum=8612341234

2. 발송내역 상세 조회 API 응답

2.1 Response Body Parameters

파라미터명
타입
설명

totalCount

int

총 조회 결과수

mblnum

String

수신자번호

svcKndCd

String

서비스종류코드

svcKndCdNm

String

서비스종류코드명

country

String

수신자 국가명

messageCount

int

과금건수 1건의 발송이여도 메시지 글자 수에 따라 실과금건수가 상이합니다.

varJson

Map

치환변수

sndStsCd

String

발송상태코드 (MTC-발송완료, MTF-발송실패)

sndStsCdNm

String

발송상태코드명

sndRstCd

String

sndStsCzCmt

String

발송결과사유

regDtt

String

등록일시

sndCplDtt

String

발송완료일시

2.2 응답 예시

{
    "code": "0000",
    "result": {
        "totalCount": 2,
        "result": [
            {
                "mblnum": "861234444",
                "svcKndCd": "GLOBALSMS",
                "svcKndCdNm": "국제SMS",
                "country": "CHINA",
                "messageCount": 0,
                "varJson": null,
                "sndStsCd": "MTF",
                "sndStsCdNm": "발송실패",
                "sndRstCd": "-2019",
                "sndStsCzCmt": "RecipientNo is invalid.",
                "regDtt": "2024-08-14T17:41:20",
                "sndCplDtt": "2024-08-14T17:41:28"
            },
            {
                "mblnum": "8617885881187",
                "svcKndCd": "GLOBALSMS",
                "svcKndCdNm": "국제SMS",
                "country": "CHINA",
                "messageCount": 2,
                "varJson": {
                    "#{code}": "123456",
                },
                "sndStsCd": "MTC",
                "sndStsCdNm": "발송완료",
                "sndRstCd": "1000",
                "sndStsCzCmt": "SUCCESS",
                "regDtt": "2024-08-12T13:54:56",
                "sndCplDtt": "2024-08-12T13:55:07"
            }
        ]
    }
}

2.3 발송 결과 코드

결과 코드
코드 설명 국문
코드 설명 영문

1000

성공

SUCCESS

4

파라미터 유효성 검증 실패

-1000

유효하지 않은 앱키

Invalid appKey.

-1001

존재하지 않는 앱키

Service is not exist.

-1002

사용 종료된 앱키

Service is disabled.

-1003

프로젝트에 포함되지 않는 멤버

Not project memeber id.

-1004

허용되지 않는 IP

Not allow ip.

-1007

유효하지 않은 멤버

MemberType is invalid.

-1008

차단된 프로젝트

Service is blocked.

-9995

유효하지 않는 API 버전

Invalid api version.

-9996

유효하지 않는 contentType. Only application/JSON

Only application/json Content-type is supported.

-9997

유효하지 않는 JSON 형식

Invalid API parameters.

-9998

존재하지 않는 API

Not exist API.

-9999

시스템 오류(예기치 못한 오류)

System error. Please inquire at support@toast.com.

-1005

유효하지 않는 검색 조건

Service parameter is invalid.

-1006

유효하지 않는 발송 메시지(messageType) 유형

MessageType is invalid.

-2000

유효하지 않는 날짜 형식

Date format error.

-2001

수신자가 비어 있는 경우

RecipientList can not be null.

-2002

첨부 파일 이름이 잘못된 경우

Invalid attach file name.

-2003

첨부 파일 확장자가 jpg, jpeg가 아닌 경우

Attach file required jpg or jpeg.

-2004

첨부 파일이 만료되거나 존재하지 않는 경우

File is expired or does not exist.

-2005

첨부 파일 사이즈가 300KB가 넘는 경우

The file size must be greater than 0 and less than 300KB.

-2006

템플릿에 설정된 발송 유형과 요청온 발송 유형이 맞지 않는 경우

Invalid template type.

-2008

요청 ID(requestId)가 잘못된 경우

Invalid requestId.

-2009

첨부 파일 업로드 도중 서버 오류로 인해 정상적으로 업로드되지 않은 경우

Upload attach file error.

-2010

첨부 파일 업로드 유형이 잘못된 경우(서버 오류)

Upload attach file type can not be empty.

-2011

필수 조회 파라미터가 비어 있는 경우(requestId 또는 startRequestDate, endRequestdate)

RequestId or start/endRequestDate or start/endCreateDate is required.

-2012

상세 조회 파라미터가 잘못된 경우(requestId 또는 mtPr)

Search parameter is invalid.(requestId and mtPr).

-2014

제목 또는 본문이 비어 있는 경우

The recipient can not be empty.

-2015

제목 또는 본문이 초과된 경우

Title or Body exceed maximum byte.

-2016

수신자가 1,000명이 넘어간 경우

The max recipient size is 1000.

-2017

Excel 생성이 실패한 경우

Making Excel file is failed.

-2018

수신자 번호가 비어 있는 경우

RecipientNo can not be empty.

-2019

수신자 번호가 유효하지 않는 경우

RecipientNo is invalid.

-2021

시스템 오류(큐 저장 실패)

System error. Failed insert queue.

-2022

요청 일시를 현재 시간보다 이전으로 설정한 경우

RequestDate is not before currentDate.

-2023

제목 또는 본문에 허용되지 않는 문자(Emoji 등)가 포함된 경우

Unacceptable characters in title and body.

-2024

LMS/MMS로 국제 발송을 전송하는 경우

LMS/MMS Type is not sent to outside of Korea.

-2044

발송 불가능한 국가로 요청을 보낸 경우

Invalid countryCode for sending.

-2045

국제 발송을 차단한 경우

International sending blocked by service.

-2046

차단한 국가에 발송한 경우

Blocked country by service.

-2047

차단 제한 건수가 넘은 경우

Blocked by total indicator.

-2048

국제 발송 본문이 초과된 경우

International message body exceed maximum length.

-2050

국제 발송 전환에 실패한 경우(전환 가능한 상태가 아님)

Conversion status is not ready.

-2051

전환율 기반 차단으로 인해 발송에 실패한 경우

Conversion rate is lower than threshold.

-4000

조회 범위가 한달이 넘어간 경우

Search is possible within one month.

-8000

인증 발송에 인증 문구가 포함되지 않은 경우

The body must contain auth guide ment.

-2312

발신 번호가 비어 있거나 미등록 상태

Not regist sendno.

-2313

차단된 발신 번호

This sendno is blocked.

-7001

유효하지 않는 파라미터

Invalid parameter.

결과 코드
분류
의미

1001

실패

Server Busy

1002

실패

수신 번호 형식 오류

1003

실패

발신 번호 형식 오류

1019

실패

TTL 초과

2000

실패

전송 시간 초과

2001

실패

전송 실패(무선망단)

2002

실패

전송 실패(무선망 > 단말기단)

2003

실패

단말기 전원 꺼짐

2004

실패

통신사와 단말 사이에 메시지 버퍼가 가득 차 전달 불가 상태

2005

실패

음영 지역

2006

실패

메시지 삭제됨

2007

실패

일시적인 단말 문제

3000

실패

전송할 수 없음

3001

실패

가입자 없음

3002

실패

성인 인증 실패

3003

실패

수신 번호 형식 오류 또는 결번(없는 번호)

3004

실패

단말기 서비스 일시 정지

3005

실패

단말기 호 처리(Call processing) 상태, 단말에 도달하지 못함

3006

실패

착신 거절

3007

실패

콜백 URL을 받을 수 없는 단말기

3008

실패

기타 단말기 문제

3009

실패

메시지 형식 오류

3010

실패

MMS 미지원 단말

3011

실패

서버 오류

3012

실패

스팸

3013

실패

서비스 거부

3014

실패

기타

3015

실패

전송 경로 없음

3016

실패

첨부 파일 크기 제한 실패

3017

실패

발신 번호 변작 방지 서비스에 의거한 번호 형식 오류

3018

실패

발신 번호 변작 방지 서비스에 가입된 휴대폰 개인 가입자 번호

3019

실패

KISA 또는 미래부에서 모든 고객사에 대하여 차단 처리한 발신 번호

E911

실패

첨부파일 확장자가 없는 경우

E913

실패

첨부파일 크기가 0인 경우

E915

실패

중복 메시지

E919

실패

발송 제한 시간인 경우, 메시지 재발송 처리가 금지된 경우

E999

실패

기타 오류

발송결과코드 참고

발송 내역 조회 API
발송내역 상세 조회 API
2.3 발송 결과 코드