Campaigns

Start, pause and stop outbound dialing campaigns, and read or change their settings.

• POSTPlay campaigntype=play_campaignStarts outbound dialing for a campaign. It keeps dialing until you pause or stop it, or until it runs out of accounts to call.
• POSTPause campaigntype=pause_campaignSuspends outbound dialing for a running campaign. Calls already in progress finish normally.
• POSTStop campaigntype=stop_campaignStops a running or paused campaign, deactivates it and clears its dialing queue.
• POSTList campaignstype=get_campaignsLists the campaigns you can access, newest first, with their status.
• POSTGet campaign settingstype=get_campaign_settingsReturns a campaign’s settings (dial method, caller ID, calling hours, answering-machine detection, recording and more), each with its current value and the allowed options.
• POSTUpdate campaigntype=update_campaignChanges one or more settings of a campaign. Send only the fields you want to change; get the allowed values from Get campaign settings.
• POSTPlace a test callCalls or textstype=dial_numberPlaces a single test call with a campaign’s settings, so you can hear the message and check delivery before any account holders are called.