EnableCalls API reference

Generated from the OpenAPI file at https://api.enablecalls.com/v1/openapi.json. Base URL https://api.enablecalls.com/v1.

AreaEndpoints
AccountGET /me, GET /balance
EmployeesGET /employees, GET /employees/{employee_id}
Phone numbersGET /phone-numbers, GET /phone-numbers/{number_id}
CallsGET /calls, POST /calls, GET /calls/{call_id}, POST /calls/{call_id}/cancel
LeadsGET /leads, GET /leads/{lead_id}
CampaignsGET /campaigns, POST /campaigns, GET /campaigns/{campaign_id}, GET /campaigns/{campaign_id}/contacts, POST /campaigns/{campaign_id}/launch, POST /campaigns/{campaign_id}/pause, POST /campaigns/{campaign_id}/resume, POST /campaigns/{campaign_id}/stop
ContactsGET /contacts, POST /contacts, GET /contacts/{contact_id}, PATCH /contacts/{contact_id}, DELETE /contacts/{contact_id}, GET /contact-fields
AppointmentsGET /appointments, GET /appointments/{appointment_id}
Do-not-callGET /dnc, POST /dnc, DELETE /dnc/{phone}
WebhooksGET /webhook-endpoints, POST /webhook-endpoints, GET /webhook-endpoints/{endpoint_id}, PATCH /webhook-endpoints/{endpoint_id}, DELETE /webhook-endpoints/{endpoint_id}, POST /webhook-endpoints/{endpoint_id}/rotate-secret, POST /webhook-endpoints/{endpoint_id}/test, GET /webhook-endpoints/{endpoint_id}/deliveries, POST /webhook-endpoints/{endpoint_id}/deliveries/{delivery_id}/resend
EventsGET /events, GET /events/{event_id}

Account

Your key and your coins.

Check your API key: GET /me

Answers 200 with a Me.

Get your coin balance: GET /balance

1 coin = ₹1. Held coins are reserved for calls in progress.

Answers 200 with a Balance.

Employees

Your AI employees.

List employees: GET /employees

ParameterInTypeRequiredNotes
limitqueryintegerDefault 25. 1 to 100.
starting_afterquerystring or null

Answers 200 with a Page_Employee_.

Get an employee: GET /employees/{employee_id}

ParameterInTypeRequiredNotes
employee_idpathidyes

Answers 200 with a Employee.

Phone numbers

Numbers your employees call from and answer.

List phone numbers: GET /phone-numbers

Answers 200 with a Page_PhoneNumber_.

Get a phone number: GET /phone-numbers/{number_id}

ParameterInTypeRequiredNotes
number_idpathidyes

Answers 200 with a PhoneNumber.

Calls

Ask an employee to call one person.

List calls: GET /calls

Single calls: API calls and lead-source leads, newest first. status is applied after reading, so a page may hold fewer than limit items while has_more is true.

ParameterInTypeRequiredNotes
employee_idqueryid or null
phonequerystring or null
external_idquerystring or null
sourcequeryapi, lead_source, facebook, dashboard, callback, missed_call or null
statusqueryqueued, scheduled, in_progress, completed, not_connected, failed, canceled, blocked or null
created_afterquerytime (UTC) or null
created_beforequerytime (UTC) or null
limitqueryintegerDefault 25. 1 to 100.
starting_afterquerystring or null

Answers 200 with a CallList.

Place a call: POST /calls

Ask an employee to call one person now (or at the next calling window).

Request body (CallCreate):

FieldTypeRequiredNotes
employee_ididyes
phonestring or null
namestring or null
emailstring or null
detailsobject
external_idstring or null
metadataobject or null
max_attemptsintegerDefault 1. 1 to 3.
retry_after_minutesintegerDefault 60. 15 to 1440.
scheduled_attime (UTC) or null
contact_idid or null
lead_idid or null
dry_runbooleanDefault false.

Answers 201 with a Call or CallPreview.

Get a call: GET /calls/{call_id}

ParameterInTypeRequiredNotes
call_idpathidyes

Answers 200 with a Call.

Cancel a call: POST /calls/{call_id}/cancel

Only a call still waiting (calling hours or a retry) can be cancelled.

ParameterInTypeRequiredNotes
call_idpathidyes

Answers 200 with a Call.

Leads

The result of every conversation.

List leads: GET /leads

Newest first. Poll with updated_after to pick up results as calls finish.

