국제 SMS 발송

국제 SMS 발송 정책을 반드시 확인 후 API 사용 부탁드립니다.

API 목록

No	Method	API	설명
1	POST	/v1/openapi/globalsms/send	문자 발송 API

1. 국제 SMS 발송 API 요청

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

1.1 Headers

헤더명	타입	설명
Authorization	String	발급받은 API Key
Content-Type	String	application/json

1.2 Request Body Parameters

파라미터명	타입	필수여부	설명	예시
svcKndCd	String	필수	[메세지 타입] GLOBALSMS만 허용	GLOBALSMS
msgCotn	String	필수	[메시지내용] 줄바꿈 시 \n 사용	您的验证码是00000 verification code is 00000
snPhnum	String	필수	[발신전화번호] 사전에 등록한 번호만 사용가능	1234-1234
messageReceiverList	List	필수	[수신자 리스트] 최대 1개	1.3 messageReceiverList 참고

1.3 messageReceiverList

메시지 본문이 변수 내용에 의해서 EUC-KR 기준 90Byte가 초과되면 LMS로 발송해야 합니다.

파리미터명	타입	필수여부	설명	예시
countryCode	String	필수	[국가코드]	81
mbnum	String	필수	[수신전화번호] 최대 30자	12341234
varJson	Map		[치환변수 JSON] 최대 50개	"#{변수명}" : "치환값" 메시지 본문의 변수는 #{xxx} 형식이어야 합니다. 메시지 본문에 존재하는 변수를 varJson에 적어주지 않으면 치환되지 않고 전송됩니다.

1.4 요청 예시

국제 SMS 일반 발송

{
  "svcKndCd": "GLOBALSMS",
  "msgCotn": "您的验证码是 1234,
  "snPhnum": "1234-1234",
  "messageReceiverList": [
      {
      "countryCode" : "+86",
      "mbnum": "17885881187",
    }
  ]
}

국제 SMS 치환변수 발송

{
  "svcKndCd": "GLOBALSMS",
  "msgCotn": "您的验证码是#{code},
  "snPhnum": "1234-1234",
  "messageReceiverList": [
    {
      "countryCode" : "81",
      "mbnum": "70-2323423523",
      "varJson": {
        "#{code}" : "91835",
      }
    }
  ]
}

2. 국제 SMS 발송 API 응답

2.1 Response Body Parameters

파라미터명	타입	설명
success	boolean	성공여부
code	String	결과 코드
message	String	결과 메시지
data	Json	결과 데이터
msgGrpNo	String	메시지그룹번호
timestamp	LocalDateTime	현재 시간

2.2 응답 예시

200: OK

{
    "success": true,
    "code": "200",
    "message": "성공",
    "data": {
        "msgGrpNo": 105706
    },
    "timestamp": "2024-08-14T17:03:57.226002"
}

400: Bad Request

{
    "status": 400,
    "code": 6132,
    "message": "지원하지않는 해외문자 국가 입니다.",
    "success": false,
    "timestamp": "2024-08-14T17:10:44.359779",
    "description": [
        {
            "field": "countryCode",
            "errorType": "field",
            "message": "지원하지않는 해외문자 국가 입니다."
        }
    ]
}

2.3 응답 코드

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 입니다."
6103, "서비스구분코드는 필수 값입니다."
6106, "메시지내용은 필수 값입니다."
6107, "단가 정보를 불러오지 못했습니다."
6108, "수신전화번호는 최소 1개 이상 필수 값입니다."
6109, "발신전화번호는 숫자만 가능합니다."
6112, "1일 최대 발송한도를 초과했습니다."
6119, "대체문자의 메시지내용은 필수 값입니다."
6120, "대체문자의 메시지구분코드는 필수 값입니다."
6121, "대체문자의 발신전화번호는 필수 값입니다."
6122, "대체문자의 발신전화번호는 숫자만 가능합니다."
6126, "등록된 발신번호가 아닙니다. \n발신번호를 먼저 등록해주시기 바랍니다."
6127, "해당 발신번호는 스팸차단 되었습니다. \n고객센터로 문의하시기 바랍니다."
6128, "해당 메시지 내용중에 스팸차단된 문구를 포함하고 있으므로 \n발송하실 수 없습니다."
6132, "지원하지않는 해외문자 국가 입니다."
6133, "지원하지않는 해외문자 단가 입니다."
6134, "서비스구분코드는 GLOBALSMS만 가능합니다."
6300, "예약시간을 다시 설정해주세요.\n현재로부터 10분 이후의 시점부터 예약할 수 있습니다."
6301, "예약시간을 다시 설정해주세요.\n현재로부터 30일 이내의 시점까지 예약할 수 있습니다."
6302, "예약하신 시간이 심야 시간(21:00 ~ 익일 08:00)에 해당합니다.\n야간 발송제한시간에는 광고문자를 발송할 수 없습니다."
6303, "발송시간이 심야 시간(21:00 ~ 익일 08:00)에 해당합니다.\n야간 발송제한시간에는 광고문자를 발송할 수 없습니다."
6304, "예약 발송건이 아닙니다."
6305, "예약시간을 다시 설정해주세요.\n발송 예정 일시 10분 전에는 예약을 취소 및 수정 할 수 없습니다."