Kakao Moment

Message management

This document describes how to use the Message management API.

View list of coupons

Basic information

Method	URL	Authorization
`GET`	`https://apis.moment.kakao.com/openapi/v4/messages/coupons`	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 a list of coupons that you can set as a button for a Message creative.

Send a GET request with the issued business token in the request header. You must also pass the profile ID of the Kakao Talk Channel through the profileId parameter to retrieve coupons that can be used for a message button. If the request is successful, this API returns the list of the coupons in JSON format. If failed, refer to Error code to figure out its failure cause.

Request

Header

Name	Description	Required
Authorization	`Authorization: Bearer ${BUSINESS_ACCESS_TOKEN}` Business token as a type of user authentication.	O

Query parameter

Name	Type	Description	Required
profileId	`Long`	Kakao Talk Channel's profile ID.	O

Response

Body

Name	Type	Description
-	`ChannelCoupon[]`	List of coupon information.

Sample

Request

curl -X GET "https://apis.moment.kakao.com/openapi/v4/messages/coupons?profileId=${PROFILE_ID}" \
    -H "Authorization: Bearer ${BUSINESS_ACCESS_TOKEN}"

Response

// HTTP/1.1 200 OK
// Content-Type: application/json;charset=UTF-8
[
  {
    "id": 12345,
    "title": "First test coupon",
    "content": "This is the first test coupon.",
    "statusCode": "done",
    "permalink": "http://xxx.kakao.com/_xxx/coupons/_xxx",
    "entryImage": {
      "type": "image",
      "url": "http://xxx.kakao.com/img_xl.jpg",
      "thumbnail": null,
      "previewImage": null,
      "playUrl": null,
      "name": null
    },
    "createdAt": "2021-01-11T15:43:12"
  },
  {
    "id": 12346,
    "title": "Second test coupon",
    "content": "This is the second test coupon.",
    "statusCode": "done",
    "permalink": "http://xxx.kakao.com/_xxx/coupons/_xxx",
    "entryImage": {
      "type": "image",
      "url": "http://xxx.kakao.com/img_xl.jpg",
      "thumbnail": null,
      "previewImage": null,
      "playUrl": null,
      "name": null
    },
    "createdAt": "2021-01-11T15:43:12"
  }
]

View details of coupon

Basic information

Method	URL	Authorization
`GET`	`https://apis.moment.kakao.com/openapi/v4/messages/coupons/${ID}`	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 details of the coupon that you can set as a button for a Message creative.

Send a GET request with the issued business token in the request header. To retrieve a specific Kakao Talk Channel's coupon, you must pass the profile ID of the Kakao Talk Channel through the profileId parameter. If the request is successful, this API returns the details of the coupon in JSON format. If failed, refer to Error code to figure out its failure cause.

Request

Header

Name	Description	Required
Authorization	`Authorization: Bearer ${BUSINESS_ACCESS_TOKEN}` Business token as a type of user authentication.	O

Path variable

Name	Type	Description	Required
ID	`Long`	Coupon ID.	O

Query parameter

Name	Type	Description	Required
profileId	`Long`	Kakao Talk Channel's profile ID.	O

Response

Body

Name	Type	Description
id	`Long`	Coupon ID.
title	`String`	Coupon Title.
content	`String`	Coupon content.
statusCode	`String`	Coupon status.
permalink	`String`	Coupon link.
entryImage	`EntryImage`	Detailed information about the image on the Coupon.
createdAt	`String`	Creation time of the Coupon.

Sample

Request

curl -X GET "https://apis.moment.kakao.com/openapi/v4/messages/coupons/${ID}?profileId=${PROFILE_ID}" \
    -H "Authorization: Bearer ${BUSINESS_ACCESS_TOKEN}"

Response

// HTTP/1.1 200 OK
// Content-Type: application/json;charset=UTF-8
{
  "id": 12345,
  "title": "Test coupon",
  "content": "Test",
  "statusCode": "done",
  "permalink": "http://xxx.kakao.com/xxx/coupons/xxx",
  "entryImage": null,
  "createdAt": "2021-02-26T16:12:31"
}

View list of Ad Views

Basic information

