API Reference

Complete reference for all BringRings API endpoints.

Base URL

https://api.bringrings.com

Authentication

All API requests require authentication via the x-api-key header. See Authentication for details.

Calls

Method	Endpoint	Description
POST	/calls/initiate	Initiate an outbound call
GET	/calls/:id	Get call details
POST	/calls/:id/end	End an active call
GET	/logs/:id	Get call transcript

Agents

Method	Endpoint	Description
GET	/agents	List all agents
POST	/agents	Create an agent
GET	/agents/:id	Get agent details
PUT	/agents/:id	Update an agent
DELETE	/agents/:id	Delete an agent

Campaigns

Method	Endpoint	Description
GET	/outbound/campaigns	List campaigns
POST	/outbound/campaigns	Create a campaign
POST	/outbound/campaigns/:id/start	Start a campaign
PUT	/outbound/campaigns/:id/status	Pause/resume campaign

Usage

Method	Endpoint	Description
GET	/billing/usage	Get current usage
GET	/analytics	Get analytics data

Response Format

All responses are returned as JSON with the following structure:

{
  "success": true,
  "data": { ... }
}

// Or for errors:
{
  "success": false,
  "error": {
    "message": "Error description",
    "code": "ERROR_CODE"
  }
}