페이지 이동경로
  • Docs>
  • Kakao Talk Channel>
  • Flutter

Kakao Talk Channel

Flutter

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

Before you begin

Before using Kakao Talk Channel APIs with the Flutter SDK, you must complete the prerequisites.

Add modules

To use the features of Kakao Talk Channel, you need to add kakao_flutter_sdk_talk for Kakao Talk module and kakao_flutter_sdk_user for Kakao Login module in pubspec.yaml by referring to Install SDK. After that, add the following libraries in your dart file.

import 'package:kakao_flutter_sdk_talk/kakao_flutter_sdk_talk.dart';

//If you use the Checking Kakao Talk Channel relationship API, import this module as well.
import 'package:kakao_flutter_sdk_user/kakao_flutter_sdk_user.dart';

Select Method to add Kakao Talk Channel

Follow Kakao Talk Channel and Add Kakao Talk Channel are available. Refer to Add Kakao Talk Channel and decide what to use. Follow Kakao Talk Channel is recommended because of the easy implementation.

Set Custom URL scheme

To use Follow Kakao Talk channel, set a custom URL scheme in AndroidManifest.xml. The custom URL scheme is used to launch the service app after following Kakao Talk channel. Refer to the sample below.

<!-- Custom URL scheme setting for Android device in the Flutter project -->
<activity 
    android:name="com.kakao.sdk.flutter.FollowChannelHandlerActivity"
    android:exported="true">
    <intent-filter>
        <action android:name="android.intent.action.VIEW" />
        <category android:name="android.intent.category.DEFAULT" />
        <category android:name="android.intent.category.BROWSABLE" />
        <!-- Redirect URI: "kakao${NATIVE_APP_KEY}://channel" -->
        <data android:scheme="kakao${YOUR_NATIVE_APP_KEY}" android:host="channel"/>
    </intent-filter>
    </intent-filter>
</activity>

Follow Kakao Talk Channel

Basic information
Permission Prerequisite Kakao Login User consent Reference
- Register platforms
Activate Kakao Login
Manage consent items
Set Kakao Talk Channel
- - FollowChannelResult
followChannel()
Caution

To use this feature, set Custom URL scheme.

Note: Kakao Login

Follow Kakao Talk Channel is available without Kakao Login. However, to avoid an inconvenient login process, we recommend using Follow Kakao Talk Channel in a service with Kakao Login.


Requests adding Kakao Talk Channel to the user. Displays a screen for adding Kakao Talk Channel and returns the result in the response.

Request followChannel() in TalkApi. Kakao Talk Channel profile ID is required. Refer to Services using Kakao Login and Services not using Kakao Login for the request process.

try {
  // Follow Kakao Talk Channel
  await TalkApi.instance.followChannel("${CHANNEL_PUBLIC_ID}");
  print("Success")
  // Success
} catch(error) {
  Log.e(context, tag, "Fail", error);
  // Fail
}

If the request is successful, FollowChannelResult in the response includes the Kakao Talk Channel profile ID and the result. If the request fails, refer to Trouble shooting to figure out the reason.

Add Kakao Talk Channel

Basic information
Permission Prerequisite Kakao Login User consent Reference
- Register platforms - - addChannel()
addChannelUrl()

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

Parameter

Name Type Description Required
channelPublicId String Kakao Talk Channel ID. O
try {
  // Add Kakao Talk Channel
  await TalkApi.instance.addChannel(channelId);
} catch(e) {
  Log.e(context, tag, 'Failed to add', e);
}

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

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 specified Kakao Talk Channel via a default web browser, call the launchBrowserTab() method.

// Add URL of Kakao Talk Channel
Uri url = await TalkApi.instance.addChannelUrl('_ABcdE');

// Open URL via a device browser
try {
  await launchBrowserTab(url);
} catch (error) {
  print('Any web browser is not installed: Install a web browser. $error');
}

Start Kakao Talk Channel chat

Basic information
Permission Prerequisite Kakao Login User consent Reference
- Register platforms - - chatChannel()
chatChannelUrl()

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

Parameter

Name Type Description Required
channelPublicId String Kakao Talk Channel ID. O
try {
  // Start Kakao Talk Channel chat
  await TalkApi.instance.chatChannel(channelId);
} catch(e) {
  Log.e(context, tag, 'Failed to start a chat', e);
}

Bridge page

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 specified Kakao Talk Channel via a default web browser, call launchBrowserTab() method.

// Kakao Talk Channel chat URL
Uri url = await TalkApi.instance.chatChannelUrl('_ABcdE');

// Open URL via a device browser
try {
  await launchBrowserTab(url);
} catch (error) {
  print('Any web browser is not installed: Install a web browser. $error');
}

Check Kakao Talk Channel relationship

Basic information
Permission Prerequisite Kakao Login User consent Reference
- Register platforms
Activate Kakao Login
Manage consent items
Set Kakao Talk Channel
Required Required:
Kakao Talk Channel addition status and details
channels()
Channels

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

// Checking Kakao Talk Channel relationship
try {
  Channels relations = await TalkApi.instance.channels();
  print('Succeeded in checking channel relationship.\n${relations.channels}');
} catch (error) {
  print('Failed to check channel relationship. $error');
}

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

Channels
Name Type Description Required
userId Int Service user ID. X
channels List<Channel> Kakao Talk Channel information. X
Channel
Name Type Description Required
uuid String Kakao Talk Channel ID for search purpose. O
encodedId String Kakao Talk Channel profile ID.
(Example: _ZeUTxl)
O
relation String Relationship between a Kakao Talk Channel and a user.
- ADDED: a user has added the channel.
- BLOCKED: a user has blocked the channel.
- NONE: a user has not either added or blocked the channel.
O
updatedAt DateTime Time when a Kakao Talk Channel is added or blocked in UTC*.
Only returned if a Kakao Talk Channel is added (ADDED) or blocked (BLOCKED).
X

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

Note

To get a notification when a user adds or blocks one of your Kakao Talk Channels linked to you service, use the Kakao Talk Channel callback function.

See more