페이지 이동경로
  • Docs>
  • Kakao Moment>
  • Message ad operation

Kakao Moment

Message ad operation

This document describes how to use the Message ad operation API for Kakao Moment message ads.

Before you begin

Message ads have different components depending on the message type, so the available parameters differ from each other. For detailed information, refer to Message type components.

Available message types

Message ads can send the following types of messages. For detailed information on each message type, refer to the Kakao Business Channel Message Guide.

Name Message type
Basic Text BASIC_TEXT_MESSAGE
Wide Image WIDE_MESSAGE
Wide List WIDE_LIST_MESSAGE
Carousel Commerce CAROUSEL_COMMERCE_MESSAGE
Carousel Feed CAROUSEL_FEED_MESSAGE
Premium Video PREMIUM_VIDEO_MESSAGE

Premium Video (PREMIUM_VIDEO_MESSAGE) message type cannot be sent via the Message ad API.

Message type components

This section provides information about the field path, specifications, and required status for each message type component.

Basic text (BASIC_TEXT_MESSAGE)

Component and Field Path Specification Required
Promotional Area
message.items.imageUrl		 - Images that comply with Promotional area common specifications can be applied.
- Landing: Connects to Button1 element landing URL (separate setting not available).		 X
Promotional Text
message.description		 - Character count: Maximum 300 characters when promotional area element is included (maximum 400 characters when not included), links cannot be entered.
- Line breaks: Maximum 29.
- Landing: Not available.		 O
Button1
message.buttons		 - Button name: Maximum 8 characters including spaces.
- Landing: Connects to registered button landing URL.
- Required when this element is included: Button name, button mobile landing URL.		 X
Button2
message.buttons		 - Button name: Maximum 8 characters including spaces.
- Landing: Connects to registered button landing URL.
- Required when this element is included: Button name, button mobile landing URL.		 X
Coupon
message.couponBook		 - Landing: Connects to registered coupon landing URL.
- Required when this element is included: Coupon type, coupon title, coupon detailed description, coupon mobile landing URL.		 X

Wide image (WIDE_MESSAGE)

Component and Field Path Specification Required
Promotional Area
message.items.imageUrl		 - Images that comply with Promotional area common specifications can be applied.
- Landing: Connects to registered item landing URL.		 O
Promotional Text
message.description		 - Character count: Maximum 76 characters, links cannot be entered.
- Line breaks: Maximum 1.
- Landing: Connects to registered item landing URL.		 O
Creative Landing
message.items.landing		 - Landing connected when the promotional area is clicked.
- Landing can be registered.		 O
Button1
message.buttons		 - Button name: Maximum 8 characters including spaces.
- Landing: Connects to registered button landing URL.
- Required when this element is included: Button name, button mobile landing URL.		 X
Button2
message.buttons		 - When share flag (message.shareFlag) is set, operates as Share button, button name and landing setting not available.
- Button name: Maximum 8 characters including spaces.
- Landing: Connects to registered button landing URL.
- Required when this element is included: Button name, button mobile landing URL.		 X
Coupon
message.couponBook		 - Landing: Connects to registered coupon landing URL.
- Required when this element is included: Coupon type, coupon title, coupon detailed description, coupon mobile landing URL.		 X

Wide list (WIDE_LIST_MESSAGE)

Component and Field Path Specification Required
Promotional Area
message.items.imageUrl		 - Images that comply with Promotional area common specifications can be applied.
- Landing: Connects to registered item landing URL.
- Required status*: List1-3 required, List4-5 optional.		 O*
Title
message.messageTitle		 - Character count: Maximum 20 characters, links cannot be entered, line breaks not allowed.
- Landing: Connects to registered item landing URL.		 O
Item Promotional Text
message.items.description		 - List1 character count: Maximum 25 characters, links cannot be entered, line breaks not allowed.
- List2-5 character count: Maximum 30 characters, links cannot be entered, line breaks not allowed.
- Landing: Connects to registered item landing URL.
- Required status*: List2-3 required, List1 and List4-5 optional.		 O*
Creative Landing
message.items.landing		 - Landing connected when the promotional area is clicked.
- Landing can be registered.		 O
Button1
message.buttons		 - Button name: Maximum 8 characters including spaces.
- Landing: Connects to registered button landing URL.
- Required when this element is included: Button name, button mobile landing URL.		 X
Button2
message.buttons		 - When share flag (message.shareFlag) is set, operates as Share button. X
Coupon
message.couponBook		 - Landing: Connects to registered coupon landing URL.
- Required when this element is included: Coupon type, coupon title, coupon detailed description, coupon mobile landing URL.		 X

Carousel commerce (CAROUSEL_COMMERCE_MESSAGE)

  • Divided into intro and carousel (1-6).
  • When intro is included, carousel1 is required; when not included, carousel1-2 are required.
Intro
Component and Field Path Specification Required
Title
message.introCarousel.messageTitle		 - Character count: Maximum 20 characters, links cannot be entered, line breaks not allowed. O
Promotional Image
message.introCarousel.imageUrl		 - Only images that comply with Promotional area common specifications can be applied.
- Recommended size: 800x400 (2:1 ratio), 800x800 (1:1 ratio), 800x600 (4:3 ratio).
- Landing: Connects to registered intro landing URL.		 O
Promotional Text
message.introCarousel.description		 - Character count: Maximum 50 characters, links cannot be entered, line breaks not allowed.
- Landing: Connects to registered intro URL.		 O
Intro Landing URL
message.introCarousel.landing		 - When separate URL landing is needed for PC KakaoTalk, intro PC landing URL can be additionally registered. X
Carousel
Component and Field Path Specification Required
Title
message.carousels.messageTitle		 - Character count: Maximum 25 characters, links cannot be entered, line breaks not allowed. O
Promotional Image
message.carousels.imageUrl		 - Only images that comply with Promotional area common specifications can be applied.
- Recommended size: 800x400 (2:1 ratio), 800x800 (1:1 ratio), 800x600 (4:3 ratio).
- Landing: Connects to Button1 landing URL.		 O
Promotional Text
message.carousels.description		 - Character count: Maximum 50 characters, links cannot be entered.
- Line breaks: Maximum 2.
- Landing: Connects to Button1 landing URL.		 O
Carousel Landing URL
message.carousels.landing		 - Applied to Button1 landing URL.
- When separate URL landing is needed for PC KakaoTalk, carousel PC landing URL can be additionally registered.		 O
Price Information
message.carousels.priceAmount		 - When currency information is Korean Won (₩) or Japanese Yen (￥), only integers with 8 digits or less (0-99999999) can be entered.
- When currency information is Dollar ($) or Euro (€), integers with 8 digits or less or numbers with up to 2 decimal places (0-99999999.99) can be entered.		 O
Currency Information
message.carousels.priceCurrencyCode		 - Sets the currency unit for price information.
- Can be applied as one of Korean Won (₩), Dollar ($), Japanese Yen (￥), Euro (€).		 O
Discounted Price Information
message.carousels.discountedPriceAmount		 - Must enter a value that differs by 1% or more from the price information value.
- Discount rate: Automatically calculated and applied with decimal places truncated when discounted price information is entered (1%-100%).		 X
Button1
message.carousels		 - Cannot be set by user, automatically generated as a button with the following attributes.
- Button name: Purchase.
- Landing: Connects to registered carousel landing URL.		 O
Button2
message.buttons		 - When share flag (message.shareFlag) is set, operates as Share button for all carousels (1-6). Button name and landing setting not available.
- Button name: Maximum 8 characters including spaces.
- Landing: Connects to registered button landing URL.
- Required when this element is included: Button name, button mobile landing URL.		 X
More
message.moreButton		 - Connects to registered landing URL. X

