Conversations

List Conversation Messages

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

post/conversations/{id}/messages

Request

  • Base URL: https://api.pinnacle.sh
  • URL: https://api.pinnacle.sh/conversations/{id}/messages
  • Auth: API key in header PINNACLE-API-KEY

Path parameters

idstring required

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

Query parameters

pageIndexinteger

Zero-based index for pagination.

pageSizeinteger

Number of messages to return per page.

sortOrder'asc' | 'desc'

Sort order for messages. <br>

  • asc: Oldest messages first
  • desc: Newest messages first (default)
direction'INBOUND' | 'OUTBOUND'

Filter messages by direction. <br>

  • INBOUND: Messages received from contacts
  • OUTBOUND: Messages sent to contacts
status'PENDING' | 'SENT' | 'SEND_FAILED' | 'DELIVERED' | 'DELIVERY_FAILED' | 'FALLBACK_SENT' | 'RECEIVED' | 'READ'

Filter messages by delivery status.

type'SMS' | 'MMS' | 'RCS'

Filter messages by protocol type.

dateFromstring date-time

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

dateTostring date-time

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

Response

Returns a paginated list of messages in the conversation.

hasMoreboolean required

Indicates if more messages are available beyond the current page.

countinteger required

Total number of messages in the conversation.

Changes

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