API
문자API
문자API 가이드

고객센터

이용요금안내

이용가이드

API 기본정보

API명 문자발송
- SMS/LMS/MMS 문자 메시지를 발송합니다.
API URL POST - /api/sms/send.do


공통 HEADER Basic Auth

항목 Mandatory Type 설명 비고
API ID Mandatory String 애드망고 회원 ID accessKey
API KEY Mandatory String 발급받은 API KEY accessValue


요청 파라미터

항목 Mandatory Type 설명
smsType Mandatory String 문자 유형 :
SMS: 단문문자
LMS: 장문문자
MMS:포토문자 | attach는 mandatory
body Mandatory String 문자 내용
SMS : 최대 90byte
LMS, MMS : 최대 2,000byte
next line text '\n' 
attach Optional String smsType는 MMS일때만 사용

Jpg, jpeg, png 파일들을
Base64로 변환 해서 업로드
denyExclude Mandatory String 수신거부 여부
- Y
- N
adYn Mandatory String (광고)애드망고
내용
무료수신거부 0808801160
reserveYn Mandatory String 발송 형태
- Y 일때 reserveDt는 mandatory
- N
reserveDt Optional String 예약 일시
reserveYn : "Y" 일때.
년월일 시간을 입력해야 함.
divYn Optional String 분할전송여부
- Y 일때 divCnt, divGap는 mandatory
- N
divCnt Optional Integer 분할전송단위
divGap Optional Integer 분할전송간격
receiveList Mandatory String 받는 사람 전화 번호 목록
receiveList.receive Mandatory String 받는 사람 전화 번호
receiveList.name Optional String # {항목1} - 값 입력
receiveList.item2 Optional String # {항목2} - 값 입력
receiveList.item3 Optional String # {항목3} - 값 입력
receiveList.item4 Optional String # {항목4} - 값 입력
receiveList.item5 Optional String # {항목5} - 값 입력
receiveList.item6 Optional String # {항목6} - 값 입력
receiveList.item7 Optional String # {항목7} - 값 입력
receiveList.item8 Optional String # {항목8} - 값 입력
receiveList.item9 Optional String # {항목9} - 값 입력
receiveList.item10 Optional String # {항목10} - 값 입력


요청 예시(Json)

요청 
{
   "smsType": "SMS",
   "body": "test api sms",
   "callback": "010-1234-5678",
   "adYn": "Y",
   "reserveYn": "N",
   "denyExclude": "N",
   "divYn": "Y",
   "receiveList":[
     {
        "receive":"010-1231-2312"
        "name" : "애드망고01",
        "item2" : "item2"
     },
     {
        "receive":"010-1231-2314"
        "name" : "애드망고02",
        "item2" : "item2 test"
     }
   ]
}


응답 파라미터

항목 Mandatory Type 설명 비고
code Mandatory String 응답 코드 0 : 성공
그 외 : 실패
message Mandatory String 응답 메시지 성공 : '문자 발송에 성공하였습니다.'
기타 : 그 외 메시지
data.name Mandatory String 사용자 이름  
data.smsStatsSeq Mandatory Integer 메시지 아이디 예약문자 취소 시 사용


응답 예시(Json)

성공시 
{
   "code": "0",
   "message": "문자 발송에 성공하였습니다.",
   "data": {
      "name": "애드망고",
      "messageId": 86
   }
}
기타 
{
   "code": "3000",
   "message": "메세지 내용이 비어있습니다.",
   "data": null
}



예약문자 발송 취소

API명 예약문자 발송 취소
- 발송한 예약문자를 취소합니다.
API URL PUT - /api/sms/reservation/cancel.do?smsStatsSeq={smsStatsSeq}

공통 HEADER

항목 Mandatory Type 설명
API ID Mandatory String 애드망고 회원 ID
API KEY Mandatory String 발급받은 API KEY

주소 파라미터

항목 Mandatory Type 설명 비고
smsStatsSeq Mandatory Integer 메세지 아이디 예약문자 취소 시 사용

요청 파라미터

항목 Mandatory Type 설명 비고
N / A        

요청 예시(Json)

요청 N / A

응답 파라미터

항목 Mandatory Type 설명 비고
code Mandatory String 응답 코드 0 : 성공
그 외 : 실패
message Mandatory String 응답 메시지 성공 : '예약 문자 발송 취소에 성공하였습니다.'
기타 : 그 외 메시지

응답 예시(Json)

성공시 
{
   "code": "0",
   "message": "예약 문자 발송 취소에 성공하였습니다."
}
기타 
{
   "code": "",
   "message": "존재 하지 않는 문자 입니다."
}

문자 리스트 조회

API명 문자 리스트 조회
- 발송한 문자 리스트를 조회합니다.
API URL GET - /api/sms/list.do

