Callfire API Documentation

CallFire API Documentation

API version: V2

Auth

basic

Base URL

https://api.callfire.com/v2

Setup

1. Configure auth: basic
2. GET /calls -- verify access
3. POST /calls -- create first calls

Endpoints

123 endpoints across 11 groups. See references/api-spec.lap for full details.

calls

campaigns

contacts

keywords

me

media

numbers

orders

reports

texts

webhooks

Common Questions

Match user requests to endpoints in references/api-spec.lap. Key patterns:

• "List all calls?" -> GET /calls
• "Create a call?" -> POST /calls
• "List all broadcasts?" -> GET /calls/broadcasts
• "Create a broadcast?" -> POST /calls/broadcasts
• "Get broadcast details?" -> GET /calls/broadcasts/{id}
• "Update a broadcast?" -> PUT /calls/broadcasts/{id}
• "Create a archive?" -> POST /calls/broadcasts/{id}/archive
• "List all batches?" -> GET /calls/broadcasts/{id}/batches
• "Create a batche?" -> POST /calls/broadcasts/{id}/batches
• "List all calls?" -> GET /calls/broadcasts/{id}/calls
• "Create a recipient?" -> POST /calls/broadcasts/{id}/recipients
• "Create a start?" -> POST /calls/broadcasts/{id}/start
• "List all stats?" -> GET /calls/broadcasts/{id}/stats
• "Create a stop?" -> POST /calls/broadcasts/{id}/stop
• "Create a toggleRecipientsStatus?" -> POST /calls/broadcasts/{id}/toggleRecipientsStatus
• "Get recording details?" -> GET /calls/recordings/{id}
• "Get recording details?" -> GET /calls/recordings/{id}.mp3
• "Get call details?" -> GET /calls/{id}
• "List all recordings?" -> GET /calls/{id}/recordings
• "Get recording details?" -> GET /calls/{id}/recordings/{name}
• "Get recording details?" -> GET /calls/{id}/recordings/{name}.mp3
• "Get batche details?" -> GET /campaigns/batches/{id}
• "Update a batche?" -> PUT /campaigns/batches/{id}
• "List all sounds?" -> GET /campaigns/sounds
• "Create a call?" -> POST /campaigns/sounds/calls
• "Create a file?" -> POST /campaigns/sounds/files
• "Create a tt?" -> POST /campaigns/sounds/tts
• "Get sound details?" -> GET /campaigns/sounds/{id}
• "Delete a sound?" -> DELETE /campaigns/sounds/{id}
• "Get sound details?" -> GET /campaigns/sounds/{id}.mp3
• "Get sound details?" -> GET /campaigns/sounds/{id}.wav
• "List all contacts?" -> GET /contacts
• "Create a contact?" -> POST /contacts
• "List all dncs?" -> GET /contacts/dncs
• "Create a dnc?" -> POST /contacts/dncs
• "Delete a source?" -> DELETE /contacts/dncs/sources/{source}
• "Get universal details?" -> GET /contacts/dncs/universals/{toNumber}
• "Get dnc details?" -> GET /contacts/dncs/{number}
• "Update a dnc?" -> PUT /contacts/dncs/{number}
• "Delete a dnc?" -> DELETE /contacts/dncs/{number}
• "List all lists?" -> GET /contacts/lists
• "Create a list?" -> POST /contacts/lists
• "Create a upload?" -> POST /contacts/lists/upload
• "Get list details?" -> GET /contacts/lists/{id}
• "Update a list?" -> PUT /contacts/lists/{id}
• "Delete a list?" -> DELETE /contacts/lists/{id}
• "List all items?" -> GET /contacts/lists/{id}/items
• "Create a item?" -> POST /contacts/lists/{id}/items
• "Delete a item?" -> DELETE /contacts/lists/{id}/items/{contactId}
• "Get contact details?" -> GET /contacts/{id}
• "Update a contact?" -> PUT /contacts/{id}
• "Delete a contact?" -> DELETE /contacts/{id}
• "List all history?" -> GET /contacts/{id}/history
• "List all keywords?" -> GET /keywords
• "List all leases?" -> GET /keywords/leases
• "List all configs?" -> GET /keywords/leases/configs
• "Get config details?" -> GET /keywords/leases/configs/{keyword}
• "Update a config?" -> PUT /keywords/leases/configs/{keyword}
• "Get id details?" -> GET /keywords/leases/id/{id}
• "Get lease details?" -> GET /keywords/leases/{keyword}
• "Update a lease?" -> PUT /keywords/leases/{keyword}
• "List all available?" -> GET /keywords/{keyword}/available
• "List all account?" -> GET /me/account
• "List all credentials?" -> GET /me/api/credentials
• "Create a credential?" -> POST /me/api/credentials
• "Get credential details?" -> GET /me/api/credentials/{id}
• "Delete a credential?" -> DELETE /me/api/credentials/{id}
• "Create a disable?" -> POST /me/api/credentials/{id}/disable
• "Create a enable?" -> POST /me/api/credentials/{id}/enable
• "List all credit-usage?" -> GET /me/billing/credit-usage
• "Get grouped details?" -> GET /me/billing/credit-usage/grouped/{rollupBinType}
• "List all plan-usage?" -> GET /me/billing/plan-usage
• "List all callerids?" -> GET /me/callerids
• "Create a verification-code?" -> POST /me/callerids/{callerid}/verification-code
• "List all media?" -> GET /media
• "Create a media?" -> POST /media
• "Get public details?" -> GET /media/public/{key}.{extension}
• "Get media details?" -> GET /media/{id}
• "Get media details?" -> GET /media/{id}.{extension}
• "List all file?" -> GET /media/{id}/file
• "List all leases?" -> GET /numbers/leases
• "List all configs?" -> GET /numbers/leases/configs
• "Get config details?" -> GET /numbers/leases/configs/{number}
• "Update a config?" -> PUT /numbers/leases/configs/{number}
• "Get lease details?" -> GET /numbers/leases/{number}
• "Update a lease?" -> PUT /numbers/leases/{number}
• "List all local?" -> GET /numbers/local
• "List all regions?" -> GET /numbers/regions
• "List all tollfree?" -> GET /numbers/tollfree
• "List all orders?" -> GET /orders
• "Create a keyword?" -> POST /orders/keywords
• "Create a number?" -> POST /orders/numbers
• "Get order details?" -> GET /orders/{id}
• "List all delivery?" -> GET /reports/delivery
• "List all texts?" -> GET /texts
• "Create a text?" -> POST /texts
• "List all auto-replys?" -> GET /texts/auto-replys
• "Create a auto-reply?" -> POST /texts/auto-replys
• "Get auto-reply details?" -> GET /texts/auto-replys/{id}
• "Delete a auto-reply?" -> DELETE /texts/auto-replys/{id}
• "List all broadcasts?" -> GET /texts/broadcasts
• "Create a broadcast?" -> POST /texts/broadcasts
• "Get broadcast details?" -> GET /texts/broadcasts/{id}
• "Update a broadcast?" -> PUT /texts/broadcasts/{id}
• "Create a archive?" -> POST /texts/broadcasts/{id}/archive
• "List all batches?" -> GET /texts/broadcasts/{id}/batches
• "Create a batche?" -> POST /texts/broadcasts/{id}/batches
• "Create a recipient?" -> POST /texts/broadcasts/{id}/recipients
• "Create a start?" -> POST /texts/broadcasts/{id}/start
• "List all stats?" -> GET /texts/broadcasts/{id}/stats
• "Create a stop?" -> POST /texts/broadcasts/{id}/stop
• "List all texts?" -> GET /texts/broadcasts/{id}/texts
• "Create a toggleRecipientsStatus?" -> POST /texts/broadcasts/{id}/toggleRecipientsStatus
• "Get text details?" -> GET /texts/{id}
• "List all webhooks?" -> GET /webhooks
• "Create a webhook?" -> POST /webhooks
• "List all resources?" -> GET /webhooks/resources
• "Get resource details?" -> GET /webhooks/resources/{resource}
• "Get webhook details?" -> GET /webhooks/{id}
• "Update a webhook?" -> PUT /webhooks/{id}
• "Delete a webhook?" -> DELETE /webhooks/{id}
• "How to authenticate?" -> See Auth section

Response Tips

• Check response schemas in references/api-spec.lap for field details
• List endpoints may support pagination; check for limit, offset, or cursor params
• Create/update endpoints typically return the created/updated object

References

• Full spec: See references/api-spec.lap for complete endpoint details, parameter tables, and response schemas

Generated from the official API spec by LAP