bizgo Developers
API 레퍼런스커뮤니케이션 API

메시지 인사이트

메시지 인사이트는 메시지 발송 결과를 통계, 이력, 상태 기준으로 조회하는 API입니다.

통계 조회

GET/api/comm/v1/message/statistics
샌드박스로 테스트하기

기간/채널 기준으로 메시지 접수 및 리포트 통계를 조회합니다.

Query Parameters

QUERY

startDate

필수String

조회 시작일(YYYYMMDD)입니다.

endDate

String

조회 종료일(YYYYMMDD)입니다.

serviceType

String

채널 타입(SMS, MMS, RCS, ALIMTALK, BRANDMESSAGE)입니다.

groupKey

String

메시지 그룹 키입니다.

Returns

common

Object

공통 응답 영역입니다.

data

Object

상품 응답 영역입니다.

요청 예시

1curl -X GET "https://mars.ibapi.kr/api/comm/v1/message/statistics?startDate=20251101&endDate=20251130&serviceType=SMS" \
2 -H "Authorization: {ApiKey}" \
3 -H "Content-Type: application/json"

응답 예시

1{
2 "common": {
3 "authCode":"A000",
4 "authResult":"Success",
5 "infobankTrId":"헤더값 X-Infobank-Tracking-Id"
6 },
7 "data": {
8 "code":"A000",
9 "result":"Success",
10 "data": {
11 "statistics": [
12 {
13 "statDate":"20251101",
14 "recvTotalCnt": 131,
15 "recvSuccCnt": 124,
16 "recvFailCnt": 7,
17 "reportTotalCnt": 131,
18 "reportSuccCnt": 118,
19 "reportFailCnt": 13
20 }
21 ]
22 }
23 }
24}

발송 이력 조회

GET/api/comm/v1/message/history
샌드박스로 테스트하기

요청 시각 기준으로 메시지 발송 이력을 조회합니다. 접수·발송·리포트 단계까지 상세 이력을 확인할 수 있습니다.

Query Parameters

QUERY

requestTime

필수String

조회 기준 시각(YYYY-MM-DDTHH:mm:ss)입니다.

serviceType

String Array

채널 타입(SMS, MMS, RCS, ALIMTALK, BRANDMESSAGE)입니다. 여러 개는 콤마(,)로 구분해 전달합니다.

groupKey

String

메시지 그룹 키입니다.

lastSeq

Integer

페이지네이션 시퀀스입니다.

limit

Integer

조회 건수입니다. 기본값 100, 최대 1,000입니다.

Returns

common

Object

공통 응답 영역입니다.

data

Object

상품 응답 영역입니다.

요청 예시

1curl -X GET "https://mars.ibapi.kr/api/comm/v1/message/history?requestTime=2025-11-01T00:00:00&limit=100" \
2 -H "Authorization: {ApiKey}" \
3 -H "Content-Type: application/json"

응답 예시

