반응형URL & 통계

반응형 URL 생성 #

반응형 URL을 생성합니다.

Request #

URL

POST /msg/v1/createClickUrl 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
loginId	String	true	메세지허브 ID
projectName	String	true	프로젝트명
urlTitle	String	true	반응형 URL 제목
orgUrl	String	true	반응형 URL 원본 URL
regDt	String	true	등록일
expDT	String	true	만료일

Response #

Name	Type	Description
code	String	생성 요청 결과 코드
message	String	생성 요청 결과 메세지
data	integer	성공건수

Sample #

Curl

 curl -X POST "https://api.msghub.uplus.co.kr/msg/v1/createClickUrl"
 -H  "accept: */*"
 -H  "Authorization: Bearer eyJhbGciOiJIUzI1NiJ..."
 -H  "Content-Type: application/json"
 -d '
{
  "loginId": "admin",
  "projectName": "test",
  "urlTitle": "test",
  "orgUrl": "test.co.kr",
  "regDt": "2023-01-01 12:00:00",
  "expDt": "2023-12-31 12:59:59"
}

Response

{
  "code": "10000",
  "message": "성공",
  "data": 1
}

참고

결과 코드 참고

반응형 URL 조회 #

반응형 URL을 조회합니다.

Request #

URL

GET /msg/v1/getClickUrl 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
loginId	String	true	메세지허브 ID
projectName	String	true	프로젝트명
page	integer	true	페이지번호

Response #

Name	Type	Description
code	String	생성 요청 결과 코드
message	String	생성 요청 결과 메세지
data.no	integer	목록번호
data.title	String	반응형 URL 제목
data.urlId	String	반응형 URL ID
data.orgUrl	String	반응형 URL 원본 URL
data.expDt	String	반응형 URL 만료일
data.regDt	String	반응형 URL 등록일

Sample #

Curl

curl -X GET "https://api.msghub-qa.uplus.co.kr/msg/v1/getClickUrl?loginId=admin&projectName=testtttt&page=1" 
-H  "accept: */*"
-H  "Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJHV19URVNUOX0.E"

Response

{
  "code": "10000",
  "message": "성공",
  "data": [
    {
      "no": 1,
      "title": "test",
      "urlId": "TUnokC",
      "orgUrl": "test.co.kr",
      "expDt": "2023-12-31 12:59:59",
      "regDt": "2023-01-01 12:00:00"
    }
  ]
}

참고

결과 코드 참고

반응형 URL 삭제 #

반응형 URL을 삭제합니다.

Request #

URL

POST /msg/v1/deleteClickUrl 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
loginId	String	true	메세지허브 ID
projectName	String	true	프로젝트명
urlId	String	true	반응형 URL ID

Response #

Name	Type	Description
code	String	생성 요청 결과 코드
message	String	생성 요청 결과 메세지
data	integer	성공건수

Sample #

Curl

curl -X POST "https://api.msghub-qa.uplus.co.kr/msg/v1/deleteClickUrl?loginId=admin&projectName=testtttt&urlId=TUnokC" 
-H  "accept: */*"
-H  "Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJHV19URVNUOX0.E"

Response

{
  "code": "10000",
  "message": "성공",
  "data": 1
}

참고

결과 코드 참고

반응형 URL 통계 #

등록된 반응형 URL 통계를 보여줍니다. 조회 기간은 반응형 URL의 등록일을 기준으로 하며, 조회 기간은 최대 31일을 넘을 수 없습니다.

Request #

URL

POST /msg/v1/stat/url/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	사용자 인증 토큰

Request body

Name	Type	Required	Description
from	String	true	조회 시작일(등록일기준)
to	String	true	조회 종료일(등록일기준)
urlId	String	false	반응형 URL ID
title	String	false	반응형 URL 이름
orgUrl	String	false	반응형 URL 원본 URL

Response #

Name	Type	Description
code	String	생성 요청 결과 코드
message	String	생성 요청 결과 메세지
data
title	String	반응형 URL 이름
urlId	String	반응형 URL ID
orgUrl	String	반응형 URL 원본 URL
regDt	String	반응형 URL 등록일
totCnt	String	반응형 URL 발송수
conCnt	String	반응형 URL 클릭수
clickThroughtRate	String	반응형 URL 클릭율

Sample #

Curl

curl -X POST "https://api.msghub.uplus.co.kr/msg/v1/stat/url/msg" 
-H  "accept: */*"
-H  "Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJHV19URVNUOX0.E"

Response

