Get message delivery list

Prev Next

Available in Classic and VPC

Get the message delivery request list of Alim Talk. You can query the list of requests within the last 30 days.

Request

This section describes the request format. The method and URI are as follows:

Method URI
GET /alimtalk/v2/services/{serviceId}/messages

Request headers

For information about the headers common to all Simple & Easy Notification Service APIs, see Simple & Easy Notification Service request headers.

Request path parameters

You can use the following path parameters with your request:

Field Type Required Description
serviceId String Required Biz Message service ID

Request query parameters

You can use the following query parameters with your request:

Field Type Required Description
requestId String Conditional Request ID
  • Enter the request ID received in response when sending the message.
  • One among requestId, requestStartTime+requestEndTime, or completeStartTime+completeEndTime must be entered.
  • requestStartTime+requestEndTime and completeStartTime+completeEndTime can't be used at the same time.
plusFriendId String Required Channel ID
requestStartTime String Conditional Query start date and time based on the delivery request
  • YYYY-MM-DD HH:mm:ss format (URL encoding required).
  • One among requestId, requestStartTime+requestEndTime, or completeStartTime+completeEndTime must be entered.
  • requestStartTime+requestEndTime and completeStartTime+completeEndTime can't be used at the same time.
requestEndTime String Conditional Query end date and time based on the delivery request
  • YYYY-MM-DD HH:mm:ss format (URL encoding required).
  • Must be within 31 days of requestStartTime.
completeStartTime String Conditional Query start date and time based on the delivery completion
  • YYYY-MM-DD HH:mm:ss format (URL encoding required).
  • One among requestId, requestStartTime+requestEndTime, or completeStartTime+completeEndTime must be entered.
  • requestStartTime+requestEndTime and completeStartTime+completeEndTime can't be used at the same time.
completeEndTime String Conditional Query end date and time based on the delivery completion
  • YYYY-MM-DD HH:mm:ss format (URL encoding required).
  • Must be within 24 hours of completeStartTime.
messageId String Optional Message ID
requestStatusName String Optional Request status
  • success | fail
    • success: Success
    • fail: Failure
messageStatusName String Optional Reception status
  • success | processing | fail
    • success: Success
    • processing: Processing
    • fail: Failure
templateCode String Optional Template code
to String Optional Recipient number
  • Only numbers can be entered.
nextToken String Optional Page location token
  • Use this when querying the next list, and enter the token value received in the previous call.
pageSize Integer Optional Number of items per page
  • 1-100 (default: 20)
  • 100 is applied by default when entering requestId.

Request example

The request example is as follows:

curl --location --request GET 'https://sens.apigw.ntruss.com/alimtalk/v2/services/ncp:kkobizmsg:kr:27*********6:sens/messages' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'

Response

This section describes the response format.

Response body

The response body includes the following data:

Field Type Required Description
requestId String - Request ID
  • Display if the request includes requestId.
statusCode String - Status code
  • It follows HTTP status code rules.
    • 202: Success
    • Others: Failure
statusName String - Status
  • success | processing | reserved | fail
    • success: Success
    • processing: Processing
    • reserved: Reserved
    • fail: Failure
messages Array - Message delivery request list: messages
pageSize Integer - Number of items per page
pageIndex Integer - Page index
nextToken String - Page location token
  • It isn't displayed if there is no next page.
itemCount Integer - Number of response results
hasMore Boolean - Whether next page exists
  • true: It exists.
  • false: It doesn't exist.

messages

The following describes messages.

Field Type Required Description
requestTime String - Request date and time
  • YYYY-MM-DDTHH:mm:ss.sss format
requestId String - Request ID
messageId String - Message ID
countryCode String - Country code
to String - Recipient number
content String - Message content
plusFriendId String - Channel ID
templateCode String - Template code
completeTime String - Completion date and time
  • YYYY-MM-DDTHH:mm:ss format
requestStatusCode String - Request status code
  • A000: Success
  • Others: Failure
requestStatusName String - Request status
  • success | fail
    • success: Success
    • fail: Failure
requestStatusDesc String - Request status description
messageStatusCode String - Reception status code
  • 0000: Success
  • Others: Failure
messageStatusName String - Reception status
  • success | processing | fail
    • success: Success
    • processing: Processing. messageStatusCode and messageStatusDesc are not displayed.
    • fail: Failure
