> ## Documentation Index
> Fetch the complete documentation index at: https://deepline.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Unipile: Get Message

> Get one message by message_id. Includes SDK V2 and CLI requests, input constraints, response fields, and Deepline credit cost.

Get one message by message\_id.

> [!NOTE]
>
> Tool ID: `unipile_get_message`

## 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.

```ts theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
import { Deepline } from 'deepline';

const deepline = await Deepline.connect();
const result = await deepline.tools.execute(
  'unipile_get_message',
  {
    "message_id": "message_123"
  },
);

console.log(result.toolResponse.raw);
```

### CLI

```bash theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
deepline tools execute unipile_get_message --input '{
  "message_id": "message_123"
}' --json
```

## Example response

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

```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
{
  "data": {
    "provider_id": "provider_123",
    "sender_id": "sender_123",
    "text": "example",
    "attachments": [
      {
        "id": "id_123",
        "unavailable": true,
        "type": "audio",
        "voice_note": true
      }
    ],
    "id": "id_123",
    "account_id": "123456789",
    "chat_id": "chat_123",
    "chat_provider_id": "chat_provider_123",
    "timestamp": "example",
    "is_sender": 0,
    "reactions": [
      {
        "value": "example",
        "sender_id": "sender_123",
        "is_sender": true
      }
    ],
    "seen": 0,
    "seen_by": {},
    "hidden": 0,
    "deleted": 0,
    "edited": 0,
    "is_event": 0,
    "delivered": 0,
    "behavior": 0,
    "original": "example",
    "sender_attendee_id": "sender_attendee_123",
    "object": "Message"
  }
}
```

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

## Input reference

Retrieve the details of a message.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `payload.message_id` | `string` | Yes | — | The id of the message to retrieve. |

<details>
  <summary>Show raw input schema</summary>

  ### Input JSON Schema

  ```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "type": "object",
    "description": "Retrieve the details of a message.",
    "properties": {
      "message_id": {
        "type": "string",
        "description": "The id of the message to retrieve."
      }
    },
    "required": [
      "message_id"
    ],
    "additionalProperties": false
  }
  ```
</details>

## Output reference

Standard tool result payload.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `result.data` | `object` | Yes | — | Provider response payload. |
| `result.data.message_id` | `string` | No | — | A unique identifier. Minimum length: 1. |
| `result.data.provider_id` | `string` | Yes | — | — |
| `result.data.sender_id` | `string` | Yes | — | — |
| `result.data.text` | `string \| null` | Yes | — | — |
| `result.data.attachments` | `array` | Yes | — | — |
| `result.data.attachments[].id` | `string` | Yes | — | — |
| `result.data.attachments[].file_size` | `number` | No | — | — |
| `result.data.attachments[].unavailable` | `boolean` | Yes | — | — |
| `result.data.attachments[].mimetype` | `string` | No | — | — |
| `result.data.attachments[].url` | `string` | No | — | — |
| `result.data.attachments[].url_expires_at` | `number` | No | — | — |
| `result.data.attachments[].type` | `"img"` | Yes | — | — |
| `result.data.attachments[].size` | `object` | Yes | — | — |
| `result.data.attachments[].size.width` | `number` | Yes | — | — |
| `result.data.attachments[].size.height` | `number` | Yes | — | — |
| `result.data.attachments[].sticker` | `boolean` | Yes | — | — |
| `result.data.attachments[].gif` | `boolean` | Yes | — | — |
| `result.data.attachments[].duration` | `number` | No | — | — |
| `result.data.attachments[].voice_note` | `boolean` | Yes | — | — |
| `result.data.attachments[].file_name` | `string` | Yes | — | — |
| `result.data.attachments[].starts_at` | `number \| null` | Yes | — | — |
| `result.data.attachments[].expires_at` | `number \| null` | Yes | — | — |
| `result.data.attachments[].time_range` | `number \| null` | Yes | — | — |
| `result.data.attachments[].post` | `object` | No | — | — |
| `result.data.attachments[].post.url` | `string` | Yes | — | — |
| `result.data.attachments[].post.author` | `string` | No | — | — |
| `result.data.attachments[].post.author_id` | `string` | No | — | — |
| `result.data.attachments[].post.author_messaging_id` | `string` | No | — | — |
| `result.data.attachments[].post.description` | `string` | No | — | — |
| `result.data.attachments[].story` | `object` | No | — | — |
| `result.data.attachments[].story.url` | `string` | Yes | — | — |
| `result.data.attachments[].story.author` | `string` | No | — | — |
| `result.data.attachments[].cta` | `object` | No | — | — |
| `result.data.attachments[].cta.text` | `string` | Yes | — | — |
| `result.data.attachments[].cta.type` | `string` | Yes | — | — |
| `result.data.attachments[].cta.url` | `string` | No | — | — |
| `result.data.attachments[].link` | `object` | No | — | — |
| `result.data.attachments[].link.text` | `string` | Yes | — | — |
| `result.data.attachments[].link.url` | `string` | Yes | — | — |
| `result.data.attachments[].link.title` | `string` | Yes | — | — |
| `result.data.attachments[].link.summary` | `string` | Yes | — | — |
| `result.data.attachments[].link.image_url` | `string` | Yes | — | — |
| `result.data.attachments[].video_call` | `object` | No | — | — |
| `result.data.attachments[].video_call.type` | `string` | Yes | — | — |
| `result.data.attachments[].video_call.description` | `string` | Yes | — | — |
| `result.data.attachments[].video_call.duration` | `number` | Yes | — | — |
| `result.data.attachments[].video_call.start_time` | `number` | Yes | — | — |
| `result.data.attachments[].video_call.end_time` | `number` | Yes | — | — |
| `result.data.attachments[].profile` | `object` | Yes | — | — |

The table shows the first 50 fields. Use the live contract below for every field.

> [!NOTE]
>
> This output schema is too large for an inline display. Read the complete live contract with `deepline describe unipile_get_message --json`.

## Deepline cost

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

## Related documentation

* [Unipile provider guide](https://deepline.com/docs/providers/unipile/guide.md)
* [SDK V2 quickstart](https://deepline.com/docs/sdk-v2/quickstart.md)
* [SDK reference](https://deepline.com/docs/sdk-v2/sdk-reference.md)
* [Run tools across a CSV](https://deepline.com/docs/sdk-v2/batch-csv.md)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.