get_conversation_users_route
Read-onlyIdempotent
Retrieve and filter conversation users by agent, branch, user ID, or date range, with sorting by last contact, conversation count, or average sentiment.
Instructions
Get Conversation Users
Tool call template
This tool declares no required parameters. Add optional parameters from the input schema as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {},
"name": "get_conversation_users_route"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| cursor | No | Used for fetching next page. Cursor is returned in the response. | |
| search | No | Search/filter by user ID (exact match). | |
| sort_by | No | The field to sort the results by. Defaults to last_contact_unix_secs. | |
| agent_id | No | Agent id (agent_…) or speech engine external id (seng_), resolved to the same underlying resource. | |
| branch_id | No | Filter conversations by branch ID. | |
| page_size | No | How many users to return at maximum. Defaults to 30. | |
| sort_direction | No | The direction to sort the results | |
| call_start_after_unix | No | Unix timestamp (in seconds) to filter conversations after to this start date. | |
| call_start_before_unix | No | Unix timestamp (in seconds) to filter conversations up to this start date. |