문자 발송

API 목록

No
Method
API
Description

1

POST

/v1/openapi/sms/send

문자 발송 API

1. 문자 발송

POST https://api.megabird.co.kr:8080/v1/openapi/sms/send

입력한 메시지 타입의 규격을 어겨서 전송한 경우 글자수가 잘리거나 이미지가 미전송될 수 있습니다. [SMS] : 메시지 길이 최대 90Byte (치환변수 포함)

[LMS/MMS] : 메시기 길이 최대 2,000Byte (치환변수 포함)

[MMS 이미지 규격] : 1500×1440px 미만, jpg/jpeg 파일만 가능, 개당 최대 500KB,

복수의 이미지 첨부 시 총합 크기가 1MB 미만

1.1 Headers

Name
Type
Description

Authorization*

String

발급받은 API Key

Content-Type*

String

application/json

1.2 Request Body Parameters

Name
Type
Required
Description
Example

svcKndCd*

String

필수

[메세지 Type]

SMS/LMS/MMS

tmplId

String

템플릿 발송 시 필수

[문자 템플릿 아이디] 메가버드 웹사이트 > 문자 템플릿 관리 에서 등록가능

SLM0001234

msgTtl

String

[메시지 제목]

LMS/MMS 에서만 사용가능 최대 30자

msgCotn

String

템플릿 발송 시 불필요

[메시지내용]

줄바꿈 시 \n 사용 치환변수 취급 byte #{이름} : 10byte 로 취급 #{1} : 20byte 로 취급 #{2} : 20byte 로 취급 #{3} : 40byte 로 취급 #{4} : 100byte 로 취급

안녕하세요 수신자 : #{이름} 발신자 : #{1}

msgMetaData

JSON

[메타데이터] 원하는 데이터 자유롭게 넣어서 사용 가능하며 최대 1KB 제한

{ "부서명": "마케팅", "비고": "사내 전용" }

snPhnum*

String

필수

[발신전화번호]

01012345678

addrNmList

String

[수신 주소록 그룹명] 메가버드 웹사이트 에서 등록가능

메가버드 그룹1

messageReceiverList

String

[수신전화번호 리스트]

최대 500개

messageReceiverList 상세 JSON

fileId

String

[수신자 목록 업로드한 파일 ID]

수신자 엑셀 업로드 API

image1FileId

String

MMS 발송시 필수

[이미지첨부파일아이디 1]

이미지 업로드 API

image2FileId

String

MMS 발송시 선택

[이미지첨부파일아이디 2]

이미지 업로드 API

image3FileId

String

MMS 발송시 선택

[이미지첨부파일아이디 3]

이미지 업로드 API

rsvDtt

String

[예약일시]

2024-08-26 17:45

adIncluYn*

String

필수

[광고문자 여부]

Y/N

entprNm

String

adIncluYn의 값이 'Y' 일 경우 필수

[업체명 또는 서비스명]

최대 30자

메가버드

useDefault080

Boolean

자체 080 수신거부 번호 사용시 'false' 필수

[메가버드 제공 080 수신거부 번호 사용 여부] Default 값 : true

true/false

blockedPhnum

String

useDefault080의 값이 'false' 일 경우 필수

[자체 080수신거부 번호]

08012341234

blockedDstKey

String

자체 080 수신거부 번호에 인증코드가 필요한 경우 필수

[080 수신거부 인증코드]

1234567

tagList

List<String>

[메세지 그룹 태그 목록] 하나의 메시지 그룹당 등록 가능한 태그는 최대 5개 태그의 길이 최대 25자(한글/영어 공통)

"태그1", "태그2"

1.3 messageReceiverList

Name
Type
Required
Description
Example

mbnum

String

필수

[수신전화번호]

01056785678

tgusNm

String

