BringRingsBringRings
← Back to API Reference

Campaigns API

Launch and manage outbound calling campaigns at scale.

GET/outbound/campaigns

List Campaigns

Retrieve all campaigns for your organization.

javascript
const campaigns = await client.campaigns.list();
campaigns.forEach(campaign => {
  console.log(campaign.name, campaign.status);
});
POST/outbound/campaigns/:id/start

Start a Campaign

Begin calling contacts in a campaign.

javascript
await client.campaigns.start('campaign-uuid');
// Campaign will begin calling contacts from the lead list
Note: Ensure your campaign has a valid lead list and phone numbers allocated before starting.
PUT/outbound/campaigns/:id/status

Pause/Resume Campaign

Control campaign execution status.

javascript
await client.campaigns.pause('campaign-uuid');
// Campaign will pause after current calls complete

Status Values

  • active - Campaign is running
  • paused - Campaign is paused
  • completed - Campaign finished

Campaign Analytics

Track campaign performance metrics including:

  • Total calls attempted
  • Successful connections
  • Average call duration
  • Conversion rate
  • Cost per call

Access campaign analytics through the dashboard or via the /analytics endpoint.