브랜드메시지

브랜드메시지는 카카오톡 채널 친구에게 브랜드형 메시지를 발송하는 카카오 비즈메시지 채널입니다. 템플릿 기반의 기본형 발송과 메시지 내용을 직접 구성하는 자유형 발송을 모두 지원합니다.

브랜드메시지 기본형 발송

기본형 브랜드메시지는 사전에 등록된 템플릿을 기준으로 발송합니다. 템플릿 코드 기반 치환 발송에 사용할 수 있습니다.

기본형 메시지 발송

POST/api/comm/v1/send/omni

메시지 발송 체험하기 샌드박스로 테스트하기

브랜드메시지 기본형 발송 규격입니다. 사전 승인된 템플릿 코드를 사용하며 sendType은 basic입니다.

Body Parameters

{}JSON

destinations

필수 Object Array

수신 정보 배열입니다. 동보발송 최대 200건입니다.

필수 String

수신번호입니다.

ref

String

개별 참조 필드입니다.

messageFlow

필수 Object Array

메시지를 추가하면 순서대로 자동 Fallback 메시지 처리됩니다.

brandmessage

필수 Object

브랜드메시지 객체입니다.

sendType

필수 String

발송 타입입니다.

msgType

필수 String

메시지 타입입니다.

fallback

Object

대체 발송 정보입니다.

paymentCode

String

정산용 부서 코드입니다.

groupKey

String

메시지 인사이트 에서 그룹으로 묶어서 통계를 확인하기 위해 설정하는 키입니다.

idempotencyKey

String

요청에 대한 멱등함을 구분하는 멱등성 키 필드입니다.

idempotencyTtl

Integer

멱등 처리키 유효시간 입니다.

ref

String

요청 참조 필드입니다.

Returns

common

Object

공통 응답 영역입니다.

data

Object

서비스 응답 영역입니다.

data

Object

실제 메시지 응답 데이터입니다.

destinations

Object Array

수신자별 처리 결과 배열입니다.

요청 예시

curl -X POST "/api/comm/v1/send/omni" \
  -H "Authorization: {ApiKey}" \
  -H "Content-Type: application/json" \
  -d '{
    "destinations": [{ "to": "01012345678", "messageVariable": { "name": "홍길동" } }],
    "messageFlow": [{
      "brandmessage": {
        "sendType": "basic",
        "msgType": "TEXT",
        "senderKey": "SENDER_KEY",
        "templateCode": "BM_TEMPLATE_001"
      }
    }],
    "ref": "brand-basic-20260331-001"
  }'

응답 예시

{
  "common": {
    "authCode": "A000",
    "authResult": "Success",
    "infobankTrId": "Infobank-Tracking-Id"
  },
  "data": {
    "code": "A000",
    "result": "SUCCESS",
    "data": {
      "destinations": [{
        "to": "01012345678",
        "msgKey": "BM20260331-000001",
        "code": "A000",
        "result": "Success"
      }]
    },
    "ref": "brand-basic-20260331-001"
  }
}

기본형 템플릿 자동 치환 발송

POST/api/comm/v1/send/omni

메시지 발송 체험하기 샌드박스로 테스트하기

기본형 브랜드메시지를 템플릿 전문 없이 템플릿 코드와 치환 변수만으로 발송합니다. Bizgo API가 템플릿 코드에 맞는 전문을 생성한 뒤 destinations[].replaceWords 값을 치환해 발송합니다.

Body Parameters

{} JSON

destinations

필수Object Array

수신 정보 배열입니다.

필수String

수신번호입니다.

example: 01000000000

replaceWords

필수Object

템플릿 변수에 치환할 JSON 객체입니다.

messageFlow

필수Object Array

메시지 규격 배열입니다.

brandmessage

필수Object

브랜드메시지 정보입니다.

senderKey

필수String

발신프로필 키입니다.

templateCode

필수String

브랜드메시지 템플릿 코드입니다.

sendType

필수String

템플릿 변수 자동 치환 발송 타입입니다.

template을 입력합니다.

targeting

필수String

브랜드메시지 타게팅 유형입니다.

M, N, I 중 하나를 입력합니다.

pushAlarm

String

메시지 도착 시 푸시 알림 발송 여부입니다.

default: Y

ref

String

요청 참조 필드입니다.

max: 200

Returns

common

Object

공통 응답 영역입니다.

data

Object

서비스 응답 영역입니다.

data

Object

메시지 접수 결과 데이터입니다.

destinations

Object Array

수신자별 접수 결과 배열입니다.

요청 예시

curl -X POST "https://mars.ibapi.kr/api/comm/v1/send/omni" \
  -H "Authorization: {ApiKey}" \
  -H "Content-Type: application/json" \
  -d '{
    "destinations": [{
      "to": "01000000000",
      "replaceWords": {
        "customerName": "홍길동",
        "point": "500"
      }
    }],
    "messageFlow": [{
      "brandmessage": {
        "senderKey": "{senderKey}",
        "templateCode": "{templateCode}",
        "sendType": "template",
        "targeting": "I"
      }
    }],
    "ref": "brand-template-001"
  }'

응답 예시

{
  "common": {
    "authCode": "A000",
    "authResult": "Success",
    "infobankTrId": "Infobank-Tracking-Id"
  },
  "data": {
    "code": "A000",
    "result": "Success",
    "data": {
      "destinations": [{
        "to": "01000000000",
        "msgKey": "BM20260408-000001",
        "code": "A000",
        "result": "Success"
      }]
    },
    "ref": "brand-template-001"
  }
}

브랜드메시지 자유형 발송

자유형 브랜드메시지는 템플릿 등록 없이 메시지 내용을 직접 구성해 발송합니다. 메시지 타입에 맞는 이미지, 버튼, 캐러셀 요소를 함께 정의할 수 있습니다.

자유형 메시지 발송

POST/api/comm/v1/send/omni

메시지 발송 체험하기 샌드박스로 테스트하기

브랜드메시지 자유형 발송 규격입니다. 템플릿 코드 없이 본문/버튼 값을 직접 구성하며 sendType은 free입니다.

Body Parameters

{}JSON

destinations

필수 Object Array

수신 정보 배열입니다. 동보발송 최대 200건입니다.

필수 String

수신번호입니다.

ref

String

개별 참조 필드입니다.

messageFlow

필수 Object Array

메시지를 추가하면 순서대로 자동 Fallback 메시지 처리됩니다.

brandmessage

필수 Object

브랜드메시지 객체입니다.

sendType

필수 String

발송 타입입니다.

image

Object

이미지 정보입니다.

buttons

Object Array

버튼 목록입니다.

fallback

Object

대체 발송 정보입니다.

paymentCode

String

정산용 부서 코드입니다.

groupKey

