Get Conversation

Fetch a specific conversation using either its unique identifier or by matching sender and recipient details.

Request

This endpoint expects an object.

Get by IDobjectRequired

Retrieve conversation information by ID.

Get by ParticipantsobjectRequired

Retrieve conversation information by sender and recipient.

Response

Returns the full conversation details, or null if not found.

brandIdinteger or null

Identifier for the brand associated with this conversation.

campaignobject or null

Campaign information if this conversation is part of a marketing campaign.

contactobject

Contact information for the recipient in a conversation.

createdAtstring

ISO 8601 timestamp when the conversation was created.

idinteger

Unique identifier for the conversation.

notesstring

Free-form notes or comments about the conversation.

senderobject or null

The sender of messages in this conversation. Can be:

A phone number with its capabilities and metadata
An RCS agent with ID and name
null if no sender is associated

The sender of messages in this conversation. Can be: - A phone number with its capabilities and metadata - An RCS agent with ID and name - `null` if no sender is associated

updatedAtstring

ISO 8601 timestamp when the conversation was last updated.

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.get({});
8	}
9	main();

1	{
2	"brandId": 119,
3	"campaign": {
4	"id": "136",
5	"type": "TOLL_FREE"
6	},
7	"contact": {
8	"id": 70,
9	"phoneNumber": "+16509231662"
10	},
11	"createdAt": "2024-09-11T00:05:29.434",
12	"id": 1,
13	"notes": "Customer inquired about product availability",
14	"sender": {
15	"capabilities": {
16	"mms": true,
17	"sms": true,
18	"voice": true
19	},
20	"createdAt": "2024-01-15T09:30:00Z",
21	"isSandbox": false,
22	"phoneNumber": "+18445551234",
23	"updatedAt": "2024-01-15T09:30:00Z"
24	},
25	"updatedAt": "2024-08-14T14:19:40.237"
26	}

Headers

Request

Response

Errors