ParameterInTypeRequiredNotes
employee_idqueryid or null
campaign_idqueryid or null
outcomequeryqualified, callback, converted, unqualified or null
channelqueryinstant, bulk, inbound or nullinstant: single calls; bulk: campaigns; inbound: calls in.
hotqueryboolean or null
sentimentquerypositive, neutral, negative or null
external_idquerystring or null
updated_afterquerytime (UTC) or null
created_afterquerytime (UTC) or null
created_beforequerytime (UTC) or null
limitqueryintegerDefault 25. 1 to 100.
starting_afterquerystring or null

Answers 200 with a LeadList.

Get a lead, with its transcript: GET /leads/{lead_id}

ParameterInTypeRequiredNotes
lead_idpathidyes

Answers 200 with a Lead.

Campaigns

Call a list within calling hours.

List campaigns: GET /campaigns

ParameterInTypeRequiredNotes
employee_idqueryid or null
statusquerystring or null
limitqueryintegerDefault 25. 1 to 100.
starting_afterquerystring or null

Answers 200 with a CampaignList.

Create a campaign: POST /campaigns

Create a campaign with its people, optionally starting it (launch: true).

Request body (CampaignCreate):

FieldTypeRequiredNotes
namestringyes
employee_ididyes
contactsarray of CampaignContactIn or nullUp to 1,000 people.
contact_list_idid or nullOr a contact list you already have.
consent_sourcestring or nullWhere these people agreed to be called (needed for promotional).
purposeservice, promotionalDefault "service".
start_attime (UTC) or nullDefault: now.
end_attime (UTC) or nullDefault: 7 days after start.
calling_window_startstringDefault "10:00:00".
calling_window_endstringDefault "19:00:00".
linesintegerCalls at the same time. Default 1. 1 to 100.
max_attemptsintegerDefault 2. 1 to 3.
retry_after_minutesintegerDefault 120. 15 to 1440.
briefstring or null
launchbooleanStart calling (or schedule for start_at) right away. Default false.
dry_runbooleanDefault false.

Answers 201 with a Campaign.

Get a campaign: GET /campaigns/{campaign_id}

ParameterInTypeRequiredNotes
campaign_idpathidyes

Answers 200 with a Campaign.

List a campaign's people: GET /campaigns/{campaign_id}/contacts

ParameterInTypeRequiredNotes
campaign_idpathidyes
statusquerypending, queued, answered, no_answer, busy, failed, skipped or null
limitqueryintegerDefault 25. 1 to 100.
starting_afterquerystring or null

Answers 200 with a CampaignContactList.

Start calling: POST /campaigns/{campaign_id}/launch

Starts now, or at start_at when that is later.

ParameterInTypeRequiredNotes
campaign_idpathidyes

Answers 200 with a Campaign.

Pause: POST /campaigns/{campaign_id}/pause

ParameterInTypeRequiredNotes
campaign_idpathidyes

Answers 200 with a Campaign.

Resume: POST /campaigns/{campaign_id}/resume

ParameterInTypeRequiredNotes
campaign_idpathidyes

Answers 200 with a Campaign.

Stop for good: POST /campaigns/{campaign_id}/stop

People not called yet are skipped. Calls already ringing finish.

ParameterInTypeRequiredNotes
campaign_idpathidyes

Answers 200 with a Campaign.

Contacts

People and your own details about them.

List contacts: GET /contacts

ParameterInTypeRequiredNotes
phonequerystring or null
searchquerystring or null
limitqueryintegerDefault 25. 1 to 100.
starting_afterquerystring or null

Answers 200 with a ContactList.

Create Contact: POST /contacts

Add a person. Their fields fill {{placeholders}} on campaign calls.

Request body (ContactIn):

FieldTypeRequiredNotes
namestring or null
phonestringyes
emailstring or null
notesstring or null
tagsarray of string
fieldsobjectYour contact fields: label → value.
consent_sourcestring or nullWhere they agreed to be called.
dry_runbooleanDefault false.

Answers 201 with a Contact.

Get Contact: GET /contacts/{contact_id}

ParameterInTypeRequiredNotes
contact_idpathidyes

Answers 200 with a Contact.

Update Contact: PATCH /contacts/{contact_id}

ParameterInTypeRequiredNotes
contact_idpathidyes

Request body (ContactPatch):

FieldTypeRequiredNotes
namestring or null
phonestring or null
emailstring or null
notesstring or null
tagsarray of string or null
fieldsobject or nullReplaces all fields.
consent_sourcestring or null

Answers 200 with a Contact.

Delete Contact: DELETE /contacts/{contact_id}

Removes the person from your contacts; their past calls and leads stay.

ParameterInTypeRequiredNotes
contact_idpathidyes

Answers 204 No Content.

List your contact fields: GET /contact-fields

Answers 200 with a ContactFieldList.

Appointments

Booked on calls or by your team.

List appointments: GET /appointments