1{
2 "common": {
3 "authCode":"A000",
4 "authResult":"Success",
5 "infobankTrId":"Infobank-Tracking-Id"
6 },
7 "data": {
8 "code":"A000",
9 "result":"Success",
10 "data": {
11 "messages": [
12 {
13 "msgKey":"msgkey1",
14 "serviceType":"SMS",
15 "msgType":"SM",
16 "to":"01000000000",
17 "fallback":"Y",
18 "responseCode":"A000",
19 "responseText":"요청 성공",
20 "requestTime":"2025-11-13T15:15:56+09:00",
21 "sendTime":"2025-11-13T15:15:56+09:00",
22 "reportTime":"2025-11-13T15:15:59+09:00",
23 "reportType":"0",
24 "reportCode":"10000",
25 "reportText":"성공",
26 "carrier":"10003"
27 },
28 {
29 "msgKey":"msgkey1",
30 "serviceType":"RCS",
31 "msgType":"RS",
32 "to":"01000000000",
33 "fallback":"Y",
34 "responseCode":"A000",
35 "responseText":"요청 성공",
36 "requestTime":"2025-11-13T15:15:56+09:00",
37 "sendTime":"2025-11-13T15:15:56+09:00",
38 "reportTime":"2025-11-13T15:15:55+09:00",
39 "reportType":"0",
40 "reportCode":"54003",
41 "reportText":"단말기기로 RCS 메시지를 전송할 수 없습니다.",
42 "carrier":"20003"
43 },
44 {
45 "msgKey":"msgkey1",
46 "serviceType":"ALIMTALK",
47 "msgType":"AT",
48 "to":"01000000000",
49 "fallback":"N",
50 "responseCode":"A000",
51 "responseText":"요청 성공",
52 "requestTime":"2025-11-13T15:15:56+09:00",
53 "sendTime":"2025-11-13T15:15:56+09:00",
54 "reportTime":"2025-11-13T15:15:56+09:00",
55 "reportType":"0",
56 "reportCode":"63020",
57 "reportText":"알림톡 수신 차단 (2025-01-15 적용)"
58 },
59 {
60 "msgKey":"msgkey3",
61 "serviceType":"ALIMTALK",
62 "msgType":"AT",
63 "to":"01000000000",
64 "fallback":"N",
65 "responseCode":"A000",
66 "responseText":"요청 성공",
67 "requestTime":"2025-11-13T15:15:56+09:00",
68 "sendTime":"2025-11-13T15:15:56+09:00",
69 "reportTime":"2025-11-13T15:15:57+09:00",
70 "reportType":"0",
71 "reportCode":"10000",
72 "reportText":"성공"
73 },
74 {
75 "msgKey":"msgkey2",
76 "serviceType":"ALIMTALK",
77 "to":"",
78 "fallback":"N",
79 "responseCode":"A306",
80 "responseText":"유효하지 않거나 비어있는 필드 (필드명 : to)",
81 "requestTime":"2025-11-13T15:15:56+09:00",
82 "reportType":"1"
83 }
84 ]
85 }
86 }
87}

상태 조회(단건)

GET/api/comm/v1/message/inquiry/msgKey/{msgKey}
샌드박스로 테스트하기

msgKey 기준으로 단건 메시지의 접수·발송·리포트 상태를 조회합니다.

Path Parameters

PATH

msgKey

필수String

조회할 메시지 키입니다.

Returns

common

Object

공통 응답 영역입니다.

data

Object

상품 응답 영역입니다.

요청 예시

1curl -X GET "https://mars.ibapi.kr/api/comm/v1/message/inquiry/msgKey/{msgKey}" \
2 -H "Authorization: {ApiKey}" \
3 -H "Content-Type: application/json"

응답 예시

1{
2 "common": {
3 "authCode":"A000",
4 "authResult":"Success",
5 "infobankTrId":"헤더값 X-Infobank-Tracking-Id"
6 },
7 "data": {
8 "code":"A000",
9 "result":"Success",
10 "data": {
11 "messages": [
12 {
13 "msgKey":"msgKey",
14 "serviceType":"RCS",
15 "msgType":"RS",
16 "to":"01000000000",
17 "fallback":"Y",
18 "responseCode":"A000",
19 "responseText":"요청 성공",
20 "requestTime":"2025-11-13T14:18:18+09:00",
21 "sendTime":"2025-11-13T14:18:18+09:00",
22 "reportTime":"2025-11-13T14:18:18+09:00",
23 "reportType":"0",
24 "reportCode":"54003",
25 "reportText":"단말기기로 RCS 메시지를 전송할 수 없습니다.",
26 "carrier":"20003"
27 },
28 {
29 "msgKey":"msgKey",
30 "serviceType":"ALIMTALK",
31 "msgType":"AT",
32 "to":"01000000000",
33 "fallback":"N",
34 "responseCode":"A000",
35 "responseText":"요청 성공",
36 "requestTime":"2025-11-13T14:18:18+09:00",
37 "sendTime":"2025-11-13T14:18:18+09:00",
38 "reportTime":"2025-11-13T14:18:18+09:00",
39 "reportType":"0",
40 "reportCode":"63020",
41 "reportText":"알림톡 수신 차단 (2025-01-15 적용)"
42 },
43 {
44 "msgKey":"msgKey",
45 "serviceType":"SMS",
46 "msgType":"SM",
47 "to":"01000000000",
48 "fallback":"Y",
49 "responseCode":"A000",
50 "responseText":"요청 성공",
51 "requestTime":"2025-11-13T14:18:18+09:00",
52 "sendTime":"2025-11-13T14:18:19+09:00",
53 "reportTime":"2025-11-13T14:18:20+09:00",
54 "reportType":"0",
55 "reportCode":"10000",
56 "reportText":"성공",
57 "carrier":"10003"
58 }
59 ]
60 }
61 }
62}

상태 조회(여러건)

