통합 메시지 발송 #

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

Request #

URL

POST /msg/v1.1/send 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
tmpltCode	String	true	통합발송 템플릿
campaignId	String	false	캠페인 ID
agency	Object<Agency>	false	대행사/재판매 사업자 발송정보 (일반사업자는 미사용)
deptCode	String	false	부서코드
resvYn	String	false	예약발송 여부
resvReqDt	String	false	예약발송 일시(yyyy-MM-dd hh:mm)
recvInfoLst	List<SmartRecvInfo>	true	발송 정보 목록(최대 10건 발송가능)
clickUrlYn	String	true	단축URL 사용여부

SmartRecvInfo 발송 정보

Name	Type	Required	Description
cliKey	String	true	클라이언트키: 고객사에서 부여하는 메시지 고유 키(^[a-zA-Z0-9-_.@]{1,30}$)
phone	String	true	수신번호(^[0-9-]{1,20}$)
callback	String	false	발신번호 – RCS, SMS, LMS, MMS 채널의 발신번호를 변경하고자 하는 경우 추가 – 사전 등록되지 않은 번호의 경우 발송실패 됩니다.
cuid	String	true	앱 로그인 시 사용되는 아이디
kvData	HashMap<String, String>	false	가변데이터
fileData	HashMap<String, String>	false	파일데이터 없을 시 템플릿에 등록된 파일 기본 전송 MMS : mms.1 , RCS : rcs.1, 친구톡 : friendtalk.1, PUSH : push.1 * 각 매체별 첨부이미지개수가 차이가 있으며, 해당 매체의 이미지 개수를 초과하여 첨부할 경우 발송 실패됩니다. * MMS 는 이미지 순서가 없어 폰에 표현 시 위치가 변경될 수 있습니다. * 작성 방법 Sample 참고.
userCustomFields	HashMap<String, String>	false	웹훅 추가필드 데이터

Response #

스키마를 참조하세요.

Sample #

Curl

curl -X POST "https://api.msghub.uplus.co.kr/msg/v1.1/send"
-H  "accept: */*"
-H  "Authorization: Bearer eyJhbGciOiJIUzI1NiJ..."
-H  "Content-Type: application/json"
-d '
  {
    "tmpltCode": "템플릿코드",
    "campaignId": "",
    "agency":{
                   "kisaOrigCode": "재판매사 KISA 최초식별코드",
                   "rcsAgencyId": "재판매사 RCS Agency ID",
                   "rcsAgencyKey": "재판매사 RCS Agency Key"
    },
    "resvYn": "Y",
    "resvReqDt": "2023-01-13 13:15",
    "recvInfoLst": [
        {
            "cliKey": "cliKey1",
            "phone": "01012341234",
            "kvData":{"치환대상문자열":"치환문자열",...,"치환대상문자열":"치환문자열"},
            "fileData":{"mms.1":"FLETt9wbx", "mms.2":"FLETt9", "rcs.1":"FLETt9"},
            "userCustomFields": {
            "orderId": "Y_ORD12345",
            "customerName": "홍길동",
            "amount": 10000
          }
        },
        {
            "cliKey": "cliKey2",
            "phone": "01012341235",
            "kvData":{"치환대상문자열":"치환문자열",...,"치환대상문자열":"치환문자열"},
            "fileData":{"mms.1":"FLETt9wbx", "mms.2":"FLETt9", "rcs.1":"FLETt9"},
            "userCustomFields": {
            "orderId": "Y_ORD6789",
            "customerName": "김철수",
            "amount": 10000
          }
        }
    ]
}'

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": "성공"
        }
    ]
}

참고

결과 코드 참고