メッセージの照会

Prev Next

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

メッセージの詳細情報を照会します。

リクエスト

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

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

リクエストヘッダ

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

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

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

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

リクエスト例

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

curl --location --request GET 'https://dashboard-api.ncloudchat.naverncp.com/v1/api/messages/8ed73d56-****-****-****-2bd6eb8b4a14/672036b**********125bc79"' \
--header 'x-api-key: {API Key}' \
--header 'x-project-id: {Project ID}'

レスポンス

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

レスポンスボディ

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

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

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

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

レスポンス例

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

{
    "id": "672036b**********125bc79",
    "message_id": "672036b**********125bc79",
    "channel_id": "8ed73d56-****-****-****-2bd6eb8b4a14",
    "sort_id": "1730164402698",
    "message_type": "file",
    "sender": {
        "id": "radevjs3",
        "name": "radevjs3",
        "profile": ""
    },
    "admin": {
        "id": "",
        "name": "",
        "profile": ""
    },
    "attachment_filenames": {
        "name": "죠르디벚꽃.jpg",
        "size": 70439,
        "type": "file",
        "url": "/archive/8ecf3fce-****-****-****-88e8225cdc32"
    },
    "has": "",
    "embed_providers": "",
    "embed_type": "",
    "isExpress": false,
    "link_hostnames": "",
    "mentions": [],
    "mentions_everyone": "false",
    "content": null,
    "sended_at": "2024-10-29T10:13:22+09:00",
    "created_at": "2024-10-29T10:13:22+09:00"
}