Carousel feed (CAROUSEL_FEED_MESSAGE)

  • Carousel1-2 required, Carousel3-6 optional.
Component and Field Path Specification Required
Title
message.carousels.messageTitle		 - Character count: Maximum 20 characters, links cannot be entered, line breaks not allowed.
- Landing: Connects to Button1 landing URL.		 O
Promotional Image
message.carousels.imageUrl		 - Only images that comply with Promotional area common specifications can be applied.
- All carousel1-6 must register images with the same ratio.
- Recommended size: 800x400 (2:1 ratio), 800x600 (4:3 ratio).
- Landing: Connects to Button1 landing URL.		 O
Promotional Text
message.carousels.description		 - Character count: Maximum 180 characters, links cannot be entered, line breaks not allowed.
- Landing: Connects to Button1 landing URL.		 O
Button1
message.buttons		 - Button name: Maximum 8 characters including spaces.
- Landing: Connects to registered button landing URL.
- Required when this element is included: Button name, button mobile landing URL.		 O
Button2
message.buttons		 - When share flag (message.shareFlag) is set, operates as share button for Button2. Button name and landing setting not available.
- Button name: Maximum 8 characters including spaces.
- Landing: Connects to registered button landing URL.
- Required when this element is included: Button name, button mobile landing URL.		 X
Coupon
message.couponBook		 - Landing: Connects to registered coupon landing URL.
- Required when this element is included: Coupon type, coupon title, coupon detailed description, coupon mobile landing URL.		 X
More
message.moreButton		 - Connects to registered landing URL. X

Premium video (PREMIUM_VIDEO_MESSAGE)

Component and Field Path Specification
Promotional Video
message.items.video.url		 Promotional video URL registered by user.
Promotional Video Auto Thumbnail
message.items.video.autoThumbnailUrl		 Automatically generated promotional video thumbnail.
Thumbnail is set when uploaded thumbnail is not available.
Promotional Video Upload Thumbnail
message.items.video.uploadThumbnailUrl		 Promotional video upload thumbnail registered by user.
Title
message.messageTitle		 Character count: Maximum 20 characters, links cannot be entered, line breaks not allowed.
Promotional Text
message.description		 Character count: Maximum 76 characters, links cannot be entered, line breaks not allowed.
Button
message.buttons		 - Button name: Maximum 8 characters including spaces.
- Landing: Connects to registered button landing URL.
- Required when this element is included: Button name, button mobile landing URL.
Coupon
message.couponBook		 - Landing: Connects to registered coupon landing URL.
- Required when this element is included: Coupon type, coupon title, coupon detailed description, coupon mobile landing URL.

* Premium video creation is not possible, but premium videos created in [Kakao Moment] > [Message] > [Create Message] in Kakao Business can be retrieved.

Promotional area common specifications

  • Image
    • Format: JPG, JPEG, PNG
    • Size: Width greater than 80px (recommended: 800x400, 800x800, 800x600)
    • Capacity: 10MB or less
    • Ratio: Width: Height ratio less than 1:2.5 (recommended: 2:1, 1:1, 4:3)

Encoding

If URLs contain special characters or Korean text that are not encoded in UTF-8, ads may not land properly in the Kakao Talk in-app browser on iOS devices. Below are examples of special characters that may cause landing errors.

  • %
  • |
  • "

Additionally, deep link (Deeplink) format URLs that require parameter and macro substitution are not officially supported.

Save message ad

Basic information
Method URL Authorization
POST https://apis.moment.kakao.com/openapi/message/v2/message-ads/message Business token
Permission Prerequisite Business Authentication Business consent items
Required:
Request permission		 Switch to a Biz app
Set Business redirect URI
Business consent items		 Required Required

Saves the message ad content that will be sent from the Kakao Talk Channel.

The availability and required status of parameters differ depending on the message type (type). For related detailed information, refer to Message type components.

Send a POST request with the business token, ad account ID, and Kakao Talk Channel profile ID in the header. If the request is successful, the response includes detailed information of the created message. If failed, see Error code.

This API is limited to 1 request per second per user account and ad account.

Request

Header
Name Description Required
Authorization Authorization: Bearer ${BUSINESS_ACCESS_TOKEN}
Authorization method, authenticate with Business token		 O
adAccountId adAccountId: ${AD_ACCOUNT_ID}
Ad account ID		 O
channel-profile-id channel-profile-id: ${CHANNEL_PROFILE_ID}
Kakao Talk Channel profile ID		 O
Content-Type Content-Type: application/json
Request data type		 O
Body
Name Type Description Required
name String Message name
Maximum 50 characters		 X
ageVerification Boolean Whether age verification is required for the message
true: Age verification required message
false: Regular message (default)		 X
message Message Message information to create O

Response

Body

Sample

Request
Basic Text
Wide Image
Wide List
Carousel Commerce
Carousel Feed
curl -X POST "https://apis.moment.kakao.com/openapi/message/v2/message-ads/message" \
    -H "Authorization: Bearer ${BUSINESS_ACCESS_TOKEN}" \
    -H "adAccountId: ${AD_ACCOUNT_ID}" \
    -H "channel-profile-id: ${CHANNEL_PROFILE_ID}" \
    -H "Content-Type: application/json" \
    -d '{
  "name": "Message_Ad_Test_Basic_Text",
  "ageVerification": false,
  "message": {
    "type": "BASIC_TEXT_MESSAGE",
    "description": "Promotional Text",
    "shareFlag": true,
    "adFlag": true,
    "items": [
      {
        "imageUrl": "https://partner.com/img/message/001.jpg"
      }
    ],
    "buttons": [
      {
        "title": "Button 1 Name",
        "pcLandingUrl": "https://daum.net/1",
        "mobileLandingUrl": "https://daum.net/1"
      },
      {
        "title": "Button 2 Name",
        "pcLandingUrl": "https://daum.net/1",
        "mobileLandingUrl": "https://daum.net/1"
      }
    ],
    "couponBook": {
      "couponBookTitleType": "UPGRADE",
      "couponBookTitle": "Coupon Title",
      "title": "Coupon Detailed Description",
      "pcLandingUrl": "https://daum.net",
      "mobileLandingUrl": "https://daum.net"
    }
  }
}'

