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 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.
Request Parameters
| Parameter | Demo Value | Description | Data Type |
|---|---|---|---|
| QueryCccCampaignsRequest | CccCampaigns request by query | object | |
| MaxResults | Max number of results to return limited to 1000 (default: 1000) | long | |
| FirstResult | Start of next result set (default: 0) | long | |
| Running | Filter on running CCC Campaigns | boolean | |
| Name | Name of Campaign | string | |
| LabelName | Label that result must have to be included | string |
* indicates choice value, bolded parameters are required
Response Parameters
| Parameter | Description | Data Type |
|---|---|---|
| QueryCccCampaignsResponse | List of CCC Campaigns returned from query | |
| TotalResults | Results count | long |
| CccCampaign | ||
| id | Unique ID of Campaign | long |
| Name | Name of Campaign | string |
| Status | Status of Campaign (response only)[START_PENDING, RUNNING, STOPPED, FINISHED, ARCHIVED, TEST, SETUP, SCHEDULED, SUSPENDED, VALIDATING_EMAIL, VALIDATING_START, BLOCKED_SUSPICIOUS, APPROVED, DECLINED, PAUSED, CANCELED] | BroadcastStatus |
| Created | DateTime Campaign was created 'CCYY-MM-DDThh:mm:ss[Z|(+|-)hh:mm]' | dateTime |
| LastModified | Last Modified 'CCYY-MM-DDThh:mm:ss[Z|(+|-)hh:mm]' | dateTime |
| LocalRestrictBegin | Earliest time a client can be contacted in the timezone associated with the number's NPA/NXX | time |
| LocalRestrictEnd | Latest time a client can be contacted in the timezone associated with the number's NPA/NXX | time |
| ConfigUpdated | DateTime Campaign Config was updated 'CCYY-MM-DDThh:mm:ss[Z|(+|-)hh:mm]' | dateTime |
| Script | Script content | string |
| Question | ||
| Label | Question label | string |
| ResponseType | Question response type [STRING, CHOICE, NUMBERIC][STRING, CHOICE, NUMERIC] | QuestionResponseType |
| Choices | Choices available if ResponseType.CHOICE | string |
| TransferNumber | ||
| Name | Transfer Number name | string |
| Number | Transfer Number | PhoneNumber |
| AllowAssistedTransfer | Allow assisted transfer | boolean |
| FromNumber | E.164 11 digit number or short code | PhoneNumber |
| RetryConfig | Retry logic for campaign | |
| MaxAttempts | Max attempts to retry broadcast (default: 1) | int |
| MinutesBetweenAttempts | Minutes between broadcast attempts (default: 60) | int |
| RetryResults | Conditions to retry on[LA, AM, BUSY, DNC, XFER, NO_ANS, XFER_LEG, SENT, RECEIVED, DNT, TOO_BIG, INTERNAL_ERROR, CARRIER_ERROR, CARRIER_TEMP_ERROR, UNDIALED, SD, POSTPONED, ABANDONED, SKIPPED, INVALID_NUMBER] | List[Result] |
| RetryPhoneTypes | Phone types to call in retry[FIRST_NUMBER, HOME_PHONE, WORK_PHONE, MOBILE_PHONE] | List[RetryPhoneType] |
| AgentGroupId | Unique ID of AgentGroup | long |
| AgentGroupName | Name of AgentGroup | string |
| SmartDropSoundId | Unique ID of SmartDropSound | long |
| SmartDropSoundRef | URI of SmartDropSound | anyURI |
| AllowAnyTransfer | Allow any transfer | boolean |
| TransferCallerId | Transfer caller Id | string |
| Recorded | Recorded | boolean |
| MultilineDialingRatio | Allow calling up to 4 lines at a time (default = 1). This feature will increase your abandoned rate. | int |
| MultilineDialingEnabled | Enable calling up to 4 lines at a time (MultilineDialingRatio default = 1). Enabling this feature will increase your abandoned rate. | boolean |
| ScrubLevel | Scrub level | int |
| NumberOfRings | The system will wait the number of rings you select (default = 4) before assigning "No answer" as the call result. | int |
| Label | Label for CccCampaign | string |