---
title: "Get chat messages"
method: GET
path: "/api/v2/chats/{id}/message"
tags: ["Chats"]
---

# Get chat messages

`GET /api/v2/chats/{id}/message`

<a class="try-sandbox-link" href="https://sandbox.textmagic.com/#/Chats/getChatMessages" target="_blank">Try in sandbox</a><br>

## Path parameters

- `id` integer, required

## Query parameters

- `page` integer
- `limit` integer
- `query` string
- `start` string
- `end` string
- `direction` 'asc' | 'desc'
- `voice` 0 | 1
- `includeNotes` 0 | 1

## Response `200`

Returned when successful.

- GetChatMessagesPaginatedResponse
  - `page` integer, required
  - `pageCount` integer, required — The total number of pages.
  - `limit` integer, required — The number of results per page.
  - `resources` Conversation[], required
    - `id` integer, required
    - `direction` 'in' | 'out' | 'o' | 'i', required — Message type: inbound or outbound.
    - `sender` string, nullable, required — Sender phone number.
    - `messageTime` string, date-time, required — Time when the message arrived at Textmagic.
    - `text` string, required — Message text.
    - `receiver` string, required — Receiver's phone number.
    - `status` string, required — Message status (for chats outbound only). See [message delivery statuses](https://docs.textmagic.com/#section/Delivery-status-codes) for details.
    - `firstName` string, required — Contact first name.
    - `lastName` string, required — Contact last name.
    - `sessionId` integer, nullable, required — Session ID of a message. See [message sessions](https://docs.textmagic.com/#tag/Outbound-Message-Sessions) for details.
    - `initiatorId` integer, nullable — Initiator ID of a message. See [message sessions](https://docs.textmagic.com/#tag/Outbound-Message-Sessions) for details.
    - `messageFileId` integer, nullable — Message file id.
    - `type` 'text' | 'image' | 'audio' | 'voice' | 'document' | 'video' | 'log' | 'initial' | 'note' — Message type.
    - `chatType` 'sms' | 'facebook_messenger' | 'instagram' | 'whatsapp_business' | 'live_chat' — Chat type.
    - `chatId` integer — Chat id.
    - `isEdited` boolean
    - `errorCode` string, nullable — Error code.
    - `files` File[]
      - `id` integer, required
      - `name` string, required
      - `originalName` string, required
      - `mimeType` string, required
      - `size` integer, required
      - `type` 'attachment' | 'import' | 'raw_email' | 'inline_attachment' | 'chat-attachment' | 'knowledge_base' | 'facebook_page_picture' | 'instagram_account_picture' | 'logo', required — File type.
      - `createdAt` string, date-time, required
      - `previewUrl` string
      - `url` string
      - `metadata` FileMetadata, nullable
        - `type` 'image' | 'video', required — File metadata type.
        - `height` integer, required
        - `width` integer, required
        - `preview` FileMetadataPreview, nullable, required
          - `height` integer, required
          - `width` integer, required
    - `payload` MessagePayload, nullable
      - `type` string, required — Payload type.
      - `mediaPreview` string, required — Media preview link.
    - `avatar` string, nullable

## Other responses

- `400` — Returned when invalid phone number specified.

---

[API](https://skmtc.net/textmagic/apis/textmagic-api.md) · [All operations](https://skmtc.net/textmagic/apis/textmagic-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/textmagic/textmagic-api/revisions/3e4029d19684/schema)