JavaScript

This document describes how to integrate Kakao Talk Social APIs into your service with the Kakao SDK for JavaScript ("JavaScript SDK").

Retrieve Kakao Talk profile

Basic information

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.

Request

Call the Kakao.API.request() function, and set url to /v1/api/talk/profile to request Kakao Talk profile.

Parameter

Response

Kakao.API.request() returns Promise. If the promise is fulfilled, the Kakao Talk profile information is returned. For the detailed response fields, refer to REST API > Retrieve Kakao Talk profile.

Sample

Kakao.API.request({
  url: '/v1/api/talk/profile',
})
  .then(function(response) {
    console.log(response);
  })
  .catch(function(error) {
    console.log(error);
  });

Retrieve friends through picker

Basic information

This API displays the Friend picker and provides the information of the Kakao Talk friends that a user selects through the picker.

• The JavaScript SDK 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.

Request

Call one of the following functions depends on the selection type.

The components can be set by parameters.

Response

Kakao.Picker.selectFriends() returns Promise. If the promise is fulfilled, the information of the friends that a user selects from the Friend picker is returned through SelectedUsers.

Sample

Kakao.Picker.selectFriend({
  title: 'Select friends',
})
  .then(function(response) {
    console.log(response);
  })
  .catch(function(error) {
    console.log(error);
  });

Kakao.Picker.selectFriends({
  title: 'Select friends',
  maxPickableCount: 10,
  minPickableCount: 1,
})
  .then(function(response) {
    console.log(response);
  })
  .catch(function(error) {
    console.log(error);
  });

Additional Feature

Redirection

To call the friend picker on the current web page, use returnUrl parameter.

Specify the URL of the service server that processes the response to the returnUrl parameter. returnUrl must be one of the site domains in [My Application] > [Platform] > [Web]. Use the enableBackButton parameter to disable the back button.

When the user completes choosing friends, the web page will HTTP 302 redirect with the response as an encoded query string to the returnUrl.

// 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,
});

Retrieve list of friends

Basic information

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.

Request

Call the Kakao.API.request() function, and set url to /v1/api/talk/friends to request Kakao Talk friends information.

Parameter

data: Retrieving list of friends

Response

Kakao.API.request() returns Promise. If the promise is fulfilled, a list of friends is returned. For the detailed response fields, refer to REST API > Retrieve list of friends.

If the promise is rejected 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.

Sample

Kakao.API.request({
  url: '/v1/api/talk/friends',
})
  .then(function(response) {
    console.log(response);
  })
  .catch(function(error) {
    console.log(error);
  });

See more

Kakao Talk Social for JavaScript SDK v1