List Conversation Messages | Pinnacle

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

PINNACLE-API-KEYstring

API Key authentication via header

idstringRequired

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

pageIndexintegerOptional>=0Defaults to 0

Zero-based index for pagination.

pageSizeintegerOptional10-50Defaults to 10

Number of messages to return per page.

sortOrderenumOptionalDefaults to desc

Sort order for messages.

Sort order for messages. <br> - `asc`: Oldest messages first - `desc`: Newest messages first (default)

Allowed values:

directionenumOptional

Filter messages by direction.

Filter messages by direction. <br> - `INBOUND`: Messages received from contacts - `OUTBOUND`: Messages sent to contacts

Allowed values:

statusenumOptional

Filter messages by delivery status.

typeenumOptional

Filter messages by protocol type.

Allowed values:

dateFromdatetimeOptional

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

dateTodatetimeOptional

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

Returns a paginated list of messages in the conversation.

messageslist of objects

Array of messages in the conversation.

hasMoreboolean

Indicates if more messages are available beyond the current page.

countinteger

Total number of messages in the conversation.

1	import { PinnacleClient } from "rcs-js";
2
3	async function main() {
4	const client = new PinnacleClient({
5	environment: "https://api.pinnacle.sh",
6	});
7	await client.conversations.listMessages("id", {});
8	}
9	main();

1	{
2	"messages": [
3	{
4	"content": {
5	"text": "Hello, how can I help you today?"
6	},
7	"cost": 0.0075,
8	"deliveredAt": "2024-09-11T00:05:30.123Z",
9	"direction": "OUTBOUND",
10	"error": {},
11	"id": "msg_1234567890",
12	"method": "API",
13	"numSegments": 1,
14	"reaction": "string",
15	"receiver": "+16509231662",
16	"sender": "+18445551234",
17	"sentAt": "2024-09-11T00:05:29.434Z",
18	"status": "DELIVERED",
19	"type": "SMS"
20	},
21	{
22	"content": {
23	"text": "I need help with my order"
24	},
25	"cost": {},
26	"deliveredAt": "2024-09-11T00:10:16.123Z",
27	"direction": "INBOUND",
28	"error": {},
29	"id": "msg_0987654321",
30	"method": "API",
31	"numSegments": 1,
32	"reaction": "👍",
33	"receiver": "+18445551234",
34	"sender": "+16509231662",
35	"sentAt": "2024-09-11T00:10:15.234Z",
36	"status": "DELIVERED",
37	"type": "SMS"
38	}
39	],
40	"hasMore": true,
41	"count": 42
42	}