GET/api/comm/v1/message/inquiry/requestId/{requestId}
샌드박스로 테스트하기

requestId 기준으로 동보 요청의 다건 메시지 상태를 일괄 조회합니다. requestId는 msgKey 끝 3자리를 제외한 값입니다.

Path Parameters

PATH

requestId

필수String

동보 요청 식별자입니다. msgKey 끝 3자리를 제외한 값입니다.

Returns

common

Object

공통 응답 영역입니다.

data

Object

상품 응답 영역입니다.

요청 예시

1curl -X GET "https://mars.ibapi.kr/api/comm/v1/message/inquiry/requestId/{requestId}" \
2 -H "Authorization: {ApiKey}" \
3 -H "Content-Type: application/json"

응답 예시

1{
2 "common": {
3 "authCode":"A000",
4 "authResult":"Success",
5 "infobankTrId":"헤더값 X-Infobank-Tracking-Id"
6 },
7 "data": {
8 "code":"A000",
9 "result":"Success",
10 "data": {
11 "messages": [
12 {
13 "msgKey":"requestId000",
14 "serviceType":"BRANDMESSAGE",
15 "msgType":"FT",
16 "to":"01000000000",
17 "fallback":"N",
18 "responseCode":"A000",
19 "responseText":"요청 성공",
20 "requestTime":"2025-11-13T14:58:31+09:00",
21 "sendTime":"2025-11-13T14:58:31+09:00",
22 "reportTime":"2025-11-13T14:58:31+09:00",
23 "reportType":"0",
24 "reportCode":"10000",
25 "reportText":"성공",
26 "userType":""
27 },
28 {
29 "msgKey":"requestId002",
30 "serviceType":"SMS",
31 "msgType":"SM",
32 "to":"01000000002",
33 "fallback":"Y",
34 "responseCode":"A000",
35 "responseText":"요청 성공",
36 "requestTime":"2025-11-13T14:58:31+09:00",
37 "sendTime":"2025-11-13T14:58:31+09:00",
38 "reportTime":"2025-11-13T14:58:33+09:00",
39 "reportType":"0",
40 "reportCode":"10000",
41 "reportText":"성공",
42 "carrier":"10003"
43 },
44 {
45 "msgKey":"{requestId}001",
46 "serviceType":"BRANDMESSAGE",
47 "msgType":"FT",
48 "to":"01000000001",
49 "fallback":"N",
50 "responseCode":"A000",
51 "responseText":"요청 성공",
52 "requestTime":"2025-11-13T14:58:31+09:00",
53 "sendTime":"2025-11-13T14:58:31+09:00",
54 "reportTime":"2025-11-13T14:58:31+09:00",
55 "reportType":"0",
56 "reportCode":"10000",
57 "reportText":"성공",
58 "userType":""
59 },
60 {
61 "msgKey":"{requestId}002",
62 "serviceType":"BRANDMESSAGE",
63 "msgType":"FT",
64 "to":"01000000002",
65 "fallback":"N",
66 "responseCode":"A000",
67 "responseText":"요청 성공",
68 "requestTime":"2025-11-13T14:58:31+09:00",
69 "sendTime":"2025-11-13T14:58:31+09:00",
70 "reportTime":"2025-11-13T14:58:31+09:00",
71 "reportType":"0",
72 "reportCode":"63018",
73 "reportText":"메시지를 전송할 수 없음",
74 "userType":""
75 },
76 {
77 "msgKey":"{requestId}002",
78 "serviceType":"RCS",
79 "msgType":"RS",
80 "to":"01000000002",
81 "fallback":"Y",
82 "responseCode":"A000",
83 "responseText":"요청 성공",
84 "requestTime":"2025-11-13T14:58:31+09:00",
85 "sendTime":"2025-11-13T14:58:31+09:00",
86 "reportTime":"2025-11-13T14:58:30+09:00",
87 "reportType":"0",
88 "reportCode":"54003",
89 "reportText":"단말기기로 RCS 메시지를 전송할 수 없습니다.",
90 "carrier":"20003"
91 }
92 ]
93 }
94 }
95}

MO(수신) 이력 조회

GET/api/comm/v1/message/history/mo
샌드박스로 테스트하기

MO 발생 시각 기준으로 수신 메시지 이력을 최신순으로 조회합니다. lastSeq를 커서로 사용해 다음 페이지를 이어서 조회합니다.

Query Parameters

QUERY