String

메시지 인사이트 에서 그룹으로 묶어서 통계를 확인하기 위해 설정하는 키입니다.

idempotencyKey

String

요청에 대한 멱등함을 구분하는 멱등성 키 필드입니다.

idempotencyTtl

Integer

멱등 처리키 유효시간 입니다.

ref

String

요청 참조 필드입니다.

Returns

common

Object

공통 응답 영역입니다.

data

Object

서비스 응답 영역입니다.

data

Object

실제 메시지 응답 데이터입니다.

destinations

Object Array

수신자별 처리 결과 배열입니다.

요청 예시

curl -X POST "/api/comm/v1/send/omni" \
  -H "Authorization: {ApiKey}" \
  -H "Content-Type: application/json" \
  -d '{
    "destinations": [{ "to": "01012345678" }],
    "messageFlow": [{
      "brandmessage": {
        "sendType": "free",
        "msgType": "TEXT",
        "senderKey": "SENDER_KEY",
        "content": "자유형 브랜드메시지 본문입니다."
      }
    }],
    "ref": "brand-free-20260331-001"
  }'

응답 예시

{
  "common": {
    "authCode": "A000",
    "authResult": "Success",
    "infobankTrId": "Infobank-Tracking-Id"
  },
  "data": {
    "code": "A000",
    "result": "SUCCESS",
    "data": {
      "destinations": [{
        "to": "01012345678",
        "msgKey": "BM20260331-000002",
        "code": "A000",
        "result": "Success"
      }]
    },
    "ref": "brand-free-20260331-001"
  }
}

브랜드메시지 기본형 동보 발송

친구 그룹을 대상으로 기본형 템플릿 메시지를 일괄 발송하는 기능입니다. 발송 제어와 상태 조회, 예상 모수와 소요 시간 조회까지 함께 제공합니다.

동보 발송

POST/api/comm/v1/center/brandmessage/groupMessage

메시지 발송 체험하기 샌드박스로 테스트하기

기본형 템플릿을 기준으로 카카오 친구 그룹 전체에 동보발송을 예약합니다. 발송 시작 시각은 요청 시점 기준 10분 이후부터 설정할 수 있고, 08:00~20:50(KST) 범위에서 운영합니다.

Body Parameters

{} JSON

brandmessage

필수Object

기본형 템플릿 동보발송 정보입니다.

senderKey

필수String

발신프로필 키입니다.

templateCode

필수String

기본형 템플릿 코드입니다.

friendGroupKey

String

대상 친구 그룹 키입니다.

sendStartAt

필수String

동보발송 시작 일시입니다.

yyyy-MM-dd HH:mm:ss, KST 기준

요청 시점 기준 10분 이후부터 설정합니다.

pushAlarm

String

메시지 푸시 알림 발송 여부입니다.

default: Y

Y 또는 N

originCID

String

최초 발신사업자 식별코드입니다.

length: 9

재판매/특수부가 업체인 경우 입력합니다.

paymentCode

String

정산용 부서 코드입니다.

max: 20

Returns

common

Object

공통 응답 영역입니다.

data

Object

서비스 응답 영역입니다.

data

Object

동보발송 응답 데이터입니다.

brandmessage

Object

동보발송 기본 정보입니다.

요청 예시

curl -X POST "https://mars.ibapi.kr/api/comm/v1/center/brandmessage/groupMessage" \
  -H "Authorization: {ApiKey}" \
  -H "Content-Type: application/json" \
  -d '{
    "brandmessage": {
      "senderKey": "{senderKey}",
      "templateCode": "{templateCode}",
      "friendGroupKey": "{friendGroupKey}",
      "sendStartAt": "2026-04-08 16:40:00",
      "pushAlarm": "Y"
    }
  }'

응답 예시

{
  "common": {
    "authCode": "A000",
    "authResult": "Success",
    "infobankTrId": "Infobank-Tracking-Id"
  },
  "data": {
    "code": "A000",
    "result": "Success",
    "data": {
      "brandmessage": {
        "requestId": "1203981",
        "status": "READY",
        "sendStartAt": "2026-04-08 16: 40: 00",
        "pushAlarm": "Y",
        "expectedCount": 7,
        "sendCount": 0,
        "senderKey": "{senderKey}",
        "msgType": "FI",
        "templateCode": "{templateCode}"
      }
    }
  }
}

동보 발송 재개

POST/api/comm/v1/center/brandmessage/groupMessage/resume

샌드박스로 테스트하기

중지된 기본형 템플릿 동보발송 요청을 다시 시작합니다.

Body Parameters

{} JSON

brandmessage

필수Object

동보발송 제어 정보입니다.

Returns

common

Object

공통 응답 영역입니다.

data

Object

서비스 응답 영역입니다.

data

Object

동보발송 응답 데이터입니다.

brandmessage

Object

동보발송 기본 정보입니다.

요청 예시

curl -X POST "https://mars.ibapi.kr/api/comm/v1/center/brandmessage/groupMessage/resume" \
  -H "Authorization: {ApiKey}" \
  -H "Content-Type: application/json" \
  -d '{
    "brandmessage": {
      "senderKey": "{senderKey}",
      "requestId": "1203981"
    }
  }'

응답 예시

{
  "common": {
    "authCode": "A000",
    "authResult": "Success",
    "infobankTrId": "Infobank-Tracking-Id"
  },
  "data": {
    "code": "A000",
    "result": "Success",
    "data": {
      "brandmessage": {
        "requestId": "1203981",
        "status": "READY",
        "sendStartAt": "2026-04-08 16: 20: 00",
        "pushAlarm": "Y",
        "expectedCount": 7,
        "sendCount": 0,
        "senderKey": "{senderKey}",
        "msgType": "FI",
        "templateCode": "{templateCode}"
      }
    }
  }
}

동보 발송 중지

POST/api/comm/v1/center/brandmessage/groupMessage/pause

샌드박스로 테스트하기

진행 중인 기본형 템플릿 동보발송 요청을 일시 중지합니다.

Body Parameters

{} JSON

brandmessage

필수Object

동보발송 제어 정보입니다.

Returns

common

Object

공통 응답 영역입니다.

data

Object

서비스 응답 영역입니다.

data

Object

동보발송 응답 데이터입니다.

brandmessage

Object

동보발송 기본 정보입니다.

요청 예시

curl -X POST "https://mars.ibapi.kr/api/comm/v1/center/brandmessage/groupMessage/pause" \
  -H "Authorization: {ApiKey}" \
  -H "Content-Type: application/json" \
  -d '{
    "brandmessage": {
      "senderKey": "{senderKey}",
      "requestId": "1203981"
    }
  }'

응답 예시

