List Conversations

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

Request

This endpoint expects an object.

pageIndexintegerRequired>=0

Zero-based index for pagination.

brandIdintegerOptional>=1

The unique identifier of the brand to filter conversations.

campaignIdintegerOptional>=1

The unique identifier of the campaign to filter conversations.

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_’

Response

Returns conversations that meets your filters.

Errorobject

ConversationListobject

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	}
9	main();

Headers

Request

Response

Errors