curl -X POST "https://apis.moment.kakao.com/openapi/message/v2/message-ads/message" \
    -H "Authorization: Bearer ${BUSINESS_ACCESS_TOKEN}" \
    -H "adAccountId: ${AD_ACCOUNT_ID}" \
    -H "channel-profile-id: ${CHANNEL_PROFILE_ID}" \
    -H "Content-Type: application/json" \
    -d '{
  "name": "Message_Ad_Test_Wide_Image",
  "ageVerification": false,
  "message": {
    "type": "WIDE_MESSAGE",
    "description": "Promotional Text",
    "shareFlag": true,
    "adFlag": true,
    "items": [
      {
        "imageUrl": "https://partner.com/img/message/001.jpg",
        "pcLandingUrl": "https://daum.net",
        "mobileLandingUrl": "https://daum.net"
      }
    ],
    "buttons": [
    {
    "title": "Button 1 Name",
    "pcLandingUrl": "https://daum.net/1",
    "mobileLandingUrl": "https://daum.net/1"
    }
],
"couponBook": {
    "couponBookTitleType": "UPGRADE",
    "couponBookTitle": "Coupon Title",
    "title": "Coupon Detailed Description",
    "pcLandingUrl": "https://daum.net",
    "mobileLandingUrl": "https://daum.net"
    }
  }
}'

curl -X POST "https://apis.moment.kakao.com/openapi/message/v2/message-ads/message" \
    -H "Authorization: Bearer ${BUSINESS_ACCESS_TOKEN}" \
    -H "adAccountId: ${AD_ACCOUNT_ID}" \
    -H "channel-profile-id: ${CHANNEL_PROFILE_ID}" \
    -H "Content-Type: application/json" \
    -d '{
  "name": "Message_Ad_Test_Wide_List",
  "ageVerification": false,
  "message": {
    "type": "WIDE_LIST_MESSAGE",
    "messageTitle": "Title",
    "shareFlag": true,
    "adFlag": true,
    "items": [
      {
        "description": "List 1 Promotional Text",
        "imageUrl": "https://partner.com/img/message/001.jpg",
        "landing": {
          "pcLandingUrl": "https://daum.net",
          "mobileLandingUrl": "https://daum.net"
        }
      },
      {
        "description": "List 2 Promotional Text",
        "imageUrl": "https://partner.com/img/message/001.jpg",
        "landing": {
          "pcLandingUrl": "https://daum.net",
          "mobileLandingUrl": "https://daum.net"
        }
      },
      {
        "description": "List 3 Promotional Text",
        "imageUrl": "https://partner.com/img/message/001.jpg",
        "landing": {
          "pcLandingUrl": "https://daum.net",
          "mobileLandingUrl": "https://daum.net"
        }
      },
      {
        "description": "List 4 Promotional Text",
        "imageUrl": "https://partner.com/img/message/001.jpg",
        "landing": {
          "pcLandingUrl": "https://daum.net",
          "mobileLandingUrl": "https://daum.net"
        }
      },
      {
        "description": "List 5 Promotional Text",
        "imageUrl": "https://partner.com/img/message/001.jpg",
        "landing": {
          "pcLandingUrl": "https://daum.net",
          "mobileLandingUrl": "https://daum.net"
        }
      }
    ],
    "buttons": [
      {
        "title": "Button 1 Name",
        "pcLandingUrl": "https://daum.net/1",
        "mobileLandingUrl": "https://daum.net/1"
      }
    ]
  }
}'

curl -X POST "https://apis.moment.kakao.com/openapi/message/v2/message-ads/message" \
    -H "Authorization: Bearer ${BUSINESS_ACCESS_TOKEN}" \
    -H "adAccountId: ${AD_ACCOUNT_ID}" \
    -H "channel-profile-id: ${CHANNEL_PROFILE_ID}" \
    -H "Content-Type: application/json" \
    -d '{
  "name": "Message_Ad_Test_Carousel_Commerce",
  "ageVerification": false,
  "message": {
    "type": "CAROUSEL_COMMERCE_MESSAGE",
    "shareFlag": true,
    "adFlag": true,
    "introCarousel": {
      "messageTitle": "Intro Carousel Title",
      "description": "Intro Carousel Promotional Text",
      "imageUrl": "https://partner.com/img/message/001.jpg",
      "landing": {
        "pcLandingUrl": "https://daum.net",
        "mobileLandingUrl": "https://daum.net"
      }
    },
    "carousels": [
      {
        "messageTitle": "Carousel 1 Title",
        "priceCurrencyCode": "KRW",
        "priceAmount": 10000,
        "discountedPriceAmount": 1000,
        "imageUrl": "https://partner.com/img/message/001.jpg",
        "landing": {
          "pcLandingUrl": "https://daum.net",
          "mobileLandingUrl": "https://daum.net"
        }
      },
      {
        "messageTitle": "Carousel 2 Title",
        "priceCurrencyCode": "KRW",
        "priceAmount": 10000,
        "discountedPriceAmount": 1000,
        "imageUrl": "https://partner.com/img/message/001.jpg",
        "landing": {
          "pcLandingUrl": "https://daum.net",
          "mobileLandingUrl": "https://daum.net"
        }
      },
      {
        "messageTitle": "Carousel 3 Title",
        "priceCurrencyCode": "KRW",
        "priceAmount": 10000,
        "discountedPriceAmount": 1000,
        "imageUrl": "https://partner.com/img/message/001.jpg",
        "landing": {
          "pcLandingUrl": "https://daum.net",
          "mobileLandingUrl": "https://daum.net"
        }
      },
      {
        "messageTitle": "Carousel 4 Title",
        "priceCurrencyCode": "KRW",
        "priceAmount": 10000,
        "discountedPriceAmount": 1000,
        "imageUrl": "https://partner.com/img/message/001.jpg",
        "landing": {
          "pcLandingUrl": "https://daum.net",
          "mobileLandingUrl": "https://daum.net"
        }
      },
      {
        "messageTitle": "Carousel 5 Title",
        "priceCurrencyCode": "KRW",
        "priceAmount": 10000,
        "discountedPriceAmount": 1000,
        "imageUrl": "https://partner.com/img/message/001.jpg",
        "landing": {
          "pcLandingUrl": "https://daum.net",
          "mobileLandingUrl": "https://daum.net"
        }
      },
      {
        "messageTitle": "Carousel 6 Title",
        "priceCurrencyCode": "KRW",
        "priceAmount": 10000,
        "discountedPriceAmount": 1000,
        "imageUrl": "https://partner.com/img/message/001.jpg",
        "landing": {
          "pcLandingUrl": "https://daum.net",
          "mobileLandingUrl": "https://daum.net"
        }
      }
    ]
    "moreButton": {
      "mobileLandingUrl": "https://daum.net",
      "pcLandingUrl": "https://daum.net"
    }
  }
}'

