Messages

List Messages

List all messages with optional filtering and pagination. Results are sorted by creation date, newest first.

post/messages/list

Request

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

Request body

pageIndexinteger
pageSizeinteger
direction'INBOUND' | 'OUTBOUND'
status'PENDING' | 'SENT' | 'SEND_FAILED' | 'DELIVERED' | 'DELIVERY_FAILED' | 'RECEIVED' | 'READ' | 'QUEUED' | 'FALLBACK_SENT'
type'SMS' | 'MMS' | 'RCS'
method'API' | 'SDK' | 'OTHER'

Filter by the method used to send the message.

fromstring

Filter by sender phone number (E.164 format) or agent id.

tostring

Filter by recipient phone number (E.164 format).

contentstring

Search message content (partial match, case-insensitive).

dateFromstring date-time

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

dateTostring date-time

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

Response

Returns paginated list of messages.

hasMoreboolean required
countinteger required

Changes

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