Kakao

브랜드 메시지 발송

Changed on

사전에 등록된 브랜드 메시지 템플릿을 이용해 고객에게 광고성 메시지를 발송합니다. 오류가 발생해도 HTTP 200으로 응답하므로, 본문의 code와 errorCode로 성공 여부를 확인해야 합니다.

post/v2/messages/kakao/brand-message

Request

  • Base URL
    https://api.sendon.io
  • URL
    https://api.sendon.io/v2/messages/kakao/brand-message
  • Auth
    HTTP basic

Request body

sendProfileIdstring required

채널 ID. 카카오 채널 관리자센터에서 등록한 채널의 ID입니다.

templateCodestring required

브랜드메시지 템플릿 코드. 미리 생성된 템플릿의 코드를 사용합니다.

useCreditboolean

크레딧 우선 사용 여부. true 시 포인트보다 크레딧을 먼저 차감합니다.

targeting'I' | 'N' | 'M'

타겟팅 옵션

  • I: 수신자 중 채널을 친구로 등록한 수신자에게만 메시지 발송
  • N: 수신자 중 채널을 친구로 등록하지 않은 수신자에게만 메시지 발송
  • M: 모든 수신자에게 메시지 발송 (메시지 발송 예약 후 타겟팅 가능)

N, M 옵션은 비친구 광고채널 전용입니다.

Example request

{
  "sendProfileId": "@test1234",
  "templateCode": "BM_TEMPLATE_001",
  "to": [
    "01011112222",
    {
      "phone": "01011113333",
      "variables": {
        "#{고객명}": "김철수",
        "#{주문번호}": "20240115001"
      }
    }
  ],
  "useCredit": true,
  "reservation": {
    "dateTime": "2024-01-15T14:30:00Z",
    "datetime": "2026-03-07T09:00:00+09:00"
  },
  "fallback": {
    "fallbackType": "CUSTOM",
    "custom": {
      "senderNumber": "01011112222",
      "isAd": true,
      "message": "안녕하세요. 고객님의 주문이 접수되었습니다.",
      "title": "주문 확인",
      "images": [
        "https://example.com/image1.jpg",
        "https://example.com/image2.jpg"
      ]
    }
  },
  "targeting": "I",
  "blockCall": {
    "numberOf080": "080-1234-5678",
    "pinNumber": "1234"
  }
}

Response

브랜드 메시지 발송 요청 처리 결과입니다. 성공 시 그룹 ID가 포함되며, 실패 시 code와 errorCode에 상세 사유가 제공됩니다.

codenumber required

HTTP 상태 코드입니다. 200이면 성공, 400대는 클라이언트 오류, 500대는 서버 오류를 나타냅니다.

messagestring required

API 호출 결과에 대한 사람이 읽을 수 있는 메시지입니다. 성공 시 "OK", 실패 시 구체적인 오류 사유가 포함됩니다.

Example response

{
  "code": 200,
  "message": "OK",
  "data": {
    "groupId": "004a6217-f06c-40f6-8f39-bf35b3f76111"
  }
}

Changes

    • breaking

      request body became required

    • breaking

      added to the request property allOf list

    • breaking

      the request property type changed from object to no type

    • breaking

      the response's property type changed from object to no type for status

    • breaking

      removed the required property / from the response with the status

    • warning

      removed the request property /

    • info

      api operation id sendBrandMessage removed and replaced with MessageController_sendBrandMessage

    • info

      the endpoint scheme security basic was added to the API

    • info

      added the new optional request property

    • info

      added to the response property allOf list for the response status

    • info

      the response property became required for the status

    • info

      the response's property default value 성공 was removed for the status

    • info

      removed the 200.00 enum value from the response property for the response status