Friend Talk

Friend Talk is a service that enables corporate clients to send “information/advertisement” to KakaoTalk users. Unlike AlimTalk, it can only send messages to users who have been added as KakaoTalk friends. Friend Talk is sent using phone number information, but it is not sent to all registered phone numbers. Instead, it is sent only to users who have added the KakaoTalk channel.

Friend Talk API is as follows.

Note

• Before calling BizMessage API, you must call OAuth 2.0 API in advance.
• Please refer to the Sample Code document for API-specific codes.
• For detailed information on button guides and specifications by message type, please refer to the Appendix. Layout Guide and Message Specs.

Warning
As the staging server is linked to the Kakao operation server and actually sends messages, please be careful to avoid sending messages incorrectly.

Sending Friend Talk

This API is used to send Friend Talk and upload image.

Request

Request Syntax

코드예제Request Syntax of Sending Friend Talk

curl -X POST "https://{base_url}/v2/send/kakao" \
-H  "accept: */*" \
-H  "authorization: Bearer {oauthToken}" \
-H  "Content-Type: application/json" \
-d  '{
        "message_type": "FT",
        "sender_key": "{senderKey}",
        "cid": "202210181600001",
        "template_code": "TEMPLATE_001",
        "phone_number": "01012341234",
        "sender_no": "021112222",
        "message": "Alim Talk message",
        "fall_back_yn": false
    }'

Request Header

Request Elements

Response

Response Syntax

코드예제Response Syntax of Sending Friend Talk

{
  "code": "200",
  "uid": "",
  "cid": "",
  "result": {
    "detail_code": "NRM0000",
    "detail_message": "success"
  }
}

Response Elements

Note
Please refer to the Sample Code document for API-specific codes.

Uploading General Image to Friend Talk

This API is used to upload images before sending Friend Talk.

Request

Request Syntax

코드예제Request Syntax of Uploading General Image to Friend Talk

curl -X POST "http://{base_url}/v2/upload/ft/image" \
-H  "accept: */*" \
-H  "authorization: Bearer {oauthToken}" \
-H  "Content-Type: multipart/form-data" \
-F "image=@FT_IMAGE.png;type=image/png"

Request Header

Request Elements

Image Specification

Response

Response Syntax

코드예제Response Syntax of Uploading General Image to Friend Talk

{
  "code": "200",
  "image": "https://mud-kage.kakao.com/dn/vrLEd/btq6LeEmTgd/bQSvTliqYH3DPxk2PpwQ70",
  "result": {
    "detail_code": "NRM0000",
    "detail_message": "Success"
  }
}

Response Elements

Note
Please refer to the Sample Code document for API-specific codes.

Uploading Wide Image to Friend Talk

This API is used to upload wide images before sending Friend Talk.

Request

Request Syntax

코드예제Request Syntax of Uploading Wide Image to Friend Talk

curl -X POST "http://{base_url}/v2/upload/ft/wide/image" \
-H  "accept: */*" \
-H  "authorization: Bearer {oauthToken}" \
-H  "Content-Type: multipart/form-data" \
-F "image=@FT_IMAGE.png;type=image/png"

Request Header

Request Elements

Response

Response Syntax

코드예제Response Syntax of Uploading Wide Image to Freind Talk

{
  "code": "200",
  "image": "https://mud-kage.kakao.com/dn/vrLEd/btq6LeEmTgd/bQSvTliqYH3DPxk2PpwQ70",
  "result": {
    "detail_code": "NRM0000",
    "detail_message": "Success"
  }
}

Response Elements

Note
Please refer to the Sample Code document for API-specific codes.

Retrieving Delivery List of Friend Talk

The following API returns the delivery list of Friend Talk sent.

Note
The difference between GET and POST is whether they use Query or Body. (GET method is scheduled to be deprecated.)

Request

Request Syntax

코드예제Request Syntax of Retrieving Delivery List of Friend Talk

curl -X 'POST' \
  'https://{base_url}/v2/info/ft/search/detail/{uid}' \
  -H 'accept: */*' \
  -H 'Authorization: Bearer {oauthToken}' \
  -H 'Content-Type: application/json' \
  -d '{
    "start_date": "2022-10-18",
    "end_date": "2022-10-18",
    "size": 1000
  }'

Request Header

Request Elements

Response

Response Syntax

코드예제Response Syntax of Retrieving Delivery List of Friend Talk

{
  "status": "200",
  "code": "200",
  "message": "success",
  "count": 1,
  "next": true,
  "last_uid": "21018173501346cxU7zEswSYSsTmS",
  "results": [
    {
      "uid": "21018173501346cxU7zEswSYSsTmS",
      "reg_date": "2022-12-05T05:08:07.713Z",
      "status_code": "API_200",
      "error_message": "",
      "kko_status_code": "0000",
      "sms_status_code": "",
      "etc1": "",
      "etc2": "",
      "etc3": "",
      "etc4": "",
      "etc5": "",
      "etc6": "",
      "etc7": "",
      "etc8": "",
      "etc9": "",
      "etc10": "",
      "tax_cd1": "",
      "tax_cd2": "",
      "cid": "202212050508070001"
    }
  ]
}

Response Elements

Retrieving Detailed Delivery List of Friend Talk

This API is used to retrieve detailed result of Friend Talk sent.

Request

Request Syntax

코드예제Request Syntax of Retrieving Detailed Delivery List of Friend Talk

curl -X 'GET' \
  'https://{base_url}/v2/info/ft/search/detail/{uid}' \
  -H 'accept: */*' \
  -H 'Authorization: Bearer {oauthToken}'

Path Parameter

Request Header

Response

Response Syntax

코드예제Response Syntax of Retrieving Detailed Delivery List of Friend Talk

{
  "code": "200",
  "code_detail": {
    "detail_code": "NRM00000",
    "detail_message": "Success"
  },
  "result": {
    "uid": "221018173501346cxU7zEswSYSsTmS",
    "reg_date": "2022-10-18T17:35:01",
    "message_type": "FT",
    "status_code": "API_200",
    "phone_number": "01000000000",
    "req_date": "2022-10-18T17:35:01",
    "req_sms_yn": "N",
    "message": "DMA3lRw9gr/khDXYmAhGcuyHnQ5FOHmJAOuPgYCr8NM=",
    "cid": "202210189990001"
  }
}

Response Elements