occurredTime

필수String

조회 기준 MO 발생 시각(YYYY-MM-DDTHH:mm:ss+09:00)입니다. 타임존 오프셋까지 포함해야 합니다.

from

String

발신번호로 필터링합니다.

to

String

수신번호(MO 번호)로 필터링합니다.

lastSeq

Integer

다음 페이지 조회에 사용하는 커서입니다. 미입력 시 최신 건부터 조회합니다.

limit

Integer

조회 건수입니다. 기본값 100, 최대 1,000입니다.

Returns

common

Object

공통 응답 영역입니다.

data

Object

상품 응답 영역입니다.

요청 예시

1curl -X GET "https://mars.ibapi.kr/api/comm/v1/message/history/mo?occurredTime=2026-04-23T14:11:01%2B09:00&limit=100" \
2 -H "Authorization: {ApiKey}" \
3 -H "Content-Type: application/json"

응답 예시

1{
2 "common": {
3 "authCode":"A000",
4 "authResult":"Success",
5 "infobankTrId":"헤더값 X-Infobank-Tracking-Id"
6 },
7 "data": {
8 "code":"A000",
9 "result":"Success",
10 "data": {
11 "lastSeq": 949194539147,
12 "hasNext": true,
13 "messages": [
14 {
15 "msgKey":"20260423141101437PSM949194539147",
16 "serviceType":"MO",
17 "msgType":"SM",
18 "to":"0316000000",
19 "from":"01000000000",
20 "originator":"01000000000",
21 "content":"수신거부",
22 "carrier":"10003",
23 "occurredTime":"2026-04-23T14:11:01+09:00"
24 }
25 ]
26 }
27 }
28}

MO(수신) 단건 조회

GET/api/comm/v1/message/inquiry/mo/msgKey/{msgKey}
샌드박스로 테스트하기

msgKey 기준으로 MO(수신) 메시지를 조회합니다. 동일한 msgKey가 여러 건일 수 있어 배열로 반환합니다.

Path Parameters

PATH

msgKey

필수String

조회할 MO 메시지 키입니다.

Returns

common

Object

공통 응답 영역입니다.

data

Object

상품 응답 영역입니다.

요청 예시

1curl -X GET "https://mars.ibapi.kr/api/comm/v1/message/inquiry/mo/msgKey/{msgKey}" \
2 -H "Authorization: {ApiKey}" \
3 -H "Content-Type: application/json"

응답 예시

1{
2 "common": {
3 "authCode":"A000",
4 "authResult":"Success",
5 "infobankTrId":"헤더값 X-Infobank-Tracking-Id"
6 },
7 "data": {
8 "code":"A000",
9 "result":"Success",
10 "data": {
11 "messages": [
12 {
13 "msgKey":"20260423141101437PSM949194539147",
14 "serviceType":"MO",
15 "msgType":"SM",
16 "to":"0316000000",
17 "from":"01000000000",
18 "originator":"01000000000",
19 "content":"수신거부",
20 "carrier":"10003",
21 "occurredTime":"2026-04-23T14:11:01+09:00"
22 }
23 ]
24 }
25 }
26}

카카오 알림톡 인사이트

카카오에서 직접 제공하는 알림톡 채널 기반의 발송 성공·읽음·클릭 통계를 조회합니다.

주요 인사이트 조회

GET/api/comm/v1/center/statistics/alimtalk
샌드박스로 테스트하기

기간·발신프로필 기준으로 알림톡 발송 성공/실패·읽음·클릭 등 주요 통계를 조회합니다.

Query Parameters

QUERY

startDate

필수String

조회 시작일(YYYYMMDD)입니다.

endDate

필수String

조회 종료일(YYYYMMDD)입니다.

senderKey

필수String Array

발신프로필 키입니다. 여러 개를 조회하려면 콤마(,)로 구분해 전달합니다.

templateCode

String Array

템플릿 코드입니다. 여러 개를 조회하려면 콤마(,)로 구분해 전달합니다. 미입력 시 전체 조회합니다.

Returns

common

Object

공통 응답 영역입니다.

data

Object

상품 응답 영역입니다.

요청 예시

1curl -X GET "https://mars.ibapi.kr/api/comm/v1/center/statistics/alimtalk?startDate=20251101&endDate=20251130&senderKey={senderKey}" \
2 -H "Authorization: {ApiKey}" \
3 -H "Content-Type: application/json"

응답 예시

