AlimTalk API Reference
  • PDF

AlimTalk API Reference

  • PDF

The latest service changes have not yet been reflected in this content. We will update the content as soon as possible. Please refer to the Korean version for information on the latest updates.

Basic info

API URL

https://sens.apigw.ntruss.com/alimtalk/v2

Go to SENS Alim Talk API Swagger

API Header

Item Mandatory Description
Content-Type Mandatory Specifies the request body content type as application/json (POST)
x-ncp-apigw-timestamp Mandatory This is the number of milliseconds that have elapsed since January 1, 1970 00:00:00 UTC.
If the time difference compared to the API Gateway server is more than 5 minutes, then the request is considered invalid.
x-ncp-iam-access-key Mandatory This is the access key ID issued by the portal or Sub Account
x-ncp-apigw-signature-v2 Mandatory This is the signature that encrypted the body of the example above as SecretKey, which is mapped with the access key ID
HmacSHA256 is used as the HMAC encryption algorithm

Go to Guide for how to generate NAVER Cloud Platform authentication key and signature


Message

Send message

This sends a message.

Request URL

POST https://sens.apigw.ntruss.com/alimtalk/v2/services/{serviceId}/messages

Content-Type: application/json; charset=utf-8
x-ncp-apigw-timestamp: {Timestamp}
x-ncp-iam-access-key: {Sub Account Access Key}
x-ncp-apigw-signature-v2: {API Gateway Signature}

Path Variables

Item Mandatory Type Description Note
serviceId Mandatory String Service ID Service ID issued when registering the project

Headers

Go to API header

Request body

{
    "plusFriendId":"string",
    "templateCode":"string",
    "messages":[
        {
            "countryCode":"string",
            "to":"string",
            "title":"string",
            "content":"string",
            "headerContent":"string",
            "itemHighlight":{
                "title":"string",
                "description":"string"
            },
            "item":{
                "list":[
                    {
                        "title":"string",
                        "description":"string"
                    }
                ],
                "summary":{
                    "title":"string",
                    "description":"string"
                }
            },
            "buttons":[
                {
                    "type":"string",
                    "name":"string",
                    "linkMobile":"string",
                    "linkPc":"string",
                    "schemeIos":"string",
                    "schemeAndroid":"string"
                }
            ],
            "useSmsFailover": "boolean",
            "failoverConfig": {
                "type": "string",
                "from": "string",
                "subject": "string",
                "content": "string"
            }
        }
    ],
    "reserveTime": "yyyy-MM-dd HH:mm",
    "reserveTimeZone": "string",
    "scheduleCode": "string"
}
Item Mandatory Type Description Remarks
plusFriendId Mandatory String Name of Kakao Talk Channel ((formerly) Plus Friend ID)
templateCode Mandatory String Template code
messages Mandatory Object Message information Refer to items below (messages.XXX)
Up to 100
messages.countryCode Optional String Recipient country code
messages.to Mandatory String Recipient number
messages.title Optional String Alim Talk highlighted content It can only be used in a highlighting type template.
messages.content Mandatory String Alim Talk message content
messages.headerContent Optional String Alim Talk header content It can only be used in an item list type template.
- Up to 16 characters in length can be entered.
messages.itemHighlight Optional Object Item highlight It can only be used in an item list type template.
messages.itemHighlight.title Mandatory String Item highlight title It can only be used in an item list type template.
When there's no image
- Up to 30 characters can be entered (2 lines).
- Up to 15 characters per line can be entered.
When there are images
- Up to 21 characters can be entered (2 lines).
- Up to 10 characters per line can be entered.
- If the length goes over 2 lines, then the excess is represented by an ellipsis.
messages.itemHighlight.description Mandatory String Item highlight description It can only be used in an item list type template.
When there's no image
- Up to 19 characters per line can be entered.
When there are images
- Up to 13 characters per line can be entered.
- If the length goes over one line, then the excess is represented by an ellipsis.
messages.item Optional Object Item list It can only be used in an item list type template.
messages.messages.item.list Mandatory Array of Object Item list It can only be used in an item list type template.
- It must be between 2 and 10.
messages.messages.item.list.title Mandatory String Item list title It can only be used in an item list type template.
- Up to 6 characters in length can be entered.
messages.messages.item.list.description Mandatory String Item list description It can only be used in an item list type template.
- Up to 23 characters in length can be entered.
messages.messages.summary Optional Object Item summary information It can only be used in an item list type template.
messages.messages.summary.title Mandatory String Item summary title It can only be used in an item list type template.
- Up to 6 characters in length can be entered.
messages.messages.summary.description Mandatory String Item summary description It can only be used in an item list type template.
- Allowed characters: currency symbols (unicode currency symbols, yuan, yen, won), currency codes (ISO 4217), number, commas, decimal points, spaces
- Up to two decimal places allowed
- Up to 23 characters in length can be entered.
messages.buttons Optional Array of Object Alim Talk message button Refer to the following template button information.
messages.buttons.type Mandatory String Button type Refer to the following template button information.
messages.buttons.name Mandatory String Button name Refer to the following template button information.
messages.useSmsFailover Optional Boolean SMS failover use status Available only on Kakao Talk Channels where failover is configured.
Default: Follows the failover settings of Kakao Talk Channel.
messages.failoverConfig Optional Object Failover settings Refer to the items below.
messages.failoverConfig.type Optional String Failover SMS message type SMS or LMS
Default: automatically applied according to the content length (SMS if 90 bytes or less, LMS if it exceeds 90 bytes)
messages.failoverConfig.from Optional String Failover SMS caller ID Default: caller ID selected when setting up failover
Failover does not work when using an unauthorized caller ID.
messages.failoverConfig.subject Optional String Failover SMS title Used when operating in LMS type
Default: Kakao Talk Channel name
messages.failoverConfig.content Optional String Failover SMS content Default: Alim Talk message content (excluding button)
reserveTime Optional String Reserved date and time Reserved date and time for message delivery (yyyy-MM-dd HH:mm)
reserveTimeZone Optional String Time zone of reserved date and time Time zone of reserved date and time (default: Asia/Seoul)
*List of supported time zones
* Use the TZ database name value
scheduleCode Optional String Schedule code Schedule code to be registered
Caution
  • The content and buttons must be entered according to the registered and approved template specifications.
  • If the message you want to send does not meet the template specifications, then your request to send the message will fail.
