Kakao

캐러셀 피드형 브랜드 메시지 템플릿 등록

Changed on

캐러셀 피드형 브랜드 메시지 템플릿을 등록합니다. 여러 장의 카드를 순차로 구성해 다양한 상품과 버튼을 함께 소개할 수 있습니다.

post/v2/messages/kakao/send-profiles/{sendProfileId}/brand-message-templates/carousel-feed

Request

  • Base URL
    https://api.sendon.io
  • URL
    https://api.sendon.io/v2/messages/kakao/send-profiles/{sendProfileId}/brand-message-templates/carousel-feed
  • Auth
    HTTP basic

Path parameters

sendProfileIdstring required
Example:@bizmsg_official

템플릿을 등록할 카카오 채널(발신 프로필) ID입니다.

Request body

templateNamestring required

템플릿의 이름입니다. 최대 50자로 관리용으로 활용합니다.

Example request

{
  "templateName": "추천 상품 캐러셀",
  "carousel": {
    "list": [
      {
        "header": "베스트셀러 1위",
        "content": "고객님께 추천하는 베스트 상품!\n특별 할인가로 만나보세요.",
        "imageUrl": "https://mud-kage.kakao.com/dn/bi82do/btsg3pIhJq4/r5qukHdGYPRod9KhKGeeck/img_l.jpg",
        "imageLink": "https://m.example.com/product/best1",
        "buttons": [
          {
            "name": "자세히 보기",
            "linkType": "WL",
            "linkM": "https://m.example.com",
            "linkP": "https://www.example.com",
            "linkI": "myapp://page/123",
            "linkA": "myapp://page/123"
          }
        ],
        "coupon": {
          "title": "10% 할인 쿠폰",
          "description": "첫 구매 시 10% 할인 혜택",
          "linkM": "https://m.example.com/coupon/ABC123",
          "linkP": "https://www.example.com/coupon/ABC123",
          "linkI": "myapp://coupon/ABC123",
          "linkA": "myapp://coupon/ABC123"
        }
      }
    ],
    "tail": {
      "linkM": "https://m.example.com/more",
      "linkP": "https://www.example.com/more",
      "linkI": "myapp://more",
      "linkA": "myapp://more"
    }
  },
  "fallback": {
    "senderNumber": "01012345678",
    "message": "#{고객명}님, 브랜드메시지가 발송되지 못하여 대체문자로 발송됩니다.",
    "title": "대체문자 안내",
    "images": [
      "https://mud-kage.kakao.com/dn/bgUWpm/btsgfyhWuWn/L9SHkckn2VXHOayfGa9ok1/img_l.jpg"
    ],
    "groupId": "004a6217-f06c-40f6-8f39-bf35b3f76111"
  }
}

Response

등록 처리 결과입니다. 오류가 발생해도 HTTP 200으로 응답하므로, 실패 여부는 본문의 code와 errorCode를 확인하세요.

codenumber required

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

messagestring required

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

Example response

{
  "code": 200,
  "message": "OK",
  "data": {
    "templateId": "tpl_bm_123456",
    "templateCode": "BM_TEMPLATE_20240515001"
  }
}

Changes

    • breaking

      request body became required

    • breaking

      added to the request property allOf list

    • breaking

      added to the request property allOf list

    • breaking

      the request property type changed from object to no type

    • 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

    • breaking

      removed the required property / from the response with the status

    • warning

      removed the request property /

    • warning

      removed the request property /

    • warning

      removed the request property /

    • warning

      removed the request property /

    • warning

      removed the request property /

    • warning

      removed the request property /

    • warning

      removed the request property /

    • warning

      removed the request property /

    • warning

      removed the request property /

    • info

      api operation id createCarouselFeedBrandMessageTemplate removed and replaced with BrandMessageTemplateController_createCarouselFeedBrandMessageTemplate

    • info

      the endpoint scheme security basic was added to the API

    • info

      added to the response property allOf list for the response status

    • info

      the response property became required for the status

    • info

      the response property became required for the status

    • info

      the response's property default value 200 was removed for the status

    • info

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