대화방 메뉴 클릭 통계

Request

고객반응 통계 - 대화방 메뉴 클릭 통계를 조회합니다.

고객반응 통계 - 대화방 메뉴 클릭 통계를 조회합니다.

• 대화방별 1건 이상 사용자선택이 일어난 경우에 대해 집계됩니다.
• 통계 조회 기간은 데이터 존재 시 최근 1년 6개월 이내 기간 중 최대 31일까지 검색 가능합니다.

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

get

/statQuery/persistentMenu/{brandId}

Authorizations

Path parameters

brandIdstring · max: 13required

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

Query parameters

startDatestringrequired

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

endDatestringrequired

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

chatbotIdstringrequired

대화방ID Query Parameter 입니다.

Header parameters

X-RCS-Brandkeystring · max: 18

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

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

cURL

JavaScript

Python

HTTP

cURL

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

Response

필드명	타입	길이	필수여부	기본값	설명
result	array<object>		O		대화방메뉴 통계 Data
code	string	5	O	20000000
status	integer	3	O	200
desc	string		O

result - array<object>

필드명	타입	길이	필수여부	기본값	설명
statDate	string	8			통계일자
corpId	string	13			RCS Biz Center에 등록된 기업ID
corpRegNum	string	10			기업사업자 등록 번호
brandId	string	13			브랜드 ID
chatbotId	string	15			대화방 ID
menuList	array<object>				대화방메뉴 별 상세 Data

menuList - array<object>

필드명	타입	길이	필수여부	기본값	설명
postbackId	string	40	O		메뉴에 할당된 postbackId
menuType	string	40	O		메뉴 할당된 액션 구분 action: RCS 액션 버튼(urlAction, mapAction, ...) 메뉴 reply: 기본응답 메뉴 autoreply: 자동응답 메뉴 menu: 하위 메뉴를 갖는 상위 메뉴
actionType	string				menuType이 action인 경우, 할당된 RCS 액션 유형 이미지 영역에 동영상 스트리밍을 설정한 경우 iframeplayB로 별도 구분 (현재 자동응답메시지는 iframepalyB 설정 미지원)
title	string	40	O		버튼명, 이미지는 image_1, image_2, ..., image_# 형식으로 제공되며, 동영상 스트리밍의 경우는 iframeplayB_1, iframeplayB_2, ..., iframeplayB_# 형식으로 제공
clickCount	integer				menuType이 action, reply, autoreply 인 경우 클릭수 (1일 내 동일 고객의 버튼 클릭 수 제외)
subList	array<object>				하위 메뉴 또는 자동응답메시지 상의 버튼 상세 Data

subList - array<object>

필드명	타입	길이	필수여부	기본값	설명
postbackId	string	40	O		메뉴에 할당된 postbackId
menuType	string	40	O		메뉴 할당된 액션 구분 action: RCS 액션 버튼(urlAction, mapAction, ...) 메뉴 reply: 기본응답 메뉴 autoreply: 자동응답 메뉴 menu: 하위 메뉴를 갖는 상위 메뉴
actionType	string				menuType이 action인 경우 할당된 RCS 액션 유형 이미지 영역에 동영상 스트리밍을 설정한 경우 iframeplayB로 별도 구분 (현재 자동응답메시지는 iframepalyB 설정 미지원)
title	string	40	O		버튼명, 이미지는 image_1, image_2, ..., image_# 형식으로 제공되며, 동영상 스트리밍의 경우는 iframeplayB_1, iframeplayB_2, ..., iframeplayB_# 형식으로 제공
clickCount	integer				menuType이 action, reply, autoreply 인 경우 클릭수 (1일 내 동일 고객의 버튼 클릭 수 제외)
subActionList	array<object>				menuType이 autoReply인 경우 자동응답메시지 상의 상세 버튼 Data

subActionList - array<object>

필드명	타입	길이	필수여부	기본값	설명
postbackId	string	40	O		메뉴에 할당된 postbackId
actionType	string				menuType이 action인 경우 할당된 RCS 액션 유형 이미지 영역에 동영상 스트리밍을 설정한 경우 iframeplayB로 별도 구분(현재 자동응답메시지는 iframepalyB 설정 미지원)
title	string	40	O		버튼명, 이미지는 image_1, image_2, ..., image_# 형식으로 제공되며, 동영상 스트리밍의 경우는 iframeplayB_1, iframeplayB_2, ..., iframeplayB_# 형식으로 제공
clickCount	integer				menuType이 action, reply, autoreply 인 경우 클릭수 (1일 내 동일 고객의 버튼 클릭 수 제외)

❖ response body sample

200

{
    "code": "20000000",
    "desc": null,
    "result": [
        {
            "statDate": "20240630",
            "corpId": "CO.NoI0czCZ64",
            "corpRegNum": "8632573324",
            "brandId": "BR.mp0Xf8sGBE",
            "chatbotId": "09044196573",
            "menuList": [
                {
                    "postbackId": "P090pbJY06J6fgX",
                    "menuType": "autoreply",
                    "title": "내원 진료 시간",
                    "clickCount": 1
                },
                {
                    "postbackId": "ARM6J1wfCn81N6u",
                    "menuType": "autoreply",
                    "title": "위치 안내",
                    "clickCount": 1,
                    "subList": [
                        {
                            "postbackId": "Pec587X6nVY8k5c",
                            "menuType": "action",
                            "title": "지도",
                            "clickCount": 1,
                            "actionType": "urlAction",
                            "messagebaseId": "SCwThT00",
                            "reactionType": "button",
                            "cardNum": 1,
                            "buttonNum": 1
                        }
                    ]
                }
            ]
        },
        {
            "statDate": "20240629",
            "corpId": "CO.NoI0czCZ64",
            "corpRegNum": "8632573324",
            "brandId": "BR.mp0Xf8sGBE",
            "chatbotId": "09044196573",
            "menuList": [
                {
                    "postbackId": "ARM6J1wfCn81N6u",
                    "menuType": "autoreply",
                    "title": "위치 안내",
                    "clickCount": 1,
                    "subList": [
                        {
                            "postbackId": "Pec587X6nVY8k5c",
                            "menuType": "action",
                            "title": "지도",
                            "clickCount": 1,
                            "actionType": "urlAction",
                            "messagebaseId": "SCwThT00",
                            "reactionType": "button",
                            "cardNum": 1,
                            "buttonNum": 1
                        }
                    ]
                }
            ]
        },
        {
            "statDate": "20240628",
            "corpId": "CO.NoI0czCZ64",
            "corpRegNum": "8632573324",
            "brandId": "BR.mp0Xf8sGBE",
            "chatbotId": "09044196573",
            "menuList": [
                {
                    "postbackId": "P41aj0w7FTu97Zw",
                    "menuType": "autoreply",
                    "title": "국민건강보험공단 검진 안내",
                    "clickCount": 2
                },
                {
                    "postbackId": "ARM6J1wfCn81N6u",
                    "menuType": "autoreply",
                    "title": "위치 안내",
                    "clickCount": 1
                }
            ]
        }
    ],
    "status": 200
}

400

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

{
    "error": {
        "code": "64203",
        "message": "query paramter required [chatbotId]"
    },
    "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
}

401

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

403

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

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