CallFire has a new API!
We are proud to announce the launch of our API 2.0! Learn more about our streamlined, transactional and broadcast APIs. This version of the API documentation will remain available for reference only. There will be no new development, only bug fixes. We highly recommend upgrading to our newer and more sophisticated documentation.
Query for existing Agents using optional filters such as campaignId,
name, etc... Returns a list of Agents and all associated info.
See GetAgent to return just a single Agent by id.
Request Parameters
| Parameter | Demo Value | Description | Data Type |
|---|---|---|---|
| QueryAgentsRequest | Query agents by campaignId, groupId, or status | object | |
| MaxResults | Max number of results to return limited to 1000 (default: 1000) | long | |
| FirstResult | Start of next result set (default: 0) | long | |
| CampaignId | Unique ID of CCC Campaign | long | |
| AgentEmail | Unique ID of CCC Campaign | string | |
| AgentGroupId | Unique ID of AgentGroup | long | |
| AgentGroupName | AgentGroup name | string | |
| Enabled | Agent enabled or not | boolean |
* indicates choice value, bolded parameters are required
Response Parameters
| Parameter | Description | Data Type |
|---|---|---|
| QueryAgentsResponse | List of Agents returned from query | |
| TotalResults | Results count | long |
| Agent | ||
| id | Unique ID of Ccc Agent | long |
| Enabled | Whether Agent is enable or disabled | boolean |
| Name | Name of Agent | string |
| Email address of Agent | string | |
| LastLogin | DateTime of last login 'CCYY-MM-DDThh:mm:ss[Z|(+|-)hh:mm]' | dateTime |
| CampaignIds | List of CampaignIds this Agent belongs to | List[long] |
| GroupIds | List of GroupIds this Agent belongs to | List[long] |
| ActiveSessionId | Agent active session | long |