Method	URL	Authorization
`GET`	`https://apis.moment.kakao.com/openapi/v4/messages/adViews`	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 a list of Ad Views you can set as a button for a Message creative.

Send a GET request with the issued business token and an ad account ID (adAccountId) in the request header. If the request is successful, this API returns a list of AD Views in JSON format. If failed, refer to Error code to figure out its failure cause.

Request

Header

Name	Description	Required
Authorization	`Authorization: Bearer ${BUSINESS_ACCESS_TOKEN}` Business token as a type of user authentication.	O
adAccountId	`adAccountId: ${AD_ACCOUNT_ID}` Ad account's ID.	O

Response

Body

Name	Type	Description
-	`AdView[]`	List of Ad Views.

Sample

Request

curl -X GET "https://apis.moment.kakao.com/openapi/v4/messages/adViews" \
    -H "Authorization: Bearer ${BUSINESS_ACCESS_TOKEN}"
    -H "adAccountId: ${AD_ACCOUNT_ID}"

Response

// HTTP/1.1 200 OK
// Content-Type: application/json;charset=UTF-8
[
  {
    "id": 1234,
    "name": "Ad View1",
    "type": "COMPACT",
    "templateType": "IMAGE"
  },
  {
    "id": 5678,
    "name": "Ad View2",
    "type": "COMPACT",
    "templateType": "IMAGE"
  }
]

View list of posts

Basic information

Method	URL	Authorization
`GET`	`https://apis.moment.kakao.com/openapi/v4/messages/posts/${PROFILE_ID}`	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 a list of posts uploaded in Kakao Talk Channel, which you can set as a button for a Message creative.

Send a GET request with the issued business token and an ad account ID (adAccountId) in the request header. You must also pass the profile ID of the Kakao Talk Channel to be retrieved as a path parameter. If the request is successful, this API returns the list of the requested Kakao Talk Channel's posts in JSON format. If failed, refer to Error code to figure out its failure cause.

Request

Header

Name	Description	Required
Authorization	`Authorization: Bearer ${BUSINESS_ACCESS_TOKEN}` Business token as a type of user authentication.	O
adAccountId	`adAccountId: ${AD_ACCOUNT_ID}` Ad account's ID.	O

Path variable

Name	Type	Description	Required
PROFILE_ID	`String`	Kakao Talk Channel's profile ID.	O

Response

Body

Name	Type	Description
-	`ChannelPost[]`	List of posts uploaded in the requested Kakao Talk Channel.

Sample

Request

curl -X GET "https://apis.moment.kakao.com/openapi/v4/messages/posts/${PROFILE_ID}" \
    -H "Authorization: Bearer ${BUSINESS_ACCESS_TOKEN}" \
    -H "adAccountId: ${AD_ACCOUNT_ID}"

Response

// HTTP/1.1 200 OK
// Content-Type: application/json;charset=UTF-8
[
  {
    "id": 1234,
    "title": "Post",
    "status": "published",
    "permalink": "http://kakao.com/_xxxx/1",
    "createdDate": "2021-01-01T00:00:00",
    "publishedDate": "2021-01-01T00:00:00"
  },
  {
    "id": 1235,
    "title": "Post 2",
    "status": "published",
    "permalink": "http://kakao.com/_xxxx/2",
    "createdDate": "2021-01-02T00:00:00",
    "publishedDate": "2021-01-02T00:00:00"
  }
]

View list of Business Forms

Basic information

Method	URL	Authorization
`GET`	`https://apis.moment.kakao.com/openapi/v4/messages/bizForms`	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 a list of Business Forms that you can set as a button for a Message creative.

Send a GET request with the issued business token and an ad account ID (adAccountId) in the request header. If the request is successful, this API returns the list of the Business Forms in JSON format. If failed, refer to Error code to figure out its failure cause.

Request

Header

Name	Description	Required
Authorization	`Authorization: Bearer ${BUSINESS_ACCESS_TOKEN}` Business token as a type of user authentication.	O
adAccountId	`adAccountId: ${AD_ACCOUNT_ID}` Ad account's ID.	O

Response

Body

Name	Type	Description
-	`BusinessForm[]`	List of Business Forms.

Sample

Request

