Conversations (v5)

List Message IDs

List all message IDs for the specified conversation with cursor pagination. Returns message IDs only. Optional filters for user IDs, status, date, and direction.

get/v5/conversations/{id}/messages/ids

Request

  • Base URL: https://api.carbonvoice.app
  • URL: https://api.carbonvoice.app/v5/conversations/{id}/messages/ids
  • Auth: one of:
    • API key in header pxtoken
    • OAuth 2 (implicit, authorization URL https://api.carbonvoice.app/oauth/authorize)

Path parameters

idstring required

Query parameters

direction'older' | 'newer'
limitnumber

Number of items to return (min: 1, max: 1000)

datestring
Example:2024-01-01T00:00:00.000Z

Date filter for messages

starting_afterstring

Cursor to fetch the next page (use value from next_cursor).

ending_beforestring

Cursor to fetch the previous page (use value from previous_cursor).

user_idsstring[]

List of user IDs to filter by. Can be passed as repeated parameters: user_ids=id1&user_ids=id2

statusMessageStatus[]

List of message statuses to filter by. Can be passed as repeated parameters: status=active&status=processing. If not provided, defaults to ACTIVE only.

Response

next_cursorstring nullable

Cursor to fetch the next page

has_moreboolean required

Whether there are more items to fetch

totalnumber nullable

Total number of messages (filtered by the query). Only included when include_total=true is provided in the query.

resultsstring[] required

List of message IDs

Changes

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