List Conversation Messages API Reference

Serverhttps://api.pinnacle.sh/

Retrieve a paginated and filtered list of messages for a specific conversation.

Authorization

Pinnacle API key

PINNACLE-API-KEY<token>

In: header

Path Parameters

idstring

Unique identifier of the conversation. This identifier is a string that always begins with the prefix conv_, for example: conv_1234567890.

Example

"resource_01J8K3R7M9"

Query Parameters

pageIndexintegerOptional

Zero-based index for pagination.

Range

0 <= value

Default

pageSizeintegerOptional

Number of messages to return per page.

Range

10 <= value <= 50

Default

sortOrderstringOptional

Sort order for messages.

asc: Oldest messages first
desc: Newest messages first (default)

Default

"desc"

Allowed values

"asc""desc"

directionstringOptional

Filter messages by direction.

INBOUND: Messages received from contacts
OUTBOUND: Messages sent to contacts

Allowed values

"INBOUND""OUTBOUND"

statusstringOptional

Filter messages by delivery status.

Allowed values

"PENDING""SENT""SEND_FAILED""DELIVERED""DELIVERY_FAILED""FALLBACK_SENT""RECEIVED""READ"

typestringOptional

Filter messages by protocol type.

Allowed values

"SMS""MMS""RCS"

dateFromstringOptional

Filter messages sent on or after this date (ISO 8601 format).

Format

date-time

Example

"2026-10-15T17:30:00Z"

dateTostringOptional

Filter messages sent on or before this date (ISO 8601 format).

Format

date-time

Example

"2026-10-15T17:30:00Z"

Response Body

`application/json`

Pinnacle client libraries

import { PinnacleClient } from "rcs-js";

const client = new PinnacleClient({
  apiKey: process.env.PINNACLE_API_KEY!,
});

await client.conversations.listMessages("id");

Responses

{  "messages": [    {      "id": "msg_1234567890",      "sender": "+18445551234",      "receiver": "+16509231662",      "sentAt": "2024-09-11T00:05:29.434Z",      "deliveredAt": "2024-09-11T00:05:30.123Z",      "status": "DELIVERED",      "error": null,      "method": "API",      "numSegments": 1,      "cost": 0.0075,      "type": "SMS",      "content": {        "text": "Hello, how can I help you today?"      },      "direction": "OUTBOUND",      "reactions": []    },    {      "id": "msg_0987654321",      "sender": "+16509231662",      "receiver": "+18445551234",      "sentAt": "2024-09-11T00:10:15.234Z",      "deliveredAt": "2024-09-11T00:10:16.123Z",      "status": "DELIVERED",      "error": null,      "method": "API",      "numSegments": 1,      "cost": null,      "type": "SMS",      "content": {        "text": "I need help with my order"      },      "direction": "INBOUND",      "reactions": [        "👍"      ]    }  ],  "hasMore": true,  "count": 42}

List Conversation Messages

AuthorizationCopy Anchor Link

Path ParametersCopy Anchor Link

Query ParametersCopy Anchor Link

Response BodyCopy Anchor Link

200application/json

400application/json

401application/json

403application/json

404application/json

500application/json

Authorization

Path Parameters

Query Parameters

Response Body

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`