About Alim Talk

Alim Talk is a service that enables corporate clients to send informative KakaoTalk messages to users, including those who have not connected as friends on KakaoTalk channels.

The messages that can be sent through Alimtalk are limited to certain informative messages that are deemed appropriate for the service from a user protection standpoint among the exceptions to advertising information according to the Korea Internet & Security Agency (KISA) guidelines related to the Information and Communication Network Act. This includes informational content such as order/reservation confirmation, payment details, and delivery status that are sent immediately according to the customer’s actions. Informational messages do not include newsletters for subscribers, congratulations on membership, announcements, and so on.

Sending spam messages through Alim Talk can result in the suspension of both Alim Talk and KakaoTalk channels, as well as fines. For more information on informational messages, please visit the KISA Illegal Spam Response Center. For a detailed explanation, please refer to the KISA Information and Communications Network Act Guidelines for Prevention of Illegal Spam (5th Edition).

Note

• Before calling every BizMessage API, you must call OAuth 2.0 API in advance.
• For detailed information on button guides and specifications by message type, please refer to the Appendix. Layout Guide and Message Specs.
• In order to send AlimTalk, you need to first register a template on the Kakao Biz Message site and have it inspected for approval.

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 Alim Talk Only

If you have signed a contract to send AlimTalk using the PUSH method, you can send AlimTalk using The following API and immediately check the result as a response.

Request

Request Syntax

코드예제Request Syntax of Sending Alim Talk Only

curl -X POST "https://{base_url}/v2/send/kakao" \
-H  "accept: */*" \
-H  "authorization: Bearer {access_token}" \
-H  "Content-Type: application/json" \
-d  '{
         "message_type": "AT",
         "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

If you have contracted to send Alim Talk using the Push method, please refer to the following sample code. If you have contracted for sending AlimTalk using the Polling method, however, you need to manually request the delivery result of AlimTalk and close the request upon completion. For more information, please refer to Retreiving Alim Talk Delivery Result(Polling).

Response Syntax

코드예제Response Syntax of Sending Alim Talk Only

{
  "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.

Retreiving Alim Talk Delivery Result(Polling)

If you send Alim Talk using the Polling method, you need to call The following API to check its delivery result.

Note
If you use the Polling method according to the contract or send SMS/LMS as an alternative message, you can get the message delivery results up to 1000 through this API.

• After using this API, be sure to call the Closing Alim Talk Delivery Result Retrieval Request(Polling) API to close the requests and not to retrieve the results.

Request

Request Syntax

코드예제Request Syntax of Retreiving Alim Talk Delivery Result(Polling)

curl -X 'GET' \
  'https://{base_url}/v2/info/message/results' \
  -H 'accept: */*' \
  -H 'Authorization: Bearer {oauthToken}'

Request Header

Response

Response Syntax

코드예제Response Syntax of Retreiving Alim Talk Delivery Result(Polling)

{
  "code": "200",
  "code_detail": {
    "detail_code": "NRM00000",
    "detail_message": "Success"
  },
  "report_group_no": "8493608862033069978",
  "results": [
    {
      "seq_no": 266931826,
      "client_id": "",
      "uid": "220918080309405KFXrvK8CR9e+k8s",
      "cid": "77613652af2d464580796c41cf0d39a3",
      "status_code": "API_200",
      "sms_status_code": "-100",
      "ended_yn": "Y",
      "ended_date": "2022-09-18T08:04:04",
      "message_type": "SM"
    }
  ]
}

Response Elements

Closing Alim Talk Delivery Result Retrieval Request (Polling)

This API is used to close the request of retrieving the delivery result of Alim Talk.

Request

Request Syntax

코드예제Request Syntax of Closing Alim Talk Delivery Result Retrieval Request(Polling)

curl -X 'PUT' \
  'https://{base_url}/v2/info/message/results/complete/{report_group_no}' \
  -H 'accept: */*' \
  -H 'Authorization: Bearer {oauthToken}'

Request Header

Response

Response Syntax

코드예제Response Syntax of Closing Alim Talk Delivery Result Retrieval Request(Polling)

{
  "code": "200",
  "code_detail": {
    "detail_code": "NRM00000",
    "detail_message": "Success"
  }
}

Response Elements

Retrieving Alim Talk Delivery List

The API for retrieving the Alim Talk Delivery list is as follows.

Request

Request Syntax

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

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

Path Parameter

Request Header

Request Elements

Response

Response Syntax

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

{
  "status": "200",
  "code": "200",
  "count": 4,
  "next": false,
  "code_detail": {
    "detail_code": "NRM00000",
    "detail_message": "success"
  },
  "results": [
    {
      "uid": "221018080314511j7usTgzgQDOXvIk",
      "reg_date": "2022-10-18T08:03:15",
      "status_code": "API_200",
      "kko_status_code": "0000",
      "cid": "11329b64174a4738b049e2a74e93c5c1"
    }
  ]
}

Response Elements

Retreiving Detailed Alim Talk Delivery List

This API is used to retrieve detailed delivery information of Alim Talk.

Request

Request Syntax

코드예제Request Syntax of Retreiving Detailed Alim Talk Delivery List

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

Request Header

Response

Response Syntax

코드예제Response Syntax of Retreiving Detailed Alim Talk Delivery List

{
  "code": "200",
  "code_detail": {
    "detail_code": "NRM00000",
    "detail_message": "success"
  },
  "result": {
    "uid": "221018080314511j7usTgzgQDOXvIk",
    "reg_date": "2022-10-18T08:03:15",
    "message_type": "AT",
    "status_code": "API_200",
    "phone_number": "01000000000",
    "template_code": "test_kep_template_005",
    "req_date": "2022-10-18T08:03:14",
    "req_sms_yn": "N",
    "kko_status_code": "0000",
    "message": "test message",
    "cid": "11329b64174a4738b049e2a74e93c5c1"
  }
}

Response Elements

Alim Talk Messaging Code

Please refer to Messaging Code of Alim Talk.