messageStatusDesc String - Reception status description
useSmsFailover Boolean - Use of SMS alternative delivery
  • true | false
    • true: Enable
    • false: Disable
failover Object - SMS alternative delivery information
  • Display if alternative delivery has been executed.
failover.smsServiceId String - SMS service ID used for alternative delivery
failover.requestId String - Alternative delivery request ID
failover.messageId String - Alternative delivery message ID
failover.requestStatusCode String - SMS alternative delivery request status code
failover.requestStatusName String - Alternative delivery request status
  • success | fail
    • success: Success
    • fail: Failure
failover.requestStatusDesc String - Alternative delivery request status description
failover.messageStatus String - Alternative delivery message status
  • READY | PROCESSING | COMPLETED
    • READY: Standby
    • PROCESSING: Processing
    • COMPLETED: Completed
failover.messageStatusCode String - Alternative delivery message reception status code
failover.messageStatusName String - Alternative delivery message reception status
failover.messageStatusDesc String - Alternative delivery message reception status description

Response status codes

For information about the HTTP status codes common to all Simple & Easy Notification Service APIs, see Simple & Easy Notification Service response status codes.

Response example

The response example is as follows:

{
    "statusCode": "202",
    "statusName": "success",
    "messages": [
        {
            "requestTime": "2025-11-25T15:39:20.899",
            "requestId": "RBAA-*************-****-********-zgrtzVEW",
            "messageId": "aa724ca6-****-****-****-66dfc1a700e7",
            "countryCode": "82",
            "to": "010********",
            "content": "Dear Gildong Hong,\nThe translation document [PO394857] you requested will be sent via email today at 6:00 PM KST.\n\nWe will send you a notification after the email is sent.\nThank you.",
            "plusFriendId": "@******",
            "templateCode": "temp001",
            "completeTime": "2025-11-25T15:39:21",
            "requestStatusCode": "A000",
            "requestStatusName": "success",
            "requestStatusDesc": "Succeeded",
            "messageStatusCode": "0000",
            "messageStatusName": "success",
            "messageStatusDesc": "Normal delivery",
            "useSmsFailover": true
        },
        {
            "requestTime": "2025-11-25T11:59:35.611",
            "requestId": "RBAA-*************-****-********-ERsezZLD",
            "messageId": "0a7e05bf-****-****-****-cfb51e38fe36",
            "countryCode": "82",
            "to": "010********",
            "content": "Dear Cheongi Shim,\nThe 35th anniversary celebration translation document you requested will be sent via email today at 2:00 PM KST.\n\nWe will send you a notification after the email is sent.\nThank you.",
            "plusFriendId": "@******",
            "templateCode": "temp001",
            "completeTime": "2025-11-25T11:59:36",
            "requestStatusCode": "A000",
            "requestStatusName": "success",
            "requestStatusDesc": "Succeeded",
            "messageStatusCode": "3016",
            "messageStatusName": "fail",
            "messageStatusDesc": "Message content does not match the template.",
            "useSmsFailover": true,
            "failover": {
                "smsServiceId": "ncp:sms:kr:27*********6:sens",
                "requestId": "RSLA-*************-****-********-ZzdhBYsk",
                "messageId": "6cc7eab4-****-****-****-c523f8a0e8ce",
                "requestStatusCode": "0",
                "requestStatusName": "success",
                "requestStatusDesc": "Succeeded",
                "messageStatus": "COMPLETED",
                "messageStatusCode": "0",
                "messageStatusName": "success",
                "messageStatusDesc": "Succeeded"
            }
        }
    ],
    "pageSize": 2,
    "pageIndex": 0,
    "nextToken": "eyJwYXJhbWV0ZXJIYXNoIjoiN...LWNmYjUxZTM4ZmUzNiJ9",
    "itemCount": 2,
    "hasMore": true
}
Business Registration Number: 129-86-31394 E-commerce Permit Number:No. 2009-GyeonggiSeongnam-0510
CEO: Kim Yuwon Address: NAVER Green Factory 17th–26th Floors, Buljeong-ro 6, Bundang-gu, Seongnam-si, Gyeonggi-do 13561, Republic of Korea. Customer Support Number: 1544-5876
© NAVER Cloud Corp. All Rights Reserved.