{
  "common": {
    "authCode": "A000",
    "authResult": "Success",
    "infobankTrId": "Infobank-Tracking-Id"
  },
  "data": {
    "code": "A000",
    "result": "Success",
    "data": {
      "brandmessage": {
        "requestId": "1203981",
        "status": "PAUSED",
        "sendStartAt": "2026-04-08 16: 20: 00",
        "pushAlarm": "Y",
        "expectedCount": 7,
        "sendCount": 3,
        "senderKey": "{senderKey}",
        "msgType": "FI",
        "templateCode": "{templateCode}"
      }
    }
  }
}

동보 발송 종료

POST/api/comm/v1/center/brandmessage/groupMessage/terminate

샌드박스로 테스트하기

예약 또는 진행 중인 기본형 템플릿 동보발송 요청을 종료합니다.

Body Parameters

{} JSON

brandmessage

필수Object

동보발송 제어 정보입니다.

Returns

common

Object

공통 응답 영역입니다.

data

Object

서비스 응답 영역입니다.

data

Object

동보발송 응답 데이터입니다.

brandmessage

Object

동보발송 기본 정보입니다.

요청 예시

curl -X POST "https://mars.ibapi.kr/api/comm/v1/center/brandmessage/groupMessage/terminate" \
  -H "Authorization: {ApiKey}" \
  -H "Content-Type: application/json" \
  -d '{
    "brandmessage": {
      "senderKey": "{senderKey}",
      "requestId": "1203981"
    }
  }'

응답 예시

{
  "common": {
    "authCode": "A000",
    "authResult": "Success",
    "infobankTrId": "Infobank-Tracking-Id"
  },
  "data": {
    "code": "A000",
    "result": "Success",
    "data": {
      "brandmessage": {
        "requestId": "1203981",
        "status": "TERMINATED",
        "sendStartAt": "2026-04-08 16: 20: 00",
        "pushAlarm": "Y",
        "expectedCount": 7,
        "sendCount": 3,
        "senderKey": "{senderKey}",
        "msgType": "FI",
        "templateCode": "{templateCode}"
      }
    }
  }
}

동보 발송 조회

GET/api/comm/v1/center/brandmessage/groupMessage

샌드박스로 테스트하기

발신프로필 키와 요청 아이디를 기준으로 특정 동보발송 요청 상태를 조회합니다.

Query Parameters

senderKey

필수String

발신프로필 키입니다.

requestId

필수Integer

동보발송 요청 아이디입니다.

Returns

common

Object

공통 응답 영역입니다.

data

Object

서비스 응답 영역입니다.

data

Object

동보발송 응답 데이터입니다.

brandmessage

Object

동보발송 기본 정보입니다.

요청 예시

curl -X GET "https://mars.ibapi.kr/api/comm/v1/center/brandmessage/groupMessage?senderKey={senderKey}&requestId=1203981" \
  -H "Authorization: {ApiKey}"

응답 예시

{
  "common": {
    "authCode": "A000",
    "authResult": "Success",
    "infobankTrId": "Infobank-Tracking-Id"
  },
  "data": {
    "code": "A000",
    "result": "Success",
    "data": {
      "brandmessage": {
        "requestId": "1203981",
        "status": "SENDING",
        "sendStartAt": "2026-04-08 16: 40: 00",
        "pushAlarm": "Y",
        "expectedCount": 7,
        "sendCount": 3,
        "senderKey": "{senderKey}",
        "msgType": "FI",
        "templateCode": "{templateCode}"
      }
    }
  }
}

최근 변경된 동보 발송 요청 목록 조회

GET/api/comm/v1/center/brandmessage/groupMessage/lastModified

샌드박스로 테스트하기

기준 시각 이후 변경된 동보발송 요청 아이디 목록을 조회합니다. 누락된 요청 상태를 후속 동기화할 때 사용할 수 있습니다.

Query Parameters

senderKey

필수String

발신프로필 키입니다.

since

String

변경 기준 일시입니다.

yyyy-MM-dd'T'HH:mm:ss

default: 요청 1시간 전

Returns

common

Object

공통 응답 영역입니다.

data

Object

서비스 응답 영역입니다.

data

Object

변경 이력 응답 데이터입니다.

brandmessage

Object

동보발송 조회 결과입니다.

요청 예시

curl -X GET "https://mars.ibapi.kr/api/comm/v1/center/brandmessage/groupMessage/lastModified?senderKey={senderKey}&since=2026-04-08T15:00:00" \
  -H "Authorization: {ApiKey}"

응답 예시

{
  "common": {
    "authCode": "A000",
    "authResult": "Success",
    "infobankTrId": "Infobank-Tracking-Id"
  },
  "data": {
    "code": "A000",
    "result": "Success",
    "data": {
      "brandmessage": {
        "requestIds": ["1203981", "1203982", "1203983"]
      }
    }
  }
}

동보 발송 예상 모수 확인

GET/api/comm/v1/center/brandmessage/groupMessage/possible

샌드박스로 테스트하기

메시지 타입과 친구 그룹 조건을 기준으로 동보발송 가능 예상 수를 조회합니다.

Query Parameters

senderKey

필수String

발신프로필 키입니다.

msgType

필수String

브랜드메시지 타입입니다.

friendGroupKey

String

대상 친구 그룹 키입니다.

Returns

common

Object

공통 응답 영역입니다.

data

Object

서비스 응답 영역입니다.

data

Object

발송 가능 수 응답 데이터입니다.

brandmessage

Object

동보발송 가능 수 결과입니다.

요청 예시

curl -X GET "https://mars.ibapi.kr/api/comm/v1/center/brandmessage/groupMessage/possible?senderKey={senderKey}&msgType=FI&friendGroupKey={friendGroupKey}" \
  -H "Authorization: {ApiKey}"

응답 예시

{
  "common": {
    "authCode": "A000",
    "authResult": "Success",
    "infobankTrId": "Infobank-Tracking-Id"
  },
  "data": {
    "code": "A000",
    "result": "Success",
    "data": {
      "brandmessage": {
        "possible": 320
      }
    }
  }
}

채널 전체 친구 수 조회

GET/api/comm/v1/center/brandmessage/groupMessage/friendCount

샌드박스로 테스트하기

발신프로필 기준 친구 수를 조회합니다. 동보발송 가능 대상 수를 사전에 확인할 때 사용합니다.

Query Parameters

senderKey

필수String

발신프로필 키입니다.

Returns

common

Object

공통 응답 영역입니다.

data

Object

서비스 응답 영역입니다.

data

Object

친구 수 응답 데이터입니다.

brandmessage

Object

친구 수 조회 결과입니다.

요청 예시

curl -X GET "https://mars.ibapi.kr/api/comm/v1/center/brandmessage/groupMessage/friendCount?senderKey={senderKey}" \
  -H "Authorization: {ApiKey}"

