본문 바로가기메인 메뉴 바로가기사이드 메뉴 바로가기

kakao developers

Related sites
  • Docs
  • Legacy JavaScript

사이드 메뉴

Search

This document describes how to integrate Kakao Talk Social APIs into your service with the JavaScript SDK v1 (also referred to as 'Legacy JavaScript SDK').

End of support for Legacy JavaScript SDK

Legacy JavaScript SDK (v1) will no longer be supported as of December 31, 2026. Use the latest JavaScript SDK by downloading it, or upgrading from v1 to v2. For more details, see Notice.

ReferenceApp setting
request()

This API enables you to get the Kakao Talk profile of the user currently logged in.

Note that Kakao Talk profiles may be different from Kakao Account profiles. Refer to Concepts.

Call the Kakao.API.request() function, and set url to /v1/api/talk/profile to request Kakao Talk profile. You do not need to set the HTTP request header and other parameters because the JavaScript SDK v1 proceeds automatically and sends a request instead.

NameTypeDescriptionRequired
urlStringFixed to '/v1/api/talk/profile'.O
successFunction(Object)Callback function that gets invoked when the API request is successful.X
failFunction(Object)Callback function that gets invoked if the API request is failed.X
alwaysFunction(Object)Callback function that gets invoked regardless of the API request results.X
Kakao.API.request({
url: "/v1/api/talk/profile",
success: function (response) {
console.log(response)
},
fail: function (error) {
console.log(error)
},
})

If the request is successful, the Kakao Talk profile information is returned in JSON format. To see more about the response, refer to REST API.

ReferenceApp setting
-

Opens the Friend picker and returns the information of the Kakao Talk friends selected by the user.

  • The JavaScript SDK v1 only supports the full screen type of picker, while the Android and iOS SDK provides both the popup and full screen format of picker.
  • To see the supported web browser, refer to Supported web browser.
NameTypeDescriptionRequired
titleStringText to be displayed in the title area of the Friend picker.
(Default: "Select Friends")
X
enableSearchBooleanWhether to show the Search box for friends.
(Default: true)
X
showMyProfileBooleanWhether to show my profile.
When set to true (Default), users can also select their own profile.
X
showFavoriteBooleanWhether to show the friends added as Favorite.
(Default: true)
X
showPickedFriendBooleanWhether to show the selected friends.
(Default: true)

Note: Only for the multi-picker
X
maxPickableCountNumberMaximum number of the selectable friends.
This value must be greater than or equal to minPickableCount.
(Default: 30, Maximum: 100)

Note: Only for the multi-picker
X
minPickableCountNumberMinimum number of the selectable friends.
This value must be less than or equal to maxPickableCount.
(Default: 1, Maximum: 100)

Note: Only for the multi-picker
X
successFunction(Object)Callback function that gets invoked when the API request is successful.

Note: Only for the pop-up method
X
failFunction(Object)Callback function that gets invoked if the API request is failed.

Note: Only for the pop-up method
X
alwaysFunction(Object)Callback function that gets invoked regardless of the API request results.

Note: Only for the pop-up method
X
returnUrlStringService URL that the information of the selected friends are passed to.

Important: Required for the redirect method

Important: Only allowed the domain registered in [App] > [Product Link] > [Web domain].
X
enableBackButtonBooleanWhether to show the back (←) button.
  • true: the Back button displayed. (Default)
  • false: the Back button no displayed.

Note: Only for the redirect method
X
// Pop-up method
Kakao.Picker.selectFriends({
title: "Select friends",
maxPickableCount: 10,
minPickableCount: 1,
success: function (response) {
console.log(response)
},
fail: function (error) {
console.log(error)
},
})
// Redirect method
// Success: ${returnUrl}?selected=${SelectedUsers}
// Fail: ${returnUrl}?error=${Error}
Kakao.Picker.selectFriends({
returnUrl: "https://developers.kakao.com", // Required
title: "Select friends",
maxPickableCount: 10,
minPickableCount: 1,
})

If the request is successful, the information of the friends that a user selects from the Friend picker is returned through SelectedUsers.

NameTypeDescriptionRequired
selectedTotalCountNumberNumber of friends who a user selected on the Friend picker.
It can be different from the number of friends in the list of selected friend information.
O
usersSelectedUser[]List of friends data that is passed in the response.
Refer to SelectedUser.
X
NameTypeDescriptionRequired
uuidStringUser's unique ID used to identify users in a service and used to send a Kakao Talk message.
This value may change if a user deletes and then re-creates the Kakao Talk account.
O
idStringFriend's service user ID. Only the friends who are linked to the app have a service user ID.X
profile_nicknameStringFriend's profile nickname set in Kakao Talk.X
profile_thumbnail_imageStringFriend's profile thumbnail image set in Kakao Talk.X
favoriteBooleanWhether the friend is added as Favorite.X
ReferenceApp setting
request()

You can get the list of Kakao Talk friends of the user currently logged in.

You can also add optional parameters for sort order, the number of friends to be retrieved on a page, and so on.

Call the Kakao.API.request() function, and set url to /v1/api/talk/friends to request Kakao Talk friends information. You do not need to set the HTTP request header and other parameters because the JavaScript SDK v1 proceeds automatically and sends a request instead.

NameTypeDescriptionRequired
urlStringFixed to '/v1/api/talk/friends'.O
successFunction(Object)Callback function that gets invoked when the API request is successful.X
failFunction(Object)Callback function that gets invoked if the API request is failed.X
alwaysFunction(Object)Callback function that gets invoked regardless of API request results.X
dataObjectObject that contains the parameters to be passed when requesting the API.
Refer to data: Retrieve list of friends.
X
NameTypeDescriptionRequired
offsetNumberOffset value that the list of friends starts from.
(Default: 0)
X
limitNumberMaximum number of friends to be retrieved per page.
(Maximum: 100, Default: 10)
X
orderStringSort order of friends list.
asc or desc.
  • asc: sort in ascending order. (Default)
  • desc: sort in descending order.
X
friend_orderStringYou can sort friends in the list by nickname (Kakao Talk nickname) or favorite (favorite friends, Default).X
Kakao.API.request({
url: "/v1/api/talk/friends",
success: function (response) {
console.log(response)
},
fail: function (error) {
console.log(error)
},
})

If the request is successful, a list of friends is returned in JSON format. To see more about the response, refer to REST API.

If the request fails because the user has not agreed to provide the Friends list, proceed the followings:

  • Check if 'Friends List in Kakao Service(Including profile image, nickname, and favorites)' is set to 'Consent during use' in Consent items.
  • Request additional consent to the 'Friends List in Kakao Service(Including profile image, nickname, and favorites)' scope.

Was this helpful?

    Kakao Developers | Docs