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

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.

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.

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

Kakao Talk messages include links that execute specified web pages or apps. Buttons in messages execute apps using Custom URL Scheme (Custom URL Scheme) composed of URI schemes and parameters.

To allow users to execute your app using buttons in Kakao Talk messages, refer to Configuration to configure app execution allowlist and URL scheme settings. For detailed setup instructions, see Custom URL scheme configuration.

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

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 templatable parameter.

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

// For 'templatable', refer to the 'Configure a message' guide.
if let templatable = try? SdkJSONDecoder.custom.decode(FeedTemplate.self, from: feedTemplateJsonStringData) {
    TalkApi.shared.sendDefaultMemo(templatable: templatable) {(error) in
        if let error = error {
            print(error)
        }
        else {
            print("success.")
        }
    }
}

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

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 messages, add user arguments to the corresponding custom template, then pass keys and values as the templateArgs parameter. If you do not use this parameter even though the custom template includes user arguments, the part specified as user arguments will be exposed in the message as ${KEY} format.

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

let templateId : Int64 = 12345

TalkApi.shared.sendCustomMemo(templateId: templateId, templateArgs: ["msg":"메세지 파라미터"]) {(error) in
    if let error = error {
        print(error)
    }
    else {
        print("success.")
    }
}

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

You must pass the URL of the web page to be scraped as the requestUrl parameter. The domain of the web page to be scraped must be registered in [App] > [Product Link] > [Web domain] on the app management page.

If you want to send a scrape message based on a message template defined by your service, you must pass the ID of the template configured in [Tools] > [Message Template] as the templateId parameter. For template configuration methods, 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 Manually entering user arguments.

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

let requestUrl = "https://developers.kakao.com"

TalkApi.shared.sendScrapMemo(requestUrl: requestUrl) {(error) in
    if let error = error {
        print(error)
    }
    else {
        print("success.")
    }
}

let requestUrl = "https://developers.kakao.com"
let templateId : Int64 = 12345

TalkApi.shared.sendScrapMemo(requestUrl: requestUrl, templateId: templateId, templateArgs:["title":"This is title.", "description":"This is description."]) {(error) in
    if let error = error {
        print(error)
    }
    else {
        print("success.")
    }
}

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

1. 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
2. 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.
3. Specify template and recipients: When calling sendDefaultMessage(), pass the previously configured template object as the templatable 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.

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.

// For 'templatable', refer to the 'Configure a message' guide.
if let templatable = try? SdkJSONDecoder.custom.decode(FeedTemplate.self, from: feedTemplateJsonStringData) {
    // Retrieve a list of friends.
    TalkApi.shared.friends {(friends, error) in
        if let error = error {
            print(error)
        } else {
            print("friends() success.")
            guard let friends = friends else {
                print(error)
                return
            }

            //Implement a window to select friends.
            ...

            //uuids of the friends selected in the window.
            let friendUuids = selectedIds as! [String]

            // Send a Kakao Talk message.
            TalkApi.shared.sendDefaultMessage(templatable: templatable, receiverUuids: friendUuids) { (messageSendResult, error) in
                if let error = error {
                    print(error)
                } else {
                    print("sendDefaultMessage() success.")

                    //Do something
                    _ = messageSendResult
                }
            }
        }
    }
}

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

1. 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.
2. 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.
3. 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.

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.

let templateId : Int64 = 12345

// Retrieve a list of friends.
TalkApi.shared.friends {(friends, error) in
    if let error = error {
        print(error)
    } else {
        print("friends() success.")
        guard let friends = friends else {
            print(error)
            return
        }

        //Implement a window to select friends.
        ...

        //uuids of the friends selected in the window.
        let friendUuids = selectedIds as! [String]

        // Send a Kakao Talk message.
        TalkApi.shared.sendCustomMessage(templateId:templateId, templateArgs:["title":"This is title.", "description":"This is description."], receiverUuids:friendUuids) { (messageSendResult, error) in
            if let error = error {
                print(error)
            } else {
                print("sendCustomMessage() success.")

                //Do something
                _ = messageSendResult
            }
        }
    }
}

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

1. 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.
2. Specify web page URL for scraping: When calling sendScrapMessage(), you must pass the URL of the web page to be scraped as the requestUrl parameter. The domain of the web page to be scraped must be registered in [App] > [Product Link] > [Web domain] on the app management page.
3. Apply custom template (optional): If you want to send a scrape message based on a message template defined by your service, you must pass the ID of the template configured in [Tools] > [Message Template] as the templateId parameter. For template configuration methods, see Custom template.
4. 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.

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.

let requestUrl = "https://developers.kakao.com"

// Retrieve a list of friends.
TalkApi.shared.friends {(friends, error) in
    if let error = error {
        print(error)
    } else {
        print("friends() success.")
        guard let friends = friends else {
            print(error)
            return
        }

        //Implement a window to select friends.
        ...

        //uuids of the friends selected in the window.
        let friendUuids = selectedIds as! [String]

        // Send a scrape message.
        TalkApi.shared.sendScrapMessage(requestUrl:requestUrl, receiverUuids:friendUuids) { (messageSendResult, error) in
            if let error = error {
                print(error)
            }
            else {
                print("sendScrapMessage() success.")
                //Do something
                _ = messageSendResult
            }
        }
    }
}

let requestUrl = "https://developers.kakao.com"
let templateId : Int64 = 12345

// Retrieve a list of friends.
TalkApi.shared.friends {(friends, error) in
    if let error = error {
        print(error)
    } else {
        print("friends() success.")
        guard let friends = friends else {
            print(error)
            return
        }

        //Implement a window to select friends.
        ...

        //uuids of the friends selected in the window.
        let friendUuids = selectedIds as! [String]

        // Send a Kakao Talk message.
        TalkApi.shared.sendScrapMessage(requestUrl:requestUrl, templateId:templateId, receiverUuids:friendUuids) { (messageSendResult, error) in
            if let error = error {
                print(error)
            }
            else {
                print("sendScrapMessage() success.")
                //Do something
                _ = messageSendResult
            }
        }
    }
}

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. Refer to Upload image.

• Message Template Builder