PUSH 발송 #

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

Request #

URL

POST /msg/v1/push 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	대행사/재판매 사업자 발송정보 (일반사업자는 미사용)
deptCode	String	false	부서코드
resvYn	String	false	예약발송 여부
resvReqDt	String	false	예약발송 일시(yyyy-MM-dd hh:mm)
msg	Object<PushMsgBody>	true	메시지 내용, 최대 2000자
appId	String	true	앱 아이디
ext	HashMap<String, String>	false	확장 커스텀 메시지(*하단 참고), 최대 1000 Byte 이내
fileId	String	false	파일 아이디
recvInfoLst	List<PushRecvInfo>	true	발송 정보 목록(최대 10건 발송가능)
fbInfoLst	List<FbInfo>	false	fallback 정보 목록
clickUrlYn	String	true	단축URL 사용여부

참고

확장 커스텀 메시지
이미지 푸시를 위한 URL 또는 앱 상세페이지를 꾸밀 데이타 정보 URL
ex) { 《imageUrl》 : 《http://…》, 《data1》 : 《테스트 1》, 《data2》 : 《테스트 2》, …}

PushMsgBody 메시지 내용

Name	Type	Required	Description
title	String	false	제목
body	String	false	내용

PushRecvInfo 발송 정보

Name	Type	Required	Description
cliKey	String	true	클라이언트키: 고객사에서 부여하는 메시지 고유 키(^[a-zA-Z0-9-_.@]{1,30}$)
phone	String	false	Fallback 수신번호(^[0-9-]{1,20}$)
cuid	String	true	앱 로그인 시 사용되는 아이디
mergeData	HashMap<String, String>	false	가변데이터

Response #

스키마를 참조하세요.

Sample #

Curl

 curl -X POST "https://api.msghub.uplus.co.kr/msg/v1/push"
 -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": {
       "title": "push제목",
       "body": "#{name}님, 금일 #{time}시 배송 도착 안내드립니다."
   },
   "appId": "appId01",
   "ext": {
       "imageUrl" : "http://...",   // 이미지 푸시를 위한 URL 사용시
       "additionalProp1": "string",
       "additionalProp2": "string",
       "additionalProp3": "string"
   },
   "fileId": "test01",
   "recvInfoLst": [
       {
           "cliKey": "cliKey1",
           "phone": "01012341234",
           "cuid": " APP 로그인ID",
           "mergeData": {
               "name": "홍길동",
               "time": "3시"
           },
            "userCustomFields": {
            "orderId": "Y_ORD12345",
            "customerName": "홍길동",
            "amount": 10000
          }
       },
       {
           "cliKey": "cliKey2",
           "phone": "01012341235",
           "cuid": " APP 로그인ID",
           "mergeData": {
               "name": "김길순",
               "time": "4시"
           },
            "userCustomFields": {
            "orderId": "Y_ORD6789",
            "customerName": "김철수",
            "amount": 10000
          }
       }
   ],
   "fbInfoLst": [
       {
           "ch": "SMS",
           "title": "제목",
           "msg": "SMS 메시지 내용",
           "fileId": "test01"
       }
   ]
}'

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

참고

결과 코드 참고