curl -X POST "https://apis.moment.kakao.com/openapi/message/v2/message-ads/message" \
    -H "Authorization: Bearer ${BUSINESS_ACCESS_TOKEN}" \
    -H "adAccountId: ${AD_ACCOUNT_ID}" \
    -H "channel-profile-id: ${CHANNEL_PROFILE_ID}" \
    -H "Content-Type: application/json" \
    -d '{
  "name": "Message_Ad_Test_Carousel_Feed",
  "ageVerification": false,
  "message": {
    "type": "CAROUSEL_FEED_MESSAGE",
    "adFlag": true,
    "carousels": [
      {
        "messageTitle": "Carousel 1 Title",
        "description": "Carousel 1 Promotional Text",
        "imageUrl": "https://partner.com/img/message/001.jpg",
        "shareFlag": false,
        "buttons": [
          {
            "title": "Carousel1 Button1",
            "pcLandingUrl": "https://daum.net",
            "mobileLandingUrl": "https://daum.net"
          },
          {
            "title": "Carousel1 Button2",
            "pcLandingUrl": "https://daum.net",
            "mobileLandingUrl": "https://daum.net"
          }
        ],
        "couponBook": {
          "couponBookTitleType": "UPGRADE",
          "couponBookTitle": "Coupon Title",
          "title": "Coupon Detailed Description",
          "pcLandingUrl": "https://daum.net",
          "mobileLandingUrl": "https://daum.net"
        }
      },
      {
        "messageTitle": "Carousel 2 Title",
        "description": "Carousel 2 Promotional Text",
        "imageUrl": "https://partner.com/img/message/001.jpg",
        "shareFlag": false,
        "buttons": [
          {
            "title": "Carousel2 Button1",
            "pcLandingUrl": "https://daum.net",
            "mobileLandingUrl": "https://daum.net"
          },
          {
            "title": "Carousel2 Button2",
            "pcLandingUrl": "https://daum.net",
            "mobileLandingUrl": "https://daum.net"
          }
        ],
        "couponBook": {
          "couponBookTitleType": "UPGRADE",
          "couponBookTitle": "Coupon Title",
          "title": "Coupon Detailed Description",
          "pcLandingUrl": "https://daum.net",
          "mobileLandingUrl": "https://daum.net"
        }
      },
      {
        "messageTitle": "Carousel 3 Title",
        "description": "Carousel 3 Promotional Text",
        "imageUrl": "https://partner.com/img/message/001.jpg",
        "shareFlag": false,
        "buttons": [
          {
            "title": "Carousel3 Button1",
            "pcLandingUrl": "https://daum.net",
            "mobileLandingUrl": "https://daum.net"
          },
          {
            "title": "Carousel3 Button2",
            "pcLandingUrl": "https://daum.net",
            "mobileLandingUrl": "https://daum.net"
          }
        ],
        "couponBook": {
          "couponBookTitleType": "UPGRADE",
          "couponBookTitle": "Coupon Title",
          "title": "Coupon Detailed Description",
          "pcLandingUrl": "https://daum.net",
          "mobileLandingUrl": "https://daum.net"
        }
      },
      {
        "messageTitle": "Carousel 4 Title",
        "description": "Carousel 4 Promotional Text",
        "imageUrl": "https://partner.com/img/message/001.jpg",
        "shareFlag": false,
        "buttons": [
          {
            "title": "Carousel4 Button1",
            "pcLandingUrl": "https://daum.net",
            "pcLandingUrl": "https://daum.net",
            "mobileLandingUrl": "https://daum.net"
          },
          {
            "title": "Carousel4 Button2",
            "pcLandingUrl": "https://daum.net",
            "mobileLandingUrl": "https://daum.net"
          }
        ],
        "couponBook": {
          "couponBookTitleType": "UPGRADE",
          "couponBookTitle": "Coupon Title",
          "title": "Coupon Detailed Description",
          "pcLandingUrl": "https://daum.net",
          "mobileLandingUrl": "https://daum.net"
        }
      },
      {
        "messageTitle": "Carousel 5 Title",
        "description": "Carousel 5 Promotional Text",
        "imageUrl": "https://partner.com/img/message/001.jpg",
        "shareFlag": false,
        "buttons": [
          {
            "title": "Carousel5 Button1",
            "pcLandingUrl": "https://daum.net",
            "mobileLandingUrl": "https://daum.net"
          },
          {
            "title": "Carousel5 Button2",
            "pcLandingUrl": "https://daum.net",
            "mobileLandingUrl": "https://daum.net"
          }
        ],
        "couponBook": {
          "couponBookTitleType": "UPGRADE",
          "couponBookTitle": "Coupon Title",
          "title": "Coupon Detailed Description",
          "pcLandingUrl": "https://daum.net",
          "mobileLandingUrl": "https://daum.net"
        }
      },
      {
        "messageTitle": "Carousel 6 Title",
        "description": "Carousel 6 Promotional Text",
        "imageUrl": "https://partner.com/img/message/001.jpg",
        "shareFlag": false,
        "buttons": [
          {
            "title": "Carousel6 Button1",
            "pcLandingUrl": "https://daum.net",
            "mobileLandingUrl": "https://daum.net"
          },
          {
            "title": "Carousel6 Button2",
            "pcLandingUrl": "https://daum.net",
            "mobileLandingUrl": "https://daum.net"
          }
        ],
        "couponBook": {
          "couponBookTitleType": "UPGRADE",
          "couponBookTitle": "Coupon Title",
          "title": "Coupon Detailed Description",
          "pcLandingUrl": "https://daum.net",
          "mobileLandingUrl": "https://daum.net"
        }
      }
    ],
    "moreButton": {
      "mobileLandingUrl": "https://daum.net",
      "pcLandingUrl": "https://daum.net"
    }
  }
}'
Response
Basic Text
Wide Image
Wide List
Carousel Commerce
Carousel Feed
HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
{
  "messageAdId": "msg-ad-1402922220759433217",
  "name": "Message_Ad_Test_Basic_Text",
  "type": "BASIC_TEXT_MESSAGE",
  "description": "Promotional Text", 
  "items": [
    {
      "imageUrl": "https://partner.com/img/message/001.jpg"
    }
  ],
  "buttons": [
    {
      "title": "버튼 1 버튼명",
      "pcLandingUrl": "https://daum.net/1",
      "mobileLandingUrl": "https://daum.net/1"
    },
          {
        "title": "Button 2 Name",
        "pcLandingUrl": "https://daum.net/1",
        "mobileLandingUrl": "https://daum.net/1"
      }
  ],
  "couponBook": {
    "title": "Coupon Detailed Description",
    "pcLandingUrl": "https://daum.net",
    "mobileLandingUrl": "https://daum.net",
    "couponBookTitle": "Coupon Title",
    "couponBookTitleType": "UPGRADE"
  },
  "ageVerification": false,
  "adFlag": true,
  "shareFlag": true
}

HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
{
  "messageAdId": "msg-ad-1402924790181675009",
  "name": "Message_Ad_Test_Wide_Image",
  "type": "WIDE_MESSAGE",
  "items": [
    {
      "landing": {
        "pcLandingUrl": "https://daum.net",
        "mobileLandingUrl": "https://daum.net"
      },
      "imageUrl": "https://partner.com/img/message/001.jpg"
    }
  ],
  "buttons": [
    {
      "title": "Button 1 Name",
      "pcLandingUrl": "https://daum.net/1",
      "mobileLandingUrl": "https://daum.net/1"
    }
  ],
  "couponBook": {
    "title": "Coupon Detailed Description",
    "pcLandingUrl": "https://daum.net",
    "mobileLandingUrl": "https://daum.net",
    "couponBookTitle": "Coupon Title",
    "couponBookTitleType": "UPGRADE"
  },
  "ageVerification": false,
  "adFlag": true,
  "shareFlag": true,
  "description": "Promotional Text"
}

HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
{
  "messageAdId": "msg-ad-1402928312512036864",
  "name": "Message_Ad_Test_Wide_List",
  "type": "WIDE_LIST_MESSAGE",
  "items": [
    {
      "landing": {
        "pcLandingUrl": "https://daum.net",
        "mobileLandingUrl": "https://daum.net"
      },
      "description": "List 1 Promotional Text",
      "imageUrl": "https://partner.com/img/message/001.jpg" 
    },
    {
      "landing": {
        "pcLandingUrl": "https://daum.net",
        "mobileLandingUrl": "https://daum.net"
      },
      "description": "List 2 Promotional Text",
      "imageUrl": "https://partner.com/img/message/001.jpg" 
    },
    {
      "landing": {
        "pcLandingUrl": "https://daum.net",
        "mobileLandingUrl": "https://daum.net"
      },
      "description": "List 3 Promotional Text",
      "imageUrl": "https://partner.com/img/message/001.jpg"
    },
    {
      "landing": {
        "pcLandingUrl": "https://daum.net",
        "mobileLandingUrl": "https://daum.net"
      },
      "description": "List 4 Promotional Text",
      "imageUrl": "https://partner.com/img/message/001.jpg" 
    },
    {
      "landing": {
        "pcLandingUrl": "https://daum.net",
        "mobileLandingUrl": "https://daum.net"
      },
      "description": "List 5 Promotional Text",
      "imageUrl": "https://partner.com/img/message/001.jpg" 
    }
  ],
  "buttons": [
    {
      "title": "Button 1 Name",
      "pcLandingUrl": "https://daum.net/1",
      "mobileLandingUrl": "https://daum.net/1"
    }
  ],
  "ageVerification": false,
  "adFlag": true,
  "shareFlag": true,
  "messageTitle": "Title"
}

HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
{
  "messageAdId": "msg-ad-1402930598056931328",
  "name": "Message_Ad_Test_Carousel_Commerce",
  "type": "CAROUSEL_COMMERCE_MESSAGE",
  "introCarousel": {
    "landing": {
      "pcLandingUrl": "https://daum.net",
      "mobileLandingUrl": "https://daum.net"
    },
    "messageTitle": "Intro Carousel Title",
    "description": "Intro Carousel Promotional Text",
    "imageUrl": "https://partner.com/img/message/001.jpg"
  },
  "carousels": [
    {
      "landing": {
        "pcLandingUrl": "https://daum.net",
        "mobileLandingUrl": "https://daum.net"
      },
      "messageTitle": "Carousel 1 Title",
      "imageUrl": "https://partner.com/img/message/001.jpg",
      "priceCurrencyCode": "KRW",
      "priceAmount": "10000",
      "discountedPriceAmount": "1000",
      "buttons": [
        {
          "title": "Purchase",
          "pcLandingUrl": "https://daum.net",
          "mobileLandingUrl": "https://daum.net"
        }
      ]
    },
    {
      "landing": {
        "pcLandingUrl": "https://daum.net",
        "mobileLandingUrl": "https://daum.net"
      },
      "messageTitle": "Carousel 2 Title",
      "imageUrl": "https://partner.com/img/message/001.jpg",
      "priceCurrencyCode": "KRW",
      "priceAmount": "10000",
      "discountedPriceAmount": "1000",
      "buttons": [
        {
          "title": "Purchase",
          "pcLandingUrl": "https://daum.net",
          "mobileLandingUrl": "https://daum.net"
        }
      ]
    },
    {
      "landing": {
        "pcLandingUrl": "https://daum.net",
        "mobileLandingUrl": "https://daum.net"
      },
      "messageTitle": "Carousel 3 Title",
      "imageUrl": "https://partner.com/img/message/001.jpg",
      "priceCurrencyCode": "KRW",
      "priceAmount": "10000",
      "discountedPriceAmount": "1000",
      "buttons": [
        {
          "title": "Purchase",
          "pcLandingUrl": "https://daum.net",
          "mobileLandingUrl": "https://daum.net"
        }
      ]
    },
    {
      "landing": {
        "pcLandingUrl": "https://daum.net",
        "mobileLandingUrl": "https://daum.net"
      },
      "messageTitle": "Carousel 4 Title",
      "imageUrl": "https://partner.com/img/message/001.jpg",
      "priceCurrencyCode": "KRW",
      "priceAmount": "10000",
      "discountedPriceAmount": "1000",
      "buttons": [
        {
          "title": "Purchase",
          "pcLandingUrl": "https://daum.net",
          "mobileLandingUrl": "https://daum.net"
        }
      ]
    },
    {
      "landing": {
        "pcLandingUrl": "https://daum.net",
        "mobileLandingUrl": "https://daum.net"
      },
      "messageTitle": "Carousel 5 Title",
      "imageUrl": "https://partner.com/img/message/001.jpg",
      "priceCurrencyCode": "KRW",
      "priceAmount": "10000",
      "discountedPriceAmount": "1000",
      "buttons": [
        {
          "title": "Purchase",
          "pcLandingUrl": "https://daum.net",
          "mobileLandingUrl": "https://daum.net"
        }
      ]
    },
    {
      "landing": {
        "pcLandingUrl": "https://daum.net",
        "mobileLandingUrl": "https://daum.net"
      },
      "messageTitle": "Carousel 6 Title",
      "imageUrl": "https://partner.com/img/message/001.jpg",
      "priceCurrencyCode": "KRW",
      "priceAmount": "10000",
      "discountedPriceAmount": "1000",
      "buttons": [
        {
          "title": "Purchase",
          "pcLandingUrl": "https://daum.net",
          "mobileLandingUrl": "https://daum.net"
        }
      ]
    }
  ],
  "moreButton": {
    "pcLandingUrl": "https://daum.net",
    "mobileLandingUrl": "https://daum.net"
  }, 
  "ageVerification": false,
  "adFlag": true,
  "shareFlag": true
}

HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
{
  "messageAdId": "msg-ad-1402932983160483841",
  "name": "Message_Ad_Test_Carousel_Feed",
  "type": "CAROUSEL_FEED_MESSAGE",
  "carousels": [
    {
      "messageTitle": "Carousel 1 Title",
      "description": "Carousel 1 Promotional Text",
      "imageUrl": "https://partner.com/img/message/001.jpg",
      "shareFlag": false,
      "buttons": [
        {
          "title": "Carousel1 Button1",
          "pcLandingUrl": "https://daum.net",
          "mobileLandingUrl": "https://daum.net"
        },
        {
          "title": "Carousel1 Button2",
          "pcLandingUrl": "https://daum.net",
          "mobileLandingUrl": "https://daum.net"
        }
      ],
      "couponBook": {
        "title": "Coupon Detailed Description",
        "pcLandingUrl": "https://daum.net",
        "mobileLandingUrl": "https://daum.net",
        "couponBookTitle": "Coupon Title",
        "couponBookTitleType": "UPGRADE"
      }
    },
    {
      "messageTitle": "Carousel 2 Title",
      "description": "Carousel 2 Promotional Text",
      "imageUrl": "https://partner.com/img/message/001.jpg",
      "shareFlag": false,
      "buttons": [
        {
          "title": "Carousel2 Button1",
          "pcLandingUrl": "https://daum.net",
          "mobileLandingUrl": "https://daum.net"
        },
        {
          "title": "Carousel2 Button2",
          "pcLandingUrl": "https://daum.net",
          "mobileLandingUrl": "https://daum.net"
        }
      ],
      "couponBook": {
        "title": "Coupon Detailed Description",
        "pcLandingUrl": "https://daum.net",
        "mobileLandingUrl": "https://daum.net",
        "couponBookTitle": "Coupon Title",
        "couponBookTitleType": "UPGRADE"
      }
    },
    {
      "messageTitle": "Carousel 3 Title",
      "description": "Carousel 3 Promotional Text",
      "imageUrl": "https://partner.com/img/message/001.jpg",
      "shareFlag": false,
      "buttons": [
        {
          "title": "Carousel3 Button1",
          "pcLandingUrl": "https://daum.net",
          "mobileLandingUrl": "https://daum.net"
        },
        {
          "title": "Carousel3 Button2",
          "pcLandingUrl": "https://daum.net",
          "mobileLandingUrl": "https://daum.net"
        }
      ],
      "couponBook": {
        "title": "Coupon Detailed Description",
        "pcLandingUrl": "https://daum.net",
        "mobileLandingUrl": "https://daum.net",
        "couponBookTitle": "Coupon Title",
        "couponBookTitleType": "UPGRADE"
      }
    },
    {
      "messageTitle": "Carousel 4 Title",
      "description": "Carousel 4 Promotional Text",
      "imageUrl": "https://partner.com/img/message/001.jpg",
      "shareFlag": false,
      "buttons": [
        {
          "title": "Carousel4 Button1",
          "pcLandingUrl": "https://daum.net",
          "mobileLandingUrl": "https://daum.net"
        },
        {
          "title": "Carousel4 Button2",
          "pcLandingUrl": "https://daum.net",
          "mobileLandingUrl": "https://daum.net"
        }
      ],
      "couponBook": {
        "title": "Coupon Detailed Description",
        "pcLandingUrl": "https://daum.net",
        "mobileLandingUrl": "https://daum.net",
        "couponBookTitle": "Coupon Title",
        "couponBookTitleType": "UPGRADE"
      }
    },
    {
      "messageTitle": "Carousel 5 Title",
      "description": "Carousel 5 Promotional Text",
      "imageUrl": "https://partner.com/img/message/001.jpg",
      "shareFlag": false,
      "buttons": [
        {
          "title": "Carousel5 Button1",
          "pcLandingUrl": "https://daum.net",
          "mobileLandingUrl": "https://daum.net"
        },
        {
          "title": "Carousel5 Button2",
          "pcLandingUrl": "https://daum.net",
          "mobileLandingUrl": "https://daum.net"
        }
      ],
      "couponBook": {
        "title": "Coupon Detailed Description",
        "pcLandingUrl": "https://daum.net",
        "mobileLandingUrl": "https://daum.net",
        "couponBookTitle": "Coupon Title",
        "couponBookTitleType": "UPGRADE"
      }
    },
    {
      "messageTitle": "Carousel 6 Title",
      "description": "Carousel 6 Promotional Text",
      "imageUrl": "https://partner.com/img/message/001.jpg",
      "shareFlag": false,
      "buttons": [
        {
          "title": "Carousel6 Button1",
          "pcLandingUrl": "https://daum.net",
          "mobileLandingUrl": "https://daum.net"
        },
        {
          "title": "Carousel6 Button2",
          "pcLandingUrl": "https://daum.net",
          "mobileLandingUrl": "https://daum.net"
        }
      ],
      "couponBook": {
        "title": "Coupon Detailed Description",
        "pcLandingUrl": "https://daum.net",
        "mobileLandingUrl": "https://daum.net",
        "couponBookTitle": "Coupon Title",
        "couponBookTitleType": "UPGRADE"
      }
    }
  ],
  "moreButton": {
    "pcLandingUrl": "https://daum.net",
    "mobileLandingUrl": "https://daum.net"
  },
  "ageVerification": false,
  "adFlag": true,
  "shareFlag": false
}

Edit message

Basic information
Method URL Authorization
PATCH https://apis.moment.kakao.com/openapi/message/v2/message-ads/${MESSAGE_AD_ID}/message Business token
Permission Prerequisite Business Authentication Business consent items
Required:
Request permission		 Switch to a Biz app
Set Business redirect URI
Business consent items		 Required Required

Modifies the message ad content that will be sent from the Kakao Talk Channel. The message modification policy is as follows:

  • Must be in the same format as the existing message.
  • After 5 minutes before the scheduled send time, only the message name can be modified. Other parameters except the name are ignored.
  • Images and text that do not match the message execution guide cannot be used.

The availability and required status of parameters differ depending on the message type (type). For related detailed information, refer to Message type components.

Send a PATCH request with the business token, ad account ID, and Kakao Talk Channel profile ID in the header. If the request is successful, the response includes detailed information of the modified message. If failed, see Error code.

Request

Header
Name Description Required
Authorization Authorization: Bearer ${BUSINESS_ACCESS_TOKEN}
Authorization method, authenticate with Business token		 O
adAccountId adAccountId: ${AD_ACCOUNT_ID}
Ad account ID		 O
channel-profile-id channel-profile-id: ${CHANNEL_PROFILE_ID}
Kakao Talk Channel profile ID		 O
Content-Type Content-Type: application/json
Request data type		 O
Path variable
Name Type Description Required
MESSAGE_AD_ID String Message ad number (messageAdId) O
Body
Name Type Description Required
name String Message name
Maximum 50 characters		 X
ageVerification Boolean Whether age verification is required for the message
true: Age verification required message
false: Regular message
If not specified, automatically set to false		 X
message Message Message information to create O

Response

Body

Send test message ad

Basic information
Method URL Authorization
POST https://apis.moment.kakao.com/openapi/message/v2/message-ads/${MESSAGE_AD_ID}/send-test Business token
Permission Prerequisite Business Authentication Business consent items
Required:
Request permission		 Switch to a Biz app
Set Business redirect URI
Business consent items		 Required Required

Requests a message test send. When sending, [Test Send] is added to the promotional text area. Only phone numbers that are friends can be sent, and test sending is limited to 1 time per minute per user account and ad account.

Send a POST request with the business token, ad account ID, and Kakao Talk Channel profile ID in the header. If the request is successful, there is no response body. If failed, see Error code.

Request

Header
Name Description Required
Authorization Authorization: Bearer ${BUSINESS_ACCESS_TOKEN}
Authorization method, authenticate with Business token		 O
adAccountId adAccountId: ${AD_ACCOUNT_ID}
Ad account ID		 O
channel-profile-id channel-profile-id: ${CHANNEL_PROFILE_ID}
Kakao Talk Channel profile ID		 O
Content-Type Content-Type: application/json
Request data type		 O
Path variable
Name Type Description Required
MESSAGE_AD_ID String Message ad number (messageAdId) O
Body
Name Type Description Required
phoneNumbers String Target phone number for sending, in 010-1234-5678 format O

Sample

