문자(SMS/LMS/MMS)

SMS 발송 #

SMS 발송 API이며, 최대 10건 까지 한번에 발송 가능합니다.

Request #

URL

POST /msg/v1/sms HTTP/1.1 
Authorization: Bearer {token} 
Content-Type: application/json 
Host: api.msghub.uplus.co.kr

Header

Name	Type	Required	Description
Authorization	String	true	사용자 인증 토큰

Request body

Name	Type	Required	Description
callback	String	*true	발신번호(*특수부가사업자의 경우 필수 아님)
campaignId	String	false	캠페인 ID
agency	Object<Agency>	false	재판매사 Agency 정보.
`resvYn`	String	false	예약발송 여부
`resvReqDt`	String	false	예약발송 일시(yyyy-MM-dd hh:mm)
deptCode	String	false	부서코드
msg	String	true	메시지 내용, 최대 90 Byte
recvInfoLst	List<RecvInfo>	true	발송 정보 목록(최대 10건 발송가능)
fbInfoLst	List<FbInfo>	false	fallback 정보 목록
clickUrlYn	String	true	단축URL 사용여부

SMS는 최종 발송채널로서 fallback 정보를 추가하지 않습니다.
Sample을 참고해주세요.

Response #

스키마를 참조하세요.

Sample #

Curl

curl -X POST "https://api.msghub.uplus.co.kr/msg/v1/sms"
    -H  "accept: */*"
    -H  "Authorization: Bearer eyJhbGciOiJIUzI1NiJ..."
    -H  "Content-Type: application/json"
    -d '
      {
        "callback": "0212341234",
        "campaignId": "캠페인ID",
        "agency":{
                   "kisaOrigCode": "재판매사 KISA 최초식별코드",
                   "rcsAgencyId": "재판매사 RCS Agency ID",
                   "rcsAgencyKey": "재판매사 RCS Agency Key"
        },
        "resvYn": "Y",
        "resvReqDt": "2023-01-13 13:15",
        "deptCode": "부서코드",
        "msg": "#{name}님, 금일 #{time}시 배송 도착 안내드립니다.",
        "recvInfoLst": [
            {
                "cliKey": "cliKey1",
                "phone": "01012341234",
                "mergeData": {
                    "name": "홍길동",
                    "time": "3시"
                }
            },
            {
                "cliKey": "cliKey2",
                "phone": "01012341235",
                "mergeData": {
                    "name": "김길순",
                    "time": "4시"
                }
            }
        ],
        "fbInfoLst": []
    }
    '

Response

{
    "code": "10000",
    "message": "성공",
    "data": [
        {
            "cliKey": "cliKey1",
            "msgKey": "tw9Tomlcen.6bTb0O",
            "phone": "01012341234",
            "code": "10000",
            "message": "성공"
        },
        {
            "cliKey": "cliKey2",
            "msgKey": "tw9Tomlcen.6bTb0O",
            "phone": "01012341234",
            "code": "10000",
            "message": "성공"
        }
    ]
}

참고

결과 코드 참고

LMS/MMS 발송 #

LMS/MMS 발송 API이며, 최대 10건 까지 한번에 발송 가능합니다.

Request #

URL

POST /msg/v1/mms HTTP/1.1
Authorization: Bearer {token}
Content-Type: application/json
Host: api.msghub.uplus.co.kr

Header

Name	Type	Required	Description
Authorization	String	true	사용자 인증 토큰

Request body

Name	Type	Required	Description
callback	String	*true	발신번호(*특수부가사업자의 경우 필수 아님)
campaignId	String	false	캠페인 ID
agency	Object<Agency>	false	재판매사 Agency 정보
resvYn	String	false	예약발송여부
resvReqDt	String	false	예약발송 일시(yyyy-MM-dd hh:mm)
deptCode	String	false	부서코드
title	String	true	제목, 최대 60 Bytes (이통사별 40바이트 초과시 잘려서 발송될 수 있습니다)
msg	String	true	메시지 내용, 최대 2000 Byte
fileIdLst	List<String>	false	파일 아이디 목록 LMS 발송인 경우 사용하지 않음 *첨부파일 리스트를 포함한 MMS 발송을 위해서는 이미지 사전등록이 진행되어야 합니다. (이미지 사전등록 API 참고)
recvInfoLst	List<RecvInfo>	true	발송 정보 목록(최대 10건 발송가능)
fbInfoLst	List<FbInfo>	false	fallback 정보 목록
clickUrlYn	String	true	단축URL 사용여부

MMS는 최종 발송채널로서 fallback 정보를 추가하지 않습니다.
Sample을 참고해주세요.

참고

첨부파일 리스트(필드명: fileIdLst)를 포함한 MMS 발송을 위해서는 이미지 사전등록이 진행되어야 합니다.
이미지사전등록 API를 참고하시기 바랍니다.

첨부 제한 사항
– 확장자 정보: 이미지(jpg), 오디오(mmf), 동영상(k3g)
– 첨부 이미지 개수: 3개 이하
– 첨부 이미지 사이즈 : 300K 이하

Response #

스키마를 참조하세요.

Sample #

Curl

