kakao developers

iOS

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

Tag used in this document

Before you begin

Register iOS Platform

To use the iOS SDK, you must register the iOS platform in advance. Go to [My Application] > [Platform] and register the iOS platform by specifying the Bundle ID.

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.

Add modules

1. Add KakaoSDKAuth (Authentication and token management module), KakaoSDKUser (Kakao Login module) and KakaoSDKTalk (Kakao Talk Social module that provides UserApi) in the Podfile by referring to Install SDK. To implement the Friend picker, you must also add KakaoSDKFriend module that provides PickerApi.
2. Add the import statements for the required modules as follows.

Sample

import KakaoSDKAuth
import KakaoSDKUser
import KakaoSDKTalk
import KakaoSDKFriend // Only used when implementing the Friend picker

import KakaoSDKAuth
import RxKakaoSDKAuth

import KakaoSDKUser
import RxKakaoSDKUser

import KakaoSDKTalk
import RxKakaoSDKTalk

// Only used when implementing the Friend picker
import KakaoSDKFriend 
import RxKakaoSDKFriend

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 TalkApi 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

TalkApi.shared.profile {(profile, error) in
    if let error = error {
        print(error)
    else {
        print("profile() success.")

        // Do something
        _ = profile                
    }
}

// Class member property
let disposeBag = DisposeBag()

TalkApi.shared.rx.profile()
    .retry(when: Auth.shared.rx.incrementalAuthorizationRequired())
    .subscribe (onSuccess:{ (profile) in
        print("success.")

        // Do something
        _ = profile   

    }, onFailure: {error in
        print(error)
    })
    .disposed(by: disposeBag)

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,

• Import the KakaoSDKFriend module, and then complete Cocoapods settings for picker.
• 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

let openPickerFriendRequestParams = OpenPickerFriendRequestParams(
    title: "Single picker in full screen", //default "Select friends"                                                
    viewAppearance: .auto,                  //default .auto
    orientation: .auto,                     //default .auto
    enableSearch: true,                     //default true
    enableIndex: true,                      //default true
    showMyProfile: true,                    //default true
    showFavorite: true                      //default true     
)

PickerApi.shared.selectFriend(params: openPickerFriendRequestParams) { selectedUsers, error in
    if let error = error {
        print(error)
    }
    else {
        print("selectFriend(params:) success.")
        
        //do something
        _ = selectedUsers 
    }
}

// Class member property
let disposeBag = DisposeBag()

let openPickerFriendRequestParams = OpenPickerFriendRequestParams(
    title: "Single picker in full screen", //default "Select friends"                                                
    viewAppearance: .auto,                  //default .auto
    orientation: .auto,                     //default .auto
    enableSearch: true,                     //default true
    enableIndex: true,                      //default true
    showMyProfile: true,                    //default true
    showFavorite: true                      //default true
)

PickerApi.shared.rx.selectFriend(params:openPickerFriendRequestParams)
    .subscribe (onNext:{ (selectedUsers) in
        print("selectFriend(params:) success.")

        //do something
        _ = selectedUsers 

    }, onError: {error in
        print(error)
    })
    .disposed(by: disposeBag) 

Single picker in popup screen

let openPickerFriendRequestParams = OpenPickerFriendRequestParams(
    title: "Single picker in popup screen", //default "Select friends"                                                
    viewAppearance: .auto,                  //default .auto
    orientation: .auto,                     //default .auto
    enableSearch: true,                     //default true
    enableIndex: true,                      //default true
    showMyProfile: true,                    //default true
    showFavorite: true                      //default true       
)

PickerApi.shared.selectFriendPopup(params: openPickerFriendRequestParams) { selectedUsers, error in
    if let error = error {
        print(error)
    }
    else {
        print("selectFriendPopup(params:) success.")
        
        //do something
        _ = selectedUsers 
    }
}

// Class member property
let disposeBag = DisposeBag()

let openPickerFriendRequestParams = OpenPickerFriendRequestParams(
    title: "Single picker in popup screen", //default "Select friends"
    viewAppearance: .auto,                  //default .auto
    orientation: .auto,                     //default .auto
    enableSearch: true,                     //default true
    enableIndex: true,                      //default true
    showMyProfile: true,                    //default true
    showFavorite: true                      //default true
)

PickerApi.shared.rx.selectFriendPopup(params:openPickerFriendRequestParams)
    .subscribe (onNext:{ (selectedUsers) in
        print("selectFriendPopup(params:) success.")

        //do something
        _ = selectedUsers 

    }, onError: {error in
        print(error)
    })
    .disposed(by: disposeBag)

Multi-picker in full screen

let openPickerFriendRequestParams = OpenPickerFriendRequestParams(
    title: "Multi-picker in full screen", //default "Select friends"                                                
    viewAppearance: .auto,                  //default .auto
    orientation: .auto,                     //default .auto
    enableSearch: true,                     //default true
    enableIndex: true,                      //default true
    showMyProfile: true,                    //default true
    showFavorite: true,                     //default true
    showPickedFriend: nil,                  //default true
    maxPickableCount: nil,                  //default 30
    minPickableCount: nil                   //default 1   
)

PickerApi.shared.selectFriends(params: openPickerFriendRequestParams) { selectedUsers, error in
    if let error = error {
        print(error)
    }
    else {
        print("selectFriends(params:) success.")
        
        //do something
        _ = selectedUsers 
    }
}

// Class member property
let disposeBag = DisposeBag()

let openPickerFriendRequestParams = OpenPickerFriendRequestParams(
    title: "Multi-picker in full screen", //default "Select friends"                                                
    viewAppearance: .auto,                  //default .auto
    orientation: .auto,                     //default .auto
    enableSearch: true,                     //default true
    enableIndex: true,                      //default true
    showMyProfile: true,                    //default true
    showFavorite: true,                     //default true
    showPickedFriend: nil,                  //default true
    maxPickableCount: nil,                  //default 30
    minPickableCount: nil                   //default 1 
)

PickerApi.shared.rx.selectFriends(params:openPickerFriendRequestParams)
    .subscribe (onNext:{ (selectedUsers) in
        print("selectFriends(params:) success.")

        //do something
        _ = selectedUsers        

    }, onError: {error in
        print(error)
    })
    .disposed(by: disposeBag)

Multi-picker in popup screen

let openPickerFriendRequestParams = OpenPickerFriendRequestParams(
    title: "Multi-picker in popup screen", //default "Select friends"                                                
    viewAppearance: .auto,                  //default .auto
    orientation: .auto,                     //default .auto
    enableSearch: true,                     //default true
    enableIndex: true,                      //default true
    showMyProfile: true,                    //default true
    showFavorite: true,                     //default true
    showPickedFriend: nil,                  //default true
    maxPickableCount: nil,                  //default 30
    minPickableCount: nil                   //default 1                  
)

PickerApi.shared.selectFriendsPopup(params: openPickerFriendRequestParams) { selectedUsers, error in
    if let error = error {
        print(error)
    }
    else {
        print("selectFriendsPopup(params:) success.")
        
        //do something
        _ = selectedUsers 
    }
}

// Class member property
let disposeBag = DisposeBag()

let openPickerFriendRequestParams = OpenPickerFriendRequestParams(
    title: "Multi-picker in popup screen", //default "Select friends"                                                
    viewAppearance: .auto,                  //default .auto
    orientation: .auto,                     //default .auto
    enableSearch: true,                     //default true
    enableIndex: true,                      //default true
    showMyProfile: true,                    //default true
    showFavorite: true,                     //default true
    showPickedFriend: nil,                  //default true
    maxPickableCount: nil,                  //default 30
    minPickableCount: nil                   //default 1 
)

PickerApi.shared.rx.selectFriendsPopup(params:openPickerFriendRequestParams)
    .subscribe (onNext:{ (selectedUsers) in
        print("selectFriendsPopup(params:) success.")

        //do something
        _ = selectedUsers 

    }, onError: {error in
        self.errorHandler(error: error)
    })
    .disposed(by: disposeBag)

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

NOTE: If the number of friends passed in response is less than the number of selected friends

The total count of friends a user selected (totalCount) 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 totalCount 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.

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 TalkApi class. You can also pass optional parameters through arguments. If you make a request without any parameters, the default settings are applied.

Parameter

Sample

TalkApi.shared.friends {(friends, error) in
    if let error = error {
        print(error)
    }
    else {
        // Do something
        _ = friends        
    }
}

// Class member property
let disposeBag = DisposeBag()

TalkApi.shared.rx.friends()
    .retry(when: Auth.shared.rx.incrementalAuthorizationRequired())
    .subscribe (onSuccess:{ (friends) in
        // Do something
        _ = friends        
        
    }, onFailure: {error in
        print(error)
    })
    .disposed(by: disposeBag)

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 iOS SDK
• API Reference for iOS →
• API Reference for ReactiveX iOS →

Legacy

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

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