Request
curl -X POST "https://apis.moment.kakao.com/openapi/message/v2/message-ads/${MESSAGE_AD_ID}/send-test" \
    -H "Authorization: Bearer ${BUSINESS_ACCESS_TOKEN}" \
    -H "adAccountId: ${AD_ACCOUNT_ID}" \
    -H "channel-profile-id: ${CHANNEL_PROFILE_ID}" \
    -H "Content-Type: application/json" \
    -d '{
        "phoneNumbers": ["014-0042-4549"]
    }'
Response
HTTP/1.1 200 OK
Content-Length: 0
Content-Type: application/json;charset=UTF-8

Create scheduled message ad

Basic information
Method URL Authorization
POST https://apis.moment.kakao.com/openapi/message/v2/message-ads/${MESSAGE_AD_ID}/sending-reservation Business token
Permission Prerequisite Business Authentication Business consent items
Required:
Request permission		 Switch to a Biz app
Set Business redirect URI
Business consent items		 Required Required

Sets the message send start time and send target. The send start time can be set in 1-minute intervals from 5 minutes after the reservation time. However, since sending starts only after parameter generation is complete, if the start time is set within 1 hour, sending may be delayed depending on the parameter scale.

The send start time can be set from 08:00 to 20:50, and messages that have not been sent after 20:55 are sent after 8 AM the next day.

Message costs differ depending on whether message targeting is set.

  • Non-target: Messages without device/targeting information set, 15 won
  • Target: Messages with at least 1 device/targeting information set, 20 won (however, 15 won when location type Domestic (domestic only) is set)

Send a POST request with the business token, ad account ID, and Kakao Talk Channel profile ID in the header. If the request is successful, the response includes message ad send reservation information as a JSON object. If failed, see Error code.

Request

Header
Name Description Required
Authorization Authorization: Bearer ${BUSINESS_ACCESS_TOKEN}
Authorization method, authenticate with Business token		 O
adAccountId adAccountId: ${AD_ACCOUNT_ID}
Ad account ID		 O
channel-profile-id channel-profile-id: ${CHANNEL_PROFILE_ID}
Kakao Talk Channel profile ID		 O
Content-Type Content-Type: application/json
Request data type		 O
Path variable
Name Type Description Required
MESSAGE_AD_ID String Message ad number (messageAdId) O
Body
Name Type Description Required
targeting Targeting Targeting
Gender, age, location targeting can be set		 O
date String Send start date and time, in yyyy-MM-dd'T'HH:mm format X
immediateSend Boolean Whether to send immediately
true: Send immediately
false: Scheduled send		 X
pushAlarm Boolean Whether to send push alarm
true: Send push alarm
false: Do not send push alarm		 X
trackId String Conversion tracking settings, pixel & SDK settings for providing message conversion metrics X
sendRate Integer Distributed send setting
Set to 0 if you don't want distributed sending
If you want distributed sending, enter the distributed cycle count, one of: 100, 500, 1000, 1500, 2000		 X
Targeting
Name Type Description Required
type String Targeting type
WHOLE: All friends
SMART: Recommended friends
DIRECT: Direct setting		 O
devices String[] Device selection type, one of the following
ANDROID
IOS		 X
demographics Demographics[] Gender, age, location information X
customs CustomTargeting[] Custom target specification X
friendPeriod FriendPeriod[] Friend period setting
Send only to users who have been channel friends for the set period		 X
ufoInterests Set<UfoInterest> Custom target > Kakao data > Category > Interests
Refer to Custom target category type lookup		 X*
ufoBusinessTypes Set<UfoBusinessType> Custom target > Kakao data > Category > Business type
Refer to Custom target category type lookup		 X*

*Read only

Response

Body
Name Type Description
messageAdId String Message ad number, identification number assigned when first created
deviceTypes String[] Device type
ANDROID: Android
IOS: iOS
targeting Targeting Targeting information
price Long Send unit price (unit: won), one of the following
15: No targeting applied
20: Targeting applied
contractCount Integer Purchase send count, message ad send reservation count
totalBudget Long Purchase amount, total amount for message ad send reservation
totalBudgetWithVAT Long Purchase amount including VAT, amount including VAT in totalBudget
date String Send start date and time, in yyyy-MM-dd'T'HH:mm format

View scheduled message ads

Basic information
Method URL Authorization
GET https://apis.moment.kakao.com/openapi/message/v2/message-ads/${MESSAGE_AD_ID}/sending-reservation Business token
Permission Prerequisite Business Authentication Business consent items
Required:
Request permission		 Switch to a Biz app
Set Business redirect URI
Business consent items		 Required Required

Retrieves detailed information about the message ad send reservation.

Send a GET request with the business token, ad account ID, and Kakao Talk Channel profile ID in the header. If the request is successful, the response includes detailed information of the message ad send reservation. If failed, see Error code.

Request

Header
Name Description Required
Authorization Authorization: Bearer ${BUSINESS_ACCESS_TOKEN}
Authorization method, authenticate with Business token		 O
adAccountId adAccountId: ${AD_ACCOUNT_ID}
Ad account ID		 O
channel-profile-id channel-profile-id: ${CHANNEL_PROFILE_ID}
Kakao Talk Channel profile ID		 O
Content-Type Content-Type: application/json
Request data type		 O
Path variable
Name Type Description Required
MESSAGE_AD_ID String Message ad number (messageAdId) O

Response

Body
Name Type Description
messageAdId String Message ad number
Identification number assigned when first created
deviceTypes String[] Device type, one of the following can be specified (all selected when empty array is specified)
ANDROID: Android
IOS: iOS
targeting Targeting Targeting
Gender, age, location targeting can be set
price Long Send unit price (unit: won), one of the following
15: No targeting applied
20: Targeting applied
contractCount Integer Purchase send count, message ad send reservation count
totalBudget Long Purchase amount, total amount for message ad send reservation
totalBudgetWithVAT Long Purchase amount including VAT, amount including VAT in totalBudget
date String Send start date and time, in yyyy-MM-dd'T'HH:mm format

Edit scheduled message ad

Basic information
Method URL Authorization
PATCH https://apis.moment.kakao.com/openapi/message/v2/message-ads/${MESSAGE_AD_ID}/sending-reservation Business token
Permission Prerequisite Business Authentication Business consent items
Required:
Request permission		 Switch to a Biz app
Set Business redirect URI
Business consent items		 Required Required

Modifies the message send start time and send target. Send reservation modification is possible until 5 minutes before the send start time.

Send a PATCH request with the business token, ad account ID, and Kakao Talk Channel profile ID in the header. If the request is successful, the response includes message ad send reservation information as a JSON object. If failed, see Error code.

Request

Header
Name Description Required
Authorization Authorization: Bearer ${BUSINESS_ACCESS_TOKEN}
Authorization method, authenticate with Business token		 O
adAccountId adAccountId: ${AD_ACCOUNT_ID}
Ad account ID		 O
channel-profile-id channel-profile-id: ${CHANNEL_PROFILE_ID}
Kakao Talk Channel profile ID		 O
Content-Type Content-Type: application/json
Request data type		 O
Path variable
Name Type Description Required
MESSAGE_AD_ID String Message ad number (messageAdId) O
Body
Name Type Description Required
deviceTypes String[] Device type, one of the following can be specified (all selected when empty array is specified)
ANDROID: Android
IOS: iOS		 O
targeting Targeting Targeting
Gender, age, location targeting can be set		 O
date String Send start date and time, in yyyy-MM-dd'T'HH:mm format O

