メッセージの削除

Prev Next

Classic/VPC環境で利用できます。

メッセージを削除します。

リクエスト

リクエスト形式を説明します。リクエスト形式は次の通りです。

メソッド URI
DELETE /v1/api/messages/{channelId}/{messageId}

リクエストヘッダ

Ncloud Chat APIで共通して使用されるヘッダの詳細は、Ncloud Chatのリクエストヘッダをご参照ください。

リクエストパスパラメータ

リクエストパスパラメータの説明は次の通りです。

フィールド タイプ 必須の有無 説明
channelId String Required チャンネル ID
messageId String Required メッセージ ID

リクエスト例

リクエストのサンプルコードは次の通りです。

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}'

レスポンス

レスポンス形式を説明します。

レスポンスボディ

レスポンスボディの説明は次の通りです。

フィールド タイプ 必須の有無 説明
message Object - メッセージ情報
message.id String - メッセージ ID
message.message_id String - メッセージ ID
message.channel_id String - チャンネル ID
message.sort_id String - 送信日時
  • Unix Timestamp形式
message.message_type String - メッセージのタイプ
  • text | file
message.sender Object - 送信者情報
message.sender.id String - 送信者 ID
message.sender.name String - 送信者名
message.sender.profile String - 送信者プロファイル画像
message.admin Object - 管理者情報
message.admin.id String - 管理者 ID
message.admin.name String - 管理者名
message.admin.profile String - 管理者プロファイル画像
message.attachment_filenames Object - 添付ファイル情報
message.attachment_filenames.name String - 添付ファイル名
message.attachment_filenames.size Number - 添付ファイルサイズ(Byte)
message.attachment_filenames.type String - 添付ファイルタイプ
message.attachment_filenames.url String - 添付ファイルの URL
message.has String - 添付特殊項目の区分 (デフォルト: "")
  • <例> link、image、video、file
message.embed_providers String - 添付エンベッド特殊項目の提供者
message.embed_type String - エンベッド特殊項目のタイプ (デフォルト: "")
message.isExpress Boolean - エクスプレスメッセージかどうか
  • true | false (デフォルト)
    • true: エクスプレスメッセージ
    • false: 通常のメッセージ
message.link_hostnames String - リンクホスト名
  • message.hasが linkの場合
message.mentions Array - メンション情報 (デフォルト: [])
message.mentions_everyone Boolean - 全員メンションかどうか
  • true | false (デフォルト)
    • true: 全員メンション
    • false: 全員メンションではない
message.content String - メッセージの内容
message.sended_at String - メッセージ送信日時
  • ISO 8601形式
message.created_at String - メッセージ作成日時
  • ISO 8601形式
status Integer - レスポンスの状態
  • 1: 成功
  • 1でない場合: 失敗

レスポンスステータスコード

Ncloud Chat APIで共通して使用されるレスポンスステータスコードの詳細は、Ncloud Chatのレスポンスステータスコードをご参照ください。

レスポンス例

レスポンスのサンプルコードは次の通りです。

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