Kakao Talk Message

Flutter

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

Guide to Kakao Talk message sending feature

The Kakao Talk Message API supports sending messages only between users within the same service.
You must have permission to use the Kakao Talk Social API to use the feature to send messages to friends.
For details, see Message sending features and How to use.

Before you begin

Choose implementation method

1. Select message sending feature

Kakao Developers provides two types of message sending features: Kakao Talk Share and Kakao Talk Message. Refer to Message sending features to select the feature to use. If you want to use Kakao Talk Message, perform the following steps.

2. Select message type and configuration method

Refer to Template types to decide which message template to use.

Refer to Configuration method comparison to decide how to configure messages. You can use default templates based on predefined templates in object form, or custom templates configured directly for your service.

3. Select message target

Note that for Kakao Talk Message, the APIs used are distinguished according to the message targets.

Target	Description
Send to me	Sends a message to the "Me" chat in Kakao Talk of the currently logged-in user. This feature cannot send messages to other users and can only send messages to the logged-in user themselves.
Send to friends	Sends a message to friends in Kakao Talk of the currently logged-in user. Important: Additional feature request is required. You must implement a process to receive recipient information through Retrieve friends through picker API or Retrieve friends through picker API. You can send messages to up to 5 friends at once. Daily and monthly quotas are set, so refer to Quota.

Permission required to send messages to friends

If you want to send messages to friends, Request permission is required. See Usage Policy as well.

Project Setting

To use the Kakao Talk Message API on the native app service, you must set the Custom URL Scheme. See how to set up a project by device environment below.

Android
iOS

Send me message with default template

Basic information

Reference	App setting
`sendDefaultMemo()` `FeedTemplate` `ListTemplate` `LocationTemplate` `CommerceTemplate` `TextTemplate` `MessageSendResult` `MessageFailureInfo`	Install Initialize Project Setting

Permission	Prerequisite	Kakao Login	User consent
-	Platform key Product Link Activate Kakao Login Manage consent items	Required	Required: Send message in Kakao Talk (talk_message)

Sends a message to the user's My Chatroom using the predefined default template in JSON format.

Request

To create a message, implement the DefaultTemplate interface, then use one of the following classes according to the desired template type to configure template objects.

Feed template: FeedTemplate
List template: ListTemplate
Location template: LocationTemplate
Commerce template: CommerceTemplate
Text template: TextTemplate
Calendar template: CalendarTemplate

When calling sendDefaultMemo(), pass the template object as the template parameter.

Response

When message transmission fails, it returns a response code. See Error code to identify the cause of failure with code and msg.

Example

try {
  await TalkApi.instance.sendDefaultMemo(defaultFeed);
  print('Succeeded in sending me a message.');
} catch (error) {
  print('Failed to send me a message. $error');
}

Send me message with custom template

Basic information

Reference	App setting
`sendCustomMemo()` `MessageSendResult` `MessageFailureInfo`	Install Initialize Project Setting

Permission	Prerequisite	Kakao Login	User consent
-	Platform key Product Link Activate Kakao Login Manage consent items Message template	Required	Required: Send message in Kakao Talk (talk_message)

Sends a message to the user's My Chatroom using a custom template configured in [Tools] > [Message Template].

Request

When calling sendCustomMemo(), you must pass the template ID confirmed in the message template tool as the templateId parameter. For how to configure a template, see Custom Template.

To include variable information in a message, add user arguments to the custom template, then pass key-value pairs to the templateArgs parameter. For detailed usage and precautions, see Directly inputting user arguments.

Response

When message transmission fails, it returns a response code. See Error code to identify the cause of failure with code and msg.

Example

// Custom template ID
int templateId = '${YOUR_CUSTOM_TEMPLATE_ID}';

try {
  await TalkApi.instance.sendCustomMemo(templateId: templateId);
  print('Succeeded in sending me a message.');
} catch (error) {
  print('Failed to send me a message. $error');
}

Send me scrape message

Basic information

Reference	App setting
`sendScrapMemo()` `FeedTemplate` `ListTemplate` `LocationTemplate` `CommerceTemplate` `TextTemplate` `MessageSendResult` `MessageFailureInfo`	Install Initialize Project Setting

Permission	Prerequisite	Kakao Login	User consent
-	Platform key Product Link Activate Kakao Login Manage consent items	Required	Required: Send message in Kakao Talk (talk_message)

Sends a scrape message to the user's My Chatroom using information extracted from the specified web page URL.