1{
2 "common": {
3 "authCode":"A000",
4 "authResult":"Success",
5 "infobankTrId":"Infobank-Tracking-Id"
6 },
7 "data": {
8 "code":"A000",
9 "result":"Success",
10 "data": {
11 "statistics": [
12 {
13 "successCount": 1240,
14 "failCount": 18,
15 "readCount": 875,
16 "buttonClickCount": 312,
17 "listClickCount": 0,
18 "thumbnailClickCount": 0,
19 "etcClickCount": 44,
20 "sendRate": 98.57,
21 "readRate": 70.56,
22 "clickRate": 25.16,
23 "ctr": 35.66
24 }
25 ]
26 }
27 }
28}

시간별 반응 지표

GET/api/comm/v1/center/statistics/alimtalk/reaction/hourly
샌드박스로 테스트하기

기간·발신프로필 기준으로 알림톡 시간대별 반응 통계를 조회합니다.

Query Parameters

QUERY

startDate

필수String

조회 시작일(YYYYMMDD)입니다.

endDate

필수String

조회 종료일(YYYYMMDD)입니다.

senderKey

필수String Array

발신프로필 키입니다. 여러 개를 조회하려면 콤마(,)로 구분해 전달합니다.

templateCode

String Array

템플릿 코드입니다. 여러 개를 조회하려면 콤마(,)로 구분해 전달합니다. 미입력 시 전체 조회합니다.

Returns

common

Object

공통 응답 영역입니다.

data

Object

상품 응답 영역입니다.

요청 예시

1curl -X GET "https://mars.ibapi.kr/api/comm/v1/center/statistics/alimtalk/reaction/hourly?startDate=20251101&endDate=20251130&senderKey={senderKey}" \
2 -H "Authorization: {ApiKey}" \
3 -H "Content-Type: application/json"

응답 예시

1{
2 "common": {
3 "authCode":"A000",
4 "authResult":"Success",
5 "infobankTrId":"Infobank-Tracking-Id"
6 },
7 "data": {
8 "code":"A000",
9 "result":"Success",
10 "data": {
11 "statistics": [
12 {
13 "hour":"14",
14 "successCount": 1240,
15 "failCount": 18,
16 "readCount": 875,
17 "buttonClickCount": 312,
18 "listClickCount": 0,
19 "thumbnailClickCount": 0,
20 "etcClickCount": 44,
21 "sendRate": 98.57,
22 "readRate": 70.56,
23 "clickRate": 25.16,
24 "ctr": 35.66
25 }
26 ]
27 }
28 }
29}

템플릿 상세 조회

GET/api/comm/v1/center/statistics/alimtalk/template
샌드박스로 테스트하기

기간·발신프로필 기준으로 알림톡 템플릿별 통계를 조회합니다.

Query Parameters

QUERY

startDate

필수String

조회 시작일(YYYYMMDD)입니다.

endDate

필수String

조회 종료일(YYYYMMDD)입니다.

senderKey

필수String Array

발신프로필 키입니다. 여러 개를 조회하려면 콤마(,)로 구분해 전달합니다.

templateCode

String Array

템플릿 코드입니다. 여러 개를 조회하려면 콤마(,)로 구분해 전달합니다. 미입력 시 전체 조회합니다.

Returns

common

Object

공통 응답 영역입니다.

data

Object

상품 응답 영역입니다.

요청 예시

1curl -X GET "https://mars.ibapi.kr/api/comm/v1/center/statistics/alimtalk/template?startDate=20251101&endDate=20251130&senderKey={senderKey}" \
2 -H "Authorization: {ApiKey}" \
3 -H "Content-Type: application/json"

응답 예시

1{
2 "common": {
3 "authCode":"A000",
4 "authResult":"Success",
5 "infobankTrId":"Infobank-Tracking-Id"
6 },
7 "data": {
8 "code":"A000",
9 "result":"Success",
10 "data": {
11 "statistics": [
12 {
13 "templateCode":"ORDER_COMPLETE_001",
14 "templateName":"주문 완료 알림",
15 "successCount": 1240,
16 "failCount": 18,
17 "readCount": 875,
18 "buttonClickCount": 312,
19 "listClickCount": 0,
20 "thumbnailClickCount": 0,
21 "etcClickCount": 44,
22 "sendRate": 98.57,
23 "readRate": 70.56,
24 "clickRate": 25.16,
25 "ctr": 35.66
26 }
27 ]
28 }
29 }
30}

