Conversations

List Conversations

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

post/conversations/list

Request

  • Base URL: https://api.pinnacle.sh
  • URL: https://api.pinnacle.sh/conversations/list
  • Auth: API key in header PINNACLE-API-KEY

Request body

brandIdstring

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.

campaignIdstring

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)
campaignType'TOLL_FREE' | '10DLC' | 'RCS'

The type of campaign:

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

Zero-based index for pagination.

pageSizeinteger

Number of conversations to return per page.

receiverstring

Receiver's phone number in E.164 format.

senderstring

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 required

Total number of conversations matching the filter.

hasMoreboolean required

Indicates if more conversations are available beyond the current page.

Changes

No recorded changes to this operation across all 1 revision of this API.