공통 HEADER

항목 Mandatory Type 설명 비고
API ID Mandatory String 애드망고 회원 ID
API KEY Mandatory String 발급받은 API KEY

주소 파라미터

항목 Mandatory Type 설명 비고
N / A

요청 파라미터

항목 Mandatory Type 설명 비고
smsType Optional String 문자 유형 SMS : 단문문자
LMS : 장문문자
MMS : 포토문자
DEFAULT ''(전체조회)
page Optional Integer 페이지 수  
pageSize Optional Integer 한 페이지에 몇개를 보여 줄 건지 default : 10로 되어 있음
startDate Optional String 검색 시작 날짜  
endDate Optional String 검색 끝 날짜  

요청 예시(Json)

요청 

{
   "smsType" : "",
   "searchWord" : "",
   "pageSize" : 20,
   "page" : 1
}

응답 파라미터

항목 Mandatory Type 설명 비고
code Mandatory String 응답 코드 0 : 성공
그 외 : 실패
message Mandatory String 응답 메시지 성공 : '문자 발송 리스트 조회에 성공하였습니다.'
기타 : 그 외 메시지
totalCount Mandatory Integer 데이터 리스트 총 카운트
totalPage Mandatory Integer 총 페이즈 수  
data.messageId Optional Integer 메세지 아이디 예약문자 취소 시 사용
data.smsType Optional String 실제 발송 문자 유형  SMS, LMS, MMS
data.sendNumber Optional String 발신번호 발신번호 : 하이픈 결합 후 전송
data.message Optional String 문자 내용 문자 내용
data.totalCnt Optional Integer 총 발송수량  
data.successCnt Optional Integer 발송 성공 수량  
data.waitCnt Optional Integer 발송 대기 수량  
data.failCnt Optional Integer 발송 실패 수량  
data.regDate Optional String 문자 발송 일시 1/10/2021 12:00
data.reserveName Optional String 문자 발송 형태 즉시발송, 예약발송
data.reserveDate Optional String 예약 일시 예약문자일 경우
data.divName Optional String 분할전송여부 일반전송,분할전송
data.divCnt Optional Integer 분할전송단위 일반전송일 경우 0
data.divGap Optional Integer 분할전송간격 단위는 분, 일반전송일 경우 0

응답 예시(Json)

성공시 
{
   "code": "200",
   "message": "문자 발송 리스트 조회에 성공하였습니다.",
   "totalCount": 35,
   "totalPage": 1,
   "data": [
   {
      "messageId": "81",
      "smsType": "SMS",
      "sendNumber": "010-1234-5678",
      "message": "(광고)회사명 \nqwerqwerqwerqwer\n무료수신거부 08012345678",
      "totalCnt": 1,
      "successCnt": 0,
      "waitCnt": 1,
      "failCnt": 0,
      "regDate": "2022-09-20 15:30:04",
      "reserveName": "즉시",
      "reserveDate": null,
      "divName": "일반전송",
      "divCnt": 0,
      "divGap": 0
   }
   ]
}
기타 

{
   "code": "0",
   "totalCount": 0,
   "message" :  "문자 발송 리스트 조회에 성공하였습니다.",
   "data" : null
}

API 기본정보

API명 문자 리스트 조회
- 발송한 문자 내용을 상세 조회합니다.
API URL GET - /api/sms/detail.do?smsStatsSeq={smsStatsSeq}

공통 HEADER

항목 Mandatory Type 설명
API ID Mandatory String 애드망고 회원 ID
API KEY Mandatory String 발급받은 API KEY

주소 파라미터

항목 Mandatory Type 설명 비고
smsSeq Mandatory Integer sms ID 예약문자 취소 시 사용

요청 파라미터

항목 Mandatory Type 설명 비고
offset Optional Integer 요청 레코드 기본값 : 0
limit Optional Integer 요청 갯수 요청 레코드부터 갯수(기본값 : 10 최대값 : 100)

응답 파라미터

항목 Mandatory Type 설명 비고
code Mandatory String 응답 코드 0 : 성공
그 외 : 실패
message Mandatory String 응답 메시지  성공 : '문자 발송 상세 조회에 성공하였습니다.'
기타 : 그 외 메시지
data.messageId Mandatory Integer 메세지 아이디 예약문자 취소 시 사용
data.smsType Mandatory String 실제 발송 문자 유형 SMS, LMS, MMS
data.sendNumber Mandatory String 발신번호 발신번호
data.message Mandatory String 문자 내용 문자 내용
data.totalCnt Optional Integer 전체 발송 수량  
data.successCnt Optional Integer 성공 수량  
data.waitCnt Optional Integer 대기 수량  
data.failCnt Optional Integer 실패 수량  
data.regDate Optional String 문자 발송 문자 발송 일자 시간
예)2019-01-17 18:13
data.reserveName Optional String 수신자 명 수신자 명
data.reserveDate Optional String 예약 일시 예약문자일 경우
예)2021-01-11 18:50
data.divName Optional String 분할전송여부 일반전송,분할전송
data.divCnt Optional Integer 분할전송단위 일반전송일 경우 0
data.divGap Optional Integer 분할전송간격 일반전송일 경우 0
data.receiveListCount Optional Integer 수신자 목록 카운트 총 카운트
data.receiveListPageCount Optional Integer 수신자 목록 페이지 카운트  
data.received.receivedNumber Optional String 수신자 번호 수신자 번호
data.received.resultName Optional String 수신자 명 수신자 명
data.received.result Optional String 문자 수신 결과 코드