응답 예시

{
  "common": {
    "authCode": "A000",
    "authResult": "Success",
    "infobankTrId": "Infobank-Tracking-Id"
  },
  "data": {
    "code": "A000",
    "result": "Success",
    "data": {
      "brandmessage": {
        "count": 1250
      }
    }
  }
}

예상 소요시간 조회

GET/api/comm/v1/center/brandmessage/groupMessage/estimate

샌드박스로 테스트하기

동보발송 시작 시각과 대상 수를 기준으로 예상 종료 시각과 소요 시간을 조회합니다.

Query Parameters

senderKey

필수String

발신프로필 키입니다.

startTime

필수String

동보발송 시작 일시입니다.

yyyy-MM-dd'T'HH:mm:ss, KST 기준

count

필수Integer

발송 모수입니다.

target

String

대상 유형입니다.

NONE 또는 FRIEND_GROUP

default: NONE

Returns

common

Object

공통 응답 영역입니다.

data

Object

서비스 응답 영역입니다.

data

Object

예상 시간 응답 데이터입니다.

brandmessage

Object

동보발송 예상 시간 결과입니다.

요청 예시

curl -X GET "https://mars.ibapi.kr/api/comm/v1/center/brandmessage/groupMessage/estimate?senderKey={senderKey}&startTime=2026-04-08T16:40:00&count=320&target=FRIEND_GROUP" \
  -H "Authorization: {ApiKey}"

응답 예시

{
  "common": {
    "authCode": "A000",
    "authResult": "Success",
    "infobankTrId": "Infobank-Tracking-Id"
  },
  "data": {
    "code": "A000",
    "result": "Success",
    "data": {
      "brandmessage": {
        "estimatedFinishedAt": "2026-04-08T16: 58: 00",
        "duration": 18
      }
    }
  }
}

이미지 파일 관리

브랜드메시지 템플릿과 자유형 메시지 구성에 사용할 이미지 파일을 업로드합니다. 메시지 타입과 레이아웃에 따라 업로드 경로를 구분합니다.

이미지 업로드

POST/api/comm/v1/file/brandmessage/default

샌드박스로 테스트하기

기본형 브랜드메시지에서 사용하는 이미지를 업로드합니다. 발송 본문에 파일을 직접 첨부하는 API가 아니라 브랜드메시지 템플릿 등록과 구성에 사용할 이미지 URL을 발급받는 API입니다.

Body Parameters

FORM-DATA

file

필수Binary

업로드할 브랜드메시지 이미지 파일 바이너리입니다.

권장 사이즈: 800 x 400px

가로: 500px 이상

비율: 세로 ÷ 가로 = 0.5

파일 형식: jpg, png

max: 500KB

Returns

common

Object

공통 응답 영역입니다.

data

Object

서비스 응답 영역입니다.

data

Object

업로드 결과 데이터입니다.

요청 예시

curl -X POST "https://mars.ibapi.kr/api/comm/v1/file/brandmessage/default" \
  -H "Authorization: {ApiKey}" \
  -F "file=@/path/brand-image.jpg"

응답 예시

{
  "common": {
    "authCode": "A000",
    "authResult": "Success",
    "infobankTrId": "Infobank-Tracking-Id"
  },
  "data": {
    "code": "A000",
    "result": "Success",
    "data": {
      "imgUrl": "https://example.kakao.image/brand-image.jpg"
    }
  }
}

와이드 이미지 업로드

POST/api/comm/v1/file/brandmessage/wide

샌드박스로 테스트하기

와이드 이미지형 브랜드메시지에서 사용하는 이미지를 업로드합니다. 발급된 imgUrl은 브랜드메시지 템플릿 또는 발송 구성에 사용합니다.

Body Parameters

FORM-DATA

file

필수Binary

업로드할 브랜드메시지 이미지 파일 바이너리입니다.

권장 사이즈: 800 x 600px 또는 800 x 400px

가로: 500px 이상

비율: 0.5 ~ 1

파일 형식: jpg, png

max: 5MB

Returns

common

Object

공통 응답 영역입니다.

data

Object

서비스 응답 영역입니다.

data

Object

업로드 결과 데이터입니다.

요청 예시

curl -X POST "https://mars.ibapi.kr/api/comm/v1/file/brandmessage/wide" \
  -H "Authorization: {ApiKey}" \
  -F "file=@/path/brand-image.jpg"

응답 예시

{
  "common": {
    "authCode": "A000",
    "authResult": "Success",
    "infobankTrId": "Infobank-Tracking-Id"
  },
  "data": {
    "code": "A000",
    "result": "Success",
    "data": {
      "imgUrl": "https://example.kakao.image/brand-image.jpg"
    }
  }
}

와이드 리스트 첫번째 이미지 업로드

POST/api/comm/v1/file/brandmessage/wideItemList/first

샌드박스로 테스트하기

와이드 리스트형 브랜드메시지의 첫 번째 리스트 이미지에 사용할 이미지를 업로드합니다.

Body Parameters

FORM-DATA

file

필수Binary

업로드할 브랜드메시지 이미지 파일 바이너리입니다.

가로: 500px 이상

비율: 세로 ÷ 가로 = 0.5

파일 형식: jpg, png

max: 5MB

Returns

common

Object

공통 응답 영역입니다.

data

Object

서비스 응답 영역입니다.

data

Object

업로드 결과 데이터입니다.

요청 예시

curl -X POST "https://mars.ibapi.kr/api/comm/v1/file/brandmessage/wideItemList/first" \
  -H "Authorization: {ApiKey}" \
  -F "file=@/path/brand-image.jpg"

응답 예시

{
  "common": {
    "authCode": "A000",
    "authResult": "Success",
    "infobankTrId": "Infobank-Tracking-Id"
  },
  "data": {
    "code": "A000",
    "result": "Success",
    "data": {
      "imgUrl": "https://example.kakao.image/brand-image.jpg"
    }
  }
}

와이드 리스트 이미지 업로드

POST/api/comm/v1/file/brandmessage/wideItemList

샌드박스로 테스트하기

와이드 리스트형 브랜드메시지의 2~4번째 리스트 이미지에 사용할 이미지를 업로드합니다.

Body Parameters

FORM-DATA

file

필수Binary

업로드할 브랜드메시지 이미지 파일 바이너리입니다.

가로: 500px 이상

비율: 세로 ÷ 가로 = 1

파일 형식: jpg, png

max: 5MB

Returns

common

Object

공통 응답 영역입니다.

data

Object

서비스 응답 영역입니다.

data

Object

업로드 결과 데이터입니다.

요청 예시

curl -X POST "https://mars.ibapi.kr/api/comm/v1/file/brandmessage/wideItemList" \
  -H "Authorization: {ApiKey}" \
  -F "file=@/path/brand-image.jpg"