Request

To send a Kakao Talk message to the user's My Chatroom by scrapping a web page, call the sendScrapMemo() method in the TalkApi class. You must pass url when calling this method.

When using a custom template, the template ID verified in the message template tool must be passed to the templateId parameter. For how to configure a template, see Custom Template.

Response

When message transmission fails, it returns a response code. See Error code to identify the cause of failure with code and msg.

Example: Using default template

// Web page URL to be shared.
//  * Caution: The domain of the URL to be shared must be registered in [App] > [Product Link] > [Web domain] in Kakao Developers.
String url = 'https://developers.kakao.com';

try {
  await TalkApi.instance.sendScrapMemo(url: url);
  print('Succeeded in sending me a message');
} catch (error) {
  print('Failed to send me a message. $error');
}

Example: Using custom template

// Custom template ID
int templateId = '${YOUR_CUSTOM_TEMPLATE_ID}';

try {
  await TalkApi.instance.sendScrapMemo(url: url);
  print('Succeeded in sending me a message.');
} catch (error) {
  print('Failed to send me a message. $error');
}

Send message with default template

Basic information

Reference	App setting
`sendDefaultMessage()` `FeedTemplate` `ListTemplate` `LocationTemplate` `CommerceTemplate` `TextTemplate` `MessageSendResult` `MessageFailureInfo`	Install Initialize Project Setting

Permission	Prerequisite	Kakao Login	User consent
Required: Permission	Platform key Product Link Activate Kakao Login Manage consent items	Required	Required: Send message in Kakao Talk (talk_message)

Sends a message composed in JSON according to the predefined default template format.

Request

Configure message template: To create a message, implement the DefaultTemplate interface, then use one of the following classes according to the desired template type to configure template objects.
- Feed template: FeedTemplate
- List template: ListTemplate
- Location template: LocationTemplate
- Commerce template: CommerceTemplate
- Text template: TextTemplate
- Calendar template: CalendarTemplate
Retrieve message recipients: To send a message to friends, you must determine who to send the message to. First, call the Retrieve friends through picker API or Retrieve list of friends API to get the uuid information of friends to send messages to.
Specify template and recipients: When calling sendDefaultMessage(), pass the previously configured template object as the template parameter, and pass the list of uuids of friends selected by the user as the receiverUuids parameter. You can send messages to up to 5 friends at once.

Response

The message transmission result is returned as a MessageSendResult object. When message transmission succeeds, successfulReceiverUuids contains a list of uuids of friends who successfully received the message. When message transmission fails for some friends, failureInfos contains failure information. See Error code to identify the cause of failure with code and msg.

Example

// Retrieve a list of Kakao Talk friends.
Friends friends;
try {
  friends = await TalkApi.instance.friends();
} catch (error) {
  print('Failed to retrieve a list of friends. $error');
  return;
}

if (friends.elements == null) {
  return;
}

if (friends.elements!.isEmpty) {
  print('There is no friend to send a message to :(');
} else {
  // Retrieve UUIDs of the friends to send a message according to your service's environment.
  // This sample displays the Friends list and collects the UUIDs of the friends selected by a user.
  List<String> selectedItems = await Navigator.of(context).push(
  MaterialPageRoute(
    builder: (context) => FriendPage(
    items: friends.elements!
      .map((friend) => PickerItem(
        friend.uuid,
        friend.profileNickname ?? '',
        friend.profileThumbnailImage))
      .toList(),
      ),
    ),
  );

  if (selectedItems.isEmpty) {
    return;
  }
  print('Selected friends:\n${selectedItems.join('\n')}');

  // List of UUIDs of recipients to send a message to.
  List<String> receiverUuids = selectedItems;

  // Feed message
  FeedTemplate template = defaultFeed;

  // Send a Feed message
  try {
  MessageSendResult result =
    await TalkApi.instance.sendDefaultMessage(
    receiverUuids: receiverUuids,
    template: template,
  );
  print('Succeeded in sending a message to ${result.successfulReceiverUuids}.');

  if (result.failureInfos != null) {
      print('Succeed! But failed to send a message to some friends: \n${result.failureInfos}');
  }
  } catch (error) {
  print('Failed to send a message. $error');
  }
}

Send message with custom template

Basic information

Reference	App setting
`sendCustomMessage()` `MessageSendResult` `MessageFailureInfo`	Install Initialize Project Setting

