メッセージ一覧の取得

Error

A valid request URL is required to generate request examples

{
  "messages": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "channel_id": "<string>",
      "sent_by": {
        "id": "<string>",
        "display_name": "<string>",
        "icon_url": "<string>",
        "metadata": {}
      },
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "content": "<string>",
      "thread_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "read_by": [
        {
          "id": "<string>",
          "display_name": "<string>",
          "icon_url": "<string>",
          "metadata": {}
        }
      ],
      "reactions": [
        {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "message_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "emoji_code": "<string>",
          "user": {
            "id": "<string>",
            "display_name": "<string>",
            "icon_url": "<string>",
            "metadata": {}
          },
          "created_at": "2023-11-07T05:31:56Z"
        }
      ],
      "attachments": [
        {
          "url": "<string>",
          "name": "<string>",
          "mime_type": "<string>",
          "size": 123,
          "channel_id": "<string>",
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "message_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "metadata": {}
        }
      ],
      "mentions": [
        {
          "user": {
            "id": "<string>",
            "display_name": "<string>",
            "icon_url": "<string>",
            "metadata": {}
          }
        }
      ],
      "thread_reply_info": {
        "count": 123,
        "last_replied_at": "2023-11-07T05:31:56Z"
      },
      "edited_at": "2023-11-07T05:31:56Z",
      "deleted_at": "2023-11-07T05:31:56Z",
      "metadata": {}
    }
  ],
  "has_more": true,
  "next_message_id": "<string>"
}

{
  "error": {
    "message": "<string>",
    "code": "BAD_REQUEST",
    "errors": [
      {
        "field": "<string>",
        "message": "<string>",
        "code": "<string>"
      }
    ]
  }
}

{
  "error": {
    "message": "<string>",
    "code": "UNAUTHORIZED"
  }
}

{
  "error": {
    "message": "<string>",
    "code": "FORBIDDEN"
  }
}

{
  "error": {
    "message": "<string>",
    "code": "NOT_FOUND"
  }
}

{
  "error": {
    "message": "<string>",
    "code": "INTERNAL_SERVER_ERROR"
  }
}

GET

channels

{channel_id}

messages

Error

A valid request URL is required to generate request examples

{
  "messages": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "channel_id": "<string>",
      "sent_by": {
        "id": "<string>",
        "display_name": "<string>",
        "icon_url": "<string>",
        "metadata": {}
      },
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "content": "<string>",
      "thread_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "read_by": [
        {
          "id": "<string>",
          "display_name": "<string>",
          "icon_url": "<string>",
          "metadata": {}
        }
      ],
      "reactions": [
        {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "message_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "emoji_code": "<string>",
          "user": {
            "id": "<string>",
            "display_name": "<string>",
            "icon_url": "<string>",
            "metadata": {}
          },
          "created_at": "2023-11-07T05:31:56Z"
        }
      ],
      "attachments": [
        {
          "url": "<string>",
          "name": "<string>",
          "mime_type": "<string>",
          "size": 123,
          "channel_id": "<string>",
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "message_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "metadata": {}
        }
      ],
      "mentions": [
        {
          "user": {
            "id": "<string>",
            "display_name": "<string>",
            "icon_url": "<string>",
            "metadata": {}
          }
        }
      ],
      "thread_reply_info": {
        "count": 123,
        "last_replied_at": "2023-11-07T05:31:56Z"
      },
      "edited_at": "2023-11-07T05:31:56Z",
      "deleted_at": "2023-11-07T05:31:56Z",
      "metadata": {}
    }
  ],
  "has_more": true,
  "next_message_id": "<string>"
}

{
  "error": {
    "message": "<string>",
    "code": "BAD_REQUEST",
    "errors": [
      {
        "field": "<string>",
        "message": "<string>",
        "code": "<string>"
      }
    ]
  }
}

{
  "error": {
    "message": "<string>",
    "code": "UNAUTHORIZED"
  }
}

{
  "error": {
    "message": "<string>",
    "code": "FORBIDDEN"
  }
}

{
  "error": {
    "message": "<string>",
    "code": "NOT_FOUND"
  }
}

{
  "error": {
    "message": "<string>",
    "code": "INTERNAL_SERVER_ERROR"
  }
}

Authorizations

Authorization

string

header

required

ユーザーがログインすると発行されるsession_idをBearerトークンとして指定します

Path Parameters

channel_id

string

required

メッセージを取得したいチャンネルのID

Required string length: 1 - 100

Pattern: ^[a-zA-Z0-9_-]+$

Query Parameters

limit

integer

default:20

取得するメッセージの上限数

anchor_message_id

string<uuid>

取得の基準点となるメッセージID。このIDを含んで後のメッセージを取得します。指定がない場合は最も古いメッセージから取得します。（reverseがtrueの場合は最も新しいメッセージから取得します）

reverse

boolean

default:false

true: 新しい順（最新→古い）、false: 古い順（古い→最新）（default: false）

include_reactions

boolean

default:false

リアクションしたユーザーを含めるかどうかを決定します。（default: false）

include_read_by

boolean

default:false

既読したユーザーを含めるかどうかを決定します。（default: false）

include_reply_messages

boolean

default:false

返信メッセージを取得するかどうかを決定します。（default: false）注意: thread_idが指定されている場合、このパラメータは無視されます。

thread_id

string<uuid>

特定のスレッドの返信のみを取得する場合に親メッセージIDを指定します。このパラメータを指定した場合、指定した親メッセージへの返信のみが取得されます。

include_thread_reply_info

boolean

default:false

スレッド返信情報を含めるかどうかを決定します。（default: false）

Response

メッセージ一覧を返却

messages

object[]

required

メッセージの一覧

Show child attributes

has_more

boolean

required

次のメッセージがあるかどうか

next_message_id

string

次のメッセージのID

はじめに

Channels

Messages

Users

Authorizations

Path Parameters

Query Parameters

Response