카카오 브랜드메시지 인사이트

카카오에서 직접 제공하는 브랜드메시지 채널 기반의 발송 성공·읽음·클릭 통계를 조회합니다.

주요 인사이트 조회

GET/api/comm/v1/center/statistics/brandmessage
샌드박스로 테스트하기

기간·발신프로필 기준으로 브랜드메시지 발송 성공/실패·읽음·클릭 등 주요 통계를 조회합니다.

Query Parameters

QUERY

startDate

필수String

조회 시작일(YYYYMMDD)입니다.

endDate

필수String

조회 종료일(YYYYMMDD)입니다.

senderKey

필수String Array

발신프로필 키입니다. 여러 개를 조회하려면 콤마(,)로 구분해 전달합니다.

templateCode

String Array

템플릿 코드입니다. 여러 개를 조회하려면 콤마(,)로 구분해 전달합니다. 미입력 시 전체 조회합니다.

Returns

common

Object

공통 응답 영역입니다.

data

Object

상품 응답 영역입니다.

요청 예시

1curl -X GET "https://mars.ibapi.kr/api/comm/v1/center/statistics/brandmessage?startDate=20251101&endDate=20251130&senderKey={senderKey}" \
2 -H "Authorization: {ApiKey}" \
3 -H "Content-Type: application/json"

응답 예시

1{
2 "common": {
3 "authCode":"A000",
4 "authResult":"Success",
5 "infobankTrId":"Infobank-Tracking-Id"
6 },
7 "data": {
8 "code":"A000",
9 "result":"Success",
10 "data": {
11 "statistics": [
12 {
13 "successCount": 1240,
14 "failCount": 18,
15 "readCount": 875,
16 "buttonClickCount": 312,
17 "listClickCount": 0,
18 "thumbnailClickCount": 0,
19 "etcClickCount": 44,
20 "sendRate": 98.57,
21 "readRate": 70.56,
22 "clickRate": 25.16,
23 "ctr": 35.66
24 }
25 ]
26 }
27 }
28}

시간별 반응 지표

GET/api/comm/v1/center/statistics/brandmessage/reaction/hourly
샌드박스로 테스트하기

기간·발신프로필 기준으로 브랜드메시지 시간대별 반응 통계를 조회합니다.

Query Parameters

QUERY

startDate

필수String

조회 시작일(YYYYMMDD)입니다.

endDate

필수String

조회 종료일(YYYYMMDD)입니다.

senderKey

필수String Array

발신프로필 키입니다. 여러 개를 조회하려면 콤마(,)로 구분해 전달합니다.

templateCode

String Array

템플릿 코드입니다. 여러 개를 조회하려면 콤마(,)로 구분해 전달합니다. 미입력 시 전체 조회합니다.

Returns

common

Object

공통 응답 영역입니다.

data

Object

상품 응답 영역입니다.

요청 예시

1curl -X GET "https://mars.ibapi.kr/api/comm/v1/center/statistics/brandmessage/reaction/hourly?startDate=20251101&endDate=20251130&senderKey={senderKey}" \
2 -H "Authorization: {ApiKey}" \
3 -H "Content-Type: application/json"

응답 예시

1{
2 "common": {
3 "authCode":"A000",
4 "authResult":"Success",
5 "infobankTrId":"Infobank-Tracking-Id"
6 },
7 "data": {
8 "code":"A000",
9 "result":"Success",
10 "data": {
11 "statistics": [
12 {
13 "hour":"14",
14 "successCount": 1240,
15 "failCount": 18,
16 "readCount": 875,
17 "buttonClickCount": 312,
18 "listClickCount": 0,
19 "thumbnailClickCount": 0,
20 "etcClickCount": 44,
21 "sendRate": 98.57,
22 "readRate": 70.56,
23 "clickRate": 25.16,
24 "ctr": 35.66
25 }
26 ]
27 }
28 }
29}

템플릿 상세 조회

GET/api/comm/v1/center/statistics/brandmessage/template
샌드박스로 테스트하기

기간·발신프로필 기준으로 브랜드메시지 템플릿별 통계를 조회합니다.

Query Parameters

QUERY

startDate

필수String

조회 시작일(YYYYMMDD)입니다.

endDate

필수String

조회 종료일(YYYYMMDD)입니다.

senderKey

필수String Array

발신프로필 키입니다. 여러 개를 조회하려면 콤마(,)로 구분해 전달합니다.

