kakao developers

Android

This document describes how to integrate Kakao Talk Social APIs into your service with the Kakao SDK for Android (hereinafter referred to as 'Android SDK').

Tag used in this document

Before you begin

Register Android Platform

To use the Android SDK, you must register the Android platform in advance. Go to [My Application] > [Platform] and register the Android platform by specifying its package name and key hashes.

Add modules

To use this API, you must add both v2-user (Kakao Login module) and v2-talk (Kakao Talk module that provides TalkApiClient in the module-level build.gradle file by referring to Add modules. To implement the Friend picker, you must also add v2-friend module that provides PickerClient.

Implement Kakao Login

To use the Kakao Talk Social APIs,

• You must implement Kakao Login beforehand.
• A user has been logged in with a Kakao Account.

Retrieve Kakao Talk profile Login required Consent required

To retrieve the Kakao Talk profile of the user currently logged in, call the profile() method in the TalkApiClient class.

To use this API,

• You must enable the 'Profile' scope in [My Application] > [Kakao Login] > [Consent items].
• A user must consent to the scope. Otherwise, an empty value is returned.

Sample

// Retrieve Kakao Talk profile
TalkApiClient.instance.profile { profile, error ->
    if (error != null) {
        Log.e(TAG, "Failed to retrieve Kakao Talk profile", error)
    }
    else if (profile != null) {
        Log.i(TAG, "Succeeded in retrieving Kakao Talk profile" +
                "\nNickname: ${profile.nickname}" +
                "\nProfile Thumbnail: ${profile.thumbnailUrl}"
    }
}

var disposables = CompositeDisposable()

// Retrieve Kakao Talk profile
TalkApiClient.rx.profile()
    .subscribeOn(Schedulers.io())
    .observeOn(AndroidSchedulers.mainThread())
    .subscribe({ profile ->
        Log.i(TAG, "Succeeded in retrieving Kakao Talk profile" +
                "\nNickname: ${profile.nickname}" +
                "\nProfile Thumbnail: ${profile.thumbnailUrl}" 
    }, { error ->
        Log.e(TAG, "Failed to retrieve Kakao Talk profile", error)
    }).addTo(disposables)

Return data

profile() returns the TalkProfile object which contains the user's Kakao Talk profile information.

The Kakao Talk profile obatained though profile() is different from the profile of Kakao Account. Refer to Concepts.

TalkProfile

Retrieve friends through picker Login requiredConsent required

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

To use this API,

• You must enable the 'Friends List in Kakao Service(Including profile image, nickname, and favorites)' scope in [My Application] > [Kakao Login] > [Consent items].
• A user must consent to the 'Friends List in Kakao Service(Including profile image, nickname, and favorites)' scope.

Depending on the selection type and display format of the Friend picker, you need to use a different method.

Method

Parameter

Sample

Single picker in full screen

val openPickerFriendRequestParams = OpenPickerFriendRequestParams(
    title = "Single picker in full screen", //default "Select friends"
    viewAppearance = ViewAppearance.AUTO, //default ViewAppearance.AUTO
    orientation = PickerOrientation.AUTO, //default PickerOrientation.AUTO
    enableSearch = true, //default true
    enableIndex = true, //default true
    showMyProfile = true, //default true
    showFavorite = true, //default true
)

PickerClient.instance.selectFriend(
    context = context!!,
    params = openPickerFriendRequestParams
) { selectedUsers, error ->
    if (error != null) {
        Log.e(TAG, "Failed to retrieve the selected friend through the picker.", error)
    } else {
        Log.d(TAG, "Succeeded in retrieving the selected friend through the picker. $selectedUsers")
    }
}

val openPickerFriendRequestParams = OpenPickerFriendRequestParams(
    title = "Single picker in full screen", //default "Select friends"
    viewAppearance = ViewAppearance.AUTO, //default ViewAppearance.AUTO
    orientation = PickerOrientation.AUTO, //default PickerOrientation.AUTO
    enableSearch = true, //default true
    enableIndex = true, //default true
    showMyProfile = true, //default true
    showFavorite = true, //default true
)

PickerClient.rx.selectFriend(
    context = context!!,
    params = openPickerFriendRequestParams
).subscribe({ selectedUsers ->
    Log.d(TAG, "Succeeded in retrieving the selected friend through the picker. $selectedUsers")
}, { error ->
    Log.e(TAG, "Failed to retrieve the selected friend through the picker.", error)
}).addTo(disposables)

Single picker in popup screen

val openPickerFriendRequestParams = OpenPickerFriendRequestParams(
    title = "Single picker in popup screen", //default "Select friends"
    viewAppearance = ViewAppearance.AUTO, //default ViewAppearance.AUTO
    orientation = PickerOrientation.AUTO, //default PickerOrientation.AUTO
    enableSearch = true, //default true
    enableIndex = true, //default true
    showMyProfile = true, //default true
    showFavorite = true, //default true
)

PickerClient.instance.selectFriendPopup(
    context = context!!,
    params = openPickerFriendRequestParams
) { selectedUsers, error ->
    if (error != null) {
        Log.e(TAG, "Failed to retrieve the selected friend through the picker.", error)
    } else {
        Log.d(TAG, "Succeeded in retrieving the selected friend through the picker. $selectedUsers")
    }
}

val openPickerFriendRequestParams = OpenPickerFriendRequestParams(
    title = "Single picker in popup screen", //default "Select friends"
    viewAppearance = ViewAppearance.AUTO, //default ViewAppearance.AUTO
    orientation = PickerOrientation.AUTO, //default PickerOrientation.AUTO
    enableSearch = true, //default true
    enableIndex = true, //default true
    showMyProfile = true, //default true
    showFavorite = true, //default true
)

PickerClient.rx.selectFriendPopup(
    context = context!!,
    params = openPickerFriendRequestParams
).subscribe({ selectedUsers ->
    Log.d(TAG, "Succeeded in retrieving the selected friend through the picker. $selectedUsers")
}, { error ->
    Log.e(TAG, "Failed to retrieve the selected friend through the picker.", error)
}).addTo(disposables)

Multi-picker in full screen

val openPickerFriendRequestParams = OpenPickerFriendRequestParams(
    title = "Multi-picker in full screen", //default "Select friends"
    viewAppearance = ViewAppearance.AUTO, //default ViewAppearance.AUTO
    orientation = PickerOrientation.AUTO, //default PickerOrientation.AUTO
    enableSearch = true, //default true
    enableIndex = true, //default true
    showMyProfile = true, //default true
    showFavorite = true, //default true
    showPickedFriend = null, // default true
    maxPickableCount = null, // default 30
    minPickableCount = null // default 1
)

PickerClient.instance.selectFriends(
    context = context!!,
    params = openPickerFriendRequestParams
) { selectedUsers, error ->
    if (error != null) {
        Log.e(TAG, "Failed to retrieve the selected friend(s) through the picker.", error)
    } else {
        Log.d(TAG, "Succeeded in retrieving the selected friend(s) through the picker. $selectedUsers")
    }
}

val openPickerFriendRequestParams = OpenPickerFriendRequestParams(
    title = "Multi-picker in full screen", //default "Select friends"
    viewAppearance = ViewAppearance.AUTO, //default ViewAppearance.AUTO
    orientation = PickerOrientation.AUTO, //default PickerOrientation.AUTO
    enableSearch = true, //default true
    enableIndex = true, //default true
    showMyProfile = true, //default true
    showFavorite = true, //default true
    showPickedFriend = null, // default true
    maxPickableCount = null, // default 30
    minPickableCount = null // default 1
)

PickerClient.rx.selectFriends(
    context = context!!,
    params = openPickerFriendRequestParams
).subscribe({ selectedUsers ->
    Log.d(TAG, "Succeeded in retrieving the selected friend(s) through the picker. $selectedUsers")
}, { error ->
    Log.e(TAG, "Failed to retrieve the selected friend(s) through the picker.", error)
}).addTo(disposables)

Multi-picker in popup screen

val openPickerFriendRequestParams = OpenPickerFriendRequestParams(
    title = "Multi-picker in popup screen", //default "Select friends"
    viewAppearance = ViewAppearance.AUTO, //default ViewAppearance.AUTO
    orientation = PickerOrientation.AUTO, //default PickerOrientation.AUTO
    enableSearch = true, //default true
    enableIndex = true, //default true
    showMyProfile = true, //default true
    showFavorite = true, //default true
    showPickedFriend = null, // default true
    maxPickableCount = null, // default 30
    minPickableCount = null // default 1
)

PickerClient.instance.selectFriendsPopup(
    context = context!!,
    params = openPickerFriendRequestParams
) { selectedUsers, error ->
    if (error != null) {
        Log.e(TAG, "Failed to retrieve the selected friend(s) through the picker.", error)
    } else {
        Log.d(TAG, "Succeeded in retrieving the selected friend(s) through the picker. $selectedUsers")
    }
}

val openPickerFriendRequestParams = OpenPickerFriendRequestParams(
    title = "Multi-picker in popup screen", //default "Select friends"
    viewAppearance = ViewAppearance.AUTO, //default ViewAppearance.AUTO
    orientation = PickerOrientation.AUTO, //default PickerOrientation.AUTO
    enableSearch = true, //default true
    enableIndex = true, //default true
    showMyProfile = true, //default true
    showFavorite = true, //default true
    showPickedFriend = null, // default true
    maxPickableCount = null, // default 30
    minPickableCount = null // default 1
)

PickerClient.rx.selectFriendsPopup(
    context = context!!,
    params = openPickerFriendRequestParams
).subscribe({ selectedUsers ->
    Log.d(TAG, "Succeeded in retrieving the selected friend(s) through the picker. $selectedUsers")
}, { error ->
    Log.e(TAG, "Failed to retrieve the selected friend(s) through the picker.", error)
}).addTo(disposables)

Return data

If the request is successful, the information of the friends that a user selects from the Friend picker is returned through SelectedUsers. If you encounter errors, refer to Troubleshooting.

SelectedUsers: Selected friends data

SelectedUser: Each friend data

Retrieve list of friends Login required Consent required

This API enables you to get the list of Kakao Talk friends of the user currently logged in. Note that Kakao Talk profiles may be different from Kakao Account profiles. Refer to Concepts.

To use this API,

1. Get permission. Before permission is granted to your app, you can call this API only for the team members.
2. Enable the 'Friends List in Kakao Service(Including profile image, nickname, and favorites)' scope in [My Application] > [Kakao Login] > [Consent items]. A user must also consent to the scope. To see more about the conditions for providing friend information, refer to Usage policy.

To get the list of Kakao Talk friends of the user currently logged in, call the friends() method in the TalkApiClient class. You can also pass optional parameters through arguments. If you make a request without any parameters, the default settings are applied.

Parameter

Sample

// Retrieve a list of friends (Default)
TalkApiClient.instance.friends { friends, error ->
    if (error != null) {
        Log.e(TAG, "Failed to retrieve a list of friends.", error)
    }
    else if (friends != null) {
        Log.i(TAG, "Succeeded in retrieving a list of friends. \n${friends.elements.joinToString("\n")}")

        // You can send a message to the friends using their UUIDs.
    }
}

var disposables = CompositeDisposable()

// Retrieve a list of friends (Default)
TalkApiClient.rx.friends()
    .retryWhen(
        // Retry the request the list of friends after requesting additional consent to the consent item that the InsufficientScope error occurs. 
        RxAuthOperations.instance.incrementalAuthorizationRequired(context)
    )
    .subscribeOn(Schedulers.io())
    .observeOn(AndroidSchedulers.mainThread())
    .subscribe({ friends ->
        Log.i(TAG, "Succeeded in retrieving a list of friends \n${friends.elements.joinToString("\n")}")

        // You can send a message to the friends using their UUIDs.
    }, { error ->
        Log.e(TAG, "Failed to retrieve a list of friends.", error)
    })
    .addTo(disposables)

Return data

friends() returns Friends which contains a list of the user's Kakao Talk friends.

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.

Friends

Friend

* Deprecated 'allowedMsg' that indicates whether or not the friend allows to receive Kakao Talk messages from the app as Profile visibility option is provided. For more details, refer to DevTalk.

See more

• Download Android SDK
• API Reference →

Legacy

To see how to integrate the features of Kakao Talk Social using the Legacy Kakao SDK for Android, see Kakao Talk Social guide for Legacy Android SDK.

It is highly recommended to migrate to the new version of Android SDK as soon as possible because the Legacy version may not be supported anymore.