kakao developers

Flutter

This document describes how to integrate Kakao Talk Channel APIs into your service with the Kakao SDK for Flutter (hereinafter referred to as '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';

Add Kakao Talk Channel

Basic information

Permission	Prerequisite	Kakao Login	User consent
-	Register platforms	-	-

To enable a user to add a specific Kakao Talk Channel as a friend, call the addChannelUrl() method defined in the TalkApi class. You must pass the Kakao Talk Channel ID through channelPublicId as an argument.

To open the specified Kakao Talk Channel via a default web browser, call the launchBrowserTab() method.

Parameter

Name	Type	Description	Required
channelPublicId	String	Kakao Talk Channel ID.	O

Sample

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

If the request is successful, addChannelUrl() launches the Kakao Talk application through Custom URL Scheme, and the user is directed to the specified Kakao Talk Channel to add the channel as a friend.

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

Start Kakao Talk Channel chat

Basic information

Permission	Prerequisite	Kakao Login	User consent
-	Register platforms	-	-

To allow a user to start a Kakao Talk Channel chat, call the channelChatUrl() method defined in the TalkApi class. You must pass the Kakao Talk Channel ID through channelPublicId as an argument.

To open the specified Kakao Talk Channel via a default web browser, call launchBrowserTab() method.

Parameter

Name	Type	Description	Required
channelPublicId	String	Kakao Talk Channel ID.	O

Sample

// Kakao Talk Channel chat URL
Uri url = await TalkApi.instance.channelChatUrl('_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');
}

If the request is successful, channelChatUrl() launches the Kakao Talk application through Custom URL Scheme, and the user is directed to the specified Kakao Talk Channel's chatroom. With the bridge page is displayed, a chat with the Kakao Talk Channel is started with the message saying "안녕하세요. 무엇을 도와드릴까요?" ("Hello, how can I help you?"). This message also includes the web page URL that the user requested a chat for.

Check Kakao Talk Channel relationship

Basic information

Permission	Prerequisite	Kakao Login	User consent
-	Register platforms Activate Kakao Login Manage consent items Set Kakao Talk Channel	Required	Required: Kakao Talk Channel addition status and details

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

See more

• Download Flutter SDK
• API Reference for Flutter →