bizgo Developers
API ReferenceCommunication API

Message insight

Message insight is the set of APIs you use to look up message delivery results by statistics, history, and status.

Look up statistics

GET/api/comm/v1/message/statistics
Try it in the Sandbox

Looks up message acceptance and report statistics by period and channel.

Query Parameters

QUERY

startDate

RequiredString

The lookup start date (YYYYMMDD).

endDate

String

The lookup end date (YYYYMMDD).

serviceType

String

The channel type (SMS, MMS, RCS, ALIMTALK, BRANDMESSAGE).

groupKey

String

The message group key.

Returns

common

Object

The common response section.

data

Object

The product response section.

Request example

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"

Response example

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}

Look up delivery history

GET/api/comm/v1/message/history
Try it in the Sandbox

Looks up message send history by request time. You can review the detailed history through the acceptance, send, and report stages.

Query Parameters

QUERY

requestTime

RequiredString

The reference time for the lookup (YYYY-MM-DDTHH:mm:ss).

serviceType

String Array

The channel type (SMS, MMS, RCS, ALIMTALK, BRANDMESSAGE). Separate multiple values with commas.

groupKey

String

The message group key.

lastSeq

Integer

The pagination sequence.

limit

Integer

The number of records to look up. Default 100, maximum 1,000.

Returns

common

Object

The common response section.

data

Object

The product response section.

Request example

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"

Response example

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}

Look up status (single)

GET/api/comm/v1/message/inquiry/msgKey/{msgKey}
Try it in the Sandbox

Looks up the acceptance, send, and report status of a single message by msgKey.

Path Parameters

PATH

msgKey

RequiredString

The message key to look up.

Returns

common

Object

The common response section.

data

Object

The product response section.

Request example

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

Response example

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}

Look up status (multiple)

GET/api/comm/v1/message/inquiry/requestId/{requestId}
Try it in the Sandbox

Looks up the status of multiple messages in a broadcast request by requestId. requestId is msgKey without its last 3 digits.

Path Parameters

PATH

requestId

RequiredString

The broadcast request identifier. It is msgKey without its last 3 digits.

Returns

common

Object

The common response section.

data

Object

The product response section.

Request example

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

Response example

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}

Look up MO (inbound) history

GET/api/comm/v1/message/history/mo
Try it in the Sandbox

Looks up inbound message history in reverse chronological order by the time the MO occurred. Use lastSeq as the cursor to continue to the next page.

Query Parameters

QUERY

occurredTime

RequiredString

The MO occurrence time used as the lookup baseline (YYYY-MM-DDTHH:mm:ss+09:00). You must include the timezone offset.

from

String

Filters by sender number.

to

String

Filters by recipient number (MO number).

lastSeq

Integer

The cursor used to look up the next page. If omitted, the lookup starts from the most recent record.

limit

Integer

The number of records to look up. Default 100, maximum 1,000.

Returns

common

Object

The common response section.

data

Object

The product response section.

Request example

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"

Response example

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}

Look up a single MO (inbound) message

GET/api/comm/v1/message/inquiry/mo/msgKey/{msgKey}
Try it in the Sandbox

Looks up MO (inbound) messages by msgKey. Because the same msgKey can match multiple records, they are returned as an array.

Path Parameters

PATH

msgKey

RequiredString

The MO message key to look up.

Returns

common

Object

The common response section.

data

Object

The product response section.

Request example

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"

Response example

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}

Kakao Alimtalk insight

Look up the delivery success, read, and click statistics that Kakao provides directly for the Alimtalk channel.

Look up the main insights

GET/api/comm/v1/center/statistics/alimtalk
Try it in the Sandbox

Looks up key Alimtalk statistics — send success/failure, reads, clicks — by period and sender profile.

Query Parameters

QUERY

startDate

RequiredString

The lookup start date (YYYYMMDD).

endDate

RequiredString

The lookup end date (YYYYMMDD).

senderKey

RequiredString Array

The sender profile key. To look up several, separate them with commas.

templateCode

String Array

The template code. To look up several, separate them with commas. If omitted, all templates are returned.

Returns

common

Object

The common response section.

data

Object

The product response section.

Request example

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"

Response example

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}

Hourly reaction metrics

GET/api/comm/v1/center/statistics/alimtalk/reaction/hourly
Try it in the Sandbox

Looks up hourly Alimtalk engagement statistics by period and sender profile.

Query Parameters

QUERY

startDate

RequiredString

The lookup start date (YYYYMMDD).

endDate

RequiredString

The lookup end date (YYYYMMDD).

senderKey

RequiredString Array

The sender profile key. To look up several, separate them with commas.

templateCode

String Array

The template code. To look up several, separate them with commas. If omitted, all templates are returned.

Returns

common

Object

The common response section.

data

Object

The product response section.

Request example

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"

Response example

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}

Look up template details

GET/api/comm/v1/center/statistics/alimtalk/template
Try it in the Sandbox

