Callfireapidocumenta CallFire API Documentation

Name: CallFire API Documentation API
Brand: CallFire API Documentation
Availability: InStock

★ Only Publicly Available OpenAPI DocumentCommunicationsVoice Telephonybasic107 EndpointsREST

For Agents

Install Jentic One Beta

Connect the CallFire API Documentation to your agent

Jentic One is a self-hosted execution layer for AI agents. It lets your agent call the CallFire API Documentation, or any other public or private API you need. You set the rules, the agent never sees your credentials, and every call is logged.

Two steps, two machines. Install the instance in a safe environment, then register your agent from wherever it runs.

Step 1: Jentic One Host machine

# On the machine that will host your Jentic One instance:
curl -fsSL "https://jentic.com/install.sh?src=apis&api=%2Fapis%2Fcallfireapidocumenta%2Fcallfireapidocumenta" | sh

Step 2: Agent machine

# On the machine where your agent runs (keep this separate from the instance):
curl -fsSL "https://jentic.com/install.sh?src=apis&api=%2Fapis%2Fcallfireapidocumenta%2Fcallfireapidocumenta" | sh
jentic register       # connects your agent to your Jentic One instance

Jentic One is in public beta. The setup above keeps your agent separate from the instance, which is what you want before using real credentials: an agent running as the same OS user as Jentic One can read its stored keys directly. Just evaluating? A single local install is fine to start. See the secure deployment guide for the tiers.

Capabilities

What an agent can do with CallFire API Documentation API.

Run text broadcasts with start, stop, and archive lifecycle controls via /campaigns/text-broadcasts

Run voice broadcasts via /campaigns/voice-broadcasts and recorded IVR campaigns via /campaigns/ivrs

Configure inbound automatic text replies via /campaigns/text-auto-replys

GET STARTED

Start building with CallFire API Documentation API

Explore with Jentic One

View OpenAPI Document

This is a SwaggerHub-hosted mirror of the CallFire V2 API documentation, covering 107 operations across 73 paths. CallFire is a voice and SMS communications platform that supports text broadcasts, voice broadcasts, IVR campaigns, text auto-reply, keyword leasing, number leasing, contacts and lists, do-not-call (DNC) management, orders, subscriptions, and webhooks. Authentication is HTTP Basic with the API username and password issued in the CallFire dashboard. This spec is sourced from a third-party SwaggerHub maintainer rather than CallFire's own developer portal, so resource coverage is wider in places but version-tracking lags the vendor-official spec.

Use Cases

Patterns agents use CallFire API Documentation API for, with concrete tasks.

★ IVR Campaign with Branching

Build an interactive voice response campaign by POSTing to /campaigns/ivrs with the IVR tree definition, attaching recipients via /campaigns/ivrs/{id}/recipients, then starting the campaign with /campaigns/ivrs/{id}/start. Real-time call detail records are available through /campaigns/ivrs/{id}/calls and the campaign can be paused with the matching stop endpoint.

POST an IVR definition to /campaigns/ivrs, attach recipients, then POST to /campaigns/ivrs/{id}/start.

Inbound Auto-Reply on Keyword

Lease a keyword via /keyword-leases, then create an auto-reply with /campaigns/text-auto-replys so that any inbound text matching the keyword gets a templated response without an agent in the loop. This pattern is used for opt-in confirmations, voucher delivery, and event RSVPs.

Lease a keyword via /keyword-leases then POST a /campaigns/text-auto-replys entry that fires on that keyword.

Bulk SMS Broadcast with DNC Filtering

Before sending a marketing text broadcast, add suppressed numbers to the DNC list via the /dncs endpoints, then create a contact list, attach it to a /campaigns/text-broadcasts entry, and start the broadcast. CallFire automatically excludes DNC numbers, which keeps campaigns compliant with TCPA and similar opt-out rules.

POST DNC entries to /dncs, create the contact list, then POST a /campaigns/text-broadcasts entry and call start.

Phone Number Provisioning

Lease a new phone number via /number-leases for use in an outbound voice broadcast or as an inbound number that triggers IVR or auto-reply campaigns. The /numbers endpoints expose number metadata including capabilities (voice, SMS) so the agent can pick a suitable number programmatically before leasing.

Search /numbers for available US local numbers with SMS capability, then POST to /number-leases to lease the chosen number.

AI Agent Multi-Channel Outreach via Jentic

Through Jentic, an AI agent searches for an intent like 'send a text broadcast' and is returned the matching CallFire operation along with its input schema. Because CallFire uses HTTP Basic, Jentic stores both the username and password fragments in the credential vault and assembles the Authorization header at execution time. The agent can chain text broadcasts, voice broadcasts, and webhook subscriptions in a single workflow without writing direct API client code.