Response

Body
Name Type Description
messageAdId String Message ad number
Identification number assigned when first created
deviceTypes String[] Device type, one of the following can be specified (all selected when empty array is specified)
ANDROID: Android
IOS: iOS
targeting Targeting Targeting
Gender, age, location targeting can be set
price Long Send unit price (unit: won), one of the following
15: No targeting applied
20: Targeting applied
contractCount Integer Purchase send count, message ad send reservation count
totalBudget Long Purchase amount, total amount for message ad send reservation
totalBudgetWithVAT Long Purchase amount including VAT, amount including VAT in totalBudget
date String Send start date and time, in yyyy-MM-dd'T'HH:mm format

View targeting locations

Basic information
Method URL Authorization
GET https://apis.moment.kakao.com/openapi/message/v2/message-ads/sending-reservation/location Business token
Permission Prerequisite Business Authentication Business consent items
Required:
Request permission		 Switch to a Biz app
Set Business redirect URI
Business consent items		 Required Required

Retrieves detailed information for location settings used in message ad send reservations. For the complete list, refer to the Administrative District Type Information CSV file (download).

Send a GET request with the business token, ad account ID, and Kakao Talk Channel profile ID in the header. If the request is successful, the response includes targeting location information. If failed, see Error code.

Request

Header
Name Description Required
Authorization Authorization: Bearer ${BUSINESS_ACCESS_TOKEN}
Authorization method, authenticate with Business token		 O
adAccountId adAccountId: ${AD_ACCOUNT_ID}
Ad account ID		 O
channel-profile-id channel-profile-id: ${CHANNEL_PROFILE_ID}
Kakao Talk Channel profile ID		 O
Content-Type Content-Type: application/json
Request data type		 O
Query parameter
Name Type Description Required
codes String Location code
Multiple location codes can be specified as comma-separated strings
(Example: A7000A001,Q20000025)		 X

Response

Body
Name Type Description
id String City/Province value
name String depth1Name of the city/province value
children Children[] Sub-location data
Not provided when query parameter codes is used
deprecated Boolean Whether the location information is deleted, true means deleted location and is only included in the response when codes is included in the query parameter
Children
Name Type Description
id String Location value
name String Location name
children Children[] Sub-location data
deprecated Boolean Whether the location information is deleted, true means deleted location and is only included in the response when codes is included in the query parameter

Sample

Request
curl -X GET "https://apis.moment.kakao.com/openapi/message/v2/message-ads/sending-reservation/location" \
    -H "Authorization: Bearer ${BUSINESS_ACCESS_TOKEN}" \
    -H "adAccountId: ${AD_ACCOUNT_ID}" \
    -H "channel-profile-id: ${CHANNEL_PROFILE_ID}" \
    -H "Content-Type: application/json"
Request: Specify location codes
curl -v -G GET "https://apis.moment.kakao.com/openapi/message/v2/message-ads/sending-reservation/location" \
    -H "Authorization: Bearer ${BUSINESS_ACCESS_TOKEN}" \
    -H "adAccountId: ${AD_ACCOUNT_ID}" \
    -H "channel-profile-id: ${CHANNEL_PROFILE_ID}" \
    -H "Content-Type: application/json" \
    -d "codes=A7000A001,Q20000025"
Response
HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
{
    "id": "A",
    "name": "Gangwon Special Self-Governing Province",
    "children": [
        {
            "id": "A7000",
            "name": "Gangneung-si",
            "children": [
                {
                    "id": "A7000A001",
                    "name": "Gangnam-dong"
                }
            ]
        }
        ...
    ],
    ...
}
Response: Specify location codes
HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
[
    {
        "id": "A7000A001",
        "name": "Gangwon Special Self-Governing Province Gangneung-si Gangnam-dong",
        "deprecated": true
    },
    {
        "id": "Q20000025",
        "name": "Sejong Special Self-Governing City Sejong-si Haemil-dong",
        "deprecated": false
    }
]

View targeting audience and price

Basic information
Method URL Authorization
POST https://apis.moment.kakao.com/openapi/message/v2/message-ads/${MESSAGE_AD_ID}/sending-reservation/targeting-price Business token
Permission Prerequisite Business Authentication Business consent items
Required:
Request permission		 Switch to a Biz app
Set Business redirect URI
Business consent items		 Required Required

Retrieves the available audience and price for sending. The existing messageAdId setting values are reflected in the lookup or do not affect existing send reservations, and simply refer to the targeting audience and price for the targeting conditions of the API request.

Send a POST request with the business token, ad account ID, and Kakao Talk Channel profile ID in the header. If the request is successful, the response includes targeting audience and price information. If failed, see Error code.

Request

Header
Name Description Required
Authorization Authorization: Bearer ${BUSINESS_ACCESS_TOKEN}
Authorization method, authenticate with Business token		 O
adAccountId adAccountId: ${AD_ACCOUNT_ID}
Ad account ID		 O
channel-profile-id channel-profile-id: ${CHANNEL_PROFILE_ID}
Kakao Talk Channel profile ID		 O
Content-Type Content-Type: application/json
Request data type		 O
Path variable
Name Type Description Required
MESSAGE_AD_ID String Message ad number (messageAdId) O
Body
Name Type Description Required
deviceTypes String[] Device type, one of the following can be specified (all selected when empty array is specified)
ANDROID: Android
IOS: iOS		 O

Finish message ad

Basic information
Method URL Authorization
PUT https://apis.moment.kakao.com/openapi/message/v2/message-ads/${MESSAGE_AD_ID}/finish Business token
Permission Prerequisite Business Authentication Business consent items
Required:
Request permission		 Switch to a Biz app
Set Business redirect URI
Business consent items		 Required Required

Terminates the message ad. Messages currently being sent will be stopped, and scheduled messages will be cancelled.

Send a PUT request with the business token, ad account ID, and Kakao Talk Channel profile ID in the header. If the request is successful, the response returns only an HTTP 200 status code without a body. If failed, see Error code.

Request

Header
Name Description Required
Authorization Authorization: Bearer ${BUSINESS_ACCESS_TOKEN}
Authorization method, authenticate with Business token		 O
adAccountId adAccountId: ${AD_ACCOUNT_ID}
Ad account ID		 O
channel-profile-id channel-profile-id: ${CHANNEL_PROFILE_ID}
Kakao Talk Channel profile ID		 O
Content-Type Content-Type: application/json
Request data type		 O
Path variable
Name Type Description Required
MESSAGE_AD_ID String Message ad number (messageAdId) O

Sample

Request
curl -X PUT "https://apis.moment.kakao.com/openapi/message/v2/message-ads/${MESSAGE_AD_ID}/finish" \
    -H "Authorization: Bearer ${BUSINESS_ACCESS_TOKEN}" \
    -H "adAccountId: ${AD_ACCOUNT_ID}" \
    -H "channel-profile-id: ${CHANNEL_PROFILE_ID}" \
    -H "Content-Type: application/json"
Response
HTTP/1.1 200 OK
Content-Length: 0
Content-Type: application/json;charset=UTF-8
Kakao Moment> Message ad operation