Delete message

Prev Next

Available in Classic and VPC

Delete a message.

Request

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

Method URI
DELETE /v1/api/messages/{channelId}/{messageId}

Request headers

For information about the headers common to all Ncloud Chat APIs, see Ncloud Chat request headers.

Request path parameters

You can use the following path parameters with your request:

Field Type Required Description
channelId String Required Channel ID
messageId String Required Message ID

Request example

The request example is as follows:

curl --location --request DELETE 'https://dashboard-api.ncloudchat.naverncp.com/v1/api/messages/4073efd6-****-****-****-cc4550fed7b7/6836b0**********0e3838a2' \
--header 'x-api-key: {API Key}' \
--header 'x-project-id: {Project ID}'

Response

This section describes the response format.

Response body

The response body includes the following data:

Field Type Required Description
message Object - Message information
message.id String - Message ID
message.message_id String - Message ID
message.channel_id String - Channel ID
message.sort_id String - Delivery date and time
  • Unix timestamp format
message.message_type String - Message type
  • text | file
message.sender Object - Sender information
message.sender.id String - Sender ID
message.sender.name String - Sender name
message.sender.profile String - Sender profile image
message.admin Object - Admin information
message.admin.id String - Admin ID
message.admin.name String - Admin name
message.admin.profile String - Admin profile image
message.attachment_filenames Object - Attachment information
message.attachment_filenames.name String - Attachment name
message.attachment_filenames.size Number - Attachment size (byte)
message.attachment_filenames.type String - Attachment type
message.attachment_filenames.url String - Attachment URL
message.has String - Attachment special item classification (default: "")
  • Example: link, image, video, file
message.embed_providers String - Provider of attachment embed special item
message.embed_type String - Type of embed special item (default "")
message.isExpress Boolean - Express message status
  • true | false (default)
    • true: Express message
    • false: General message
message.link_hostnames String - Link host name
  • If message.has is link
message.mentions Array - Mention information (default: [])
message.mentions_everyone Boolean - Whether to mention all
  • true | false (default)
    • true: All
    • false: Not all
message.content String - Message content
message.sended_at String - Message delivery date and time
  • ISO 8601 format
message.created_at String - Message creation date and time
  • ISO 8601 format
status Integer - Response status
  • 1: Success
  • If not 1: Failure

Response status codes

For information about the HTTP status codes common to all Ncloud Chat APIs, see Common Ncloud Chat response status codes.

Response example

The response example is as follows:

{
    "message": {
        "id": "6836b0**********0e3838a2",
        "message_id": "6836b0**********0e3838a2",
        "channel_id": "4073efd6-****-****-****-cc4550fed7b7",
        "sort_id": "1748414498672",
        "message_type": "text",
        "sender": {
            "id": "osoriz",
            "name": "osoriz",
            "profile": ""
        },
        "admin": {
            "id": "",
            "name": "",
            "profile": ""
        },
        "attachment_filenames": {
            "name": "",
            "size": 0,
            "type": "text",
            "url": ""
        },
        "has": "",
        "embed_providers": "",
        "embed_type": "",
        "isExpress": false,
        "link_hostnames": "",
        "mentions": [],
        "mentions_everyone": "false",
        "content": "test",
        "sended_at": "2025-05-28T15:41:38+09:00",
        "created_at": "2025-05-28T15:41:38+09:00"
    },
    "status": 1
}