Use Jentic search for 'send a text broadcast', load the /campaigns/text-broadcasts schema, and execute it with the contact list and message body.

Key Endpoints

107 endpoints — this is a swaggerhub-hosted mirror of the callfire v2 api documentation, covering 107 operations across 73 paths.

METHOD

PATH

DESCRIPTION

POST

/campaigns/text-broadcasts

Create a text broadcast

POST

/campaigns/text-broadcasts/{id}/start

Start a text broadcast

POST

/campaigns/voice-broadcasts

Create a voice broadcast

POST

/campaigns/ivrs

Create an IVR campaign

POST

/campaigns/ivrs/{id}/start

Start an IVR campaign

POST

/campaigns/text-auto-replys

Configure inbound auto-reply

POST

/campaigns/sounds/tts

Generate a TTS sound

POST

/campaigns/text-broadcasts

Create a text broadcast

POST

/campaigns/text-broadcasts/{id}/start

Start a text broadcast

POST

/campaigns/voice-broadcasts

Create a voice broadcast

POST

/campaigns/ivrs

Create an IVR campaign

POST

/campaigns/ivrs/{id}/start

Start an IVR campaign

Why Jentic?

What agents get from Jentic-routed access to this vendor.

Setup

Wiring CallFire by hand means encoding its HTTP Basic credentials and picking the right voice, text, or IVR campaign route out of more than 100 operations. Through Jentic you install once, import the CallFire API from the API Directory, store the username and password once, and your agent calls it.

Permission scoping

CallFire puts the campaign id in the URL path (/campaigns/text-broadcasts/{id}/start), so a rule can pin your agent to one campaign: it can start that campaign and nothing else. You choose the operations it may call, so creating new voice broadcasts or IVR campaigns is not included unless you add them.

Credential isolation

Your CallFire username and password are stored once, encrypted, by your own Jentic One instance and combined into the Basic Authorization header at execution time. They never enter the agent's prompt, logs, or context.

Intent-based discovery

Agents search Jentic by intent such as 'send a text broadcast' or 'set up an auto reply', and Jentic returns the matching CallFire operation with its input schema so the agent calls the right endpoint without browsing the reference docs.

FAQs

Specific to using CallFire API Documentation API through Jentic.

What authentication does this CallFire API mirror use?

It uses HTTP Basic authentication with the API username and password issued in the CallFire dashboard. The agent presents an Authorization header containing the base64-encoded credentials. Through Jentic, both fragments are held encrypted in the vault and only assembled at execution time.

Can I run an IVR campaign through this API?

Yes. POST an IVR definition to /campaigns/ivrs, attach recipients via /campaigns/ivrs/{id}/recipients, and start the campaign with /campaigns/ivrs/{id}/start. Lifecycle endpoints for stop and archive are also exposed.

How does this spec differ from the official CallFire spec?

This spec is a SwaggerHub-hosted mirror with 107 operations across 73 paths. It tends to lag the vendor-official spec on new endpoints, but includes broader resource coverage in some areas such as IVRs and keyword leases. Pick the vendor-official CallFire spec when version recency matters most.

What are the rate limits for this API?

Rate limits are not declared in the OpenAPI specification. CallFire enforces account-level throughput tied to your plan and dialer concurrency - review your CallFire dashboard before scheduling concurrent broadcasts.

How do I send a text broadcast through Jentic?

Run a Jentic search for 'send a text broadcast', load the /campaigns/text-broadcasts schema, and execute it with the contact list and message body. Then load and execute the start broadcast schema. Install the SDK with pip install jentic and use the async search, load, and execute pattern.

Is this API free to use?

CallFire prices on a per-minute and per-text basis with monthly plans, and the SwaggerHub mirror does not change the underlying billing. Check callfire.com for current rates and dashboard usage before launching a campaign.

Can I limit what my agent is allowed to do with the CallFire API?

Yes. Jentic One runs self-hosted, so your own rules decide which CallFire operations and credentials the agent may use. Because CallFire puts the campaign id in the URL path, such as /campaigns/text-broadcasts/{id}/start, a rule can pin the agent to a single campaign so it can start that one broadcast and nothing else. You pick the exact operations it may call, so creating new voice broadcasts or IVR campaigns via /campaigns/voice-broadcasts or /campaigns/ivrs stays off limits unless you add them.

Callfireapidocumenta CallFire API Documentation

Connect the CallFire API Documentation to your agent

Capabilities

Start building with CallFire API Documentation API

Use Cases

Key Endpoints

Why Jentic?

Related APIs

FAQs