Looks up per-template Alimtalk statistics by period and sender profile.

Query Parameters

QUERY

startDate

RequiredString

The lookup start date (YYYYMMDD).

endDate

RequiredString

The lookup end date (YYYYMMDD).

senderKey

RequiredString Array

The sender profile key. To look up several, separate them with commas.

templateCode

String Array

The template code. To look up several, separate them with commas. If omitted, all templates are returned.

Returns

common

Object

The common response section.

data

Object

The product response section.

Request example

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"

Response example

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}

Kakao Brand Message insight

Look up the delivery success, read, and click statistics that Kakao provides directly for the Brand Message channel.

Look up the main insights

GET/api/comm/v1/center/statistics/brandmessage
Try it in the Sandbox

Looks up key Brand Message statistics — send success/failure, reads, clicks — by period and sender profile.

Query Parameters

QUERY

startDate

RequiredString

The lookup start date (YYYYMMDD).

endDate

RequiredString

The lookup end date (YYYYMMDD).

senderKey

RequiredString Array

The sender profile key. To look up several, separate them with commas.

templateCode

String Array

The template code. To look up several, separate them with commas. If omitted, all templates are returned.

Returns

common

Object

The common response section.

data

Object

The product response section.

Request example

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"

Response example

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}

Hourly reaction metrics

GET/api/comm/v1/center/statistics/brandmessage/reaction/hourly
Try it in the Sandbox

Looks up hourly Brand Message engagement statistics by period and sender profile.

Query Parameters

QUERY

startDate

RequiredString

The lookup start date (YYYYMMDD).

endDate

RequiredString

The lookup end date (YYYYMMDD).

senderKey

RequiredString Array

The sender profile key. To look up several, separate them with commas.

templateCode

String Array

The template code. To look up several, separate them with commas. If omitted, all templates are returned.

Returns

common

Object

The common response section.

data

Object

The product response section.

Request example

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"

Response example

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}

Look up template details

GET/api/comm/v1/center/statistics/brandmessage/template
Try it in the Sandbox

Looks up per-template Brand Message statistics by period and sender profile.

Query Parameters

QUERY

startDate

RequiredString

The lookup start date (YYYYMMDD).

endDate

RequiredString

The lookup end date (YYYYMMDD).

senderKey

RequiredString Array

The sender profile key. To look up several, separate them with commas.

templateCode

String Array

The template code. To look up several, separate them with commas. If omitted, all templates are returned.

Returns

common

Object

The common response section.

data

Object

The product response section.

Request example

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"

Response example

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 message insight

Look up RCS delivery results by customer response. Beyond delivery and displayed (read) counts, you can see button clicks, persistent menu usage, and brand profile impressions.

Statistics are aggregated per groupId. You must supply a groupId when you send an RCS message; that value is what the statistics are grouped and looked up by. Sends without a groupId are not included, so decide the unit you want to measure (a campaign, a message type, and so on) and pass it with the send request.

Message delivery and display statistics

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

Looks up RCS message delivery counts and displayed (read) counts by date, for a brand and group.

Query Parameters

startDate

RequiredString

The start date of the lookup.

endDate

RequiredString

The end date of the lookup.

groupId

RequiredString

The group ID.

chatbotId

String

The chatbot ID. Supplying it narrows the lookup to that chatbot.

Path Parameters

brandId

RequiredString

The RCS brand ID.

Returns

common

Object

The common response section.

data

Object

The product response section.

Request example

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

Response example

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}

Message button click statistics

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

Looks up how often the buttons in an RCS message were clicked, per card and per button.

Query Parameters

startDate

RequiredString

The start date of the lookup.

endDate

RequiredString

The end date of the lookup.

groupId

RequiredString

The group ID.

chatbotId

String

The chatbot ID. Supplying it narrows the lookup to that chatbot.

Path Parameters

brandId

RequiredString

The RCS brand ID.

Returns

common

Object

The common response section.

data

Object

The product response section.

Request example

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

Response example

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}

Chat room menu click statistics

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

Looks up click counts for the persistent menu at the bottom of the chat room, per menu item. This is the only one of these specifications that requires a chatbot ID.

Query Parameters

startDate

RequiredString

The start date of the lookup.

endDate

RequiredString

The end date of the lookup.

chatbotId

RequiredString

The chatbot ID.

Path Parameters

brandId

RequiredString

The RCS brand ID.

Returns

common

Object

The common response section.

data

Object

The product response section.

Request example

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

Response example

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}

Brand profile display statistics

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

Looks up how often the brand profile was displayed, by date. It takes only a period — no group or chatbot condition.

Query Parameters

startDate

RequiredString

The start date of the lookup.

endDate

RequiredString

The end date of the lookup.

Path Parameters

brandId

RequiredString

The RCS brand ID.

Returns

common

Object

The common response section.

data

Object

The product response section.

Request example

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

Response example

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}