응답 예시

{
  "common": {
    "authCode": "A000",
    "authResult": "Success",
    "infobankTrId": "Infobank-Tracking-Id"
  },
  "data": {
    "code": "A000",
    "result": "Success",
    "data": {
      "imgUrl": "https://example.kakao.image/brand-image.jpg"
    }
  }
}

캐러셀 피드 이미지 업로드

POST/api/comm/v1/file/brandmessage/carouselFeed

샌드박스로 테스트하기

캐러셀 피드형 브랜드메시지에서 사용하는 이미지를 업로드합니다.

Body Parameters

FORM-DATA

file

필수Binary

업로드할 브랜드메시지 이미지 파일 바이너리입니다.

권장 사이즈: 800 x 600px 또는 800 x 400px

가로: 500px 이상

비율: 0.5 ~ 1.333

파일 형식: jpg, png

max: 5MB

Returns

common

Object

공통 응답 영역입니다.

data

Object

서비스 응답 영역입니다.

data

Object

업로드 결과 데이터입니다.

요청 예시

curl -X POST "https://mars.ibapi.kr/api/comm/v1/file/brandmessage/carouselFeed" \
  -H "Authorization: {ApiKey}" \
  -F "file=@/path/brand-image.jpg"

응답 예시

{
  "common": {
    "authCode": "A000",
    "authResult": "Success",
    "infobankTrId": "Infobank-Tracking-Id"
  },
  "data": {
    "code": "A000",
    "result": "Success",
    "data": {
      "imgUrl": "https://example.kakao.image/brand-image.jpg"
    }
  }
}

캐러셀 커머스 이미지 업로드

POST/api/comm/v1/file/brandmessage/carouselCommerce

샌드박스로 테스트하기

캐러셀 커머스형 브랜드메시지에서 사용하는 이미지를 업로드합니다. 전체 캐러셀 이미지 비율은 동일하게 맞춰야 합니다.

Body Parameters

FORM-DATA

file

필수Binary

업로드할 브랜드메시지 이미지 파일 바이너리입니다.

권장 사이즈: 800 x 600px 또는 800 x 400px

가로: 500px 이상

비율: 0.5 ~ 1.333

파일 형식: jpg, png

max: 5MB

Returns

common

Object

공통 응답 영역입니다.

data

Object

서비스 응답 영역입니다.

data

Object

업로드 결과 데이터입니다.

요청 예시

curl -X POST "https://mars.ibapi.kr/api/comm/v1/file/brandmessage/carouselCommerce" \
  -H "Authorization: {ApiKey}" \
  -F "file=@/path/brand-image.jpg"

응답 예시

{
  "common": {
    "authCode": "A000",
    "authResult": "Success",
    "infobankTrId": "Infobank-Tracking-Id"
  },
  "data": {
    "code": "A000",
    "result": "Success",
    "data": {
      "imgUrl": "https://example.kakao.image/brand-image.jpg"
    }
  }
}

기본형 템플릿 관리

기본형 브랜드메시지 발송에 사용하는 템플릿을 조회하고 등록, 수정, 삭제합니다. 이미지가 필요한 유형은 이미지 파일 관리 API로 먼저 imgUrl을 발급받아 사용합니다.

템플릿 조회

GET/api/comm/v1/center/brandmessage/template

샌드박스로 테스트하기

발신프로필 키와 템플릿 코드를 기준으로 브랜드메시지 템플릿 상세 정보를 조회합니다.

Query Parameters

senderKey

필수String

발신프로필 키입니다.

templateCode

필수String

템플릿 코드입니다.

Returns

common

Object

공통 응답 영역입니다.

data

Object

서비스 응답 영역입니다.

data

Object

템플릿 응답 데이터입니다.

brandmessage

Object

브랜드메시지 템플릿 정보입니다.

요청 예시

curl -X GET "https://mars.ibapi.kr/api/comm/v1/center/brandmessage/template?senderKey={senderKey}&templateCode={templateCode}" \
  -H "Authorization: {ApiKey}"

응답 예시

{
  "common": {
    "authCode": "A000",
    "authResult": "Success",
    "infobankTrId": "Infobank-Tracking-Id"
  },
  "data": {
    "code": "A000",
    "result": "Success",
    "data": {
      "brandmessage": {
        "senderKey": "{senderKey}",
        "templateCode": "{templateCode}",
        "msgType": "TEXT",
        "content": "#{customerName}님, 혜택을 확인해 주세요."
      }
    }
  }
}

템플릿 등록

POST/api/comm/v1/center/brandmessage/template

샌드박스로 테스트하기

브랜드메시지 템플릿을 등록합니다. 이미지가 필요한 유형은 브랜드메시지 이미지 업로드 API로 발급받은 imgUrl을 함께 사용합니다.

Body Parameters

{} JSON

brandmessage

필수Object

브랜드메시지 템플릿 정보입니다.

image

Object

이미지 정보입니다.

buttons

Object Array

버튼 목록입니다.

Returns

common

Object

공통 응답 영역입니다.

data

Object

서비스 응답 영역입니다.

data

Object

템플릿 응답 데이터입니다.

brandmessage

Object

브랜드메시지 템플릿 정보입니다.

요청 예시

curl -X POST "https://mars.ibapi.kr/api/comm/v1/center/brandmessage/template" \
  -H "Authorization: {ApiKey}" \
  -H "Content-Type: application/json" \
  -d '{
    "brandmessage": {
      "senderKey": "{senderKey}",
      "templateCode": "BRAND_TEXT_001",
      "templateName": "브랜드 혜택 안내",
      "msgType": "TEXT",
      "content": "#{customerName}님, 새로운 혜택을 확인해 주세요."
    }
  }'

응답 예시

{
  "common": {
    "authCode": "A000",
    "authResult": "Success",
    "infobankTrId": "Infobank-Tracking-Id"
  },
  "data": {
    "code": "A000",
    "result": "Success",
    "data": {
      "brandmessage": {
        "senderKey": "{senderKey}",
        "templateCode": "BRAND_TEXT_001",
        "msgType": "TEXT",
        "content": "#{customerName}님, 새로운 혜택을 확인해 주세요."
      }
    }
  }
}

템플릿 수정

PUT/api/comm/v1/center/brandmessage/template

샌드박스로 테스트하기

등록된 브랜드메시지 템플릿 정보를 수정합니다. 검수 상태와 카카오 정책에 따라 수정 가능한 범위가 달라질 수 있습니다.

Body Parameters

{} JSON

brandmessage

필수Object

브랜드메시지 템플릿 정보입니다.

image

Object

이미지 정보입니다.

buttons

Object Array

버튼 목록입니다.

