1 of 1

메시지 버튼 클릭 통계

Request

Response

필드명

타입

길이

필수여부

기본값

설명

array<object>

메시지 버튼 클릭 카운트

code

string

20000000

status

integer

200

desc

string

result - array<object>

필드명

타입

길이

필수여부

기본값

설명

statDate

string

통계일자

corpId

string

RCS Biz Center에 등록된 기업ID

corpRegNum

string

기업사업자 등록 번호

brandId

string

브랜드 ID

chatbotId

string

대화방 ID

groupId

string

발송 캠페인 구분 ID

messagebaseId

string

발송 메시지의 messagebaseId

reactionType

string

고객이 클릭 반응한 대상(

cardNum

string

고객이 클릭 반응한 대상

array<object>

발송 캠페인 메시지에 포함된 RCS 액션 버튼 통계 Data

buttonList - array<object>

필드명

타입

길이

필수여부

기본값

설명

buttonNum

string

이미지, 칩리스트 또는 버튼 reactionType별 메시지 내 위치를 나타내는 번호(식별 불가시 0)

좌에서 우, 위에서 아래로 1부터 번호 부여하며 Carousel은 각 카드별로 1부터 부여

actionType

string

메시지 버튼에 할당된 RCS 액션 유형 이미지 영역에 동영상 스트리밍을 설정한 경우 iframeplayB로 별도 구분

title

string

버튼명, 이미지는 image_1, image_2, ..., image_# 형식으로 제공되며, 동영상 스트리밍의 경우는 iframeplayB_1, iframeplayB_2, ..., iframeplayB_# 형식으로 제공

clickCount

integer

버튼 클릭수 (1일 내 동일 고객의 버튼 클릭 수 제외)

❖ response body sample

{
    "code": "20000000",
    "desc": null,
    "result": [
        {
            "statDate": "20240629",
            "corpId": "CO.NoI0czCZ64",
            "corpRegNum": "8632573324",
            "brandId": "BR.mp0Xf8sGBE",
            "chatbotId": "09044196572",
            "groupId": "6236",
            "messagebaseId": "IBR.mp0Xf8sGBE-iE8w82N11u45AHjEC3Oz8CB9A",
            "cardNum": 1,
            "reactionType": "button",
            "buttonList": [
                {
                    "actionType": "urlAction",
                    "title": "자세히 보기",
                    "clickCount": 272,
                    "buttonNum": 1
                },
                {
                    "actionType": "urlAction",
                    "title": "버닝러시",
                    "clickCount": 82,
                    "buttonNum": 2
                }
            ]
        },
        {
            "statDate": "20240629",
            "corpId": "CO.NoI0czCZ64",
            "corpRegNum": "8632573324",
            "brandId": "BR.mp0Xf8sGBE",
            "chatbotId": "09044196572",
            "groupId": "6236",
            "messagebaseId": "IBR.mp0Xf8sGBE-iE8w82N11u45AHjEC3Oz8CB9A",
            "cardNum": 1,
            "reactionType": "image",
            "buttonList": [
                {
                    "actionType": "urlAction",
                    "title": "image_1",
                    "clickCount": 32,
                    "buttonNum": 1
                }
            ]
        }
    ],
    "status": 200
}

{
    "error": {
        "code": "64002",
        "message": "Invalid Brand Key"
    },
    "status": 400
}

{
    "error": {
        "code": "64203",
        "message": "query paramter required [groupId]"
    },
    "status": 400
}

{
    "error": {
        "code": "64203",
        "message": "query paramter required [endDate]"
    },
    "status": 400
}

{
    "error": {
        "code": "64338",
        "message": "invalid value: [endDate], endDate must be within 31 days"
    },
    "status": 400
}

{
    "error": {
        "code": "61003",
        "message": "Invalid token"
    },
    "status": 401
}

{
    "error": {
        "code": "63001",
        "message": "No Brand Permission"
    },
    "status": 403
}

error code는 RCS Biz Center - Response body error code 참조

메시지 버튼 클릭 통계

Request

Response

필드명

타입

길이

필수여부

기본값

설명

array<object>

메시지 버튼 클릭 카운트

code

string

20000000

status

integer

200

desc

string

result - array<object>

필드명

타입

길이

필수여부

기본값

설명

statDate

string

통계일자

corpId

string

RCS Biz Center에 등록된 기업ID

corpRegNum

string

기업사업자 등록 번호

brandId

string

브랜드 ID

chatbotId

string

대화방 ID

groupId

string

발송 캠페인 구분 ID

messagebaseId

string

발송 메시지의 messagebaseId

reactionType

string

고객이 클릭 반응한 대상(

cardNum

string

고객이 클릭 반응한 대상

array<object>

발송 캠페인 메시지에 포함된 RCS 액션 버튼 통계 Data

buttonList - array<object>

필드명

타입

길이

필수여부

기본값

설명

buttonNum

string

이미지, 칩리스트 또는 버튼 reactionType별 메시지 내 위치를 나타내는 번호(식별 불가시 0)

좌에서 우, 위에서 아래로 1부터 번호 부여하며 Carousel은 각 카드별로 1부터 부여

actionType

string

메시지 버튼에 할당된 RCS 액션 유형 이미지 영역에 동영상 스트리밍을 설정한 경우 iframeplayB로 별도 구분

title

string

버튼명, 이미지는 image_1, image_2, ..., image_# 형식으로 제공되며, 동영상 스트리밍의 경우는 iframeplayB_1, iframeplayB_2, ..., iframeplayB_# 형식으로 제공

clickCount

integer

버튼 클릭수 (1일 내 동일 고객의 버튼 클릭 수 제외)

❖ response body sample

{
    "code": "20000000",
    "desc": null,
    "result": [
        {
            "statDate": "20240629",
            "corpId": "CO.NoI0czCZ64",
            "corpRegNum": "8632573324",
            "brandId": "BR.mp0Xf8sGBE",
            "chatbotId": "09044196572",
            "groupId": "6236",
            "messagebaseId": "IBR.mp0Xf8sGBE-iE8w82N11u45AHjEC3Oz8CB9A",
            "cardNum": 1,
            "reactionType": "button",
            "buttonList": [
                {
                    "actionType": "urlAction",
                    "title": "자세히 보기",
                    "clickCount": 272,
                    "buttonNum": 1
                },
                {
                    "actionType": "urlAction",
                    "title": "버닝러시",
                    "clickCount": 82,
                    "buttonNum": 2
                }
            ]
        },
        {
            "statDate": "20240629",
            "corpId": "CO.NoI0czCZ64",
            "corpRegNum": "8632573324",
            "brandId": "BR.mp0Xf8sGBE",
            "chatbotId": "09044196572",
            "groupId": "6236",
            "messagebaseId": "IBR.mp0Xf8sGBE-iE8w82N11u45AHjEC3Oz8CB9A",
            "cardNum": 1,
            "reactionType": "image",
            "buttonList": [
                {
                    "actionType": "urlAction",
                    "title": "image_1",
                    "clickCount": 32,
                    "buttonNum": 1
                }
            ]
        }
    ],
    "status": 200
}

{
    "error": {
        "code": "64002",
        "message": "Invalid Brand Key"
    },
    "status": 400
}

{
    "error": {
        "code": "64203",
        "message": "query paramter required [groupId]"
    },
    "status": 400
}

{
    "error": {
        "code": "64203",
        "message": "query paramter required [endDate]"
    },
    "status": 400
}

{
    "error": {
        "code": "64338",
        "message": "invalid value: [endDate], endDate must be within 31 days"
    },
    "status": 400
}

{
    "error": {
        "code": "61003",
        "message": "Invalid token"
    },
    "status": 401
}

{
    "error": {
        "code": "63001",
        "message": "No Brand Permission"
    },
    "status": 403
}

error code는 RCS Biz Center - Response body error code 참조

고객반응 통계 - 캠페인 메시지 버튼 클릭 통계를 조회합니다.

동일 Group ID에 발송일 기준 4일간(D+3) 집계됩니다. 단, 이통사별 발송 성공건수 100건 이상인 경우에 한해 집계됩니다.
통계 조회 기간은 데이터 존재 시 최근 1년 6개월 이내 기간 중 최대 31일까지 검색 가능합니다.

계정 권한: 마스터, 매니저, 대행사
브랜드 권한: 브랜드 대표운영자, 운영자

get

/statQuery/messageButton/{brandId}

Authorizations

Path parameters

brandIdstring · max: 13required

maxLength: 13 - 브랜드 내 정보 접근시 사용되는 브랜드ID Path Parameter 입니다.

Query parameters

startDatestringrequired

통계 조회 기간 시작일자(yyyymmdd) 입니다.

endDatestringrequired

통계 조회 기간 종료일자(yyyymmdd) 입니다.

groupIdstringrequired

발송 캠페인 구분 ID 입니다.

chatbotIdstring

대화방ID Query Parameter 입니다.

Header parameters

X-RCS-Brandkeystring · max: 18

maxLength: 18 - RCS Biz Center에서 브랜드 등록 시 자동 생성되는 Key 입니다.

대행사가 해당 브랜드에 대한 권한 여부를 판단하는데 사용됩니다. 따라서, 대행사 계정으로 브랜드 내 정보를 조회/등록/수정 API 연동 시 Header에 설정되어야 합니다.

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api-qa.rcsbizcenter.com/api/1.1/statQuery/messageButton/{brandId}?startDate=text&endDate=text&groupId=text' \
  --header 'Authorization: Bearer JWT'