List Conversations | Pinnacle

Retrieves conversations by page with optional filtering based off provided parameters.

Authentication

PINNACLE-API-KEYstring

API Key authentication via header

Request

This endpoint expects an object.

pageIndexintegerRequired>=0

Zero-based index for pagination.

brandIdstringOptional

The unique identifier of the brand to filter conversations. This identifier is a string that always begins with the prefix b_, for example: b_1234567890.

campaignIdstringOptional

The unique identifier of the campaign to filter conversations. This identifier is a string that begins with the prefix:

TOLL_FREE: tf_ (e.g., tf_1234567890)
10DLC: dlc_ (e.g., dlc_1234567890)
RCS: rcs_ (e.g., rcs_1234567890)

The unique identifier of the campaign to filter conversations. This identifier is a string that begins with the prefix: - TOLL_FREE: `tf_` (e.g., `tf_1234567890`) - 10DLC: `dlc_` (e.g., `dlc_1234567890`) - RCS: `rcs_` (e.g., `rcs_1234567890`)

campaignTypeenumOptional

The type of campaign:

TOLL_FREE: Toll-free number campaigns
10DLC: 10-digit long code campaigns for A2P messaging
RCS: Rich Communication Services campaigns

The type of campaign: - TOLL_FREE: Toll-free number campaigns - 10DLC: 10-digit long code campaigns for A2P messaging - RCS: Rich Communication Services campaigns

Allowed values:

pageSizeintegerOptional>=1Defaults to 10

Number of conversations to return per page.

receiverstringOptional

Receiver's phone number in E.164 format.

senderstringOptional

The sender identifier. Can be either:

A phone number in E.164 format
An RCS agent ID prefixed with ‘agent_’

The sender identifier. Can be either: - A phone number in E.164 format - An RCS agent ID prefixed with 'agent_'

Response

Returns conversations that meets your filters.

countinteger

Total number of conversations matching the filter.

conversationslist of objects

hasMoreboolean

Indicates if more conversations are available beyond the current page.

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.list({
8	pageIndex: 0,
9	brandId: "b_1234567890",
10	campaignId: "tf_1234567890",
11	campaignType: "TOLL_FREE",
12	pageSize: 20,
13	receiver: "+16509231662",
14	sender: "+18445551234",
15	});
16	}
17	main();

1	{
2	"count": 50,
3	"conversations": [
4	{
5	"brandId": "b_1234567890",
6	"campaign": {
7	"id": "dlc_1234567890",
8	"type": "10DLC"
9	},
10	"contact": {
11	"id": "co_1234567890",
12	"phoneNumber": "+16509231662"
13	},
14	"createdAt": "2024-09-11T00:05:29.434",
15	"id": "conv_1234567890",
16	"notes": "VIP customer",
17	"sender": {
18	"capabilities": {
19	"mms": true,
20	"sms": true,
21	"voice": false
22	},
23	"createdAt": "2024-01-15T09:30:00Z",
24	"isSandbox": false,
25	"phoneNumber": "+18445551234",
26	"updatedAt": "2024-01-15T09:30:00Z"
27	},
28	"updatedAt": "2024-08-14T14:19:40.237"
29	}
30	],
31	"hasMore": true
32	}

Authentication

Request

Response

Errors