Permission	Prerequisite	Kakao Login	User consent
Required: Permission	Platform key Product Link Activate Kakao Login Manage consent items Message template	Required	Required: Send message in Kakao Talk (talk_message)

Sends a message using a custom template configured in [Tools] > [Message Template].

Request

Retrieve message recipients: To send a message to friends, you must determine who to send the message to. First, call the Retrieve friends through picker API or Retrieve list of friends API to get the uuid information of friends to send messages to. Pass the list of uuids of friends selected by the user as the receiverUuids parameter. You can send messages to up to 5 friends at once.
Pass template ID: When calling sendCustomMessage(), you must pass the template ID confirmed in the message template tool as the templateId parameter. For how to configure a template, see Custom Template.
Pass user arguments (optional): To include variable information in a message, add user arguments to the custom template, then pass key-value pairs to the templateArgs parameter. For detailed usage and precautions, see Directly inputting user arguments.

Response

// Retrieve a list of friends.
Friends friends;
try {
  friends = await TalkApi.instance.friends();
} catch (error) {
  print('Failed to retrieve a list of friends. $error');
  return;
}

if (friends.elements == null) {
  return;
}

if (friends.elements!.isEmpty) {
  print('There is no friend to send a message to :(');
} else {
  // Retrieve UUIDs of the friends to send a message according to your service's environment.
  // This sample displays the Friends list and collects the UUIDs of the friends selected by a user.
  List<String> selectedItems = await Navigator.of(context).push(
    MaterialPageRoute(
        builder: (context) => FriendPage(
        items: friends.elements!
            .map((friend) => PickerItem(
            friend.uuid,
            friend.profileNickname ?? '',
            friend.profileThumbnailImage))
            .toList(),
        ),
    ),
  );

  if (selectedItems.isEmpty) {
    return;
  }
  print('Selected friends:\n${selectedItems.join('\n')}');

  // List of UUIDs of recipients to send a message to
  List<String> receiverUuids = selectedItems;

  // Custom template ID
  int templateId = '${YOUR_CUSTOM_TEMPLATE_ID}';

  // Send a message with custom template
  try {
  MessageSendResult result = await TalkApi.instance.sendCustomMessage(
    receiverUuids: receiverUuids,
    templateId: templateId,
  );
  print('Succeeded in sending a message to ${result.successfulReceiverUuids}.');

  if (result.failureInfos != null) {
    print('Succeed! But failed to send a message to some friends: \n${result.failureInfos}');
  }
  } catch (error) {
  print('Failed to send a message. $error');
  }
}

Send scrap message

Basic information

Reference	App setting
`sendScrapMessage()` `FeedTemplate` `ListTemplate` `LocationTemplate` `CommerceTemplate` `TextTemplate` `MessageSendResult` `MessageFailureInfo`	Install Initialize Project Setting

Permission	Prerequisite	Kakao Login	User consent
Required: Permission	Platform key Product Link Activate Kakao Login Manage consent items	Required	Required: Send message in Kakao Talk (talk_message)

Sends a scrape message using information extracted from the specified web page URL.

Request

Retrieve message recipients: To send a message to friends, you need to determine who to send the message to. First, call the Retrieve friends through picker API or Retrieve list of friends API to get the uuid information of friends to send messages to.
Specify web page URL to scrape: When calling sendScrapMessage(), you must pass the URL of the web page to scrape as the url parameter. The domain of the web page to scrape must be registered in [App] > [Product Link] > [Web domain] in the app management page.
Apply custom template (optional): If you want to send a scrape message based on a message template defined in your service, you must pass the template ID configured in [Tools] > [Message Template] as the templateId parameter. For template configuration methods, see Custom template.
Pass user arguments (optional): To include variable information in a message, add user arguments to the custom template, then pass key-value pairs to the templateArgs parameter. For detailed usage and precautions, see Directly inputting user arguments.

Response

The message transmission result is returned as a MessageSendResult object. When message transmission is successful, successfulReceiverUuids contains a list of uuids of friends who successfully received the message. When message transmission fails for some friends, failure information is included in failureInfos. Refer to Error code to check the failure cause using code and msg.

Example: Using default template

// Sending friends a message by scrapping a web page

// Retrieving a list of friends.
Friends friends;
try {
  friends = await TalkApi.instance.friends();
} catch (error) {
  print('Failed to retrieve a list of friends. $error');
  return;
}

if (friends.elements == null) {
  return;
}