Booked on calls or by your team, by start time (default: 30 days back, 90 ahead).

ParameterInTypeRequiredNotes
starts_afterquerytime (UTC) or null
starts_beforequerytime (UTC) or null

Answers 200 with a AppointmentList.

Get Appointment: GET /appointments/{appointment_id}

ParameterInTypeRequiredNotes
appointment_idpathidyes

Answers 200 with a Appointment.

Do-not-call

Numbers never to call.

List do-not-call: GET /dnc

ParameterInTypeRequiredNotes
limitqueryintegerDefault 25. 1 to 100.
starting_afterquerystring or null

Answers 200 with a DncList.

Add Dnc: POST /dnc

Never call this number again. Calls already waiting for it are stopped too.

Request body (DncAdd):

FieldTypeRequiredNotes
phonestringyes
reasonstring or null
dry_runbooleanDefault false.

Answers 201 with a DncEntry.

Remove Dnc: DELETE /dnc/{phone}

ParameterInTypeRequiredNotes
phonepathstringyes

Answers 204 No Content.

Webhooks

Results pushed to your URL as they happen.

List webhook endpoints: GET /webhook-endpoints

Answers 200 with a EndpointList.

Create a webhook endpoint: POST /webhook-endpoints

Events are POSTed to the URL, signed with the secret returned here (once).

Request body (EndpointIn):

FieldTypeRequiredNotes
urlstringyesA public https URL.
eventsarray of call.completed, call.not_connected, call.inbound_missed, lead.updated, appointment.booked, appointment.updated | *yes
dry_runbooleanDefault false.

Answers 201 with a EndpointWithSecret.

Get Endpoint: GET /webhook-endpoints/{endpoint_id}

ParameterInTypeRequiredNotes
endpoint_idpathidyes

Answers 200 with a Endpoint.

Update Endpoint: PATCH /webhook-endpoints/{endpoint_id}

ParameterInTypeRequiredNotes
endpoint_idpathidyes

Request body (EndpointPatch):

FieldTypeRequiredNotes
activeboolean or null
eventsarray of call.completed, call.not_connected, call.inbound_missed, lead.updated, appointment.booked, appointment.updated | * or null

Answers 200 with a Endpoint.

Delete Endpoint: DELETE /webhook-endpoints/{endpoint_id}

ParameterInTypeRequiredNotes
endpoint_idpathidyes

Answers 204 No Content.

Get a new signing secret: POST /webhook-endpoints/{endpoint_id}/rotate-secret

The old secret stops working at once; update your receiver first if you can.

ParameterInTypeRequiredNotes
endpoint_idpathidyes

Answers 200 with a EndpointWithSecret.

Send a test event: POST /webhook-endpoints/{endpoint_id}/test

Sends a test event ("test": true) within a few seconds.

ParameterInTypeRequiredNotes
endpoint_idpathidyes

Answers 200 with a Sent.

List deliveries to an endpoint: GET /webhook-endpoints/{endpoint_id}/deliveries

ParameterInTypeRequiredNotes
endpoint_idpathidyes
statusquerypending, sent, failed or null
limitqueryintegerDefault 25. 1 to 100.
starting_afterquerystring or null

Answers 200 with a DeliveryList.

Send a delivery again: POST /webhook-endpoints/{endpoint_id}/deliveries/{delivery_id}/resend

ParameterInTypeRequiredNotes
endpoint_idpathidyes
delivery_idpathidyes

Answers 200 with a Sent.

Events

Everything that happened, for 30 days.

List events: GET /events

Everything sent (or that would be sent) to webhooks in the last 30 days.

ParameterInTypeRequiredNotes
typequerycall.completed, call.not_connected, call.inbound_missed, lead.updated, appointment.booked, appointment.updated or null
created_afterquerytime (UTC) or null
limitqueryintegerDefault 25. 1 to 100.
starting_afterquerystring or null

Answers 200 with a EventList.

Get an event: GET /events/{event_id}

ParameterInTypeRequiredNotes
event_idpathidyes

Answers 200 with a Event.

Objects

Call

FieldTypeAlwaysNotes
ididyes
employee_idid or nullyes
phonestring or nullyes
namestring or nullyes
detailsobjectyes
external_idstring or nullyes
metadataobject or nullyes
sourceapi, lead_source, facebook, dashboard, callback, missed_callyes
statusqueued, scheduled, in_progress, completed, not_connected, failed, canceled, blockedyes
status_detailstring or nullyes
attempts_madeintegeryes
max_attemptsintegeryes
next_attempt_atstring or nullyes
last_call_idid or nullyes
lead_ididyes
resultCallResult or nullyes
created_atstring or nullyes

CallResult

