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 sessions using optional filters such as CampaignId, AgentEmail,
etc... Returns a list of agent sessions and all associated info.
See GetAgentSession to return just a single agent session by id.
Request Parameters
| Parameter | Demo Value | Description | Data Type |
|---|---|---|---|
| QueryAgentSessionsRequest | Query agent sessions by campaignId, agentId, or agent email | 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 | |
| AgentId | Unique ID of agent | long | |
| AgentEmail | Unique email of agent | string | |
| Active | Only return active sessions | boolean |
* indicates choice value, bolded parameters are required
Response Parameters
| Parameter | Description | Data Type |
|---|---|---|
| QueryAgentSessionsResponse | List of AgentSessions returned from query | |
| TotalResults | Results count | long |
| AgentSession | ||
| id | Unique ID of Ccc AgentSession | long |
| AgentId | ID of Agent | long |
| CampaignId | ID of Campaign | long |
| AgentState | State of Agent[DISCONNECTED, CONNECTED, AVAILABLE, TALKING_CONTACT, DIALING_ASSISTED_TRANSFER, TALKING_CONTACT_AND_TRANSFER, TALKING_TRANSFER, POSTCALL, PAUSE] | AgentState |
| CallCount | Number of calls taken by agent in this session | int |
| Start | DateTime of start 'CCYY-MM-DDThh:mm:ss[Z|(+|-)hh:mm]' | dateTime |
| LastUpdate | DateTime of last update 'CCYY-MM-DDThh:mm:ss[Z|(+|-)hh:mm]' | dateTime |