curl -X GET "https://apis.moment.kakao.com/openapi/v4/messages/bizForms" \
    -H "Authorization: Bearer ${BUSINESS_ACCESS_TOKEN}" \
    -H "adAccountId: ${AD_ACCOUNT_ID}"

Response

// HTTP/1.1 200 OK
// Content-Type: application/json;charset=UTF-8
[
  {
    "id": 1,
    "adAccountId": 1234,
    "bizFormId": 10,
    "title": "Business Form",
    "flowType": "APPLY",
    "linkedDate": "2021-06-15T23:59:59",
    "beginDate": "2021-06-15T23:59:59",
    "endDate": "2021-06-15T23:59:59"
  },
  {
    "id": 2,
    "adAccountId": 1235,
    "bizFormId": 11,
    "title": "Business Form2",
    "flowType": "BANANA",
    "linkedDate": "2021-06-16T23:59:59",
    "beginDate": "2021-06-16T23:59:59",
    "endDate": "2021-06-16T23:59:59"
  }
]

View details of Business Form

Basic information

Method	URL	Authorization
`GET`	`https://apis.moment.kakao.com/openapi/v4/messages/bizForms/${BIZ_FORM_ID}`	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 a specific Business Form that you can set as a button for a Message creative.

Send a GET request with the issued business token and an ad account ID (adAccountId) in the request header. You must also pass the Business Form's ID to be retrieved as a path parameter. If the request is successful, this API returns the details of the requested Business Form in JSON format. If failed, refer to Error code to figure out its failure cause.

Request

Header

Name	Description	Required
Authorization	`Authorization: Bearer ${BUSINESS_ACCESS_TOKEN}` Business token as a type of user authentication.	O
adAccountId	`adAccountId: ${AD_ACCOUNT_ID}` Ad account's ID.	O

Path variable

Name	Type	Description	Required
BIZ_FORM_ID	`Long`	Business Form's ID.	O

Response

Body

Name	Type	Description
id	`Long`	Business Form's ID linked to Moment. This ID is required when you create a Message creative.
adAccountId	`Long`	Ad account's ID.
bizFormId	`Long`	Business Form's ID.
title	`String`	Business Form's title.
flowType	`String`	Business Form type One of: `APPLY` (바로응모형) `SURVEY` (설문조사형) `RESERV` (신청예약형)
linkedDate	`String`	Date and time when the Business Form is linked to Moment. In `yyyy-MM-dd'T'HH:mm:ss` format.
beginDate	`String`	Date and time when the Business Form starts. In `yyyy-MM-dd'T'HH:mm:ss` format.
endDate	`String`	Date and time when the Business Form ends. In `yyyy-MM-dd'T'HH:mm:ss` format.

Sample

Request

curl -X GET "https://apis.moment.kakao.com/openapi/v4/messages/bizForms/${ID}" \
    -H "Authorization: Bearer ${BUSINESS_ACCESS_TOKEN}" \
    -H "adAccountId: ${AD_ACCOUNT_ID}"

Response

// HTTP/1.1 200 OK
// Content-Type: application/json;charset=UTF-8
[
  {
    "id": 1,
    "adAccountId": 1234,
    "bizFormId": 10,
    "title": "Business Form",
    "flowType": "APPLY",
    "linkedDate": "2021-06-15T23:59:59",
    "beginDate": "2021-06-15T23:59:59",
    "endDate": "2021-06-15T23:59:59"
  }
]

See more

Kakao Moment API Reference

사이드 메뉴

Getting started

Kakao Developers

Login

Communication

Kakao Map

Navigation

Advertisement

Search

More

Message management

View list of coupons

Basic information

Request

Header

Query parameter

Response

Body

Sample

Request

Response

View details of coupon

Basic information

Request

Header

Path variable

Query parameter

Response

Body

Sample

Request

Response

View list of Ad Views

Basic information

Request

Header

Response

Body

Sample

Request

Response

View list of posts

Basic information

Request

Header

Path variable

Response

Body

Sample

Request

Response

View list of Business Forms

Basic information

Request

Header

Response

Body

Sample

Request

Response

View details of Business Form

Basic information

Request

Header

Path variable

Response

Body

Sample

Request

Response

See more

Was this helpful?

Message management