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

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

groupKey

String

메시지 그룹 키입니다.

lastSeq

String

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

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": "N",
18 "responseCode": "A100",
19 "responseText": "Success",
20 "requestTime": "2025-11-01T00: 00: 00+09: 00",
21 "sendTime": "2025-11-01T00: 00: 01+09: 00",
22 "reportTime": "2025-11-01T00: 00: 04+09: 00",
23 "reportType": "MO",
24 "reportCode": "10000",
25 "reportText": "SUCCESS",
26 "carrier": "SKT",
27 "ref": null
28 }
29 ]
30 }
31 }
32}

상태 조회(msgKey)

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": "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": "N",
18 "responseCode": "A100",
19 "responseText": "Success",
20 "requestTime": "2025-11-01T00: 00: 00+09: 00",
21 "sendTime": "2025-11-01T00: 00: 01+09: 00",
22 "reportTime": "2025-11-01T00: 00: 05+09: 00",
23 "reportType": "MO",
24 "reportCode": "54003",
25 "reportText": "DELIVERED_TO_DEVICE",
26 "carrier": "KT",
27 "ref": null
28 }
29 ]
30 }
31 }
32}

상태 조회(requestId)

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": "Infobank-Tracking-Id"
6 },
7 "data": {
8 "code": "A000",
9 "result": "Success",
10 "data": {
11 "messages": [
12 {
13 "msgKey": "requestId001",
14 "serviceType": "BRANDMESSAGE",
15 "msgType": "FT",
16 "to": "01000000001",
17 "fallback": "N",
18 "responseCode": "A100",
19 "responseText": "Success",
20 "requestTime": "2025-11-01T00: 00: 00+09: 00",
21 "sendTime": "2025-11-01T00: 00: 01+09: 00",
22 "reportTime": "2025-11-01T00: 00: 06+09: 00",
23 "reportType": "MO",
24 "reportCode": "10000",
25 "reportText": "SUCCESS",
26 "carrier": null,
27 "userType": "FRIEND",
28 "ref": null
29 }
30 ]
31 }
32 }
33}

카카오 알림톡 인사이트

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

주요 인사이트 조회

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

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

Query Parameters

QUERY

startDate

필수String

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

endDate

필수String

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

senderKey

필수String

발신프로필 키입니다.

templateCode

String

템플릿 코드입니다. 미입력 시 전체 조회합니다.

Returns

common

Object

공통 응답 영역입니다.

data

Object

상품 응답 영역입니다.

요청 예시

1curl -X GET "https://mars.ibapi.kr/api/comm/v1/center/statistics/alimtalk?startDate=20251101&endDate=20251130&senderKey={SENDER_KEY}" \
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

발신프로필 키입니다.

templateCode

String

템플릿 코드입니다. 미입력 시 전체 조회합니다.

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={SENDER_KEY}" \
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

발신프로필 키입니다.

templateCode

String

템플릿 코드입니다. 미입력 시 전체 조회합니다.

Returns

common

Object

공통 응답 영역입니다.

data

Object

상품 응답 영역입니다.

요청 예시

1curl -X GET "https://mars.ibapi.kr/api/comm/v1/center/statistics/alimtalk/template?startDate=20251101&endDate=20251130&senderKey={SENDER_KEY}" \
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

발신프로필 키입니다.

templateCode

String

템플릿 코드입니다. 미입력 시 전체 조회합니다.

Returns

common

Object

공통 응답 영역입니다.

data

Object

상품 응답 영역입니다.

요청 예시

1curl -X GET "https://mars.ibapi.kr/api/comm/v1/center/statistics/brandmessage?startDate=20251101&endDate=20251130&senderKey={SENDER_KEY}" \
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

발신프로필 키입니다.

templateCode

String

템플릿 코드입니다. 미입력 시 전체 조회합니다.

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={SENDER_KEY}" \
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

발신프로필 키입니다.

templateCode

String

템플릿 코드입니다. 미입력 시 전체 조회합니다.

Returns

common

Object

공통 응답 영역입니다.

data

Object

상품 응답 영역입니다.

요청 예시

1curl -X GET "https://mars.ibapi.kr/api/comm/v1/center/statistics/brandmessage/template?startDate=20251101&endDate=20251130&senderKey={SENDER_KEY}" \
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}