Unipile: Get Chat Messages

Get message history from a chat.

Tool ID: unipile_get_chat_messages

Run this action

Use the TypeScript SDK for one call. Use ctx.tools.execute(...) inside a Play for durable calls, scheduled calls, or CSV processing.

import { Deepline } from 'deepline';

const deepline = await Deepline.connect();
const result = await deepline.tools.execute(
  'unipile_get_chat_messages',
  {
    "chat_id": "chat_123"
  },
);

console.log(result.toolResponse.raw);

CLI

deepline tools execute unipile_get_chat_messages --input '{
  "chat_id": "chat_123"
}' --json

Example response

The SDK returns this shape at result.toolResponse.raw. The example values illustrate the response.

{
  "data": {
    "items": [
      {
        "object": "Message",
        "id": "id_123",
        "chat_id": "chat_123"
      }
    ],
    "cursor": "cursor_123",
    "object": "MessageList"
  }
}

Use deepline describe unipile_get_chat_messages --json for the latest machine-readable contract.

Input reference

Retrieve message history for a chat. Most recent messages first.

Name	Type	Required	Default	Details
`payload.chat_id`	`string`	Yes	—	Chat ID
`payload.sender_id`	`string`	No	—	Only messages from this sender.
`payload.before`	`string`	No	—	Only items created before this ISO 8601 UTC datetime. Format: `date-time`.
`payload.after`	`string`	No	—	Only items created after this ISO 8601 UTC datetime. Format: `date-time`.
`payload.limit`	`integer`	No	—	Page size, 1-250. Minimum: 1. Maximum: 250.
`payload.cursor`	`string`	No	—	Cursor from the previous page.

Output reference

Standard tool result payload.

Name	Type	Required	Default	Details
`result.data`	`object`	Yes	—	Provider response payload.
`result.data.items`	`array`	No	—	—
`result.data.items[].object`	`"Message"`	No	—	Allowed: `Message`.
`result.data.items[].id`	`string`	No	—	—
`result.data.items[].chat_id`	`string`	No	—	—
`result.data.items[].account_id`	`string`	No	—	—
`result.data.items[].provider_id`	`string`	No	—	—
`result.data.items[].sender_id`	`string`	No	—	—
`result.data.items[].sender_attendee_id`	`string`	No	—	—
`result.data.items[].text`	`string \| null`	No	—	—
`result.data.items[].timestamp`	`string`	No	—	Format: `date-time`.
`result.data.items[].is_sender`	`unknown`	No	—	Truthy when the connected account sent the message
`result.data.items[].attachments`	`array`	No	—	—
`result.data.items[].seen`	`unknown`	No	—	Unipile ‘seen’ flag
`result.data.items[].delivered`	`unknown`	No	—	Unipile ‘delivered’ flag
`result.data.items[].hidden`	`unknown`	No	—	Unipile ‘hidden’ flag
`result.data.items[].deleted`	`unknown`	No	—	Unipile ‘deleted’ flag
`result.data.items[].edited`	`unknown`	No	—	Unipile ‘edited’ flag
`result.data.cursor`	`string \| null`	No	—	—
`result.data.object`	`"MessageList"`	No	—	Allowed: `MessageList`.
`result.meta`	`object`	No	—	Additional response metadata (status, paging).

Deepline cost

Pricing model: fixed (per call).
Estimated Deepline credits: 0 per pricing unit.
Provider-native pricing may still exist outside Deepline credit billing.

​Run this action

​CLI

​Example response

​Input reference

​Output reference

​Deepline cost

​Related documentation

Run this action

CLI

Example response

Input reference

Output reference

Deepline cost

Related documentation