Skip to main content
GET
/
channels
/
{channel_id}
/
messages
{
  "messages": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "content": "<string>",
      "channel_id": "<string>",
      "thread_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "sent_by": {
        "id": "<string>",
        "display_name": "<string>",
        "icon_url": "<string>",
        "role": "Admin",
        "metadata": {}
      },
      "read_by": [
        {
          "id": "<string>",
          "display_name": "<string>",
          "icon_url": "<string>",
          "role": "Admin",
          "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>",
            "role": "Admin",
            "metadata": {}
          },
          "created_at": "2023-11-07T05:31:56Z"
        }
      ],
      "attachments": [
        {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "message_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "url": "<string>",
          "name": "<string>",
          "mime_type": "<string>",
          "size": 123,
          "source": "Binary",
          "metadata": {},
          "channel_id": "<string>"
        }
      ],
      "mentions": [
        {
          "type": "User",
          "user": {
            "id": "<string>",
            "display_name": "<string>",
            "icon_url": "<string>",
            "role": "Admin",
            "metadata": {}
          }
        }
      ],
      "thread_reply_info": {
        "count": 123,
        "last_replied_at": "2023-11-07T05:31:56Z"
      },
      "edited_at": "2023-11-07T05:31:56Z",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "deleted_at": "2023-11-07T05:31:56Z",
      "metadata": {}
    }
  ],
  "has_more": true,
  "next_message_id": "<string>"
}

Authorizations

Authorization
string
header
required

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

Path Parameters

channel_id
string
required

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

Required string length: 1 - 100

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

メッセージの一覧

has_more
boolean
required

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

next_message_id
string

次のメッセージのID