MO – 메시지 허브 사용자 가이드

MO

MO 메시지 조회 #

MO 메시지를 조회합니다.

▶ Request

URL

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

Header

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

▶ Response

Name	Type	Description
code	String	결과 코드
message	String	결과 코드 설명
data	Object	결과 데이터 목록

결과 데이터 목록 (data)

Name	Type	Description	비고
moCnt	Integer	MO 건수
moLst	Array	MO 리스트

MO 리스트 ( data.moLst[] )

Name	Type	Description	비고
moNumber	String	MO 번호
moType	String	MO 타입	SMS MO, LMS MO, MMS MO
moCallback	String	발신번호
productCode	String	상품코드	SMS MO, LMS MO, MMS MO
moTitle	String	MO 타이틀
moMsg	String	메시지
telco	String	이통사
moRecvDt	String	수신시간
contentCnt	Integer	MMS MO 컨텐츠 개수
contentInfoLst	Array	MMS MO 컨텐츠 정보 리스트

MMS MO 컨텐츠 정보 리스트 ( contentInfoLst )

Name	Type	Description	비고
contentName	String	MMS MO 컨텐츠명
contentSize	String	MMS MO 컨텐츠 사이즈
contentExt	String	MMS MO 컨텐츠 확장자
contentUrl	String	MMS MO 컨텐츠 URL	컨텐츠 요청 시, 즉시 파일이 삭제되어 재요청 불가

▶ Sample

Curl

curl -X GET "https://api.msghub.uplus.co.kr/mo/v1/msg"
-H  "accept: */*"
-H  "Content-Type: application/json"
-H  "Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiIxIiwiYWNjZXNzVXJsIjoiYXV0aCIsImlzcyI6ImNtLmxndXBsdX..."

Response

{
    "code": "10000",
    "message": "성공",
    "data": {
        "moCnt": 2,
        "moLst": [
           {
               "moKey": "pcNUC3QGVk.6cDbSU",
               "moNumber": "12341234",
               "moType": "SMSMO",
               "moCallback": "01012340000",
               "productCode": "SMSMO",
               "moTitle": null,
               "moMsg": "sms mo 테스트",
               "telco": "LGU",
               "moRecvDt": "2022-02-23T11:36:38"
               "contentCnt": 0,
               "contentInfoLst": null
             },
             {
               "moKey": "WgCiOd6MNJ.6cDbST",
               "moNumber": "12341234",
               "moType": "MMSMO",
               "moCallback": "01012340001",
               "productCode": "MMSMO",
               "moTitle": "mms mo1",
               "moMsg": "mms mo 테스트..",
               "telco": "LGU",
               "moRecvDt": "2022-02-23T11:36:38",
               "contentCnt": 2,
               "contentInfoLst": [
                    {
                       "contentName": "FLZ5r6KVyv_0.jpg",
                       "contentSize": "144934",
                       "contentExt": "jpg",
                       "contentUrl": "https://api.msghub.uplus.co.kr/mo/v1/file/WgCiOd6MNJ.6cDbST/0"
                    },
                    {
                        "contentName": "FLZ5r6KVyv_1.jpg",
                        "contentSize": "167003",
                        "contentExt": "jpg",
                        "contentUrl": "https://api.msghub.uplus.co.kr/mo/v1/file/WgCiOd6MNJ.6cDbST/1"
                    }
                ]
             }
        ]
    }
}

참고

결과 코드 참고

MO 메시지 전달(Webhook 방식) #

MO 메시지를 수신할수 있는 웹훅 URL정보를 사전에 등록해서 사용해야 합니다.
MO 메시지는 MO 가입 시 받은 웹훅 URL 정보로 전달합니다
Webhook 전달 후 성공 시 큐에서 삭제되고, 실패시 재처리 가능합니다
** _{단, 퍼블릭 웹훅URL만 지원이 되며, 전용선으로 연결 시에는 지원되지 않습니다.}

▶ Request

URL

POST mo/v1/msg HTTP/1.1
Content-Type: application/json
Host: #{WEBHOOK_URL}

▶ Response

Name	Type	Description	비고
moCnt	Integer	MO 건수
moLst	Array	MO 리스트

MO 리스트 ( moLst )

Name	Type	Description	비고
moKey	String	MO키
moNumber	String	MO 번호
moType	String	MO 타입	SMSMO, LMSMO, MMSMO
moCallback	String	발신번호
productCode	String	상품코드	SMSMO, LMSMO, MMSMO
moTitle	String	MO 타이틀
moMsg	String	메시지
telco	String	이통사
moRecvDt	String	수신시간
contentCnt	Integer	MMS MO 컨텐츠 개수
contentInfoLst	Array	MMS MO 컨텐츠 정보 리스트

MMS MO 컨텐츠 정보 리스트 ( contentInfoLst )

Name	Type	Description	비고
contentName	String	MMS MO 컨텐츠명
contentSize	String	MMS MO 컨텐츠 사이즈
contentExt	String	MMS MO 컨텐츠 확장자
contentUrl	String	MMS MO 컨텐츠 URL	컨텐츠 요청 시, 즉시 파일이 삭제되어 재요청 불가

▶ Sample

Curl

