Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Exotel Campaigns API

Create and manage bulk outbound call campaigns (v2).

Exotel Campaigns API is one of 6 APIs that Exotel publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Campaigns. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 6 operations across 3 paths, and defines 3 schemas. It is described by OpenAPI 3.0.3, at version 1.0.

Requests are made against 2 base URLs: https://api.exotel.com, https://api.in.exotel.com.

6 operations 3 paths 3 schemas 1 DELETE3 GET1 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
1.0
Base URL
https://api.exotel.com/v1/Accounts
Authentication
HTTP Basic
Resource Areas
1

Authentication & Security 1

Exotel Campaigns API declares 1 security scheme for authenticating requests. It accepts HTTP basic authentication (basicAuth). By default, every request must be authenticated.

  • basicAuth — HTTP Basic authentication. Username = API Key, Password = API Token (both from Exotel Dashboard - Settings - API Settings). May also be embedded in the URL as…

Paths & Operations 6

Across 3 paths, the API surfaces 6 operations — 1 DELETE, 3 GET, 1 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Campaigns 6

Create and manage bulk outbound call campaigns (v2).

GET
/v2/accounts/{sid}/campaigns
List campaigns
listCampaigns 1 param → 200401
POST
/v2/accounts/{sid}/campaigns
Create a campaign
createCampaign 1 param body → 200401
GET
/v2/accounts/{sid}/campaigns/{campaign_id}
Get a campaign
getCampaign 2 params → 200401404
PUT
/v2/accounts/{sid}/campaigns/{campaign_id}
Update / pause / resume a campaign
updateCampaign 2 params body → 200401
DELETE
/v2/accounts/{sid}/campaigns/{campaign_id}
Delete a campaign
deleteCampaign 2 params → 200401404
GET
/v2/accounts/{sid}/campaigns/{campaign_id}/call-details
Get campaign call details
getCampaignCallDetails 2 params → 200401

Schemas 3

The contract defines 3 schemas that model the data the API accepts and returns. The most detailed are CallResponse (11 properties), Campaign (6 properties), CampaignInput (6 properties). Each schema is shown below with its type and property counts.

CampaignInput
object
6 properties
CallResponse
object
11 properties
Campaign
object
6 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

exotel-campaigns-api-openapi.yml Raw ↑

Other APIs Exotel publishes across the network.

Exotel AgentStream Voice Streaming API
Exotel Call Details API
Exotel Numbers API
Exotel SMS API
Exotel Voice API