응답 예시(Json)

성공시 
{
   "code": "0",
   "message": "문자 발송에 성공하였습니다.",
   "data": {
      "messageId": "30",
      "smsType": "SMS",
      "sendNumber": "010-1234-1234",
      "message": "test msg88888",
      "totalCnt": 2,
      "successCnt": 0,
      "waitCnt": 2,
      "failCnt": 0,
      "regDate": "2022-09-16 14:37:59",
      "reserveName": "즉시",
      "reserveDate": null,
      "divName": "분할전송",
      "divCnt": 100,
      "divGap": 10,
      "receiveListCount": 1,
      "receiveListPageCount": 1,
      "receiveList": [
        {
           "receiveNumber": "010-0000-0001",
           "resultName": "대기",
           "result": "-2"
        },
        {
           "receiveNumber": "010-0000-0002",
           "resultName": "대기",
           "result": "-2"
        }
     ]
   }
}
기타 
{
   "code": "0",
   "message": "문자 발송 상세 조회에 성공하였습니다.",
   "data": null
}


API 기본정보

API명 문자 리스트 조회
- 발송 가능한 문자 건수 및 캐시 정보를 조회 합니다.
- 발신번호 리스트를 조회 합니다.
- 주소록 그룹 정보 리스트를 조회 합니다.
API URL GET - /api/messages/user/info.do

공통 HEADER

항목 Mandatory Type 설명 비고
API ID Mandatory String 애드망고 회원 ID
API KEY Mandatory String 발급받은 API KEY

주소 파라미터

항목 Mandatory Type 설명 비고
N / A

요청 파라미터

항목 Mandatory Type 설명 비고
N / A N/A N/A N/A N/A

요청 예시(Json)

요청 N/A

응답 파라미터

항목 Mandatory Type 설명 비고
code Mandatory String 응답 코드 0 : 성공
그 외 : 실패
message Mandatory String 응답 메시지 성공 : '문자 발송 정보 조회에 성공하였습니다.'
기타 : 그 외 메시지
data.userId Optional String 사용자 아이디 사용자 아이디
data.denyNb Optional String 무료수신거부번호 광고 문자 발송 시 사용
data.cash Optional String 보유 캐시  
data.enableSmsCnt Optional String 발송 가능 SMS 문자 수(후불제회원일 경우 0)
data.enableLmsCnt Optional String 발송 가능 LMS 문자 수(후불제회원일 경우 0)
data.enableMmsCnt Optional String 발송 가능 MMS 문자 수(후불제회원일 경우 0)
data.deferPayYnNm Optional String 회원 구분명 선불요금제회원, 후불요금제회원
data.sendList.sendNb Optional String 발신번호 핸드폰, 유선번호
data.sendList.sendNm Optional String 발신번호 이름
data.sendList.repYn Optional String 발신번호 대표번호 여부 Y/N
data.sendList.sendNbUseYn Optional String 발신번호 발신번호 사용 가능 여부 Y/N

응답 예시(Json)

성공시 
{
   "code": "0",
   "message": "문자 발송 정보 조회에 성공하였습니다.",
   "data": {
      "userId": "test",
      "denyNb": "0803070002",
      "cash": 49921.4,
      "enableSmsCnt": 6746,
      "enableLmsCnt": 2062,
      "enableMmsCnt": 832,
      "deferPayYnNm": "선불요금제회원",
      "sendList": [
        {
           "sendName": "testUser1",
           "sendNumber": "010-1234-1234",
           "repYn": "Y",
           "sendNumberUseYn": "Y"
        },
        {
           "sendName": "testUser1",
           "sendNumber": "010-1234-2345",
           "repYn": "N",
           "sendNumberUseYn": "Y"
        }
      ],
      "gradeInfo": [
         {
           "gradeNumber": "250",
           "gradeName": "일반"
         }
      ]
    }
 }
기타 
{
  "code": "0",
  "message": "문자 발송 정보 조회에 성공하였습니다.",
  "data": null
}