{
  "code": "10000",
  "message": "성공",
  "data": [
    {
      "title": "테스트3",
      "urlId": "T63zIb",
      "orgUrl": "https://m.naver.com",
      "regDt": "2023-12-19T13:54:18",
      "totCnt": 8,
      "conCnt": 2,
      "clickThroughRate": 0.25
    }
]
}

참고

결과 코드 참고

반응형 URL 타임라인(일)별 통계 – 발송기준 통계 #

등록된 반응형 URL 타임라인(일)별 통계를 보여줍니다. 발송일의 조회 기간은 15일을 넘을 수 없습니다.

Request #

URL

POST /msg/v1/stat/url/sendDay 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
from	String	true	조회 시작일(발송일 기준)
to	String	true	조회 종료일(발송일 기준)
urlId	String	true	반응형 URL ID

Response #

Name	Type	Description
code	String	생성 요청 결과 코드
message	String	생성 요청 결과 메세지
data
ymd	String	반응형 URL 발송일
urlId	String	반응형 URL ID
ch	String	발송 채널
conCnt	String	반응형 URL 클릭수

Sample #

Curl

curl -X POST "https://api.msghub.uplus.co.kr/msg/v1/stat/url/sendDay" 
-H  "accept: */*"
-H  "Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJHV19URVNUOX0.E"

Response

{
  "code": "10000",
  "message": "성공",
  "data": [
   {
      "ymd": "2023-12-01",
      "urlId": "xCaGex",
      "ch": "SMS",
      "conCnt": "2"
    },
    {
      "ymd": "2023-12-04",
      "urlId": "xCaGex",
      "ch": "KAKAO",
      "conCnt": "0"
    }
]
}

참고

결과 코드 참고

반응형 URL 타임라인(시간)별 통계 – 발송기준 통계 #

등록된 반응형 URL 타임라인(시간)별 통계를 보여줍니다. 발송일의 조회 기간은 15일을 넘을 수 없습니다.

Request #

URL

POST /msg/v1/stat/url/sendHour 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
from	String	true	조회 시작일(발송일 기준)
to	String	true	조회 종료일(발송일 기준)
urlId	String	true	반응형 URL ID

Response #

Name	Type	Description
code	String	생성 요청 결과 코드
message	String	생성 요청 결과 메세지
data
urlId	String	반응형 URL ID
ch	String	발송 채널
hour	String	발송 시간
conCnt	String	반응형 URL 클릭수
avgCnt	String	반응형 URL 평균 클릭수

Sample #

Curl

curl -X POST "https://api.msghub.uplus.co.kr/msg/v1/stat/url/sendHour" 
-H  "accept: */*"
-H  "Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJHV19URVNUOX0.E"

Response

{
  "code": "10000",
  "message": "성공",
  "data": [
  {
      "urlId": "xCaGex",
      "ch": "UNKNOWN",
      "hour": "14",
      "conCnt": "0",
      "avgCnt": "0.0"
    },
    {
      "urlId": "xCaGex",
      "ch": "KAKAO",
      "hour": "14",
      "conCnt": "1",
      "avgCnt": "1.0"
    },
    {
      "urlId": "xCaGex",
      "ch": "SMS",
      "hour": "16",
      "conCnt": "2",
      "avgCnt": "2.0"
    }
]
}

참고

결과 코드 참고

반응형 URL 타임라인(일)별 통계 – 클릭기준 통계 #

등록된 반응형 URL 타임라인(일)별 통계를 보여줍니다. 접속일의 조회 기간은 15일을 넘을 수 없습니다.

Request #

URL

POST /msg/v1/stat/url/clickDay 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
from	String	true	조회 시작일(접속일 기준)
to	String	true	조회 종료일(접속일 기준)
urlId	String	true	반응형 URL ID

Response #

Name	Type	Description
code	String	생성 요청 결과 코드
message	String	생성 요청 결과 메세지
data
ymd	String	반응형 URL 접속일
urlId	String	반응형 URL ID
ch	String	접속 채널
conCnt	String	반응형 URL 클릭수

Sample #

Curl

curl -X POST "https://api.msghub.uplus.co.kr/msg/v1/stat/url/clickDay" 
-H  "accept: */*"
-H  "Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJHV19URVNUOX0.E"

Response

{
  "code": "10000",
  "message": "성공",
  "data": [
 {
      "ymd": "2023-12-01",
      "urlId": "xCaGex",
      "ch": "SMS",
      "conCnt": "3"
    },
    {
      "ymd": "2023-12-14",
      "urlId": "xCaGex",
      "ch": "KAKAO",
      "conCnt": "1"
    }
]
}

참고

결과 코드 참고

반응형 URL 타임라인(시간)별 통계 – 접속기준 통계 #