if (friends.elements!.isEmpty) {
  print('There is no friend to send a message to :(');
} else {
  // Retrieve UUIDs of the friends to send a message according to your service's environment.
  // This sample displays the Friends list and collects the UUIDs of the friends selected by a user.
  List<String> selectedItems = await Navigator.of(context).push(
    MaterialPageRoute(
        builder: (context) => FriendPage(
        items: friends.elements!
        .map((friend) => PickerItem(
        friend.uuid,
        friend.profileNickname ?? '',
        friend.profileThumbnailImage))
        .toList(),
        ),
    ),
  );

  if (selectedItems.isEmpty) {
  return;
  }
  print('Selected friends:\n${selectedItems.join('\n')}');

  // List of UUIDs of recipients to send a message to
  List<String> receiverUuids = selectedItems;

  // Web page URL to be shared
  //  * Caution: The domain of the URL to be shared must be registered in [App] > [Product Link] > [Web domain] in Kakao Developers.
  String url = "https://developers.kakao.com";

  // Sending a scrape message
  try {
  MessageSendResult result = await TalkApi.instance.sendScrapMessage(
    receiverUuids: receiverUuids,
    url: url,
  );
  print('Succeeded in sending a message to ${result.successfulReceiverUuids}.');

  if (result.failureInfos != null) {
    print('Succeed! But failed to send a message to some friends: \n${result.failureInfos}');
  }
  } catch (error) {
  print('Failed to send a message. $error');
  }
}

Example: Using custom template

// Sending friends a message by scrapping a web page with a custom template

// Retrieving a list of friends.
Friends friends;
try {
  friends = await TalkApi.instance.friends();
} catch (error) {
  print('Failed to retrieve a list of friends. $error');
  return;
}

if (friends.elements == null) {
  return;
}

if (friends.elements!.isEmpty) {
  print('There is no friend to send a message to :(');
} else {
  // Retrieve UUIDs of the friends to send a message according to your service's environment.
  // This sample displays the Friends list and collects the UUIDs of the friends selected by a user.
  List<String> selectedItems = await Navigator.of(context).push(
  MaterialPageRoute(
      builder: (context) => FriendPage(
      items: friends.elements!
        .map((friend) => PickerItem(
          friend.uuid,
          friend.profileNickname ?? '',
          friend.profileThumbnailImage))
        .toList(),
        ),
    ),
    );

  if (selectedItems.isEmpty) {
  return;
  }
  print('Selected friends:\n${selectedItems.join('\n')}');

  // List of UUIDs of recipients to send a message to
  List<String> receiverUuids = selectedItems;

  // Web page URL to be shared
  //  * Caution: The domain of the URL to be shared must be registered in [App] > [Product Link] > [Web domain] in Kakao Developers.
  String url = "https://developers.kakao.com";

  //  Message template ID
  // * Refer to the guide: https://developers.kakao.com/docs/en/message-template/custom
  int templateId = templateIds['customMessage']!;

  // Sending friends a message by scrapping a web page with a custom template
  try {
  MessageSendResult result = await TalkApi.instance.sendScrapMessage(
      receiverUuids: receiverUuids,
      url: url,
  );
  print('Succeeded in sending a message to ${result.successfulReceiverUuids}.');

  if (result.failureInfos != null) {
      print('Succeed! But failed to send a message to some friends: \n${result.failureInfos}');
  }
  } catch (error) {
  print('Failed to send a message. $error');
  }
}

Upload image

You can attach images to a message by passing an image URL when configuring a message template or by uploading images in the Message template builder in advance. Images saved on local devices must be uploaded to the Kakao server or scraped to be used for message transmission. For detailed guidance and examples, see Upload image.

See more

Message Template Tool

사이드 메뉴

Getting started

Kakao Developers

Login

Communication

Kakao Map

Navigation

Advertisement

Search

More

Flutter

Before you begin

Choose implementation method

1. Select message sending feature

2. Select message type and configuration method

3. Select message target

Project Setting

Send me message with default template

Basic information

Request

Response

Example

Send me message with custom template

Basic information

Request

Response

Example

Send me scrape message

Basic information

Request

Response

Example: Using default template

Example: Using custom template

Send message with default template

Basic information

Request

Response

Example

Send message with custom template

Basic information

Request

Response

Send scrap message

Basic information

Request

Response

Example: Using default template

Example: Using custom template

Upload image

See more

Was this helpful?

Flutter