templateCode

String Array

템플릿 코드입니다. 여러 개를 조회하려면 콤마(,)로 구분해 전달합니다. 미입력 시 전체 조회합니다.

Returns

common

Object

공통 응답 영역입니다.

data

Object

상품 응답 영역입니다.

요청 예시

1curl -X GET "https://mars.ibapi.kr/api/comm/v1/center/statistics/brandmessage/template?startDate=20251101&endDate=20251130&senderKey={senderKey}" \
2 -H "Authorization: {ApiKey}" \
3 -H "Content-Type: application/json"

응답 예시

1{
2 "common": {
3 "authCode":"A000",
4 "authResult":"Success",
5 "infobankTrId":"Infobank-Tracking-Id"
6 },
7 "data": {
8 "code":"A000",
9 "result":"Success",
10 "data": {
11 "statistics": [
12 {
13 "templateCode":"BRAND_PROMO_001",
14 "templateName":"프로모션 안내",
15 "successCount": 1240,
16 "failCount": 18,
17 "readCount": 875,
18 "buttonClickCount": 312,
19 "listClickCount": 0,
20 "thumbnailClickCount": 0,
21 "etcClickCount": 44,
22 "sendRate": 98.57,
23 "readRate": 70.56,
24 "clickRate": 25.16,
25 "ctr": 35.66
26 }
27 ]
28 }
29 }
30}

RCS 메시지 인사이트

RCS 발송 결과를 고객 반응 기준으로 조회합니다. 발송 건수와 노출(읽음) 수는 물론 버튼 클릭, 대화방 메뉴 이용, 브랜드 프로필 노출까지 확인할 수 있습니다.

통계는 groupId 단위로 집계됩니다. RCS 메시지를 발송할 때 groupId 값을 넣어야 그 값으로 그룹화되어 조회할 수 있습니다. 발송 시 groupId를 넣지 않은 건은 조회 대상에 포함되지 않으므로, 통계를 볼 단위(캠페인·메시지 종류 등)를 미리 정해 발송 요청에 함께 전달하세요.

메시지 발송·노출 통계

GET/api/comm/v1/center/rcs/brandId/{brandId}/stat/message

브랜드·그룹 기준으로 RCS 메시지의 발송 건수와 노출(읽음) 건수를 일자별로 조회합니다.

Query Parameters

startDate

필수String

조회 시작일입니다.

endDate

필수String

조회 종료일입니다.

groupId

필수String

그룹 ID입니다.

chatbotId

String

챗봇 ID입니다. 지정하면 해당 챗봇으로 범위를 좁힙니다.

Path Parameters

brandId

필수String

RCS 브랜드 ID입니다.

Returns

common

Object

공통 응답 영역입니다.

data

Object

상품 응답 영역입니다.

요청 예시

1curl -X GET "https://mars.ibapi.kr/api/comm/v1/center/rcs/brandId/{brandId}/stat/message?startDate=20260801&endDate=20260831&groupId={groupId}" -H "Authorization: {ApiKey}"

응답 예시

1{
2 "common": {
3 "authCode":"A000",
4 "authResult":"Success",
5 "infobankTrId":"header-value-X-Infobank-Tracking-Id"
6 },
7 "data": {
8 "code":"A000",
9 "result":"Success",
10 "rcs": {
11 "stat": [
12 {
13 "statDate":"20260801",
14 "corpId":"{corpId}",
15 "corpRegNum":"0000000000",
16 "brandId":"{brandId}",
17 "chatbotId":"{chatbotId}",
18 "groupId":"{groupId}",
19 "messagebaseId":"{messagebaseId}",
20 "deliveredCount": 2540,
21 "displayedCount": 1980
22 }
23 ]
24 }
25 }
26}

메시지 버튼 클릭 통계

GET/api/comm/v1/center/rcs/brandId/{brandId}/stat/messageButton

RCS 메시지에 포함된 버튼이 얼마나 클릭됐는지 카드·버튼 단위로 조회합니다.

Query Parameters

startDate

필수String

조회 시작일입니다.

endDate

필수String

조회 종료일입니다.

groupId

필수String

그룹 ID입니다.

chatbotId

String

챗봇 ID입니다. 지정하면 해당 챗봇으로 범위를 좁힙니다.

Path Parameters

brandId

필수String

RCS 브랜드 ID입니다.

Returns

common

Object

