Agents data can be retrieved with GET requests to this endpoint: https://api.ipmaxi.convolo.ai/api/v1/agents?api-key=%api-key%
Query parameters:
page— Optional. Page number for pagination (default: 1).itemsPerPage— Optional. Number of items per page (default: 100).searchString— Optional. Specify a search string to filter results.showDeleted— Optional. Iftrue, deleted agents will also be included in the results.
Response parameters:
The JSON response contains the following parameters:
success: A boolean indicating whether the API request was successful.
agents: An array of agent objects, each containing:
id: Unique identifier for the agent
name: Agent's name
shortNumber: Agent's short number
email: Agent's email address
phone: Agent's phone number
accessType: Access level of the agent
webphoneHash: A hash value for the webphone
isDeleted: Deletion status (0 means not deleted)
page: The current page number of the results.
pagesCount: Total number of pages.
totalItems: Total number of items (agents) in the result set.