Note
  • If the template has images registered, then the registered images will be sent even if you don't insert it in the content in the request body when sending a message separately.
  • If reserveTime and scheduleCode are both requested, then it is processed as a reserved delivery. (Reserved delivery has a higher priority.)
  • SMS failover works if it is not successful based on Alim Talk reception result code.

You can check the Web Console Manual (formerly User's Guide) for a guide on template registration and approval. Go to Template Registration Guide

Template button information

Type Name Mandatory item
DS Track package
WL Web link linkMobile, linkPc (URL starting with http:// or https://)
AL App link schemeIos, schemeAndroid
BK Bot keyword
MD Send message
AC Add channel

List of supported couriers

Courier Courier name Invoice number
ePOST Korea Korea Post 13-digit number, or 6-digit number + 7-digit number
(separator is "-" or "_")
Logen Logen 11-digit number, or 3-digit number + 4-digit number + 4-digit number
(separator is "-" or "_")
ILYANG Logis - ILYANG Logis
- ILYANG
- ILYANG Logis
9 to 11-digit number
FedEX - FedEx
- FedEx
- fedex
12-digit number
HANJIN TRANSPORTATION HANJIN TRANSPORTATION 10-digit number or 12-digit number
KYOUNGDONG EXPRESS KYOUNGDONG EXPRESS 9 to 16-digit number, or 4-digit number + 3-digit number + 6-digit number
(separator is "-")
HAPDONG EXPRESS HAPDONG EXPRESS 9 to 16-digit number
LOTTE GLOBAL LOGISTICS - LOTTE GLOBAL LOGISTICS
- LOTTE LOGISTICS
- HYUNDAI EXPRESS
- Hyundai Logistics
12-digit number or 4-digit number + 4-digit number + 4-digit number
(separator is "-")
Nonghyup Logis Nonghyup Logis 12-digit number
HONAM LOGISTICS HONAM LOGISTICS 10-digit number
CHUNIL PARCEL CHUNIL PARCEL 11-digit number
DAESIN PARCEL SERVICES DAESIN PARCEL SERVICES 13-digit number
KUNYONG EXPRESS KUNYONG EXPRESS 10-digit number
CUpost - CUpost
- CU post
10-digit number, 12-digit number, or 4-digit number + 4-digit number + 4-digit number
(separator is "-" or "_")
CVSnet convenience store logistics - GS postbox
- GS convenience store logistics
- CVSnet convenience store logistics
10-digit number, 12-digit number, or 4-digit number + 4-digit number + 4-digit number
(separator is "-" or "_")
Handex Handex 10-digit number or 14-digit number
TNT Express - TNTExpress
- TNT Express
- TNT Express
8 to 9-digit number
USPS USPS 10-digit number, 22-digit number, or 2 uppercase English letters + 9-digit number + 2 uppercase English letters
(no separator)
EMS EMS 2 uppercase English letters + 9-digit number + 2 uppercase English letters
(no separator)
DHL DHL 10-digit number
GOODSTOLUCK GOODSTOLUCK 4-digit number + 4-digit number + 4-digit number
(separator is "-")
  • Buttons are not automatically added for unsupported couriers.
    • You can use web link (WL) buttons to link to the tracking page.

Response body

{
    "requestId":"string",
    "requestTime":"string",
    "statusCode":"string",
    "statusName":"string",
    "messages":[
        {
            "messageId":"string",
            "countryCode":"string",
            "to":"string",
            "content":"string",
            "requestStatusCode":"string",
            "requestStatusName":"string",
            "requestStatusDesc":"string",
            "useSmsFailover":"boolean"
        }
    ]
}
Item Mandatory Type Description Note
requestId Mandatory String Delivery request ID
requestTime Mandatory DateTime Delivery request time
statusCode Mandatory String Request status code 202 - Success
Others - Fail
* Follows the HTTP status specification
statusName Mandatory String Request status name success - Success
processing - Being processed
reserved - Being reserved
scheduled - Being scheduled
fail - Fail
messages.messageId Mandatory String Message ID
messages.countryCode Optional String Recipient's country code
messages.to Mandatory String Recipient's number
messages.content Mandatory String Alim Talk message content
messages.requestStatusCode Mandatory String Delivery request status code A000 - Success
Other cods - Fail (reason for failure specified in the Desc category)
messages.requestStatusName Mandatory String Delivery request status name success - Success
fail - Fail
messages.requestStatusDesc Mandatory String Delivery request status content
messages.useSmsFailover Mandatory Boolean SMS Failover use status

Response statuses

HTTP Status Desc
202 Accepted (Successfully requested)
400 Bad Request
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Search message delivery request

This searches the message delivery requests.

Request URL

GET https://sens.apigw.ntruss.com/alimtalk/v2/services/{serviceId}/messages?requestId=

x-ncp-apigw-timestamp: {Timestamp}
x-ncp-iam-access-key: {Sub Account Access Key}
x-ncp-apigw-signature-v2: {API Gateway Signature}

Path Variables

Item Mandatory Type Description Note
serviceId Mandatory String Service ID Service ID issued when registering the project

Parameters

Item Mandatory Type Description Note
requestId Mandatory String Request ID Delivery request ID

Headers

Go to API header

Request body

None

Response body

{
    "requestId":"string",
    "statusCode":"string",
    "statusName":"string",
    "messages":[
        {
            "requestTime":"string",
            "messageId":"string",
            "countryCode":"string",
            "to":"string",
            "content":"string",
            "plusFriendId":"string",
            "templateCode":"string",
            "completeTime":"string",
            "requestStatusCode":"string",
            "requestStatusName":"string",
            "requestStatusDesc":"string",
            "messageStatusCode":"string",
            "messageStatusName":"string",
            "messageStatusDesc":"string",
            "useSmsFailover":"boolean",
            "failover": {
                "smsServiceId":"string",
                "requestId":"string",
                "requestStatusCode":"string",
                "requestStatusName":"string",
                "requestStatusDesc":"string"
            }
        }
    ]
}
Item Mandatory Type Description Note
requestId Mandatory String Delivery request ID
statusCode Mandatory String Request status code 202 - Success
Others - Fail
* Follows the HTTP status specification
statusName Mandatory String Request status name success - Success
processing - in delivery
reserved - Being reserved
scheduled - Being scheduled
fail - Fail
messages.requestTime Mandatory DateTime Delivery request time
messages.messageId Mandatory String Message ID
messages.countryCode Optional String Recipient's country code
messages.to Mandatory String Recipient's number
messages.content Mandatory String Alim Talk message content
messages.plusFriendId Mandatory String Name of Kakao Talk Channel ((formerly) Plus Friend ID)
messages.templateCode Mandatory String Template code
messages.completeTime Optional DateTime Delivery reporting (processing completion) time
messages.requestStatusCode Mandatory String Delivery request status code A000 - Success
Other cods - Fail (reason for failure specified in the Desc category)
messages.requestStatusName Mandatory String Delivery request status name success - Success
fail - Fail
messages.requestStatusDesc Mandatory String Delivery request status content
messages.messageStatusCode Mandatory String Delivery result status code 0000 - Success
Other cods - Fail (reason for failure specified in the Desc category)
messages.messageStatusName Mandatory String Delivery result status name success - Success
processing - Being processed
    * Undergoing processing in the message delivery server after successful sending request
    * messageCode and messageDesc are not searched.
fail - Fail
messages.messageStatusDesc Mandatory String Delivery result status description
messages.useSmsFailover Mandatory Boolean SMS Failover use status
messages.failover Optional Object SMS Failover
messages.failover.smsServiceId Optional String SMS Failover service ID
messages.failover.requestId Optional String SMS Failover delivery request ID
messages.failover.requestStatusCode Optional String SMS Failover delivery request status code 202 - Success
Others - Fail
* Follows the HTTP status specification
messages.failover.requestStatusName Optional String SMS Failover delivery request status name success - Success
fail - Fail
messages.failover.requestStatusDesc Optional String SMS Failover delivery request status content

Response statuses

HTTP Status Desc
200 OK (Successfully searched)
400 Bad Request
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Search message delivery results

This searches the message delivery results.

Request URL

GET https://sens.apigw.ntruss.com/alimtalk/v2/services/{serviceId}/messages/{messageId}

x-ncp-apigw-timestamp: {Timestamp}
x-ncp-iam-access-key: {Sub Account Access Key}
x-ncp-apigw-signature-v2: {API Gateway Signature}

Path Variables

Item Mandatory Type Description Note
serviceId Mandatory String Service ID Service ID issued when registering the project
messageId Mandatory String Message ID Message identifier that is returned when the message is sent

Headers

Go to API header

Request body

None

Response body

{
    "messageId":"string",
    "requestId":"string",
    "requestTime":"string",
    "completeTime":"string",
    "plusFriendId":"string",
    "templateCode":"string",
    "countryCode":"string",
    "to":"string",
    "content":"string",
    "requestStatusCode":"string",
    "requestStatusName":"string",
    "requestStatusDesc":"string",
    "messageStatusCode":"string",
    "messageStatusName":"string",
    "messageStatusDesc":"string",
    "useSmsFailover":"boolean",
    "failover": {
        "smsServiceId":"string",
        "requestId":"string",
        "requestStatusCode":"string",
        "requestStatusName":"string",
        "requestStatusDesc":"string",
        "messageId":"string",
        "messageStatus":"string",
        "messageStatusCode":"string",
        "messageStatusName":"string",
        "messageStatusDesc":"string"
    }
}
Item Mandatory Type Description Note
messageId Mandatory String Message ID
requestId Mandatory String Delivery request ID
requestTime Mandatory DateTime Delivery request time
completeTime Optional DateTime Delivery reporting (processing completion) time
plusFriendId Mandatory String Name of Kakao Talk Channel ((formerly) Plus Friend ID)
templateCode Mandatory String Template code
countryCode Optional String Recipient's country code
to Mandatory String Recipient's number
content Mandatory String Alim Talk message content
requestStatusCode Mandatory String Delivery request status code A000 - Success
Other cods - Fail (reason for failure specified in the Desc category)
requestStatusName Mandatory String Delivery request status name success - Success
fail - Fail
requestStatusDesc Mandatory String Delivery request status content
messageStatusCode Mandatory String Delivery result status code 0000 - Success
Other cods - Fail (reason for failure specified in the Desc category)
messageStatusName Mandatory String Delivery result status name success - Success
processing - Being processed
*
Undergoing processing in the message delivery server after successful sending request
* messageCode and messageDesc are not searched.
fail - Fail
messageStatusDesc Mandatory String Delivery result status description
messages.useSmsFailover Mandatory Boolean SMS Failover use status
messages.failover Optional Object SMS Failover use status
messages.failover.smsServiceId Optional String SMS Failover service ID
messages.failover.requestId Optional String SMS Failover delivery request ID
messages.failover.requestStatusCode Optional String SMS Failover delivery request status code 202 - Success
Others - Fail
* Follows the HTTP status specification
messages.failover.requestStatusName Optional String SMS Failover delivery request status name success - Success
fail - Fail
messages.failover.requestStatusDesc Optional String SMS Failover delivery request status content
messages.failover.messageId Optional String SMS Failover delivery message ID
messages.failover.messageStatus Optional String SMS Failover delivery request status READY: Ready
PROCESSING: Being processed
COMPLETED: Processing completed
messages.failover.messageStatusCode Optional String SMS Failover delivery device received status result code See Error Code table
messages.failover.messageStatusName Optional String SMS Failover delivery device received result name
messages.failover.messageStatusDesc Optional String SMS Failover delivery device received content

Failover request status code

requestStatusCode Desc
0 Success
E4000 The failover settings are not valid.
E4001 The failover settings information is omitted.
E4002 The failover SMS service is not configured.
E4003 The failover SMS type (SMS, LMS) is not configured.
E4004 The failover SMS caller ID is not configured.
E4005 The failover SMS title is not configured.
E4006 The failover SMS content is not configured.
E4007 The failover SMS recipient number is not configured.
E4008 The failover SMS service is not available.
E4009 The failover SMS caller ID is not authenticated.
E4010 The failover SMS free 080 unsubscribing service is not available.
E4999 Failover settings parsing error (required to contact Support)
E5000 Internal error (required to contact Support)

Response statuses

HTTP Status Desc
200 OK (Successfully searched)
400 Bad Request
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Reserved message

Search reserved message status

This searches the Reservation status of message delivery.

GET https://sens.apigw.ntruss.com/alimtalk/v2/services/{serviceId}/reservations/{reserveId}/reserve-status

x-ncp-apigw-timestamp: {Timestamp}
x-ncp-iam-access-key: {Sub Account Access Key}
x-ncp-apigw-signature-v2: {API Gateway Signature}

Path Variables

Item Mandatory Type Description Note
serviceId Mandatory String Service ID Service ID issued when registering the project
reserveId Mandatory String Reserved message ID Message identifier that is returned when searching the reserved delivery requests (requestId)

Headers

Go to API header

Request body

None

Response body

{
  "reserveId": "string",
  "reserveTimeZone": "string",
  "reserveTime": "string",
  "reserveStatus": "string"
}
Item Mandatory Type Description Note
reserveId Mandatory String Reserved message ID Message identifier that is returned when searching the reserved delivery requests (requestId)
reserveTime Mandatory String Reserved date and time Reserved date and time for message delivery (yyyy-MM-dd HH:mm)
reserveTimeZone Mandatory String Time zone of reserved date and time Time zone of reserved time and date (Default: Asia/Seoul)
* List of supported time zones
* Use the TZ database name value
reserveStatus Mandatory String Reservation status READY - Waiting to be sent
PROCESSING - Requesting to send
CANCELED - Delivery canceled
FAIL - Delivery request failure
DONE - Successful delivery request
STALE - Delivery request failure (timeout)

Cancel reserved message

This cancels the reserved message delivery.

DELETE https://sens.apigw.ntruss.com/alimtalk/v2/services/{serviceId}/reservations/{reserveId}

x-ncp-apigw-timestamp: {Timestamp}
x-ncp-iam-access-key: {Sub Account Access Key}
x-ncp-apigw-signature-v2: {API Gateway Signature}

Path Variables

Item Mandatory Type Description Note
serviceId Mandatory String Service ID Service ID issued when registering the project
reserveId Mandatory String Reserved message ID Message identifier that is returned when searching the reserved delivery requests (requestId)

Headers

Go to API header

Request body

None

Response body

None

Response statuses

HTTP Status Desc
204 No Content (Successfully deleted)
400 Bad Request
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Scheduled message

Cancel schedule message

Cancel the message sending schedule.

DELETE https://sens.apigw.ntruss.com/alimtalk/v2/services/{serviceId}/schedules/{scheduleCode}/messages/{messageId}

x-ncp-apigw-timestamp: {Timestamp}
x-ncp-iam-access-key: {Sub Account Access Key}
x-ncp-apigw-signature-v2: {API Gateway Signature}

Path Variables

Item Mandatory Type Description Remarks
serviceId Mandatory String Service ID Service ID issued when registering a project
scheduleCode Mandatory String schedule code Code used to register schedule
messageId Mandatory String Reservation Message ID Message identifier (requestId) returned when querying a request for sending a schedule

Headers

Shortcut to API Header

Request Body

none

Response Body

none

Response Status

HTTP Status Desc
204 No Content (deleted)
400 Bad Request
401 Unauthorized
403 Forbidden
404 Not Found
500 Internal Server Error

Kakao Talk Channel

Search channel

Searches Kakao Talk Channels.

GET https://sens.apigw.ntruss.com/alimtalk/v2/services/{serviceId}/channels

x-ncp-apigw-timestamp: {Timestamp}
x-ncp-iam-access-key: {Sub Account Access Key}
x-ncp-apigw-signature-v2: {API Gateway Signature}

Path Variables

Item Mandatory Type Description Note
serviceId Mandatory String Service ID Service ID issued when registering the project

Parameters

Item Mandatory Type Description Remarks
pageSize Optional Integer Page size Default: 100 (Only numbers between 1 and 100 can be entered.)
pageIndex Optional Integer Page index Default: 0

Headers

Go to API header

Request body

None

Response body

[
    {
        "createTime": "string",
        "updateTime": "string",
        "serviceId": "string",
        "channelId": "string",
        "channelName": "string",
        "channelStatus": "string",
        "useSmsFailover": "boolean"
    }
]
Item Mandatory Type Description Note
createTime Mandatory String Creation time format: LocalDateTime
updateTime Optional String Editing time format: LocalDateTime
serviceId Mandatory String Service ID Service ID issued when registering the project
channelId Mandatory String Kakao Talk channel ID
channelName Mandatory String Kakao Talk channel name
channelStatus Mandatory String Kakao Talk channel status ACTIVE - Normal
DELETED - Delete
DELETING_PERMANENTLY - Deleting permanently
PERMANENTLY_DELETED - Permanently deleted
BLOCKED - Blocked
PENDING_DELETE - Pending delete
useSmsFailover Mandatory Boolean Use status of alternative SMS delivery

Response statuses

HTTP Status Desc
200 OK
400 Bad Request
401 Unauthorized
403 Forbidden
404 Not Found
429 Too Many Requests
500 Internal Server Error

Alim Talk Template

Search template

This searches the Alim Talk template registered in the Kakao Talk channel.

GET https://sens.apigw.ntruss.com/alimtalk/v2/services/{serviceId}/templates?channelId=

x-ncp-apigw-timestamp: {Timestamp}
x-ncp-iam-access-key: {Sub Account Access Key}
x-ncp-apigw-signature-v2: {API Gateway Signature}

Path Variables

Item Mandatory Type Description Note
serviceId Mandatory String Service ID Service ID issued when registering the project

Parameters

  • channelId is a required value, and it returns the detailed information of the template when using templateCode.
  • Additional information including comments is only displayed for detailed searches.
Item Mandatory Type Description Remarks
channelId Mandatory String Channel ID Channel ID registered to Kakao Talk
templateCode Mandatory String Template code The detailed search is returned when searched using templateCode
Registered template code
templateName Optional String Template name like search results are returned.
pageSize Optional Integer Page size Default: 100 (Only numbers between 1 and 100 can be entered.)
pageIndex Optional Integer Page index Default: 0

Headers

Go to API header

Request body

None

Response body

[
    {
        "createTime": "string",
        "updateTime": "string",
        "channelId": "string",
        "templateCode": "string",
        "templateName": "string",
        "content": "string",
        "comments": [
            {
                "commentId": "string",
                "content": "string",
                "status": "string",
                "createTime": "string"
            }
        ],
        "templateInspectionStatus": "string",
        "templateStatus": "string",
        "buttons":[
                {
                    "order":"integer",
                    "type":"string",
                    "name":"string",
                    "linkMobile":"string",
                    "linkPc":"string",
                    "schemeIos":"string",
                    "schemeAndroid":"string"
                }
            ]
    }
]
Item Mandatory Type Description Note
createTime Mandatory String Create Time format: LocalDateTime
updateTime Optional String Update Time format: LocalDateTime
channelId Mandatory String KakaoTalk Channel ID
templateCode Mandatory String Template Code
templateName Mandatory String Template Name
content Mandatory String Content of Template
comments.commentId Mandatory String Inspection Comment ID
comments.content Mandatory String Inspection Comment Content
comments.status Mandatory String Inspection Status APR - Approve
REJ - Reject
comments.create Mandatory String Inspection Time
templateInspectionStatus Mandatory String Template Inspection Status ACCEPT
REGISTER
INSPECT
COMPLETE
REJECT
templateStatus Mandatory String Template Status ACTIVE
READY
STOP
buttons Optional Array of Object AlimTalk Message Buttons See top template button information
buttons.order Mandatory Integer Order of button Button registration order
buttons.type Mandatory String Button Type See top template button information
buttons.name Mandatory String Button Name See top template button information
buttons.linkMobile Optional String Button mobile link Refer to the registered template button information
buttons.linkPc Optional String Button pc link Refer to the registered template button information
buttons.schemeIos Optional String Button ios scheme Refer to the registered template button information
buttons.schemeAndroid Optional String Button adnroid scheme Refer to the registered template button information
Note
  • channelId is a required value, and it returns the detailed information of the template when using templateCode.
  • Additional information including comments is only displayed for detailed searches.

Response Status

HTTP Status Desc
200 OK
400 Bad Request
401 Unauthorized
403 Forbidden
404 Not Found
429 Too Many Requests
500 Internal Server Error

Error codes

Alim Talk reception result code

Status Error text Desc
0000 - Normal delivery
1001 NoJsonBody Request body is not in JSON format.
1002 InvalidHubPartnerKey Invalid partner key
1003 InvalidSenderKey Invalid outgoing profile key
1004 NoValueJsonElement Name not found in request body (JSON)
1005 SenderNotFound Outgoing profile not found
1006 DeletedSender Deleted outgoing profile
1007 StoppedSender Blocked outgoing profile
1011 ContractNotFound Contract information not found
1012 InvalidUserKeyException Invalid format of user key request
1013 InvalidAppLink Invalid app connection
1014 InvalidBizNum Invalid business registration number
1015 TalkUserIdNotFonud Invalid app user id request
1016 BizNumNotEqual Mismatched business registration number
1020 InvalidReceiveUserException No valid user identifier value
1021 BlockedProfile Blocked Kakao Talk Channel (check from the Kakao Talk Channel operation tool)
1022 DeactivatedProfile Closed Kakao Talk Channel (check from the Kakao Talk Channel operation tool)
1023 DeletedProfile Deleted Kakao Talk Channel (check from the Kakao Talk Channel operation tool)
1024 DeletingProfile Deletion-pending Kakao Talk Channel (check from the Kakao Talk Channel operation tool)
1025 SpammedProfile Message-blocked Kakao Talk Channel (check from the Kakao Talk Channel operation tool)
1026 UnableUseMessageType The request was made with response_method unavailable for the msg_type. (image Alim Talk (AI) can't be sent in real time)
1030 InvalidParameterException Invalid parameter request
1033 - Template type and message type mismatch
2003 FailedToSendMessageByNoFriendshipException Message delivery failure (if Kakao Talk Channel is not added in the test server)
2004 FailedToMatchTemplateException Error when checking template match (internal Kakao error)
2006 FailedToMatchSerialNumberPrefixPattern Serial number format mismatch
3000 UnexceptedExcetpion Occurrence of an unexpected error
3005 AckTimeoutException A message was sent, but the read receipt was not confirmed (success uncertain).
3006 FailedToSendMessageException Message delivery failed due to Kakao's internal system error.
3008 InvalidPhoneNumberException Phone number error
3010 JsonParsseExcetpion JSON parsing error
3011 MessageNotFoundException Message does not exist.
3012 SerialNumberDuplicatedException Message serial number is duplicated. (A unique value must be assigned for the message serial number.)
3013 MessageEmptyException Blank message
3014 MessageLengthOverLimitException Message length limit error (exceeding 1,000 characters for text type, 400 characters for image type)
3015 TemplateNotFoundException Template not found
3016 NoMatchedTemplateException Message content does not match the template.
3018 NoSendAvailableException Message could not be sent.
3020 SeenInfoNotFoundException Message verification information not found
3022 NoSendAvailableTimeException Outside the time available for sending messages (Friend Talk/marketing messages can be sent from 08:00 to 20:00.)
3024 MessageInvaildImageException The image contained in the message can't be sent.
3025 ExceedMaxVariableLengthException Variable character limit exceeded
3026 Button chat_extra(event)-InvalidExtra(EventName)Exception '([A-Za-z0-9_]{1,50})' Inquiry/bot switching button extra, event character limit exceeded
3027 NoMatchedTemplateButtonException Button content does not match the template.
3028 NoMatchedTemplateTitleException Message highlighting title does not match the template.
3029 ExceedMaxTitleLengthException Message highlighting title length limit exceeded (50 characters)
3031 - Text type mismatch
3030 NoMatchedTemplateWithMessageTypeException Message type does not match the template highlight type.
3031 NoMatchedTemplateHeaderException Header does not match the template.
3032 ExceedMaxHeaderLengthException Header length limit exceeded (16 characters)
3033 NoMatchedTemplateItemHighlightException Item highlight does not match the template.
3034 ExceedMaxItemHighlightTitleLengthException Item highlight title length limit exceeded (30 characters with no images, 21 characters with images)
3035 ExceedMaxItemHighlightDescriptionLengthException Item highlight description length limit exceeded (19 characters with no images, 14 characters with images)
3036 NoMatchedTemplateItemListException Item list does not match the template.
3037 ExceedMaxItemDescriptionLengthException Item's description length limit exceeded in the item list (23 characters)
3038 NoMatchedTemplateItemSummaryException Item summary information does not match the template.
3039 ExceedMaxItemSummaryDescriptionLengthException Item summary information's description length limit exceeded (14 characters)
3040 InvalidItemSummaryDescriptionException Item summary information's description includes characters that are not allowed (inclusion of characters other than currency symbol/code, number, comma, period, and space).
4000 ResponseHistoryNotFoundException Message delivery result not found
4001 UnKnownMessageStatusError Unknown message status
7011 - Serial number pattern error
7014 - Message validity timeout error
8512 - Recipient type not found
8514 - request_id not found
8520 - Product type not supported error
8521 - Message type not supported error
8522 - Test type not supported error
8523 - Response method not supported error
8530 - Recipient list size error
8999 - Internal server error
9998 The service is not currently provided. The admin is checking a problem that occurred in the system.
9999 The admin is checking an unknown problem that occurred in the system. The admin is checking a problem that occurred in the system.

Was this article helpful?

What's Next
Changing your password will log you out immediately. Use the new password to log back in.
First name must have atleast 2 characters. Numbers and special characters are not allowed.
Last name must have atleast 1 characters. Numbers and special characters are not allowed.
Enter a valid email
Enter a valid password
Your profile has been successfully updated.