This document describes how to use the Message management API.
View list of Kakao TV channels
This API enables you to retrieve a list of Kakao TV channels that include videos to be used for a Message creative.
Send a GET request with the issued access token in the request header. If the request is successful, this API returns the list of the Kakao TV channels in JSON format. A list of Kakao TV channels shows 100 Kakao TV channels per page through pagination. You can request to retrieve the next page by using the page parameter. If failed, refer to Error code to figure out its failure cause.
Request
URL
GET /openapi/v4/messages/kakaotv/channels HTTP/1.1
Host: apis.moment.kakao.com
Authorization: Bearer {access_token}
Header
Name
Type
Description
Authorization
String
Pass an access token in Bearer ${ACCESS_TOKEN} format.
This API enables you to retrieve the details of the Kakao TV channel that includes videos to be used for a Message creative.
Send a GET request with the issued access token in the request header. You must also pass the Kakao TV channel's ID to be retrieved and as a path parameter. If the request is successful, this API returns the details of the requested Kakao TV channel in JSON format. If failed, refer to Error code to figure out its failure cause.
Request
URL
GET /openapi/v4/messages/kakaotv/channels/{id} HTTP/1.1
Host: apis.moment.kakao.com
Authorization: Bearer {access_token}
Parameter: Path
Name
Type
Description
Required
id
Long
ID of the Kakao TV channel to be retrieved.
O
Response
Name
Type
Description
id
Long
Kakao TV channel's ID.
name
String
Kakao TV channel's name.
description
String
Kakao TV channel's description.
totalClipCount
Integer
Number of video clips uploaded in the Kakao TV channel.
openClipCount
Integer
Number of public video clips in a playlist.
subscriberCount
Integer
Number of subscribers.
visitCount
Integer
Number of views of Kakao TV channel videos.
isOpen
Boolean
Whether Kakao TV channel is public or private.
createTime
DateTime
Creation time of the Kakao TV channel.
updateTime
DateTime
Update time of the Kakao TV channel.
clipCount
Integer
Number of video clips in a playlist.
linkUrl
String
URL of the Kakao TV channel page.
Sample
Request
curl -X GET "https://apis.moment.kakao.com/openapi/v4/messages/kakaotv/channels/{id}" \
-H "Authorization: Bearer ${ACCESS_TOKEN}"
Response
HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
{
"id": 1234,
"name": "Test Kakao TV Channel1",
"description": "This is Kakao TV Channel1 for test",
"totalClipCount": 72,
"openClipCount": 0,
"subscriberCount": 0,
"visitCount": 253,
"isOpen": true,
"createTime": "2018-07-10 14:51:20",
"updateTime": "2018-07-10 14:51:20",
"clipCount": 0,
"linkUrl": "https://sandbox-tv.kakao.com/channel/1234"
}
View list of Kakao TV channel videos
This API enables you to retrieve a list of videos that you can use for a Message creative.
Send a GET request with the issued access token in the request header. You must also pass the 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 videos uploaded in the Kakao Talk Channel in JSON format. A list of Kakao TV channels shows 100 Kakao TV channels per page through pagination. You can request to retrieve the next page by using the page parameter. If failed, refer to Error code to figure out its failure cause.
Request
URL
GET /openapi/v4/messages/kakaotv/channels/{id}/clipLinks HTTP/1.1
Host: apis.moment.kakao.com
Authorization: Bearer ${ACCESS_TOKEN}
Header
Name
Type
Description
Authorization
String
Pass an access token in Bearer ${ACCESS_TOKEN} format.
This API enables you to retrieve the details of the videos uploaded in a Kakao TV channel, which you can use for a Message creative.
Send a GET request with the issued access token in the request header. You must also pass the Kakao TV channel's ID and Clip Link ID to be retrieved as a path parameter. If the request is successful, this API returns the details of the video in the Kakao TV channel in JSON format. If failed, refer to Error code to figure out its failure cause.
Request
URL
GET /openapi/v4/messages/kakaotv/channels/{channelId}/clipLinks/{clipLinkId} HTTP/1.1
Host: apis.moment.kakao.com
Authorization: Bearer ${ACCESS_TOKEN}
Header
Name
Type
Description
Authorization
String
Pass an access token in Bearer ${ACCESS_TOKEN} format.
curl -X GET "https://apis.moment.kakao.com/openapi/v4/messages/kakaotv/channels/{channelId}/clipLinks/{clipLink}" \
-H "Authorization: Bearer ${ACCESS_TOKEN}"
Response
HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
{
"id": 123456789,
"displayTitle": "This is a test video.",
"playCount": 9,
"likeCount": 0,
"commentCount": 0,
"createTime": "2021-02-24 16:09:24",
"updateTime": "2021-02-24 16:09:24",
"clip": {
"id": 987654321,
"duration": 15.0,
"thumbnailUrl": "http://thumb.kakaocdn.net/dn/live_static/default/thumbnail.png",
"isOpen": false
},
"linkUrl": "https://sandbox-tv.kakao.com/v/123456789"
}
View list of coupons
This API enables you to retrieve a list of coupons that you can set as a button for a Message creative.
Send a GET request with the issued access 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
URL
GET /openapi/v4/messages/coupons HTTP/1.1
Host: apis.moment.kakao.com
Authorization: Bearer ${ACCESS_TOKEN}
Header
Name
Type
Description
Authorization
String
Pass an access token in Bearer ${ACCESS_TOKEN} format.
curl -X GET "https://apis.moment.kakao.com/openapi/v4/messages/coupons" \
-H "Authorization: Bearer ${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
This API enables you to retrieve the details of the coupon that you can set as a button for a Message creative.
Send a GET request with the issued access 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
URL
GET /openapi/v4/messages/coupons/{id} HTTP/1.1
Host: apis.moment.kakao.com
Authorization: Bearer ${ACCESS_TOKEN}
Header
Name
Type
Description
Authorization
String
Pass an access token in Bearer ${ACCESS_TOKEN} format.
This API enables you to retrieve a list of Ad Views you can set as a button for a Message creative.
Send a GET request with the issued access 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
URL
GET /openapi/v4/messages/adViews HTTP/1.1
Host: apis.moment.kakao.com
Authorization: Bearer ${ACCESS_TOKEN}
Header
Name
Type
Description
Authorization
String
Pass an access token in Bearer ${ACCESS_TOKEN} format.
This API enables you to retrieve 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 access 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
URL
GET /openapi/v4/messages/posts/{profileId} HTTP/1.1
Host: apis.moment.kakao.com
Authorization: Bearer ${ACCESS_TOKEN}
Header
Name
Type
Description
Authorization
String
Pass an access token in Bearer ${ACCESS_TOKEN} format.
This API enables you to retrieve a list of Business Forms that you can set as a button for a Message creative.
Send a GET request with the issued access 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
URL
GET /openapi/v4/messages/bizForms HTTP/1.1
Host: apis.moment.kakao.com
Authorization: Bearer ${ACCESS_TOKEN}
Header
Name
Type
Description
Authorization
String
Pass an access token in Bearer ${ACCESS_TOKEN} format.
This API enables you to retrieve a specific Business Form that you can set as a button for a Message creative.
Send a GET request with the issued access 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
URL
GET /openapi/v4/messages/bizForms/{bizFormId} HTTP/1.1
Host: apis.moment.kakao.com
Authorization: Bearer ${ACCESS_TOKEN}
Header
Name
Type
Description
Authorization
String
Pass an access token in Bearer ${ACCESS_TOKEN} format.
adAccountId
Long
Ad account's ID.
Parameter: Path
Name
Type
Description
Required
bizFormId
Long
Business Form's ID.
O
Response
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's type.
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.