Android

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

Before you begin

Add modules

To use the features of Kakao Talk Channel, you need to add v2-talk (Kakao Talk module) that provides TalkApiClient in the module-level build.gradle file by referring to Add modules. Because the ReactiveX Android SDK does not provide the Kakao Talk Channel API, you must use the Kakao Talk module that the Android SDK provides.

To use the Checking Kakao Talk Channel relationship API that requires Kakao Login, you must also add the Kakao Login module, v2-user. Implement Kakao Login beforehand. After that, call this API with the access token issued after a user logs in.

Add Kakao Talk Channel

Basic information

Launches Kakao Talk to let the user add the Kakao Talk Channel. Call addChannel() in TalkApiClient. Pass the profile ID of the Kakao Talk Channel.

Parameter

// Add Kakao Talk Channel
TalkApiClient.instance.addChannel(context, "_ZeUTxl") { error ->
    if (error != null) {
        Log.i(TAG, "Failed to add $error")
    }
}

var disposables = CompositeDisposable()

// Add Kakao Talk Channel
TalkApiClient.rx.addChannel(context, "_ZeUTxl")
    .observeOn(AndroidSchedulers.mainThread())
    .subscribe({
        Log.i(TAG, "Success")
    }, { error ->
        Log.e(TAG, "Fail", error)
    })
    .addTo(disposables)

This API does not inform whether the user adds the Kakao Talk Channel. To check the added status, use the Checking Kakao Talk Channel relationship API that shows the relationship between a user and a Kakao Talk Channel.

Bridge page

ReactiveX Android SDK does not support this feature.

To send the user to a bridge page before launching Kakao Talk, use addChannelUrl(). Pass the profile ID of the Kakao Talk Channel. To open the URL, use the openWithDefault() method in KakaoCustomTabsClient.

// Add URL of Kakao Talk Channel
val url = TalkApiClient.instance.addChannelUrl("_ABcdE")

// Open through CustomTabs
KakaoCustomTabsClient.openWithDefault(context, url)

Start Kakao Talk Channel chat

Basic information

Starts a chat with Kakao Talk Channel. Call chatChannel() in TalkApiClient. Pass the profile ID of the Kakao Talk Channel.

Parameter

// Start Kakao Talk Channel chat
TalkApiClient.instance.chatChannel(context, "_ZeUTxl") { error ->
    if (error != null) {
        Log.i(TAG, "Failed to start a chat $error")
    }
}

var disposables = CompositeDisposable()

TalkApiClient.rx.chatChannel(context, "_ZeUTxl")
    .observeOn(AndroidSchedulers.mainThread())
    .subscribe({
        Log.i(TAG, "Success")
    }, { error ->
        Log.e(TAG, "Fail", error)
    })
    .addTo(disposables)

Bridge page

ReactiveX Android SDK does not support this feature.

To send the user to a bridge page before launching Kakao Talk, use addChannelUrl(). Pass the profile ID of the Kakao Talk Channel. To open the URL, use the openWithDefault() method in KakaoCustomTabsClient.

// Kakao Talk Channel chat URL
val url = TalkApiClient.instance.chatChannelUrl("_ABcdE")

// Open through CustomTabs
KakaoCustomTabsClient.openWithDefault(context, url)

Check Kakao Talk Channel relationship

Basic information

To check if a specific user has added or blocked your Kakao Talk Channel connected to your service app, call the channels() method defined in the TalkApiClient class.

Make sure that this API only informs the relationship between the user and the Kakao Talk Channel connected to the app that made a request. Thus, you cannot get all Kakao Talk Channels' information that the user has added but the channels related to your service only.

Sample

// Check Kakao Talk Channel relationship
TalkApiClient.instance.channels { relations, error ->
    if (error != null) {
        Log.e(TAG, "Failed to check channel relationship.", error)
    }
    else if (relations != null) {
        Log.i(TAG, "Succeeded in checking channel relationship. \n${relations.channels}")
    }
}

var disposables = CompositeDisposable()

// Check Kakao Talk Channel relationship
TalkApiClient.rx.channels()
    .retryWhen(
        // Request additional consent for InsufficientScope. 
        RxAuthOperations.instance.incrementalAuthorizationRequired(context)
    )
    .subscribeOn(Schedulers.io())
    .observeOn(AndroidSchedulers.mainThread())
    .subscribe({ relations ->
        Log.i(TAG, "Succeeded in checking channel relationship. \n${relations.channels}")
    }, { error ->
        Log.e(TAG, "Failed to check channel relationship.", error)
    })
    .addTo(disposables)

If the request is successful, channels() returns the Channels object.

Channels

Channel

* The time is based on Coordinated Universal Time(UTC), being 9 hours behind Korean Standard Time(KST). For the format of time, refer to RFC3339: Date and Time on the Internet.

See more

• Download Android SDK
• API Reference →