Returns

common

Object

공통 응답 영역입니다.

data

Object

서비스 응답 영역입니다.

data

Object

템플릿 응답 데이터입니다.

brandmessage

Object

브랜드메시지 템플릿 정보입니다.

요청 예시

curl -X PUT "https://mars.ibapi.kr/api/comm/v1/center/brandmessage/template" \
  -H "Authorization: {ApiKey}" \
  -H "Content-Type: application/json" \
  -d '{
    "brandmessage": {
      "senderKey": "{senderKey}",
      "templateCode": "BRAND_TEXT_001",
      "templateName": "브랜드 혜택 안내 수정",
      "msgType": "TEXT",
      "content": "#{customerName}님, 업데이트된 혜택을 확인해 주세요."
    }
  }'

응답 예시

{
  "common": {
    "authCode": "A000",
    "authResult": "Success",
    "infobankTrId": "Infobank-Tracking-Id"
  },
  "data": {
    "code": "A000",
    "result": "Success",
    "data": {
      "brandmessage": {
        "senderKey": "{senderKey}",
        "templateCode": "BRAND_TEXT_001",
        "msgType": "TEXT",
        "content": "#{customerName}님, 업데이트된 혜택을 확인해 주세요."
      }
    }
  }
}

템플릿 삭제

DELETE/api/comm/v1/center/brandmessage/template/senderKey/{senderKey}/templateCode/{templateCode}

샌드박스로 테스트하기

발신프로필 키와 템플릿 코드를 기준으로 브랜드메시지 템플릿을 삭제합니다.

Path Parameters

senderKey

필수String

발신프로필 키입니다.

templateCode

필수String

삭제할 템플릿 코드입니다.

Returns

common

Object

공통 응답 영역입니다.

data

Object

서비스 응답 영역입니다.

요청 예시

curl -X DELETE "https://mars.ibapi.kr/api/comm/v1/center/brandmessage/template/senderKey/{senderKey}/templateCode/{templateCode}" \
  -H "Authorization: {ApiKey}"

응답 예시

{
  "common": {
    "authCode": "A000",
    "authResult": "Success",
    "infobankTrId": "Infobank-Tracking-Id"
  },
  "data": {
    "code": "A000",
    "result": "Success"
  }
}

그룹태그 관리

그룹태그는 브랜드메시지 템플릿과 운영 대상을 분류하기 위한 관리 정보입니다. 발신프로필 기준으로 그룹태그를 조회하고 등록, 수정, 삭제할 수 있습니다.

전체 그룹태그 조회

GET/api/comm/v1/center/brandmessage/groupTag/list

샌드박스로 테스트하기

발신프로필 키를 기준으로 브랜드메시지 전체 그룹태그 목록을 조회합니다.

Query Parameters

senderKey

필수String

발신프로필 키입니다.

Returns

common

Object

공통 응답 영역입니다.

data

Object

서비스 응답 영역입니다.

data

Object

그룹태그 응답 데이터입니다.

groupTags

Object Array

그룹태그 목록입니다.

요청 예시

curl -X GET "https://mars.ibapi.kr/api/comm/v1/center/brandmessage/groupTag/list?senderKey={senderKey}" \
  -H "Authorization: {ApiKey}"

응답 예시

{
  "common": {
    "authCode": "A000",
    "authResult": "Success",
    "infobankTrId": "Infobank-Tracking-Id"
  },
  "data": {
    "code": "A000",
    "result": "Success",
    "data": {
      "groupTags": [{
        "senderKey": "{senderKey}",
        "groupTagKey": "{groupTagKey}",
        "name": "VIP 고객"
      }]
    }
  }
}

그룹태그 조회

GET/api/comm/v1/center/brandmessage/groupTag

샌드박스로 테스트하기

발신프로필 키와 그룹태그 키를 기준으로 브랜드메시지 그룹태그 상세 정보를 조회합니다.

Query Parameters

senderKey

필수String

발신프로필 키입니다.

groupTagKey

필수String

그룹태그 키입니다.

Returns

common

Object

공통 응답 영역입니다.

data

Object

서비스 응답 영역입니다.

data

Object

그룹태그 응답 데이터입니다.

groupTags

Object Array

그룹태그 목록입니다.

요청 예시

curl -X GET "https://mars.ibapi.kr/api/comm/v1/center/brandmessage/groupTag?senderKey={senderKey}&groupTagKey={groupTagKey}" \
  -H "Authorization: {ApiKey}"

응답 예시

{
  "common": {
    "authCode": "A000",
    "authResult": "Success",
    "infobankTrId": "Infobank-Tracking-Id"
  },
  "data": {
    "code": "A000",
    "result": "Success",
    "data": {
      "groupTags": [{
        "senderKey": "{senderKey}",
        "groupTagKey": "{groupTagKey}",
        "name": "VIP 고객"
      }]
    }
  }
}

그룹태그 등록

POST/api/comm/v1/center/brandmessage/groupTag

샌드박스로 테스트하기

브랜드메시지 그룹태그를 등록합니다.

Body Parameters

{} JSON

groupTag

필수Object

브랜드메시지 그룹태그 정보입니다.

Returns

common

Object

공통 응답 영역입니다.

data

Object

서비스 응답 영역입니다.

data

Object

그룹태그 응답 데이터입니다.

groupTags

Object Array

그룹태그 목록입니다.

요청 예시

curl -X POST "https://mars.ibapi.kr/api/comm/v1/center/brandmessage/groupTag" \
  -H "Authorization: {ApiKey}" \
  -H "Content-Type: application/json" \
  -d '{
    "groupTag": {
      "senderKey": "{senderKey}",
      "groupTagKey": "VIP_CUSTOMER",
      "name": "VIP 고객"
    }
  }'

응답 예시

{
  "common": {
    "authCode": "A000",
    "authResult": "Success",
    "infobankTrId": "Infobank-Tracking-Id"
  },
  "data": {
    "code": "A000",
    "result": "Success",
    "data": {
      "groupTags": [{
        "senderKey": "{senderKey}",
        "groupTagKey": "VIP_CUSTOMER",
        "name": "VIP 고객"
      }]
    }
  }
}

그룹태그 수정

PUT/api/comm/v1/center/brandmessage/groupTag

샌드박스로 테스트하기

등록된 브랜드메시지 그룹태그 정보를 수정합니다.

Body Parameters

{} JSON

groupTag

필수Object

브랜드메시지 그룹태그 정보입니다.

Returns

common

Object

공통 응답 영역입니다.

data

Object

서비스 응답 영역입니다.

data

Object

그룹태그 응답 데이터입니다.

groupTags

Object Array

그룹태그 목록입니다.

요청 예시

