Conversations (v5)

Get Message Counts by User

Get aggregated message counts grouped by user for the specified conversation. Returns user IDs with their message counts only (no user profile information). Optional filters for user IDs, date, and direction.

get/v5/conversations/{id}/messages/user-counts

Request

  • Base URL: https://api.carbonvoice.app
  • URL: https://api.carbonvoice.app/v5/conversations/{id}/messages/user-counts
  • 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

user_idsstring[]

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

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

Date filter for messages

direction'older' | 'newer'

Direction for date filter (newer or older)

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

total_messagesnumber required

Total number of messages matching the filters

Changes

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