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').

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.

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.

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

• 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.

You can implement the picker with two methods:

• Popup method
  • The picker appears as the popup window.
  • The selected friends data is returned through the callback functions such as success, fail, and always.
• Redirect method
  • The picker appears on the current window.-- The information about the selected friends is passed to the returnUrl of your service server as a query string through redirection (HTTP 302 Redirect).
  • For this, you must register the domain of returnUrl in [App] > [Platform key] > [JavaScript key] > [JavaScript SDK domain].

Depending on the selection type of the Friend picker, you need to use a different function.

// 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.

If the request is failed, error code and message are returned. To check its cause and solution, refer to Error code.

The total count of friends a user selected (selectedTotalCount) on the multi-picker may differ from the number of friends passed in the response (SelectedUser). - Example case: a user A selects the user's friend B on the Friend picker. → Before the request to retrieve friends on the Friend picker is completed, B unlinks from the app. → A selects [Ok] on the Friend picker to request the friend data. - Result: B who selected on the Friend picker is counted as selectedTotalCount but not included in the response to the request of the friend information. - For this case, you must notify users that the retrieved friend data is less than the number of friends they selected, considering users' better experience.

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.

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.

• Download JavaScript SDK v1
• API Reference for JavaScript SDK v1 →
• Message Template Builder →