curl -X PUT "https://mars.ibapi.kr/api/comm/v1/center/brandmessage/groupTag" \
  -H "Authorization: {ApiKey}" \
  -H "Content-Type: application/json" \
  -d '{
    "groupTag": {
      "senderKey": "{senderKey}",
      "groupTagKey": "VIP_CUSTOMER",
      "name": "VIP 고객 수정"
    }
  }'

응답 예시

{
  "common": {
    "authCode": "A000",
    "authResult": "Success",
    "infobankTrId": "Infobank-Tracking-Id"
  },
  "data": {
    "code": "A000",
    "result": "Success",
    "data": {
      "groupTags": [{
        "senderKey": "{senderKey}",
        "groupTagKey": "VIP_CUSTOMER",
        "name": "VIP 고객 수정"
      }]
    }
  }
}

그룹태그 삭제

DELETE/api/comm/v1/center/brandmessage/groupTag/senderkey/{senderKey}/groupTagKey/{groupTagKey}

샌드박스로 테스트하기

발신프로필 키와 그룹태그 키를 기준으로 브랜드메시지 그룹태그를 삭제합니다.

Path Parameters

senderKey

필수String

발신프로필 키입니다.

groupTagKey

필수String

삭제할 그룹태그 키입니다.

Returns

common

Object

공통 응답 영역입니다.

data

Object

서비스 응답 영역입니다.

요청 예시

curl -X DELETE "https://mars.ibapi.kr/api/comm/v1/center/brandmessage/groupTag/senderkey/{senderKey}/groupTagKey/{groupTagKey}" \
  -H "Authorization: {ApiKey}"

응답 예시

{
  "common": {
    "authCode": "A000",
    "authResult": "Success",
    "infobankTrId": "Infobank-Tracking-Id"
  },
  "data": {
    "code": "A000",
    "result": "Success"
  }
}

친구 그룹 관리

친구 그룹은 발신프로필 기준으로 친구 대상을 그룹화해 기본형 동보발송에 활용하는 관리 기능입니다. 파일 업로드나 전화번호 배열로 그룹을 생성하고, 그룹별 전화번호를 추가, 삭제할 수 있습니다.

친구 그룹 파일 업로드

POST/api/comm/v1/center/brandmessage/friendGroup/file

샌드박스로 테스트하기

전화번호 목록 파일을 업로드해 친구 그룹 등록 또는 전화번호 추가·삭제에 사용할 임시 파일 키를 발급받습니다.

Body Parameters

FORM-DATA

senderKey

필수String

발신프로필 키입니다.

file

필수Binary

업로드할 전화번호 목록 파일입니다.

전화번호와 줄바꿈으로 구성된 파일

txt, csv만 허용합니다

Returns

common

Object

공통 응답 영역입니다.

data

Object

서비스 응답 영역입니다.

data

Object

친구 그룹 파일 업로드 결과입니다.

friendGroup

Object

임시 업로드 파일 정보입니다.

요청 예시

curl -X POST "https://mars.ibapi.kr/api/comm/v1/center/brandmessage/friendGroup/file" \
  -H "Authorization: {ApiKey}" \
  -H "Content-Type: multipart/form-data" \
  -F "senderKey={senderKey}" \
  -F "file=@friend-group.csv"

응답 예시

{
  "common": {
    "authCode": "A000",
    "authResult": "Success",
    "infobankTrId": "Infobank-Tracking-Id"
  },
  "data": {
    "code": "A000",
    "result": "Success",
    "data": {
      "friendGroup": {
        "fileKey": "{fileKey}",
        "expiredAt": "2026-04-10 14: 03: 25"
      }
    }
  }
}

친구 그룹 등록

POST/api/comm/v1/center/brandmessage/friendGroup

샌드박스로 테스트하기

친구 그룹을 생성합니다. fileKey 또는 phoneNumbers를 이용해 그룹에 포함할 전화번호 목록을 함께 등록할 수 있습니다.

Body Parameters

{} JSON

friendGroup

필수Object

친구 그룹 정보입니다.

Returns

common

Object

공통 응답 영역입니다.

data

Object

서비스 응답 영역입니다.

data

Object

친구 그룹 응답 데이터입니다.

friendGroup

Object

친구 그룹 정보입니다.

요청 예시

curl -X POST "https://mars.ibapi.kr/api/comm/v1/center/brandmessage/friendGroup" \
  -H "Authorization: {ApiKey}" \
  -H "Content-Type: application/json" \
  -d '{
    "friendGroup": {
      "senderKey": "{senderKey}",
      "friendGroupKey": "VIP_CUSTOMERS",
      "phoneNumbers": [
        "01000000000",
        "01000000001"
      ]
    }
  }'

응답 예시

{
  "common": {
    "authCode": "A000",
    "authResult": "Success",
    "infobankTrId": "Infobank-Tracking-Id"
  },
  "data": {
    "code": "A000",
    "result": "Success",
    "data": {
      "friendGroup": {
        "friendGroupKey": "VIP_CUSTOMERS",
        "requestId": 1203981,
        "status": "IN_PROGRESS",
        "createdAt": "2026-04-09 15: 10: 00",
        "modifiedAt": "2026-04-09 15: 10: 00"
      }
    }
  }
}

친구 그룹 조회

GET/api/comm/v1/center/brandmessage/friendGroup

샌드박스로 테스트하기

발신프로필 키와 친구 그룹 키를 기준으로 친구 그룹 상세 정보를 조회합니다.

Query Parameters

senderKey

필수String

발신프로필 키입니다.

friendGroupKey

필수String

친구 그룹 키입니다.

Returns

common

Object

공통 응답 영역입니다.

data

Object

서비스 응답 영역입니다.

data

Object

친구 그룹 상세 응답 데이터입니다.

friendGroup

Object

친구 그룹 상세 정보입니다.

요청 예시

curl -X GET "https://mars.ibapi.kr/api/comm/v1/center/brandmessage/friendGroup?senderKey={senderKey}&friendGroupKey=VIP_CUSTOMERS" \
  -H "Authorization: {ApiKey}"

응답 예시

{
  "common": {
    "authCode": "A000",
    "authResult": "Success",
    "infobankTrId": "Infobank-Tracking-Id"
  },
  "data": {
    "code": "A000",
    "result": "Success",
    "data": {
      "friendGroup": {
        "friendGroupKey": "VIP_CUSTOMERS",
        "userCount": 12000,
        "friendCount": 11540,
        "status": "COMPLETED",
        "createdAt": "2026-04-09 15: 10: 00",
        "modifiedAt": "2026-04-09 15: 12: 25"
      }
    }
  }
}

친구 그룹 목록 조회

GET/api/comm/v1/center/brandmessage/friendGroup/list

샌드박스로 테스트하기