공통 응답 영역입니다.

data

Object

상품 응답 영역입니다.

요청 예시

1curl -X GET "https://mars.ibapi.kr/api/comm/v1/center/rcs/brandId/{brandId}/stat/messageButton?startDate=20260801&endDate=20260831&groupId={groupId}" -H "Authorization: {ApiKey}"

응답 예시

1{
2 "common": {
3 "authCode":"A000",
4 "authResult":"Success",
5 "infobankTrId":"header-value-X-Infobank-Tracking-Id"
6 },
7 "data": {
8 "code":"A000",
9 "result":"Success",
10 "rcs": {
11 "stat": [
12 {
13 "statDate":"20260801",
14 "corpId":"{corpId}",
15 "corpRegNum":"0000000000",
16 "brandId":"{brandId}",
17 "chatbotId":"{chatbotId}",
18 "groupId":"{groupId}",
19 "messagebaseId":"{messagebaseId}",
20 "reactionType":"button",
21 "cardNum": 1,
22 "buttonList": [
23 {
24 "buttonNum": 1,
25 "actionType":"urlAction",
26 "title":"자세히 보기",
27 "clickCount": 128
28 }
29 ]
30 }
31 ]
32 }
33 }
34}

대화방 메뉴 클릭 통계

GET/api/comm/v1/center/rcs/brandId/{brandId}/stat/persistentMenu

대화방 하단 고정 메뉴의 클릭 수를 메뉴 단위로 조회합니다. 이 규격만 챗봇 ID가 필수입니다.

Query Parameters

startDate

필수String

조회 시작일입니다.

endDate

필수String

조회 종료일입니다.

chatbotId

필수String

챗봇 ID입니다.

Path Parameters

brandId

필수String

RCS 브랜드 ID입니다.

Returns

common

Object

공통 응답 영역입니다.

data

Object

상품 응답 영역입니다.

요청 예시

1curl -X GET "https://mars.ibapi.kr/api/comm/v1/center/rcs/brandId/{brandId}/stat/persistentMenu?startDate=20260801&endDate=20260831&chatbotId={chatbotId}" -H "Authorization: {ApiKey}"

응답 예시

1{
2 "common": {
3 "authCode":"A000",
4 "authResult":"Success",
5 "infobankTrId":"header-value-X-Infobank-Tracking-Id"
6 },
7 "data": {
8 "code":"A000",
9 "result":"Success",
10 "rcs": {
11 "stat": [
12 {
13 "statDate":"20260801",
14 "corpId":"{corpId}",
15 "corpRegNum":"0000000000",
16 "brandId":"{brandId}",
17 "chatbotId":"{chatbotId}",
18 "menuList": [
19 {
20 "postbackId":"menu_home",
21 "menuType":"text",
22 "actionType":"postbackAction",
23 "title":"홈",
24 "clickCount": 340,
25 "subList": [
26 {
27 "postbackId":"menu_home_notice",
28 "menuType":"text",
29 "actionType":"postbackAction",
30 "title":"공지사항",
31 "clickCount": 52
32 }
33 ]
34 }
35 ]
36 }
37 ]
38 }
39 }
40}

브랜드 프로필 노출 통계

GET/api/comm/v1/center/rcs/brandId/{brandId}/stat/brandProfile

브랜드 프로필이 노출된 건수를 일자별로 조회합니다. 그룹·챗봇 조건 없이 기간만으로 조회합니다.

Query Parameters

startDate

필수String

조회 시작일입니다.

endDate

필수String

조회 종료일입니다.

Path Parameters

brandId

필수String

RCS 브랜드 ID입니다.

Returns

common

Object

공통 응답 영역입니다.

data

Object

상품 응답 영역입니다.

요청 예시

1curl -X GET "https://mars.ibapi.kr/api/comm/v1/center/rcs/brandId/{brandId}/stat/brandProfile?startDate=20260801&endDate=20260831" -H "Authorization: {ApiKey}"

응답 예시

1{
2 "common": {
3 "authCode":"A000",
4 "authResult":"Success",
5 "infobankTrId":"header-value-X-Infobank-Tracking-Id"
6 },
7 "data": {
8 "code":"A000",
9 "result":"Success",
10 "rcs": {
11 "stat": [
12 {
13 "statDate":"20260801",
14 "chatbotId":"{chatbotId}",
15 "displayedCount": 1820
16 }
17 ]
18 }
19 }
20}