> ## Documentation Index
> Fetch the complete documentation index at: https://docs.notifly.tech/llms.txt
> Use this file to discover all available pages before exploring further.

# Send Kakao AlimTalk

> Send Kakao AlimTalk messages using a template code and a list of recipients.

> [!WARNING]
>
> API send statistics are available on a separate page. Contact [contact@notifly.tech](mailto:contact@notifly.tech) for access.


## OpenAPI

````yaml /en/api-reference/openapi.yaml post /messages/kakao-alimtalk
openapi: 3.0.3
info:
  title: Notifly API
  version: 1.0.0
  contact:
    email: contact@notifly.tech
servers:
  - url: https://api.notifly.tech
    description: Notifly API server
security: []
tags:
  - name: catalog
    x-group: Catalogs
paths:
  /messages/kakao-alimtalk:
    post:
      summary: send-kakao-alimtalk
      operationId: sendKakaoAlimtalk
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - projectId
                - templateId
                - recipientList
              properties:
                projectId:
                  type: string
                  description: Available on the Notifly Settings page.
                templateId:
                  type: string
                  description: >-
                    Registered template ID. Find it in the AlimTalk template
                    list.
                channelId:
                  type: string
                  description: Kakao channel ID to send from.
                resendSendNo:
                  type: string
                  description: >-
                    Sender number for fallback text messages on the `Notifly
                    (Legacy)` KakaoTalk platform. Use a number configured for
                    Notifly's own SMS delivery.
                senderGroupingKey:
                  type: string
                  description: Key used to group sends. Up to 100 characters.
                recipientList:
                  type: array
                  items:
                    type: object
                    required:
                      - recipientNo
                    properties:
                      recipientNo:
                        type: string
                        description: Recipient phone number. Up to 15 characters.
                      templateParameter:
                        type: object
                        description: >-
                          Values to substitute into `#{variable}` in the
                          AlimTalk template, for example `{ "customer_name":
                          "홍길동" }` for `#{customer_name}`.
                      failoverTextMessageTemplateParameter:
                        type: object
                        description: >-
                          Variable values for the fallback text template on the
                          `Notifly` KakaoTalk platform. For example, if the
                          template contains `{{ event["coupon_name"] }}`, send
                          `{ "coupon_name": "8월 할인 쿠폰" }`.
                      resendParameter:
                        type: object
                        description: >-
                          Fallback send settings for the `Notifly (Legacy)`
                          KakaoTalk platform.
                        properties:
                          isResend:
                            type: boolean
                            description: >-
                              Whether to retry failed sends as text messages.
                              The default is `false`.
                          resendType:
                            type: string
                            enum:
                              - SMS
                              - LMS
                            description: >-
                              Fallback message type. Supply this when `isResend`
                              is `true`.
                          resendTitle:
                            type: string
                            description: >-
                              Title for a fallback LMS. The default is the Kakao
                              Plus Friend ID.
                          resendContent:
                            type: string
                            description: >-
                              Fallback message body. The default combines the
                              original message body, web link button label, and
                              mobile web link.
                  description: List of recipients. Up to 1,000 entries.
            examples:
              notiflyProfile:
                summary: Notifly KakaoTalk platform with template-based fallback SMS
                value:
                  projectId: example_project_1234567890abcdef
                  channelId: kakao-channel-id
                  templateId: template-id
                  recipientList:
                    - recipientNo: '01012345678'
                      templateParameter:
                        customer_name: 홍길동
                      failoverTextMessageTemplateParameter:
                        coupon_name: 8월 할인 쿠폰
              legacyProfile:
                summary: Notifly (Legacy) KakaoTalk platform with SMS fallback
                value:
                  projectId: example_project_1234567890abcdef
                  channelId: legacy-kakao-channel-id
                  templateId: legacy-template-code
                  recipientList:
                    - recipientNo: '01012345678'
                      templateParameter:
                        customer_name: 홍길동
                      resendParameter:
                        isResend: true
                        resendType: SMS
      responses:
        '200':
          description: The message was sent.
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
              example:
                success: true
        '400':
          description: The sender information is not registered.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: string
                    nullable: true
                  error:
                    type: string
              example:
                data: null
                error: Sender info is not registered.
        '500':
          description: Internal server error.
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                  error:
                    type: string
              examples:
                internal_error:
                  value:
                    success: false
                    error: Internal Server Error
                resend_sender_not_registered:
                  value:
                    success: false
                    error: >-
                      The sender information for resending text message has not
                      been registered. Please register it in the Notifly console
                      first.
      security:
        - bearerAuth: []
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: Pass the token issued by `POST /authenticate` as a bearer token.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.