발신프로필 기준으로 등록된 친구 그룹 목록을 조회합니다.

Query Parameters

senderKey

필수String

발신프로필 키입니다.

Returns

common

Object

공통 응답 영역입니다.

data

Object

서비스 응답 영역입니다.

data

Object

친구 그룹 목록 응답 데이터입니다.

friendGroups

Object Array

친구 그룹 목록입니다.

요청 예시

curl -X GET "https://mars.ibapi.kr/api/comm/v1/center/brandmessage/friendGroup/list?senderKey={senderKey}" \
  -H "Authorization: {ApiKey}"

응답 예시

{
  "common": {
    "authCode": "A000",
    "authResult": "Success",
    "infobankTrId": "Infobank-Tracking-Id"
  },
  "data": {
    "code": "A000",
    "result": "Success",
    "data": {
      "friendGroups": [{
        "friendGroupKey": "VIP_CUSTOMERS",
        "userCount": 12000,
        "friendCount": 11540,
        "status": "COMPLETED",
        "createdAt": "2026-04-09 15: 10: 00",
        "modifiedAt": "2026-04-09 15: 12: 25"
      }]
    }
  }
}

친구 그룹 삭제

DELETE/api/comm/v1/center/brandmessage/friendGroup/senderKey/{senderKey}/friendGroupKey/{friendGroupKey}

샌드박스로 테스트하기

발신프로필 키와 친구 그룹 키를 기준으로 친구 그룹을 삭제합니다.

Path Parameters

senderKey

필수String

발신프로필 키입니다.

friendGroupKey

필수String

삭제할 친구 그룹 키입니다.

Returns

common

Object

공통 응답 영역입니다.

data

Object

서비스 응답 영역입니다.

요청 예시

curl -X DELETE "https://mars.ibapi.kr/api/comm/v1/center/brandmessage/friendGroup/senderKey/{senderKey}/friendGroupKey/{friendGroupKey}" \
  -H "Authorization: {ApiKey}"

응답 예시

{
  "common": {
    "authCode": "A000",
    "authResult": "Success",
    "infobankTrId": "Infobank-Tracking-Id"
  },
  "data": {
    "code": "A000",
    "result": "Success"
  }
}

친구 그룹 내 전화번호 추가

POST/api/comm/v1/center/brandmessage/friendGroup/phoneNumber/update

샌드박스로 테스트하기

기존 친구 그룹에 전화번호 목록을 추가합니다. fileKey 또는 phoneNumbers를 이용해 입력할 수 있습니다.

Body Parameters

{} JSON

friendGroup

필수Object

친구 그룹 정보입니다.

Returns

common

Object

공통 응답 영역입니다.

data

Object

서비스 응답 영역입니다.

data

Object

친구 그룹 응답 데이터입니다.

friendGroup

Object

친구 그룹 정보입니다.

요청 예시

curl -X POST "https://mars.ibapi.kr/api/comm/v1/center/brandmessage/friendGroup/phoneNumber/update" \
  -H "Authorization: {ApiKey}" \
  -H "Content-Type: application/json" \
  -d '{
    "friendGroup": {
      "senderKey": "{senderKey}",
      "friendGroupKey": "VIP_CUSTOMERS",
      "phoneNumbers": [
        "01000000002",
        "01000000003"
      ]
    }
  }'

응답 예시

{
  "common": {
    "authCode": "A000",
    "authResult": "Success",
    "infobankTrId": "Infobank-Tracking-Id"
  },
  "data": {
    "code": "A000",
    "result": "Success",
    "data": {
      "friendGroup": {
        "friendGroupKey": "VIP_CUSTOMERS",
        "requestId": 1203982,
        "status": "IN_PROGRESS",
        "createdAt": "2026-04-09 15: 15: 00",
        "modifiedAt": "2026-04-09 15: 15: 00"
      }
    }
  }
}

친구 그룹 내 전화번호 삭제

POST/api/comm/v1/center/brandmessage/friendGroup/phoneNumber/delete

샌드박스로 테스트하기

기존 친구 그룹에서 전화번호 목록을 삭제합니다. fileKey 또는 phoneNumbers를 이용해 입력할 수 있습니다.

Body Parameters

{} JSON

friendGroup

필수Object

친구 그룹 정보입니다.

Returns

common

Object

공통 응답 영역입니다.

data

Object

서비스 응답 영역입니다.

data

Object

친구 그룹 응답 데이터입니다.

friendGroup

Object

친구 그룹 정보입니다.

요청 예시

curl -X POST "https://mars.ibapi.kr/api/comm/v1/center/brandmessage/friendGroup/phoneNumber/delete" \
  -H "Authorization: {ApiKey}" \
  -H "Content-Type: application/json" \
  -d '{
    "friendGroup": {
      "senderKey": "{senderKey}",
      "friendGroupKey": "VIP_CUSTOMERS",
      "phoneNumbers": [
        "01000000003"
      ]
    }
  }'

응답 예시

{
  "common": {
    "authCode": "A000",
    "authResult": "Success",
    "infobankTrId": "Infobank-Tracking-Id"
  },
  "data": {
    "code": "A000",
    "result": "Success",
    "data": {
      "friendGroup": {
        "friendGroupKey": "VIP_CUSTOMERS",
        "requestId": 1203983,
        "status": "IN_PROGRESS",
        "createdAt": "2026-04-09 15: 18: 00",
        "modifiedAt": "2026-04-09 15: 18: 00"
      }
    }
  }
}

무료수신거부 관리

브랜드메시지 광고성 안내에 필요한 무료수신거부 정보를 발신프로필 기준으로 관리합니다.

발신프로필 무료수신거부 정보 입력

POST/api/comm/v1/center/brandmessage/unSubscribeContent

샌드박스로 테스트하기

발신프로필의 무료수신거부 전화번호와 인증번호를 등록합니다. 광고성 메시지 하단의 무료수신거부 안내에 사용할 수 있습니다.

Body Parameters

{} JSON

brandmessage

필수Object

무료수신거부 정보입니다.

Returns

common

Object

공통 응답 영역입니다.

data

Object

서비스 응답 영역입니다.

요청 예시

curl -X POST "https://mars.ibapi.kr/api/comm/v1/center/brandmessage/unSubscribeContent" \
  -H "Authorization: {ApiKey}" \
  -H "Content-Type: application/json" \
  -d '{
    "brandmessage": {
      "senderKey": "{senderKey}",
      "unsubscribePhoneNumber": "080-1234-1234",
      "unsubscribeAuthNumber": "12345"
    }
  }'

응답 예시

{
  "common": {
    "authCode": "A000",
    "authResult": "Success",
    "infobankTrId": "Infobank-Tracking-Id"
  },
  "data": {
    "code": "A000",
    "result": "Success"
  }
}