MENU
CallFire - Your Message Delivered
CLOSE
  • Products
  • Pricing
  • Developers
  • Help
  • Log In
  • Sign Up

CreateCccCampaign

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.

CallFire-API-Documentation

  • ▶/BroadcastService
    • CreateBroadcast
    • QueryBroadcasts
    • GetBroadcast
    • UpdateBroadcast
    • GetBroadcastStats
    • ControlBroadcast
    • CreateContactBatch
    • QueryContactBatches
    • GetContactBatch
    • ControlContactBatch
    • CreateBroadcastSchedule
    • QueryBroadcastSchedule
    • GetBroadcastSchedule
    • DeleteBroadcastSchedule
  • ▶/SubscriptionService
    • CreateSubscription
    • QuerySubscriptions
    • GetSubscription
    • UpdateSubscription
    • DeleteSubscription
  • ▶/TextService
    • SendText
    • QueryTexts
    • GetText
    • CreateAutoReply
    • QueryAutoReplies
    • GetAutoReply
    • DeleteAutoReply
  • ▶/CallService
    • SendCall
    • QueryCalls
    • GetCall
    • CreateSound
    • QuerySoundMeta
    • GetSoundMeta
    • GetSoundData
    • GetRecordingData
    • SendVerificationCodeToCallerId
    • VerifyCallerId
    • GetCallerIds
  • ▶/CccService
    • GetCccCampaign
    • GetCccCampaignStats
    • CreateCccCampaign
    • QueryCccCampaigns
    • UpdateCccCampaign
    • DeleteCccCampaignTransferNumbers
    • DeleteCccCampaignQuestions
    • ControlCccCampaign
    • DeleteCccCampaign
    • GetAgent
    • QueryAgents
    • AddAgents
    • GetAgents
    • RemoveAgent
    • GetAgentGroup
    • QueryAgentGroups
    • CreateAgentGroup
    • UpdateAgentGroup
    • AddAgentGroups
    • GetAgentGroups
    • DeleteAgentGroup
    • RemoveAgentGroup
    • GetAgentSession
    • QueryAgentSessions
    • SendAgentInvites
    • GetAgentInviteUri
  • ▶/ContactService
    • QueryContacts
    • UpdateContacts
    • RemoveContacts
    • GetContact
    • GetContactHistory
    • CreateContactList
    • QueryContactLists
    • DeleteContactList
    • AddContactsToList
    • GetContactList
    • RemoveContactsFromList
    • QueryDncNumbers
    • UpdateDncNumber
    • QueryDncLists
    • CreateDncList
    • GetDncList
    • DeleteDncList
    • AddNumbersToDncList
    • RemoveNumbersFromDncList
  • ▶/NumberService
    • QueryRegions
    • QueryNumbers
    • GetNumber
    • ConfigureNumber
    • SearchAvailableNumbers
    • QueryKeywords
    • SearchAvailableKeywords
    • CreateNumberOrder
    • GetNumberOrder
    • Release
  • ▶/LabelService
    • DeleteLabel
    • QueryLabels
    • LabelBroadcast
    • UnlabelBroadcast
    • LabelNumber
    • UnlabelNumber
  • API    >  
  • CccService  >  
  • CreateCccCampaign

CreateCccCampaign

Create CCC Campaign

Create ccc campaign. Returns id of newly created ccc campaign.

Request Parameters

Parameter Demo Value Description Data Type
CreateCccCampaignRequest Create Ccc Campaign using attached info object
RequestId Unique ID of web request to de-dup on anyURI
CccCampaign object
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] 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 object
Label Question label string
ResponseType Question response type [STRING, CHOICE, NUMBERIC][STRING, CHOICE, NUMERIC] QuestionResponseType
Choices Choices available if ResponseType.CHOICE string
TransferNumber object
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 object
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

* indicates choice value, bolded parameters are required

Response Parameters

Parameter Description Data Type
CreatedId Unique ID of resource long

 

Example Code

	<?php
/**
 * You'll need your login/password pair when you create the SOAP client.
 * Don't use the fake login/password provided here; it's just for show and
 * won't work.
 */
$wsdl = "http://callfire.com/api/1.1/wsdl/callfire-service-http-soap12.wsdl";
$client = new SoapClient($wsdl, array(
    'soap_version' => SOAP_1_2,
    'login'        => 'YourLoginId',    
    'password'     => 'YourPassword'));


/**
 * CreateCccCampaign.
 */
$request = new stdclass();
$request->CccCampaign = new stdclass(); // required  
$request->CccCampaign->Name = 'Test Broadcast Service'; // required

$campaignId = $client->CreateCccCampaign($request);
echo "campaignId: " . $campaignId;

// Sample response:
// campaignId: 333

/**
* A little more complicated example with text to speech.
*/
$request = new stdclass();
$request->CccCampaign = new stdclass();
$request->CccCampaign->Name = 'Test Broadcast Service (text to speech)';
$request->CccCampaign->FromNumber = '9206596476';
$request->CccCampaign->RetryConfig = new stdclass();
$request->CccCampaign->RetryConfig->MaxAttempts = 3;
$request->CccCampaign->RetryConfig->MinutesBetweenAttempts = 5;
$request->CccCampaign->RetryConfig->RetryResults = 'BUSY NO_ANS';
$request->CccCampaign->TransferNumber = '2135551212';

$campaignId = $client->CreateBroadcast($request);
echo "campaignId: " . $campaignId;

// Upon success, the $broadcastId variable should contain the broadcast ID, 
// which you can use to grab information about the broadcast ...
$broadcastInfo = $client->getBroadcast(array('Id'=>$broadcastId));
print_r($broadcastInfo);

?>

Company

  • Careers
  • Blog
  • Press

Products

  • Text Messaging
  • Call Tracking
  • Voice Broadcast
  • CallFire IVR
  • Developer API

Resources

  • Case Studies
  • Industries
  • Communications Glossary
  • Marketing Glossary
  • Area Codes
  • Labs

Help

  • FAQs
  • CallFire XML
  • Contact Support
  • Reviews
  • System Status

© Copyright 2023 CallFire Inc. All Rights Reserved

Privacy Policy / Terms / Service Policy / FTC/FCC/DNC Compliance / Sitemap

Contact Support

Msg&data rates may apply in the US. Standard message and data rates apply in Canada. To unsubscribe from any CallFire ® list simply send 'STOP' to the originating short code or contact Support.