curl -X POST "https://api.msghub.uplus.co.kr/msg/v1/mms"
  -H  "accept: */*"
  -H  "Authorization: Bearer eyJhbGciOiJIUzI1NiJ..."
  -H  "Content-Type: application/json"
  -d '
    {
      "callback": "0212341234",
      "campaignId": "캠페인ID",
      "agency":{
                   "kisaOrigCode": "재판매사 KISA 최초식별코드",
                   "rcsAgencyId": "재판매사 RCS Agency ID",
                   "rcsAgencyKey": "재판매사 RCS Agency Key"
       },
      "resvYn": "Y",
      "resvReqDt": "2023-01-13 13:15",
      "deptCode": "부서코드",
      "title": "MMS 테스트 제목",
      "msg": "#{name}님, 금일 #{time}시 배송 도착 안내드립니다.",
      "fileIdLst": [
          "test01"
      ],
      "recvInfoLst": [
          {
              "cliKey": "cliKey1",
              "phone": "01012341234",
              "mergeData": {
                  "name": "홍길동",
                  "time": "3시"
              }
          },
          {
              "cliKey": "cliKey2",
              "phone": "01012341235",
              "mergeData": {
                  "name": "김길순",
                  "time": "4시"
              }
          }
        ],
        "fbInfoLst": []
    }'

Response

{
    "code": "10000",
    "message": "성공",
    "data": [
        {
            "cliKey": "cliKey1",
            "msgKey": "tw9Tomlcen.6bTb0O",
            "phone": "01012341234",
            "code": "10000",
            "message": "성공"
        },
        {
            "cliKey": "cliKey2",
            "msgKey": "tw9Tomlcen.6bTb0O",
            "phone": "01012341234",
            "code": "10000",
            "message": "성공"
        }
    ]
}

참고

결과 코드 참고

MMS 발송 (파일 첨부 방식) #

MMS 첨부파일(multipart)을 직접 발송하며, 최대 10건 까지 한번에 발송 가능합니다.

Request #

URL

POST /msg/v1/mms HTTP/1.1
Authorization: Bearer {token}
Content-Type: multipart/form-data
Host: api.msghub.uplus.co.kr

Header

Name	Type	Required	Description
Authorization	String	true	사용자 인증 토큰

Request body

Name	Type	Required	Description
reqMsg	Object	true	발송 메시지
reqMsg.callback	String	*true	발신번호(*특수부가사업자의 경우 필수 아님)
reqMsg.campaignId	String	false	캠페인 ID
reqMsg.agency	Object<Agency>	false	재판매사 Agency 정보
reqMsg.resvYn	String	false	예약발송 여부
reqMsg.resvReqDt	String	false	예약발송 일시(yyyy-MM-dd hh:mm)
reqMsg.deptCode	String	false	부서코드
reqMsg.title	String	true	제목, 최대 60 Bytes (이통사별 40바이트 초과시 잘려서 발송될 수 있습니다)
reqMsg.msg	String	true	메시지 내용, 최대 2000 Byte
reqMsg.recvInfoLst	List<RecvInfo>	true	발송 정보 목록(최대 10건 발송가능)
reqMsg.fbInfoLst	List<FbInfo>	false	fallback 정보 목록
parts	File	false	첨부 이미지
clickUrlYn	String	true	단축URL 사용여부

MMS는 최종 발송채널로서 fallback 정보를 추가하지 않습니다.
Sample을 참고해주세요.

참고

첨부 제한 사항
– 확장자 정보: 이미지(jpg), 오디오(mmf), 동영상(k3g)
– 첨부 이미지 개수: 3개 이하
– 첨부 이미지 사이즈 : 300K 이하

Response #

스키마를 참조하세요.

Sample #

Curl

curl -X POST "https://api.msghub.uplus.co.kr/msg/v1/mms"
  -H  "accept: */*"
  -H  "Authorization: Bearer eyJhbGciOiJIUzI1Ni..."
  -H  "Content-Type: multipart/form-data"
  -F 'reqMsg={
        "callback": "0212341234",
        "campaignId": "캠페인ID",
        "agency":{
                   "kisaOrigCode": "재판매사 KISA 최초식별코드",
                   "rcsAgencyId": "재판매사 RCS Agency ID",
                   "rcsAgencyKey": "재판매사 RCS Agency Key"
        },
        "resvYn": "Y",
        "resvReqDt": "2023-01-13 13:15",
        "deptCode": "부서코드",
        "title": "MMS 테스트 제목",
        "msg": "#{name}님, 금일 #{time}시 배송 도착 안내드립니다.",
        "recvInfoLst": [
            {
                "cliKey": "cliKey1",
                "phone": "01012341234",
                "mergeData": {
                    "name": "홍길동",
                    "time": "3시"
                }
            },
            {
                "cliKey": "cliKey2",
                "phone": "01012341235",
                "mergeData": {
                    "name": "김길순",
                    "time": "4시"
                }
            }
        ],
        "fbInfoLst": []
      }'
-F "parts=@A.jpg;type=image/jpeg"

Response

{
    "code": "10000",
    "message": "성공",
    "data": [
        {
            "cliKey": "cliKey1",
            "msgKey": "tw9Tomlcen.6bTb0O",
            "phone": "01012341234",
            "code": "10000",
            "message": "성공"
        },
        {
            "cliKey": "cliKey2",
            "msgKey": "tw9Tomlcen.6bTb0O",
            "phone": "01012341234",
            "code": "10000",
            "message": "성공"
        }
    ]
}

참고

결과 코드 참고

Updated on 2023년 12월 1일

Quick Guide

서비스 개요

계정 안내

관리자 콘솔

사용자 콘솔

API 가이드

Push 앱개발 가이드

Agent 가이드

서비스 정보