curl -X POST "https://{WEBHOOK_URL}"
-H  "accept: */*"
-H  "Content-Type: application/json"
-d
  {
     "moCnt": 2,
     "moLst": [
         {
            "moKey": "pcNUC3QGVk.6cDbSU",
            "moNumber": "12341234",
            "moType": "SMSMO",
            "moCallback": "01012340000",
            "productCode": "SMSMO",
            "moTitle": null,
            "moMsg": "sms mo 테스트",
            "telco": "LGU",
            "contentCnt": 0,
            "contentInfoLst": null,
            "moRecvDt": "2022-02-23 11:36:38"
         },
         {
            "moKey": "WgCiOd6MNJ.6cDbST",
            "moNumber": "12341234",
            "moType": "MMSMO",
            "moCallback": "01012340001",
            "productCode": "MMSMO",
            "moTitle": "mms mo1",
            "moMsg": "mms mo 테스트..",
            "telco": "LGU",
            "contentCnt": 2,
            "contentInfoLst": [
                 {
                     "contentName": "FLZ5r6KVyv_0.jpg",
                     "contentSize": "144934",
                     "contentExt": "jpg",
                     "contentUrl": "https://api.msghub.uplus.co.kr/mo/v1/file/WgCiOd6MNJ.6cDbST/0"
                 },
                 {
                      "contentName": "FLZ5r6KVyv_1.jpg",
                      "contentSize": "167003",
                      "contentExt": "jpg",
                      "contentUrl": "https://api.msghub.uplus.co.kr/mo/v1/file/WgCiOd6MNJ.6cDbST/1"
                 }
            ],
            "moRecvDt": "2022-02-23 11:35:34"
         }
     ]
  }

▶ Response

HTTP	Description	비고
200	성공
204	성공	응답 혹은 처리 할 리포트가 없는 경우
400	실패	실패로 전달시 재처리 가능함

MMS MO 컨텐츠 조회 API #

MMS MO 컨텐츠를 조회한다

▶ Request

URL

GET /mo/v1/file/**   HTTP/1.1
Authorization: Bearer {token}
Content-Type: application/json
Host: api.msghub.uplus.co.kr

▶ Request

Header

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

▶ Response

HTTP	Description	비고
200	성공	조회 요청 파일 다운로드
403	실패	권한 오류(실패로 전달 시 재처리 가능)
417	실패	잘못된 요청(잘못된 요청 주소, 잘못된 헤더 값 등)

참고

MO 메세지 조회 API #

MO 메세지를 조회한다

▶ Request

URL

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

▶ Request

Header

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

▶ Response

Name	Type	Description	비고
moCnt	Integer	MO 건수
moLst	Array	MO 리스트

MO 리스트 ( moLst )

Name	Type	Description	비고
moKey	String	MO키
moNumber	String	MO 번호
moType	String	MO 타입	SMSMO, LMSMO, MMSMO
moCallback	String	발신번호
productCode	String	상품코드	SMSMO, LMSMO, MMSMO
moTitle	String	MO 타이틀
moMsg	String	메시지
telco	String	이통사
moRecvDt	String	수신시간
contentCnt	Integer	MMS MO 컨텐츠 개수
contentInfoLst	Array	MMS MO 컨텐츠 정보 리스트

MMS MO 컨텐츠 정보 리스트 ( contentInfoLst )

Name	Type	Description	비고
contentName	String	MMS MO 컨텐츠명
contentSize	String	MMS MO 컨텐츠 사이즈
contentExt	String	MMS MO 컨텐츠 확장자
contentUrl	String	MMS MO 컨텐츠 URL	컨텐츠 요청 시, 즉시 파일이 삭제되어 재요청 불가

▶ Sample

Curl

curl -X GET "https://api.msghub.uplus.co.kr/mo/direct/v1/msg"
-H  "accept: */*"
-H  "Content-Type: application/json"
-d
{
    "code": "10000",
    "message": "성공",
    "data": {
        "moCnt": 2,
        "moLst": [
           {
               "moKey": "pcNUC3QGVk.6cDbSU",
               "moNumber": "12341234",
               "moType": "SMSMO",
               "moCallback": "01012340000",
               "productCode": "SMSMO",
               "moTitle": null,
               "moMsg": "sms mo 테스트",
               "telco": "LGU",
               "moRecvDt": "2022-02-23T11:36:38"
               "contentCnt": 0,
               "contentInfoLst": null
             },
             {
               "moKey": "WgCiOd6MNJ.6cDbST",
               "moNumber": "12341234",
               "moType": "MMSMO",
               "moCallback": "01012340001",
               "productCode": "MMSMO",
               "moTitle": "mms mo1",
               "moMsg": "mms mo 테스트..",
               "telco": "LGU",
               "moRecvDt": "2022-02-23T11:36:38",
               "contentCnt": 2,
               "contentInfoLst": [
                    {
                       "contentName": "FLZ5r6KVyv_0.jpg",
                       "contentSize": "144934",
                       "contentExt": "jpg",
                       "contentUrl": "https://api.msghub.uplus.co.kr/mo/v1/file/WgCiOd6MNJ.6cDbST/0"
                    },
                    {
                        "contentName": "FLZ5r6KVyv_1.jpg",
                        "contentSize": "167003",
                        "contentExt": "jpg",
                        "contentUrl": "https://api.msghub.uplus.co.kr/mo/v1/file/WgCiOd6MNJ.6cDbST/1"
                    }
                ]
             }
        ]
    }
}

HTTP	Description	비고
200	성공
400	실패	실패로 전달 시 재처리 가능함
401	실패	엑세스 토큰 만료

참고

Updated on 2024년 2월 29일

Quick Guide

서비스 개요

계정 안내

관리자 콘솔

사용자 콘솔

API 가이드

Push 앱개발 가이드

Agent 가이드

서비스 정보

MO

MO 메시지 조회 #

MO 메시지 전달(Webhook 방식) #

MMS MO 컨텐츠 조회 API #

MO 메세지 조회 API #