메시지 발송 통계

Request

고객반응 통계 - 캠페인 메시지 발송/읽음확인 통계를 조회합니다.

get

고객반응 통계 - 캠페인 메시지 발송/읽음확인 통계를 조회합니다.

• 동일 Group ID에 발송일 기준 3일간 (D+3) 집계됩니다. 단, 이통사별 발송 성공건수 100건 이상인 경우에 한해 집계됩니다.

• 통계 조회 기간은 데이터 존재 시 최근 1년 6개월 이내 기간 중 최대 31일까지 검색 가능합니다.

• 계정 권한: 마스터, 매니저, 대행사

• 브랜드 권한: 브랜드 대표운영자, 운영자

Authorizations

Path parameters

brandIdstring · max: 13Required

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

Query parameters

startDatestringRequired

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

endDatestringRequired

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

groupIdstringRequired

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

chatbotIdstringOptional

대화방ID Query Parameter 입니다.

Header parameters

X-RCS-Brandkeystring · max: 18Optional

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

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

get

HTTPcURLJavaScriptPython

GET /api/1.1/statQuery/message/{brandId} HTTP/1.1
Host: api-qa.rcsbizcenter.com
Authorization: Bearer JWT
Accept: */*

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
groupId	string	20			발송 캠페인 구분 ID
messagebaseId	string	40			발송 메시지의 messagebaseId(식별 불가시 NA)
deliveredCount	integer				발송 건수
displayedCount	integer				읽음확인 건수

❖ response body sample

200

{
    "code": "20000000",
    "desc": null,
    "result": [
        {
            "statDate": "20240628",
            "corpId": "CO.NoI0czCZ64",
            "corpRegNum": "8632573324",
            "brandId": "BR.mp0Xf8sGBE",
            "chatbotId": "09044196572",
            "groupId": "6227",
            "messagebaseId": "SMwThT00",
            "deliveredCount": 116,
            "displayedCount": 56
        },
        {
            "statDate": "20240629",
            "corpId": "CO.NoI0czCZ64",
            "corpRegNum": "8632573324",
            "brandId": "BR.mp0Xf8sGBE",
            "chatbotId": "09044196572",
            "groupId": "6227",
            "messagebaseId": "SMwThT00",
            "deliveredCount": 0,
            "displayedCount": 9
        }
    ],
    "status": 200
}

400

{
    "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
}

401

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

403

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

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