사이드 메뉴
Getting started
Kakao Developers
Login
Communication
Advertisement
- Concepts
- Ad creation: Ad account
- Ad creation: Campaign
- Ad creation: Ad group
- Targeting for ad group
- Custom audience targeting for ad group
- Ad creation: Creative common
- Ad creation: Display creative
- Ad creation: Message creative
- Ad creation: Personalized message creative
- Bizboard landing settings
- Report
- Message management
- Personalized message management
- Message ad management
- Message ad operation
- Ad View management
- Business Form+ management
- Pixel & SDK linkage management
- Audience management
- Engagement targeting management
- Customer data management
- Customer file management
- Friend group management
- Ad account management
- Reference
- Type information
- Error code
Kakao Moment
Message management
This document describes how to use the Message management API.
| Method | URL | Authorization |
|---|---|---|
GET | https://apis.moment.kakao.com/openapi/v4/messages/coupons |
| Requirements | See also | |
|---|---|---|
Returns a list of coupons that you can set as a button for a Message creative.
| Name | Description | Required |
|---|---|---|
| Authorization | Business token as a type of user authentication.Authorization: Bearer ${BUSINESS_ACCESS_TOKEN} | O |
| Name | Type | Description | Required |
|---|---|---|---|
| profileId | Long | Kakao Talk Channel's profile ID. | O |
| Name | Type | Description |
|---|---|---|
| - | ChannelCoupon[] | List of coupon information. |
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"}]
| Method | URL | Authorization |
|---|---|---|
GET | https://apis.moment.kakao.com/openapi/v4/messages/coupons/${ID} |
| Requirements | See also | |
|---|---|---|
Returns the details of a coupon that you can set as a button for a Message creative.
| Name | Description | Required |
|---|---|---|
| Authorization | Business token as a type of user authentication.Authorization: Bearer ${BUSINESS_ACCESS_TOKEN} | O |
| Name | Type | Description | Required |
|---|---|---|---|
| ID | Long | Coupon ID. | O |
| Name | Type | Description | Required |
|---|---|---|---|
| profileId | Long | Kakao Talk Channel's profile ID. | O |
| 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. |
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"}
| Method | URL | Authorization |
|---|---|---|
GET | https://apis.moment.kakao.com/openapi/v4/messages/adViews |
| Requirements | See also | |
|---|---|---|
Returns a list of Ad Views you can set as a button for a Message creative.
| Name | Description | Required |
|---|---|---|
| Authorization | Business token as a type of user authentication.Authorization: Bearer ${BUSINESS_ACCESS_TOKEN} | O |
| adAccountId | Ad account's ID.adAccountId: ${AD_ACCOUNT_ID} | O |
| Name | Type | Description |
|---|---|---|
| - | AdView[] | List of Ad Views. |
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"}]
| Method | URL | Authorization |
|---|---|---|
GET | https://apis.moment.kakao.com/openapi/v4/messages/posts/${PROFILE_ID} |
| Requirements | See also | |
|---|---|---|
Returns a list of Kakao Talk Channel posts that you can set as a button for a Message creative.
| Name | Description | Required |
|---|---|---|
| Authorization | Business token as a type of user authentication.Authorization: Bearer ${BUSINESS_ACCESS_TOKEN} | O |
| adAccountId | Ad account's ID.adAccountId: ${AD_ACCOUNT_ID} | O |
| Name | Type | Description | Required |
|---|---|---|---|
| PROFILE_ID | String | Kakao Talk Channel's profile ID. | O |
| Name | Type | Description |
|---|---|---|
| - | ChannelPost[] | List of posts uploaded in the requested Kakao Talk Channel. |
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"}]