FieldTypeAlwaysNotes
connectedbooleanyes
outcomestring or nullyes
summarystring or nullyes
capturedobjectyes
hotbooleanyes
sentimentpositive, neutral, negative or nullHow the customer felt by the end of the call.
callback_atstring or nullyes
duration_secondsinteger or nullyes
coins_chargednumber or nullyes
started_atstring or nullyes
ended_atstring or nullyes
recording_urlstring or nullyes

CallPreview

FieldTypeAlwaysNotes
dry_runtrueDefault true.
would_callbooleanyes
statusqueued, scheduled, blocked, failedyes
next_attempt_atstring or nullyes
checksarray of Checkyes
warningsarray of stringyes

Lead

FieldTypeAlwaysNotes
ididyes
employee_idid or nullyes
campaign_idid or nullyes
channelstring or nullyes
directioninbound, outbound or nullyes
namestring or nullyes
phonestring or nullyes
emailstring or nullyes
statusstring or nullyes
outcomequalified, callback, converted, unqualified or nullyes
hotbooleanyes
sentimentpositive, neutral, negative or nullHow the person felt on their latest call.
callback_atstring or nullyes
capturedobjectyes
contactLeadContact or nullyes
external_idstring or nullyes
metadataobject or nullyes
call_idid or nullyes
call_statusstring or nullyes
business_numberstring or nullyes
summarystring or nullyes
duration_secondsinteger or nullyes
coins_chargednumber or nullyes
started_atstring or nullyes
ended_atstring or nullyes
recording_urlstring or nullyes
transcriptarray of TranscriptLine or null
created_atstring or nullyes
updated_atstring or nullyes

Campaign

FieldTypeAlwaysNotes
ididyes
namestringyes
employee_ididyes
contact_list_ididyes
statusstringyes
purposestringyes
start_atstring or nullyes
end_atstring or nullyes
calling_window_startstringyes
calling_window_endstringyes
time_zonestringyes
linesintegeryes
max_attemptsintegeryes
retry_after_minutesintegeryes
briefstring or nullyes
block_reasonstring or nullyes
countsCampaignCountsyes
progress_pctintegeryes
started_atstring or nullyes
completed_atstring or nullyes
created_atstring or nullyes

CampaignCounts

FieldTypeAlwaysNotes
totalintegeryes
pendingintegeryes
in_progressintegeryes
answeredintegeryes
no_answerintegeryes
busyintegeryes
failedintegeryes
skippedintegeryes
retryingintegeryes
qualifiedintegeryes
callbacksintegeryes
wonintegeryes
not_interestedintegeryes
talk_secondsintegeryes
coins_spentnumberyes

Contact

FieldTypeAlwaysNotes
ididyes
namestring or nullyes
phonestring or nullyes
emailstring or nullyes
notesstring or nullyes
tagsarray of stringyes
fieldsobjectyes
consent_sourcestring or nullyes
consent_atstring or nullyes
created_atstring or nullyes

Employee

FieldTypeAlwaysNotes
ididyes
namestring or nullyes
rolestring or nullyes
statusstring or nullyes
languagesarray of stringyes
incoming_calls_enabledbooleanyes
max_call_secondsintegerLongest a call may run; the employee says goodbye 30 s before. Default 600.
script_strictnessinteger1 talks freely .. 5 keeps exactly to the instructions' words. Default 3.
phone_numberstring or nullyes
phone_number_idid or nullyes
placeholdersarray of stringyes
created_atstring or nullyes

Endpoint

FieldTypeAlwaysNotes
ididyes
urlstringyes
eventsarray of stringyes
activebooleanyes
last_statusinteger or nullyes
last_errorstring or nullyes
last_sent_atstring or nullyes
created_atstring or nullyes

Event

FieldTypeAlwaysNotes
ididyes
typestringyes
api_versionstringyes
created_atstring or nullyes
testbooleanDefault false.
dataobjectyes

Delivery

FieldTypeAlwaysNotes
ididyes
event_idid or nullyes
event_typestringyes
statuspending, sent, failedyes
attemptsintegeryes
last_status_codeinteger or nullyes
last_errorstring or nullyes
next_attempt_atstring or nullyes
created_atstring or nullyes
delivered_atstring or nullyes

Appointment

FieldTypeAlwaysNotes
ididyes
employee_idid or nullyes
lead_idid or nullyes
call_idid or nullyes
customer_namestring or nullyes
customer_phonestring or nullyes
starts_atstring or nullyes
duration_minutesintegeryes
statusstringyes
sourceai, manualyes
notesstring or nullyes
created_atstring or nullyes

Ready to try it? Sign in and open Developers to create a key, or ask us about your integration.

Start freeBook a demo