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.
CccService
The operations defined here should be preferred over BroadcastService methods when appropriate
since the CccService
operations are more consise and selective in the input parameters.
GetCccCampaign
Get ccc campaign identified by id.
GetCccCampaignStats
Return campaign stats that includes call counts and billing amounts.
CreateCccCampaign
Create ccc campaign. Returns id of newly created ccc campaign.
QueryCccCampaigns
Query for existing ccc campaigns using optional filters such as name, status, labels,
etc... Returns a list of ccc campaigns and all associated info.
See GetCccCampaign
to return just a single ccc campaign by id.
UpdateCccCampaign
Update existing campaign's configuration such as time zone restrictions
or retry logic. Currently all fields from config are updated so the 'Message'
field needs to be populated just like in CreateCccCampaign
operation.
Use unique ID to specify campaign. Need to provide dummy 'Name' field Campaign even though the field will not be overwritten.
DeleteCccCampaignTransferNumbers
Delete all transfer numbers from an existing CCC Campaign. To add or update
transfer numbers on ccc campaign use UpdateCccCampaign
. This call
is only needed when deletion of all transfer numbers is needed.
DeleteCccCampaignQuestions
Delete all questions from an existing CCC Campaign. To add or update
questions on ccc campaign use UpdateCccCampaign
. This call
is only needed when deletion of all questions is needed.
ControlCccCampaign
Apply command START, STOP, or ARCHIVE to ccc campaign. Also can change the max active count of campaign.
DeleteCccCampaign
Delete ccc campaign identified by id.
GetAgent
Return individual agent by id. See QueryAgents
to return list of agents.
QueryAgents
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.
AddAgents
Add agents identified by id or email to existing ccc campaign.
GetAgents
Get list of agents attached to ccc campaign.
RemoveAgent
Remove individual agent identified by id from ccc campaign identified by campaign id.
GetAgentGroup
Return individual agent group by id. See QueryAgentGroups
to return list
of agent groups.
QueryAgentGroups
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.
CreateAgentGroup
Create agent group using either list of agent ids or list of agent emails but not both.
UpdateAgentGroup
Update existing agent group identified by id. Change name, etc...
AddAgentGroups
Add agent groups identified by ids to campaign.
GetAgentGroups
Returns a list of agent groups attached to campaign.
DeleteAgentGroup
Delete agent group identified by id.
RemoveAgentGroup
Remove agent group identified by id from campaign. If id points to non-existent agent group then ServiceFault or 404 error will be thrown.
GetAgentSession
Return ccc agent session by id. See QueryAgentSessions
to return
list of agent sessions and determine individual agent session id.
QueryAgentSessions
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.
SendAgentInvites
Send ccc agent invite email which includes a link inside email for agent to register with campaign.