[#{이름} 변수 치환 값] 최대 30자

이름

var1Vl

String

[#{1} 변수 치환 값] 최대 30자

변수1

var2Vl

String

[#{2} 변수 치환 값] 최대 30자

변수2

var3Vl

String

[#{3} 변수 치환 값] 최대 100자

변수3

var4Vl

String

[#{4} 변수 치환 값] 최대 100자

변수4

1.4 Request Example

{
  "svcKndCd": "SMS",
  "msgCotn": "api sms test",
  "adIncluYn": "N",
  "snPhnum": "1234-1234",
  "messageReceiverList": [
    {
      "mbnum": "010-xxxx-xxxx"
    }
  ],
  "tagList" : [
     "태그1"
    ,"태그2"
  ],
  "rsvDtt" : "2024-09-04 18:18"
}
{
  "tmplId" : "SLM0001234"
  ,"svcKndCd": "SMS"
  ,"adIncluYn": "N",
  "snPhnum": "010-1234-1234",
  "messageReceiverList": [
    {
      "mbnum": "010-1111-1111"
    }
  ]
}

1.5 Response Body

파라미터명
타입
설명

success

boolean

성공여부

code

String

결과 코드

message

String

결과 메시지

data

Json

결과 데이터

msgGrpNo

Long

메시지그룹번호

timestamp

LocalDateTime

현재 시간

1.6 Response Example

{
  "success": true,
  "code": "200",
  "message": "성공",
  "data": {
    "msgGrpNo": 123456
  },
  "timestamp": "2024-01-01T15:12:10.902849"
}

2. Error Code

200 , "성공"
1001, "시스템 에러가 발생하였습니다."
2001, "엑셀파일 확장자는 xls, xlxs만 허용됩니다.."
2002, "업로드 허용사이즈는 최대 100,000건입니다."
2003, "전체 컬럼의 데이터 총 개수가 일치하지 않습니다."
2004, "엑셀 업로드 파일 사이즈는 최대 50Mb입니다."
2100, "회원 아이디는 최대 10글자입니다."
3100, "유효성 검사에 실패하였습니다."
3101, "유효성 검사에 실패하였습니다."
3102, "입력 파라미터 포맷에 오류가 있습니다."
4101, "회원정보가 존재하지 않거나 등록상태가 유효하지 않습니다."
4102, "등록된 발신번호가 존재하지 않습니다."
5001, "그룹을 추가할 수 없습니다. 그룹은 최대 100개까지 등록 가능합니다."
5002, "중복된 그룹명이 존재합니다. 중복된 그룹명은 사용하실 수 없습니다."
5003, "존재하지 않는 그룹번호 입니다."
5004, "한 그룹 내 최대 번호 저장 건수인 10만건을 초과했습니다. 번호를 추가할 수 없습니다."
5005, "주소그룹번호 혹은 주소그룹명은 필수 입력 항목입니다."
5006, "삭제할 수 없는 그룹입니다."
6001, "존재하지 않는 KEY 입니다."
6002, "정지된 KEY 입니다."
6003, "허용되지 않은 IP 입니다."
6004, "등록되지 않은 파일아이디입니다."
6005, "파일업로드 데이터를 가져오는 중 오류가 발생했습니다."
6101, "허용되지 않은 채널명 입니다."
6102, "등록되지 않은 템플릿 아이디 입니다."
6103, "서비스구분코드는 필수 값입니다."
6104, "서비스구분코드는 SMS, LMS, MMS만 가능합니다."
6105, "서비스구분코드는 MMS만 가능합니다."
6106, "메시지내용은 필수 값입니다."
6107, "단가 정보를 불러오지 못했습니다."
6108, "수신전화번호는 최소 1개 이상 필수 값입니다."
6109, "발신전화번호는 숫자만 가능합니다."
6110, "SMS는 최대 90Byte까지 입력 가능합니다."
6111, "메시지내용은 최대 2,000byte까지 입력 가능합니다."
6112, "1일 최대 발송한도를 초과했습니다."
6113, "발송시간이 심야 시간(21:00 ~ 익일 08:00)에 해당합니다. 야간 발송제한시간에는 광고문자를 발송할 수 없습니다."
6114, "광고포함여부는 필수 값입니다."
6115, "광고성 정보 메시지의 경우 서비스(업체)명은 필수 값입니다."
6116, "이미지 파일은 500KB 이하의 jpg, jpeg 파일만 가능합니다."
6117, "이미지 파일은 500KB 이하의 jpg, png 파일만 가능합니다."
6118, "png 이미지 파일은 대체문자 전송이 불가능합니다."
6119, "대체문자의 메시지내용은 필수 값입니다."
6120, "대체문자의 메시지구분코드는 필수 값입니다."
6121, "대체문자의 발신전화번호는 필수 값입니다."
6122, "대체문자의 발신전화번호는 숫자만 가능합니다."
6123, "알림톡 대체문자의 메시지구분코드는 SMS, LMS 가능합니다."
6124, "친구톡(텍스트) 대체문자의 메시지구분코드는 SMS, LMS 가능합니다."
6125, "친구톡(포토) 대체문자의 메시지구분코드는 MMS 가능합니다."
6126, "등록된 발신번호가 아닙니다. \n발신번호를 먼저 등록해주시기 바랍니다."
6127, "해당 발신번호는 스팸차단 되었습니다. \n고객센터로 문의하시기 바랍니다."
6128, "해당 메시지 내용중에 스팸차단된 문구를 포함하고 있으므로 \n발송하실 수 없습니다."
6129, "MMS일 경우 이미지 파일이 포함되어야 합니다. 이미지 파일이 없으시면 LMS를 이용하시기 바랍니다."
6300, "예약시간을 다시 설정해주세요.\n현재로부터 10분 이후의 시점부터 예약할 수 있습니다."
6301, "예약시간을 다시 설정해주세요.\n현재로부터 30일 이내의 시점까지 예약할 수 있습니다."
6302, "예약하신 시간이 심야 시간(21:00 ~ 익일 08:00)에 해당합니다.\n야간 발송제한시간에는 광고문자를 발송할 수 없습니다."
6303, "발송시간이 심야 시간(21:00 ~ 익일 08:00)에 해당합니다.\n야간 발송제한시간에는 광고문자를 발송할 수 없습니다."
6304, "예약 발송건이 아닙니다."
6305, "예약시간을 다시 설정해주세요.\n발송 예정 일시 10분 전에는 예약을 취소 및 수정 할 수 없습니다."
Previous문자NextMMS 이미지 업로드

Last updated