# CallFire API Documentation API

> CallFire API Documentation API on Apizie: 122 endpoints (Find calls, Send calls, Find call broadcasts, Create a call broadcast, …) returned as clean JSON through one API key. Send your own provider key in the x-upstream-key header. Call it over REST at https://zieapi.vercel.app/v1/communication:callfire/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month.

- Project key: `communication:callfire`
- Category: Communication
- Status: byok
- Source: https://www.callfire.com
- Page: https://zieapi.vercel.app/api/communication/callfire
- OpenAPI: https://zieapi.vercel.app/api/communication/callfire/openapi.json

CallFire

## Endpoints

### Find calls
`GET https://zieapi.vercel.app/v1/communication:callfire/find-calls` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| fields | string | no | Limit fields received in response. E.g. fields: id, name or fields items (id, name), see more at [partial… |
| limit | integer | no | To set the maximum number of records to return in a paged list response. The default is 100 |
| offset | integer | no | Offset to the start of a given page. The default is 0. Check [pagination](https://developers.callfire.com/docs.html#pagination) page for… |
| id | array | no | Lists the Call ids to search for. If calls ids are specified then other query parameters can be ignored |
| campaignId | integer | no | An id of a campaign, queries for calls included to a particular campaign. Specify null for all campaigns and 0 for default campaign |
| batchId | integer | no | An id of a contact batch, queries for calls of a particular contact batch |
| fromNumber | string | no | Phone number in E.164 format (11-digit) that call was from. Example: 12132000384 |
| toNumber | string | no | Phone number in E.164 format (11-digit) that call was sent to. Example: 12132000384 |
| label | string | no | A label for a specific call |
| states | string | no | Searches for all calls which correspond to statuses listed in a comma separated string. Available values: READY, SELECTED, CALLBACK,… |
| results | string | no | Searches for all calls with statuses listed in a comma separated string. Available values: SENT, RECEIVED, DNT, TOO_BIG, INTERNAL_ERROR,… |
| inbound | boolean | no | Filters inbound calls for "true" value and outbound calls for "false" value |
| intervalBegin | integer | no | Start of the find time interval, formatted in unix time milliseconds. Example: 1473781817000 for Sat, 05 Jan 1985 14:03:37 GMT |
| intervalEnd | integer | no | End of the find time interval, formatted in unix time milliseconds. Example: 1473781817000 for Sat, 05 Jan 1985 14:03:37 GMT |

### Send calls
`POST https://zieapi.vercel.app/v1/communication:callfire/send-calls` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| fields | string | no | Limit fields received in response. E.g. fields: id, name or fields items (id, name), see more at [partial… |
| campaignId | integer | no | Specifies a campaignId to send calls quickly on a previously created campaign |
| defaultLiveMessage | string | no | Text to be turned into a sound, this text will be played when the phone is answered. Parameter can be overridden for any particular… |
| defaultMachineMessage | string | no | Text to be turned into a sound, this text will be played when answering machine is detected. Parameter can be overridden for any… |
| defaultLiveMessageSoundId | integer | no | Id of sound file to play if phone is answered. Parameter can be overridden for any particular CallRecipient |
| defaultMachineMessageSoundId | integer | no | An id of a sound file to play if answering machine is detected. Parameter can be overridden for any particular CallRecipient |
| defaultVoice | string | no | The voice set by default for all text-to-speech messages defined in CallRecipient objects or as default *Message properties |
| strictValidation | boolean | no | Turns on strict validation for recipients. System will reply with BAD_REQUEST(400) if strictValidation = true and one of numbers didn't… |
| body | object | no | JSON request body |

### Find call broadcasts
`GET https://zieapi.vercel.app/v1/communication:callfire/find-call-broadcasts` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| fields | string | no | Limit fields received in response. E.g. fields: id, name or fields items (id, name), see more at [partial… |
| limit | integer | no | To set the maximum number of records to return in a paged list response. The default is 100 |
| offset | integer | no | Offset to the start of a given page. The default is 0. Check [pagination](https://developers.callfire.com/docs.html#pagination) page for… |
| label | string | no | A label of a voice broadcast |
| name | string | no | A name of voice broadcast |
| running | boolean | no | Specify whether the campaigns should be running or not |
| scheduled | boolean | no | Specify whether the campaigns should be scheduled or not |
| intervalBegin | integer | no | Start of the find time interval, formatted in unix time milliseconds. Example: 1473781817000 for Sat, 05 Jan 1985 14:03:37 GMT |
| intervalEnd | integer | no | End of the find time interval, formatted in unix time milliseconds. Example: 1473781817000 for Sat, 05 Jan 1985 14:03:37 GMT |

### Create a call broadcast
`POST https://zieapi.vercel.app/v1/communication:callfire/create-call-broadcast` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| start | boolean | no | Specify whether to immediately start this campaign (not required) |
| strictValidation | boolean | no | Turns on strict validation for recipients. System will reply with BAD_REQUEST(400) if strictValidation = true and one of numbers didn't… |
| body | object | no | JSON request body |

### Find a specific call broadcast
`GET https://zieapi.vercel.app/v1/communication:callfire/get-call-broadcast` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | integer | yes | An id of a CallBroadcast |
| fields | string | no | Limit fields received in response. E.g. fields: id, name or fields items (id, name), see more at [partial… |

### Update a call broadcast
`POST https://zieapi.vercel.app/v1/communication:callfire/update-call-broadcast` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | integer | yes | An id of a voice broadcast |
| strictValidation | boolean | no | Turns on strict validation for recipients. System will reply with BAD_REQUEST(400) if strictValidation = true and one of numbers didn't… |
| body | object | no | JSON request body |

### Archive voice broadcast
`POST https://zieapi.vercel.app/v1/communication:callfire/archive-voice-broadcast` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | integer | yes | An id of a voice broadcast to archive |

### Find batches in a call broadcast
`GET https://zieapi.vercel.app/v1/communication:callfire/get-call-broadcast-batches` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | integer | yes | An id of a call broadcast |
| fields | string | no | Limit fields received in response. E.g. fields: id, name or fields items (id, name), see more at [partial… |
| limit | integer | no | To set the maximum number of records to return in a paged list response. The default is 100 |
| offset | integer | no | Offset to the start of a given page. The default is 0. Check [pagination](https://developers.callfire.com/docs.html#pagination) page for… |

### Add batches to a call broadcast
`POST https://zieapi.vercel.app/v1/communication:callfire/add-call-broadcast-batch` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | integer | yes | An id of a call broadcast |
| strictValidation | boolean | no | Turns on strict validation for recipients. System will reply with BAD_REQUEST(400) if strictValidation = true and one of numbers didn't… |
| body | object | no | JSON request body |

### Find calls in a call broadcast
`GET https://zieapi.vercel.app/v1/communication:callfire/get-call-broadcast-calls` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | integer | yes | An Id of a call broadcast |
| batchId | integer | no | An id of a particular batch associated with broadcast |
| fields | string | no | Limit fields received in response. E.g. fields: id, name or fields items (id, name), see more at [partial… |
| limit | integer | no | To set the maximum number of records to return in a paged list response. The default is 100 |
| offset | integer | no | Offset to the start of a given page. The default is 0. Check [pagination](https://developers.callfire.com/docs.html#pagination) page for… |

### Add recipients to a call broadcast
`POST https://zieapi.vercel.app/v1/communication:callfire/add-call-broadcast-recipients` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | integer | yes | An id of a call broadcast |
| fields | string | no | Limit fields received in response. E.g. fields: id, name or fields items (id, name), see more at [partial… |
| strictValidation | boolean | no | Turns on strict validation for recipients. System will reply with BAD_REQUEST(400) if strictValidation = true and one of numbers didn't… |
| body | object | no | JSON request body |

### Start voice broadcast
`POST https://zieapi.vercel.app/v1/communication:callfire/start-voice-broadcast` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | integer | yes | An id of voice broadcast to start |

### Get statistics on call broadcast
`GET https://zieapi.vercel.app/v1/communication:callfire/get-call-broadcast-stats` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | integer | yes | An id of a call broadcast |
| fields | string | no | Limit fields received in response. E.g. fields: id, name or fields items (id, name), see more at [partial… |
| begin | integer | no | Start of the search time interval, formatted in unix time milliseconds. Example: 1473781817000 for Sat, 05 Jan 1985 14:03:37 GMT |
| end | integer | no | End of the search time interval, formatted in unix time milliseconds. Example: 1473781817000 for Sat, 05 Jan 1985 14:03:37 GMT |

### Stop voice broadcast
`POST https://zieapi.vercel.app/v1/communication:callfire/stop-voice-broadcast` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | integer | yes | An id of voice broadcast to stop |

### Disable/enable undialed recipients in broadcast
`POST https://zieapi.vercel.app/v1/communication:callfire/toggle-call-broadcast-recipients-status` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | integer | yes | An id of a voice broadcast |
| enable | boolean | no | Flag which indicate what to do with calls (true will enable call in DISABLED status and vice versa) |
| body | object | no | JSON request body |

### Get call recording by id
`GET https://zieapi.vercel.app/v1/communication:callfire/get-call-recording` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | integer | yes | ~ |
| fields | string | no | Limit fields received in response. E.g. fields: id, name or fields items (id, name), see more at [partial… |

### Get call recording in mp3 format
`GET https://zieapi.vercel.app/v1/communication:callfire/get-call-recording-mp3` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | integer | yes | An id of a call |

### Find a specific call
`GET https://zieapi.vercel.app/v1/communication:callfire/get-call` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | integer | yes | An id of a call |
| fields | string | no | Limit fields received in response. E.g. fields: id, name or fields items (id, name), see more at [partial… |

### Get call recordings for a call
`GET https://zieapi.vercel.app/v1/communication:callfire/get-call-recordings` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | integer | yes | An id of a call |
| fields | string | no | Limit fields received in response. E.g. fields: id, name or fields items (id, name), see more at [partial… |

### Get call recording by name
`GET https://zieapi.vercel.app/v1/communication:callfire/get-call-recording-by-name` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | integer | yes | An id of a call |
| name | string | yes | A name of a recording |
| fields | string | no | Limit fields received in response. E.g. fields: id, name or fields items (id, name), see more at [partial… |

### Get call mp3 recording by name
`GET https://zieapi.vercel.app/v1/communication:callfire/get-call-recording-mp3-by-name` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | integer | yes | An id of a call |
| name | string | yes | A name of a recording |

### Find a specific batch
`GET https://zieapi.vercel.app/v1/communication:callfire/get-campaign-batch` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | integer | yes | An id of a batch |
| fields | string | no | Limit fields received in response. E.g. fields: id, name or fields items (id, name), see more at [partial… |

### Update a batch
`POST https://zieapi.vercel.app/v1/communication:callfire/update-campaign-batch` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | integer | yes | An id of a batch to update |
| body | object | no | JSON request body |

### Find sounds
`GET https://zieapi.vercel.app/v1/communication:callfire/find-campaign-sounds` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| limit | integer | no | To set the maximum number of records to return in a paged list response. The default is 100 |
| offset | integer | no | Offset to the start of a given page. The default is 0. Check [pagination](https://developers.callfire.com/docs.html#pagination) page for… |
| filter | string | no | value to filter file names again; this value is used to check if the filename contains the filter value. |
| includeArchived | boolean | no | Includes ARCHIVED sounds for "true" value |
| includePending | boolean | no | Includes UPLOAD/RECORDING sounds for "true" value |
| includeScrubbed | boolean | no | Includes SCRUBBED sounds for "true" value |
| fields | string | no | Limit fields received in response. E.g. fields: id, name or fields items (id, name), see more at [partial… |

### Add sound via call
`POST https://zieapi.vercel.app/v1/communication:callfire/post-call-campaign-sound` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| fields | string | no | Limit fields received in response. E.g. fields: id, name or fields items (id, name), see more at [partial… |
| body | object | no | JSON request body |

### Add sound via file
`POST https://zieapi.vercel.app/v1/communication:callfire/post-file-campaign-sound` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| fields | string | no | Limit fields received in response. E.g. fields: id, name or fields items (id, name), see more at [partial… |
| body | object | yes | Form fields as a JSON object |

### Add sound via text-to-speech
`POST https://zieapi.vercel.app/v1/communication:callfire/post-ttscampaign-sound` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| fields | string | no | Limit fields received in response. E.g. fields: id, name or fields items (id, name), see more at [partial… |
| body | object | no | JSON request body |

### Find a specific sound
`GET https://zieapi.vercel.app/v1/communication:callfire/get-campaign-sound` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | integer | yes | An id of a sound campaign |
| fields | string | no | Limit fields received in response. E.g. fields: id, name or fields items (id, name), see more at [partial… |

### Delete a specific sound
`POST https://zieapi.vercel.app/v1/communication:callfire/delete-campaign-sound` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | integer | yes | An id of a campaign sound |

### Download a MP3 sound
`GET https://zieapi.vercel.app/v1/communication:callfire/get-campaign-sound-data-mp3` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | integer | yes | An id of a campaign sound |

### Download a WAV sound
`GET https://zieapi.vercel.app/v1/communication:callfire/get-campaign-sound-data-wav` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | integer | yes | An id of a campaign sound |

### Find contacts
`GET https://zieapi.vercel.app/v1/communication:callfire/find-contacts` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| fields | string | no | Limit fields received in response. E.g. fields: id, name or fields items (id, name), see more at [partial… |
| limit | integer | no | To set the maximum number of records to return in a paged list response. The default is 100 |
| offset | integer | no | Offset to the start of a given page. The default is 0. Check [pagination](https://developers.callfire.com/docs.html#pagination) page for… |
| id | array | no | A list of contact IDs. If the id parameter is included, the other query parameters are ignored. |
| number | array | no | Multiple contact numbers can be specified. If the number parameter is included, the other query parameters are ignored. |
| contactListId | integer | no | Filters contacts by a particular contact list |
| propertyName | string | no | Name of a contact property to search by |
| propertyValue | string | no | Value of a contact property to search by |

### Create contacts
`POST https://zieapi.vercel.app/v1/communication:callfire/create-contacts` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### Find do not contact (dnc) items
`GET https://zieapi.vercel.app/v1/communication:callfire/find-do-not-contacts` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| fields | string | no | Limit fields received in response. E.g. fields: id, name or fields items (id, name), see more at [partial… |
| limit | integer | no | To set the maximum number of records to return in a paged list response. The default is 100 |
| offset | integer | no | Offset to the start of a given page. The default is 0. Check [pagination](https://developers.callfire.com/docs.html#pagination) page for… |
| prefix | string | no | Prefix (1-10 digits) of phone numbers |
| campaignId | integer | no | A campaign id which was used to send a message to a DNC number |
| source | string | no | A DNC source name to search for DNCs |
| call | boolean | no | Show only Do-Not-Call numbers |
| text | boolean | no | Show only Do-Not-Text numbers |
| inboundCall | boolean | no | ~ |
| inboundText | boolean | no | ~ |
| number | array | no | ~ |

### Add do not contact (dnc) numbers
`POST https://zieapi.vercel.app/v1/communication:callfire/add-do-not-contacts` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### Delete do not contact (dnc) numbers contained in source.
`POST https://zieapi.vercel.app/v1/communication:callfire/delete-do-not-contacts-by-source` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| source | string | yes | Source associated with Do Not Contact (DNC) entry. |

### Find universal do not contacts (udnc) associated with toNumber
`GET https://zieapi.vercel.app/v1/communication:callfire/get-universal-do-not-contacts` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| toNumber | string | yes | A required destination phone number in E.164 format (11-digit). Example: 12132000384 |
| fromNumber | string | no | An optional destination/source number for DNC, specified in E.164 format (11-digit). Example: 12132000384 |
| fields | string | no | Limit fields received in response. E.g. fields: id, name or fields items (id, name), see more at [partial… |

### Get do not contact (dnc)
`GET https://zieapi.vercel.app/v1/communication:callfire/get-do-not-contact` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| number | string | yes | Number associated with Do Not Contact (DNC) entry. |

### Update an individual do not contact (dnc) number
`POST https://zieapi.vercel.app/v1/communication:callfire/update-do-not-contact` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| number | string | yes | ~ |
| body | object | no | JSON request body |

### Delete do not contact (dnc) number. If number contains commas treat as list of numbers
`POST https://zieapi.vercel.app/v1/communication:callfire/delete-do-not-contact` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| number | string | yes | Number associated with Do Not Contact (DNC) entry. |

### Find contact lists
`GET https://zieapi.vercel.app/v1/communication:callfire/find-contact-lists` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| fields | string | no | Limit fields received in response. E.g. fields: id, name or fields items (id, name), see more at [partial… |
| limit | integer | no | To set the maximum number of records to return in a paged list response. The default is 100 |
| offset | integer | no | Offset to the start of a given page. The default is 0. Check [pagination](https://developers.callfire.com/docs.html#pagination) page for… |
| name | string | no | A name or a partial name of a contact list |
| exactMatch | boolean | no | ~ |
| contactCount | integer | no | ~ |
| orderBy | string | no | ~ |

### Create contact lists
`POST https://zieapi.vercel.app/v1/communication:callfire/create-contact-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| fields | string | no | Limit fields received in response. E.g. fields: id, name or fields items (id, name), see more at [partial… |
| body | object | no | JSON request body |

### Create contact list from file
`POST https://zieapi.vercel.app/v1/communication:callfire/create-contact-list-from-file` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | Form fields as a JSON object |

### Find a specific contact list
`GET https://zieapi.vercel.app/v1/communication:callfire/get-contact-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | integer | yes | An id of a contact list to return |
| fields | string | no | Limit fields received in response. E.g. fields: id, name or fields items (id, name), see more at [partial… |

### Update a contact list
`POST https://zieapi.vercel.app/v1/communication:callfire/update-contact-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | integer | yes | An id of contact list to update |
| body | object | no | JSON request body |

### Delete a contact list
`POST https://zieapi.vercel.app/v1/communication:callfire/delete-contact-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | integer | yes | An id of the contact list to be deleted |

### Find contacts in a contact list
`GET https://zieapi.vercel.app/v1/communication:callfire/get-contact-list-items` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | integer | yes | An id of a contact list |
| fields | string | no | Limit fields received in response. E.g. fields: id, name or fields items (id, name), see more at [partial… |
| limit | integer | no | To set the maximum number of records to return in a paged list response. The default is 100 |
| offset | integer | no | Offset to the start of a given page. The default is 0. Check [pagination](https://developers.callfire.com/docs.html#pagination) page for… |

### Add contacts to a contact list
`POST https://zieapi.vercel.app/v1/communication:callfire/add-contact-list-items` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | integer | yes | An id of a contact list |
| body | object | no | JSON request body |

### Delete contacts from a contact list
`POST https://zieapi.vercel.app/v1/communication:callfire/remove-contact-list-items` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | integer | yes | A id of a contact list |
| contactId | array | no | An id of a contact entity in the CallFire system |

### Delete a contact from a contact list
`POST https://zieapi.vercel.app/v1/communication:callfire/remove-contact-list-item` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | integer | yes | An id of a contact list |
| contactId | integer | yes | An id of a contact |

### Find a specific contact
`GET https://zieapi.vercel.app/v1/communication:callfire/get-contact` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | integer | yes | An id of a contact |
| fields | string | no | Limit fields received in response. E.g. fields: id, name or fields items (id, name), see more at [partial… |

### Update a contact
`POST https://zieapi.vercel.app/v1/communication:callfire/update-contact` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | integer | yes | An id of a contact |
| body | object | no | JSON request body |

### Delete a contact
`POST https://zieapi.vercel.app/v1/communication:callfire/delete-contact` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | integer | yes | An Id of a contact |

### Find a contact's history
`GET https://zieapi.vercel.app/v1/communication:callfire/get-contact-history` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | integer | yes | An Id of a contact |
| limit | integer | no | To set the maximum number of records to return in a paged list response. The default is 100 |
| offset | integer | no | Offset to the start of a given page. The default is 0. Check [pagination](https://developers.callfire.com/docs.html#pagination) page for… |
| fields | string | no | Limit fields received in response. E.g. fields: id, name or fields items (id, name), see more at [partial… |

### Find keywords
`GET https://zieapi.vercel.app/v1/communication:callfire/find-keywords` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| keywords | array | no | A keyword to search for |

### Find keyword leases
`GET https://zieapi.vercel.app/v1/communication:callfire/find-keyword-leases` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| limit | integer | no | To set the maximum number of records to return in a paged list response. The default is 100 |
| offset | integer | no | Offset to the start of a given page. The default is 0. Check [pagination](https://developers.callfire.com/docs.html#pagination) page for… |
| filter | string | no | Filter by part of Keyword name or Label name of Keyword |
| labelName | string | no | An exact label name to search by |
| fields | string | no | Limit fields received in response. E.g. fields: id, name or fields items (id, name), see more at [partial… |

### Find keyword lease configs
`GET https://zieapi.vercel.app/v1/communication:callfire/find-keyword-lease-configs` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| limit | integer | no | To set the maximum number of records to return in a paged list response. The default is 100 |
| offset | integer | no | Offset to the start of a given page. The default is 0. Check [pagination](https://developers.callfire.com/docs.html#pagination) page for… |
| filter | string | no | Filter by part of Keyword name or Label name of Keyword |
| labelName | string | no | An exact label name to search by |
| fields | string | no | Limit fields received in response. E.g. fields: id, name or fields items (id, name), see more at [partial… |

### Find a specific keyword lease config
`GET https://zieapi.vercel.app/v1/communication:callfire/get-keyword-lease-config` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| keyword | string | yes | A Keyword to get KeywordConfig by |
| fields | string | no | Limit fields received in response. E.g. fields: id, name or fields items (id, name), see more at [partial… |

### Update a keyword lease config
`POST https://zieapi.vercel.app/v1/communication:callfire/update-keyword-lease-config` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| keyword | string | yes | To update a keyword lease config |
| body | object | no | JSON request body |

### Find a keyword by id
`GET https://zieapi.vercel.app/v1/communication:callfire/get-keyword-lease-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | integer | yes | ~ |
| fields | string | no | Limit fields received in response. E.g. fields: id, name or fields items (id, name), see more at [partial… |

### Find a specific lease
`GET https://zieapi.vercel.app/v1/communication:callfire/get-keyword-lease` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| keyword | string | yes | Keyword text that a lease is desired for |
| fields | string | no | Limit fields received in response. E.g. fields: id, name or fields items (id, name), see more at [partial… |

### Update a lease
`POST https://zieapi.vercel.app/v1/communication:callfire/update-keyword-lease` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| keyword | string | yes | To update a keyword lease |
| body | object | no | JSON request body |

### Check for a specific keyword
`GET https://zieapi.vercel.app/v1/communication:callfire/is-keyword-available` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| keyword | string | yes | To specify a keyword to search for. Example: SUN, MOON |

### Find account details
`GET https://zieapi.vercel.app/v1/communication:callfire/get-account` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| fields | string | no | Limit fields received in response. E.g. fields: id, name or fields items (id, name), see more at [partial… |

### Find api credentials
`GET https://zieapi.vercel.app/v1/communication:callfire/find-api-credentials` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| name | string | no | Filter by name |
| fields | string | no | Limit fields received in response. E.g. fields: id, name or fields items (id, name), see more at [partial… |
| limit | integer | no | To set the maximum number of records to return in a paged list response. The default is 100 |
| offset | integer | no | Offset to the start of a given page. The default is 0. Check [pagination](https://developers.callfire.com/docs.html#pagination) page for… |

### Create api credentials
`POST https://zieapi.vercel.app/v1/communication:callfire/create-api-credential` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### Find a specific api credential
`GET https://zieapi.vercel.app/v1/communication:callfire/get-api-credential` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | integer | yes | An id of an API credential |
| fields | string | no | Limit fields received in response. E.g. fields: id, name or fields items (id, name), see more at [partial… |

### Delete api credentials
`POST https://zieapi.vercel.app/v1/communication:callfire/delete-api-credential` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | integer | yes | An id of an API credential |

### Disable specified API credentials
`POST https://zieapi.vercel.app/v1/communication:callfire/disable-api-credentials` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | integer | yes | An id of an API credential |

### Enable specified API credentials
`POST https://zieapi.vercel.app/v1/communication:callfire/enable-api-credentials` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | integer | yes | An id of an API credential |

### Find credit usage
`GET https://zieapi.vercel.app/v1/communication:callfire/get-credit-usage` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| intervalBegin | integer | no | Beginning of usage period formatted in unix time milliseconds. Example: 1473781817000 |
| intervalEnd | integer | no | End of usage period formatted in unix time milliseconds. Example: 1473781817000 |

### Find plan usage
`GET https://zieapi.vercel.app/v1/communication:callfire/get-billing-plan-usage` (byok)

### Find caller ids
`GET https://zieapi.vercel.app/v1/communication:callfire/get-caller-ids` (byok)

### Create a caller id
`POST https://zieapi.vercel.app/v1/communication:callfire/send-verification-code-to-caller-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| callerid | string | yes | A phone number in E.164 format (11-digit) which needs to be verified. Example: 12132000384 |

### Verify a caller id
`POST https://zieapi.vercel.app/v1/communication:callfire/verify-caller-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| callerid | string | yes | A phone number in E.164 format (11-digit) which needs to be verified. Example: 12132000384 |
| body | object | no | JSON request body |

### Find media
`GET https://zieapi.vercel.app/v1/communication:callfire/find-media` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| limit | integer | no | To set the maximum number of records to return in a paged list response. The default is 100 |
| offset | integer | no | Offset to the start of a given page. The default is 0. Check [pagination](https://developers.callfire.com/docs.html#pagination) page for… |
| filter | string | no | value to filter file names again; this value is used to check if the filename contains the filter value. |
| fields | string | no | Limit fields received in response. E.g. fields: id, name or fields items (id, name), see more at [partial… |

### Create media
`POST https://zieapi.vercel.app/v1/communication:callfire/create-media` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | Form fields as a JSON object |

### Download media by extension
`GET https://zieapi.vercel.app/v1/communication:callfire/get-media-data-by-key` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| key | string | yes | A hash-key of a media resource |
| extension | string | yes | Media file type, available types: bmp, gif, jpg, m4a, mp3, mp4, png, wav |

### Get a specific media
`GET https://zieapi.vercel.app/v1/communication:callfire/get-media` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | integer | yes | An id of a media resource |
| fields | string | no | Limit fields received in response. E.g. fields: id, name or fields items (id, name), see more at [partial… |

### Download media by extension
`GET https://zieapi.vercel.app/v1/communication:callfire/get-media-data` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | integer | yes | An id of a media resource |
| extension | string | yes | Media file type. Available types: bmp, gif, jpg, m4a, mp3, mp4, png, wav |

### Download a MP3 media
`GET https://zieapi.vercel.app/v1/communication:callfire/get-media-data-binary` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | integer | yes | An id of a media resource |

### Find leases
`GET https://zieapi.vercel.app/v1/communication:callfire/find-number-leases` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| limit | integer | no | To set the maximum number of records to return in a paged list response. The default is 100 |
| offset | integer | no | Offset to the start of a given page. The default is 0. Check [pagination](https://developers.callfire.com/docs.html#pagination) page for… |
| prefix | string | no | A 4-7 digit prefix |
| city | string | no | A city name |
| state | string | no | A two-letter state code. Example: CA, IL, etc. |
| zipcode | string | no | A five-digit Zipcode |
| labelName | string | no | A label name |
| tollFree | boolean | no | ~ |
| fields | string | no | Limit fields received in response. E.g. fields: id, name or fields items (id, name), see more at [partial… |

### Find lease configs
`GET https://zieapi.vercel.app/v1/communication:callfire/find-number-lease-configs` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| limit | integer | no | To set the maximum number of records to return in a paged list response. The default is 100 |
| offset | integer | no | Offset to the start of a given page. The default is 0. Check [pagination](https://developers.callfire.com/docs.html#pagination) page for… |
| prefix | string | no | A 4-7 digit prefix |
| city | string | no | A city name |
| state | string | no | A two-letter state code. Example: CA, IL, etc. |
| zipcode | string | no | A five-digit Zipcode |
| labelName | string | no | A label name |
| fields | string | no | Limit fields received in response. E.g. fields: id, name or fields items (id, name), see more at [partial… |

### Find a specific lease config
`GET https://zieapi.vercel.app/v1/communication:callfire/get-number-lease-config` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| number | string | yes | A phone number in E.164 format (11-digit). Example: 12132000384 |
| fields | string | no | Limit fields received in response. E.g. fields: id, name or fields items (id, name), see more at [partial… |

### Update a lease config
`POST https://zieapi.vercel.app/v1/communication:callfire/update-number-lease-config` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| number | string | yes | A phone number in E.164 format (11-digit) which needs to be verified. Example: 12132000384 |
| body | object | no | JSON request body |

### Find a specific lease
`GET https://zieapi.vercel.app/v1/communication:callfire/get-number-lease` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| number | string | yes | A phone number in E.164 format (11-digit). Example: 12132000384 |
| fields | string | no | Limit fields received in response. E.g. fields: id, name or fields items (id, name), see more at [partial… |

### Update a lease
`POST https://zieapi.vercel.app/v1/communication:callfire/update-number-lease` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| number | string | yes | A phone number in E.164 format (11-digit). Example: 12132000384 |
| body | object | no | JSON request body |

### Find local numbers
`GET https://zieapi.vercel.app/v1/communication:callfire/find-numbers-local` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| limit | integer | no | To set the maximum number of records to return in a paged list response. The default is 100 |
| prefix | string | no | A 4-7 digit prefix |
| city | string | no | A city name |
| state | string | no | A two-letter state code. Example: CA, IL, etc. |
| zipcode | string | no | A five-digit Zipcode |
| fields | string | no | Limit fields received in response. E.g. fields: id, name or fields items (id, name), see more at [partial… |

### Find number regions
`GET https://zieapi.vercel.app/v1/communication:callfire/find-number-regions` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| limit | integer | no | To set the maximum number of records to return in a paged list response. The default is 100 |
| offset | integer | no | Offset to the start of a given page. The default is 0. Check [pagination](https://developers.callfire.com/docs.html#pagination) page for… |
| prefix | string | no | A 4-7 digit prefix |
| city | string | no | A city name |
| cityPrefix | string | no | ~ |
| state | string | no | A two-letter state code. Example: CA, IL, etc. |
| zipcode | string | no | A five-digit Zipcode |
| country | string | no | ~ |
| fields | string | no | Limit fields received in response. E.g. fields: id, name or fields items (id, name), see more at [partial… |

### Find tollfree numbers
`GET https://zieapi.vercel.app/v1/communication:callfire/find-numbers-tollfree` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| pattern | string | no | Filter toll free numbers by prefix, pattern must be 3 char long and should end with '*'. Examples: 8**, 85*, 87* (but 855 will fail… |
| limit | integer | no | To set the maximum number of records to return in a paged list response. The default is 100 |
| fields | string | no | Limit fields received in response. E.g. fields: id, name or fields items (id, name), see more at [partial… |

### Find orders
`GET https://zieapi.vercel.app/v1/communication:callfire/find-orders` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| limit | integer | no | To set the maximum number of records to return in a paged list response. The default is 100 |
| offset | integer | no | Offset to the start of a given page. The default is 0. Check [pagination](https://developers.callfire.com/docs.html#pagination) page for… |
| fields | string | no | Limit fields received in response. E.g. fields: id, name or fields items (id, name), see more at [partial… |
| status | array | no | Filter by order status, accepts multiple values in comma separated string, available values: [PROCESSING, FINISHED, PAYMENT_ERROR, VOID,… |
| intervalBegin | integer | no | Start of the find time interval, formatted in unix time milliseconds. Example: 1473781817000 |
| intervalEnd | integer | no | End of the find time interval, formatted in unix time milliseconds. Example: 1473781817000 |

### Purchase keywords
`POST https://zieapi.vercel.app/v1/communication:callfire/order-keywords` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| fields | string | no | Limit fields received in response. E.g. fields: id, name or fields items (id, name), see more at [partial… |
| body | object | no | JSON request body |

### Purchase numbers
`POST https://zieapi.vercel.app/v1/communication:callfire/order-numbers` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| fields | string | no | Limit fields received in response. E.g. fields: id, name or fields items (id, name), see more at [partial… |
| body | object | no | JSON request body |

### Find a specific order
`GET https://zieapi.vercel.app/v1/communication:callfire/get-order` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | integer | yes | An id of an order |
| fields | string | no | Limit fields received in response. E.g. fields: id, name or fields items (id, name), see more at [partial… |

### Get delivery reports by ad hoc criteria
`GET https://zieapi.vercel.app/v1/communication:callfire/get-delivery-reports` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| startDate | string | no | ~ |
| endDate | string | no | ~ |
| limit | integer | no | To set the maximum number of records to return in a paged list response. The default is 100 |
| offset | integer | no | Offset to the start of a given page. The default is 0. Check [pagination](https://developers.callfire.com/docs.html#pagination) page for… |
| campaignId | integer | no | ~ |
| fromNumber | string | no | ~ |
| toNumber | string | no | ~ |
| deliveryCategory | string | no | ~ |
| deliveryState | string | no | ~ |
| carrier | string | no | ~ |
| messageText | string | no | ~ |

### Find texts
`GET https://zieapi.vercel.app/v1/communication:callfire/find-texts` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | array | no | List of Text ids to search for, if ids specified other query params ignored |
| campaignId | integer | no | An id of a campaign, queries for texts inside a particular campaign. Specify null to list texts of all campaigns or 0 for a default campaign |
| batchId | integer | no | An Id of a contact batch, queries for texts which are used in the particular contact batch |
| fromNumber | string | no | A phone number in E.164 format (11-digit). Example: 12132000384, 67076 |
| toNumber | string | no | A phone number in E.164 format (11-digit). Example: 12132000384, 67076 |
| label | string | no | A label of a text message |
| states | string | no | Expected text statuses in comma separated string, available values: READY, SELECTED, CALLBACK, FINISHED, DISABLED, DNC, DUP, INVALID,… |
| results | string | no | Expected text results in comma separated string, available values: SENT, RECEIVED, DNT, TOO_BIG, INTERNAL_ERROR, CARRIER_ERROR,… |
| inbound | boolean | no | Specify true for inbound or false for outbounds. Do not specify this parameter if you need to get both inbound and outbound texts listed… |
| intervalBegin | integer | no | Start of the find time interval, formatted in unix time milliseconds. Example: 1473781817000 |
| intervalEnd | integer | no | End of the find time interval, formatted in unix time milliseconds. Example: 1473781817000 |
| limit | integer | no | To set the maximum number of records to return in a paged list response. The default is 100 |
| offset | integer | no | Offset to the start of a given page. The default is 0. Check [pagination](https://developers.callfire.com/docs.html#pagination) page for… |
| fields | string | no | Limit fields received in response. E.g. fields: id, name or fields items (id, name), see more at [partial… |

### Send texts
`POST https://zieapi.vercel.app/v1/communication:callfire/send-texts` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| fields | string | no | Limit fields received in response. E.g. fields: id, name or fields items (id, name), see more at [partial… |
| campaignId | integer | no | Specifies a campaignId to send texts through a previously created campaign |
| defaultMessage | string | no | Text message can be overridden by TextRecipient.message field. If multiple recipients have the same text message to a different recipients… |
| strictValidation | boolean | no | Turns on strict validation for recipients |
| body | object | no | JSON request body |

### Find auto replies
`GET https://zieapi.vercel.app/v1/communication:callfire/find-text-auto-replys` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| fields | string | no | Limit fields received in response. E.g. fields: id, name or fields items (id, name), see more at [partial… |
| limit | integer | no | To set the maximum number of records to return in a paged list response. The default is 100 |
| offset | integer | no | Offset to the start of a given page. The default is 0. Check [pagination](https://developers.callfire.com/docs.html#pagination) page for… |
| number | string | no | Phone number in E.164 format (11-digit) which contains a TextAutoReply. Example: 12132000384. If number is empty then operator returns all… |

### Create an auto reply
`POST https://zieapi.vercel.app/v1/communication:callfire/create-text-auto-reply` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### Find a specific auto reply
`GET https://zieapi.vercel.app/v1/communication:callfire/get-text-auto-reply` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | integer | yes | An id of a text auto reply |
| fields | string | no | Limit fields received in response. E.g. fields: id, name or fields items (id, name), see more at [partial… |

### Delete an auto reply
`POST https://zieapi.vercel.app/v1/communication:callfire/delete-text-auto-reply` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | integer | yes | An id of a text auto reply |

### Find text broadcasts
`GET https://zieapi.vercel.app/v1/communication:callfire/find-text-broadcasts` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| name | string | no | A name of text broadcast |
| label | string | no | A label of a text broadcast |
| running | boolean | no | Returns broadcasts only in running state. |
| scheduled | boolean | no | Specify whether the campaigns should be scheduled or not |
| intervalBegin | integer | no | Start of the find time interval, formatted in unix time milliseconds. Example: 1473781817000 for Sat, 05 Jan 1985 14:03:37 GMT |
| intervalEnd | integer | no | End of the find time interval, formatted in unix time milliseconds. Example: 1473781817000 for Sat, 05 Jan 1985 14:03:37 GMT |
| limit | integer | no | To set the maximum number of records to return in a paged list response. The default is 100 |
| offset | integer | no | Offset to the start of a given page. The default is 0. Check [pagination](https://developers.callfire.com/docs.html#pagination) page for… |
| fields | string | no | Limit fields received in response. E.g. fields: id, name or fields items (id, name), see more at [partial… |

### Create a text broadcast
`POST https://zieapi.vercel.app/v1/communication:callfire/create-text-broadcast` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| start | boolean | no | If true then starts the campaign immediately (not required). |
| strictValidation | boolean | no | Turns on strict validation for recipients. System will reply with BAD_REQUEST(400) if strictValidation = true and one of numbers didn't… |
| body | object | no | JSON request body |

### Find a specific text broadcast
`GET https://zieapi.vercel.app/v1/communication:callfire/get-text-broadcast` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | integer | yes | An id of a text broadcast |
| fields | string | no | Limit fields received in response. E.g. fields: id, name or fields items (id, name), see more at [partial… |

### Update a text broadcast
`POST https://zieapi.vercel.app/v1/communication:callfire/update-text-broadcast` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | integer | yes | An id of a text broadcast |
| strictValidation | boolean | no | Turns on strict validation for recipients. System will reply with BAD_REQUEST(400) if strictValidation = true and one of numbers didn't… |
| body | object | no | JSON request body |

### Archive text broadcast
`POST https://zieapi.vercel.app/v1/communication:callfire/archive-text-broadcast` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | integer | yes | An id of a text broadcast to archive |

### Find batches in a text broadcast
`GET https://zieapi.vercel.app/v1/communication:callfire/get-text-broadcast-batches` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | integer | yes | An id of a text broadcast |
| fields | string | no | Limit fields received in response. E.g. fields: id, name or fields items (id, name), see more at [partial… |
| limit | integer | no | To set the maximum number of records to return in a paged list response. The default is 100 |
| offset | integer | no | Offset to the start of a given page. The default is 0. Check [pagination](https://developers.callfire.com/docs.html#pagination) page for… |

### Add batches to a text broadcast
`POST https://zieapi.vercel.app/v1/communication:callfire/add-text-broadcast-batch` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | integer | yes | An id of a text broadcast |
| strictValidation | boolean | no | Turns on strict validation for recipients. System will reply with BAD_REQUEST(400) if strictValidation = true and one of numbers didn't… |
| body | object | no | JSON request body |

### Add recipients to a text broadcast
`POST https://zieapi.vercel.app/v1/communication:callfire/add-text-broadcast-recipients` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | integer | yes | An id of a text broadcast |
| fields | string | no | Limit fields received in response. E.g. fields: id, name or fields items (id, name), see more at [partial… |
| strictValidation | boolean | no | Turns on strict validation for recipients. System will reply with BAD_REQUEST(400) if strictValidation = true and one of numbers didn't… |
| body | object | no | JSON request body |

### Start text broadcast
`POST https://zieapi.vercel.app/v1/communication:callfire/start-text-broadcast` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | integer | yes | An id of a text broadcast to start |

### Get statistics on text broadcast
`GET https://zieapi.vercel.app/v1/communication:callfire/get-text-broadcast-stats` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | integer | yes | An id of a text broadcast |
| fields | string | no | Limit fields received in response. E.g. fields: id, name or fields items (id, name), see more at [partial… |
| begin | integer | no | Start of a search find time interval, formatted in unix time milliseconds. Example: 1473781817000 for Sat, 05 Jan 1985 14:03:37 GMT |
| end | integer | no | End of a search time interval, formatted in unix time milliseconds. Example: 1473781817000 for Sat, 05 Jan 1985 14:03:37 GMT |

### Stop text broadcast
`POST https://zieapi.vercel.app/v1/communication:callfire/stop-text-broadcast` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | integer | yes | An Id of a text broadcast. To stop the broadcast |

### Find texts in a text broadcast
`GET https://zieapi.vercel.app/v1/communication:callfire/get-text-broadcast-texts` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | integer | yes | An id of a text broadcast |
| batchId | integer | no | ~ |
| fields | string | no | Limit fields received in response. E.g. fields: id, name or fields items (id, name), see more at [partial… |
| limit | integer | no | To set the maximum number of records to return in a paged list response. The default is 100 |
| offset | integer | no | Offset to the start of a given page. The default is 0. Check [pagination](https://developers.callfire.com/docs.html#pagination) page for… |

### Disable/enable undialed recipients in broadcast
`POST https://zieapi.vercel.app/v1/communication:callfire/toggle-text-broadcast-recipients-status` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | integer | yes | An id of a text broadcast |
| enable | boolean | no | Flag which indicate what to do with texts (true will enable texts in DISABLED status and vice versa) |
| body | object | no | JSON request body |

### Find a specific text
`GET https://zieapi.vercel.app/v1/communication:callfire/get-text` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | integer | yes | An id of a text |
| fields | string | no | Limit fields received in response. E.g. fields: id, name or fields items (id, name), see more at [partial… |

### Find webhooks
`GET https://zieapi.vercel.app/v1/communication:callfire/find-webhooks` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| fields | string | no | Limit fields received in response. E.g. fields: id, name or fields items (id, name), see more at [partial… |
| limit | integer | no | To set the maximum number of records to return in a paged list response. The default is 100 |
| offset | integer | no | Offset to the start of a given page. The default is 0. Check [pagination](https://developers.callfire.com/docs.html#pagination) page for… |
| name | string | no | A name of a webhook |
| resource | string | no | A name of a resource, available values: 'CccCampaign', 'CallBroadcast', 'TextBroadcast', 'OutboundCall', 'OutboundText', 'InboundCall',… |
| event | string | no | A name of event, available values: 'started', 'stopped', 'finished' |
| callback | string | no | A callback URL |
| enabled | boolean | no | Specifies whether webhook is enabled |

### Create a webhook
`POST https://zieapi.vercel.app/v1/communication:callfire/create-webhook` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### Find webhook resources
`GET https://zieapi.vercel.app/v1/communication:callfire/find-webhook-resources` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| fields | string | no | Limit fields received in response. E.g. fields: id, name or fields items (id, name), see more at [partial… |

### Find specific webhook resource
`GET https://zieapi.vercel.app/v1/communication:callfire/get-webhook-resource` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| resource | string | yes | A name of a webhook resource. Available resources include 'CccCampaign': ['started', 'stopped', 'finished'], 'CallBroadcast': ['started',… |
| fields | string | no | Limit fields received in response. E.g. fields: id, name or fields items (id, name), see more at [partial… |

### Find a specific webhook
`GET https://zieapi.vercel.app/v1/communication:callfire/get-webhook` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | integer | yes | An id of a webhook |
| fields | string | no | Limit fields received in response. E.g. fields: id, name or fields items (id, name), see more at [partial… |

…and 2 more. See the OpenAPI spec.

## Example
```
curl "https://zieapi.vercel.app/v1/communication:callfire/find-calls" \
  -H "x-api-key: $APIZIE_KEY" \
  -H "x-upstream-key: $PROVIDER_KEY"
```

## FAQ

### How do I call the CallFire API Documentation API?
Create a free Apizie key, then send GET https://zieapi.vercel.app/v1/communication:callfire/find-calls with the header x-api-key. Every endpoint returns { project, data, timestamp }.

### Is the CallFire API Documentation API free on Apizie?
Yes. The Free plan includes 1,000 requests a month at 100 requests a minute, no credit card. CallFire API Documentation itself also needs your own key from callfire.com.

### Can AI agents use the CallFire API Documentation API?
Yes. Add the Apizie MCP server (https://zieapi.vercel.app/mcp) to Claude, ChatGPT, Cursor or VS Code, then ask in plain language. The agent calls run_scraper with project key communication:callfire.

### What is the status of the CallFire API Documentation API?
Needs your own provider key (bring your own key)