등록된 반응형 URL 타임라인(시간)별 통계를 보여줍니다. 접속일의 조회 기간은 15일을 넘을 수 없습니다.

Request #

URL

POST /msg/v1/stat/url/clickHour 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
from	String	true	조회 시작일(접속일 기준)
to	String	true	조회 종료일(접속일 기준)
urlId	String	true	반응형 URL ID

Response #

Name	Type	Description
code	String	생성 요청 결과 코드
message	String	생성 요청 결과 메세지
data
urlId	String	반응형 URL ID
ch	String	접속 채널
hour	String	접속 시간
conCnt	String	반응형 URL 클릭수
avgCnt	String	반응형 URL 평균 클릭수

Sample #

Curl

curl -X POST "https://api.msghub.uplus.co.kr/msg/v1/stat/url/clickHour" 
-H  "accept: */*"
-H  "Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJHV19URVNUOX0.E"

Response

{
  "code": "10000",
  "message": "성공",
  "data": [
  {
      "urlId": "xCaGex",
      "ch": "KAKAO",
      "hour": "14",
      "conCnt": "1",
      "avgCnt": "1.0"
    },
    {
      "urlId": "xCaGex",
      "ch": "SMS",
      "hour": "16",
      "conCnt": "3",
      "avgCnt": "3.0"
    }
]
}

참고

결과 코드 참고

반응형 URL 유입채널별 통계 #

등록된 반응형 URL 유입채널별 통계를 보여줍니다. 발송일을 기준으로 하며, 발송일의 조회 기간은 31일을 넘을 수 없습니다.

Request #

URL

POST /msg/v1/stat/url/channel 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
from	String	true	조회 시작일(발송일 기준)
to	String	true	조회 종료일(발송일 기준)
urlId	String	true	반응형 URL ID

Response #

Name	Type	Description
code	String	생성 요청 결과 코드
message	String	생성 요청 결과 메세지
data
ch	String	발송 채널
conCnt	String	반응형 URL 클릭수
totCnt	String	반응형 URL 발송수
clickThroughRate	String	반응형 URL 클릭율

Sample #

Curl

curl -X POST "https://api.msghub.uplus.co.kr/msg/v1/stat/url/channel" 
-H  "accept: */*"
-H  "Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJHV19URVNUOX0.E"

Response

{
  "code": "10000",
  "message": "성공",
  "data": [
  {
      "ch": "UNKNOWN",
      "totCnt": 4,
      "conCnt": 0,
      "clickThroughRate": 0
    },
    {
      "ch": "KAKAO",
      "totCnt": 2,
      "conCnt": 1,
      "clickThroughRate": 0.5
    }
]
}

참고

결과 코드 참고

반응형 URL 클릭수신자별 통계 #

등록된 반응형 URL 클릭수신자별 통계를 보여줍니다. 접속일을 기준으로 하며, 접속일의 조회 기간은 31일을 넘을 수 없습니다.

Request #

URL

POST /msg/v1/stat/url/receiver 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
from	String	true	조회 시작일(접속일 기준)
to	String	true	조회 종료일(접속일 기준)
urlId	String	true	반응형 URL ID
phone	String	false	수신자 전화번호
page	integer	true	페이지 수

Response #

Name	Type	Description
code	String	생성 요청 결과 코드
message	String	생성 요청 결과 메세지
data
urlId	String	반응형 URL ID
totCnt	String	총 접속 건수
recvlst.conYmd	String	접속 일자
recvlst.urlId	String	반응형 URL ID
recvlst.phone	String	반응형 URL 발송수
recvlst.sndYmd	String	반응형 URL 클릭율
recvlst.ch	String	접속 채널
recvlst.isMobile	String	모바일 여부

Sample #

Curl

curl -X POST "https://api.msghub.uplus.co.kr/msg/v1/stat/url/receiver" 
-H  "accept: */*"
-H  "Authorization: Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJHV19URVNUOX0.E"

Response

{
  "code": "10000",
  "message": "성공",
  "data": {
    "urlId": "xCaGex",
    "totCnt": 2,
    "recvlst": [
      {
        "conYmd": "2023-12-01",
        "urlId": "xCaGex",
        "phone": "01000000000",
        "sndYmd": "2023-12-01",
        "ch": "SMS",
        "isMobile": "Y"
      },
      {
        "conYmd": "2023-12-01",
        "urlId": "xCaGex",
        "phone": "01011111111",
        "sndYmd": "2023-12-01",
        "ch": "SMS",
        "isMobile": "Y"
      }
]
}

참고

결과 코드 참고

Updated on 2023년 12월 27일