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 agent groups using optional filters such as campaignId,
name, etc... Returns a list of AgentGroups and all associated info.
See GetAgentGroup to return just a single AgentGroup by id.
Request Parameters
| Parameter | Demo Value | Description | Data Type |
|---|---|---|---|
| QueryAgentGroupsRequest | Query agent groups by campaignId, agentId, email, 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 | |
| Name | AgentGroup name | string | |
| AgentId | Unique ID of agent | long | |
| AgentEmail | Unique email of agent | string |
* indicates choice value, bolded parameters are required
Response Parameters
| Parameter | Description | Data Type |
|---|---|---|
| QueryAgentGroupsResponse | List of AgentGroups returned from query | |
| TotalResults | Results count | long |
| AgentGroup | ||
| id | Unique ID of Ccc AgentGroup | long |
| Name | Name of Agent | string |
| CampaignIds | List of CampaignIds this AgentGroup belongs to | List[long] |
| AgentIds | List of AgentIds that belong to this AgentGroup | List[long] |
| AgentEmails | List of AgentEmails that belong to this AgentGroup | List[string] |