/calls/broadcasts/{id}/batches

Add batches to a call broadcast

• id (path, required) — An id of a call broadcast
• strictValidation (query) — Turns on strict validation for recipients. System will reply with BAD_REQUEST(400) if strictValidation = true and one of numbers didn't pass validation

/calls/broadcasts/{id}/calls

Find calls in a call broadcast

• id (path, required) — An Id of a call broadcast
• batchId (query) — An id of a particular batch associated with broadcast
• fields (query) — Limit fields received in response. E.g. fields: id, name or fields items (id, name), see more at [partial response](https://developers.callfire.com/docs.html#partial-response) page.
• limit (query, limit) — To set the maximum number of records to return in a paged list response. The default is 100
• offset (query, offset) — Offset to the start of a given page. The default is 0. Check [pagination](https://developers.callfire.com/docs.html#pagination) page for more information about pagination in CallFire API.

/calls/broadcasts/{id}/recipients

Add recipients to a call broadcast

• id (path, required) — An id of a call broadcast
• fields (query) — Limit fields received in response. E.g. fields: id, name or fields items (id, name), see more at [partial response](https://developers.callfire.com/docs.html#partial-response) page.
• strictValidation (query) — Turns on strict validation for recipients. System will reply with BAD_REQUEST(400) if strictValidation = true and one of numbers didn't pass validation

/calls/broadcasts/{id}/start

Start voice broadcast

• id (path, required) — An id of voice broadcast to start

/calls/broadcasts/{id}/stats

Get statistics on call broadcast

• id (path, required) — An id of a call broadcast
• fields (query) — Limit fields received in response. E.g. fields: id, name or fields items (id, name), see more at [partial response](https://developers.callfire.com/docs.html#partial-response) page.
• begin (query) — Start of the search time interval, formatted in unix time milliseconds. Example: 1473781817000 for Sat, 05 Jan 1985 14:03:37 GMT
• end (query) — End of the search time interval, formatted in unix time milliseconds. Example: 1473781817000 for Sat, 05 Jan 1985 14:03:37 GMT

/calls/broadcasts/{id}/stop

Stop voice broadcast

• id (path, required) — An id of voice broadcast to stop

/calls/broadcasts/{id}/toggleRecipientsStatus

Disable/enable undialed recipients in broadcast

• id (path, required) — An id of a voice broadcast
• enable (query) — Flag which indicate what to do with calls (true will enable call in DISABLED status and vice versa)

/calls/recordings/{id}

Get call recording by id

• id (path, required) — ~
• fields (query) — Limit fields received in response. E.g. fields: id, name or fields items (id, name), see more at [partial response](https://developers.callfire.com/docs.html#partial-response) page.

/calls/recordings/{id}.mp3

Get call recording in mp3 format

• id (path, required) — An id of a call

/calls/{id}

Find a specific call

• id (path, required) — An id of a call
• fields (query) — Limit fields received in response. E.g. fields: id, name or fields items (id, name), see more at [partial response](https://developers.callfire.com/docs.html#partial-response) page.

/calls/{id}/recordings

Get call recordings for a call

• id (path, required) — An id of a call
• fields (query) — Limit fields received in response. E.g. fields: id, name or fields items (id, name), see more at [partial response](https://developers.callfire.com/docs.html#partial-response) page.

/calls/{id}/recordings/{name}

Get call recording by name

• id (path, required) — An id of a call
• name (path, required) — A name of a recording
• fields (query) — Limit fields received in response. E.g. fields: id, name or fields items (id, name), see more at [partial response](https://developers.callfire.com/docs.html#partial-response) page.

/calls/{id}/recordings/{name}.mp3

Get call mp3 recording by name

• id (path, required) — An id of a call
• name (path, required) — A name of a recording

/campaigns/batches/{id}

Find a specific batch

• id (path, required) — An id of a batch
• fields (query) — Limit fields received in response. E.g. fields: id, name or fields items (id, name), see more at [partial response](https://developers.callfire.com/docs.html#partial-response) page.

/campaigns/batches/{id}

Update a batch

• id (path, required) — An id of a batch to update

/contacts/dncs/universals/{toNumber}

Find universal do not contacts (udnc) associated with toNumber

• toNumber (path, required) — A required destination phone number in E.164 format (11-digit). Example: 12132000384
• fromNumber (query) — An optional destination/source number for DNC, specified in E.164 format (11-digit). Example: 12132000384
• fields (query) — Limit fields received in response. E.g. fields: id, name or fields items (id, name), see more at [partial response](https://developers.callfire.com/docs.html#partial-response) page.

/contacts/dncs/{number}

Delete do not contact (dnc) number. If number contains commas treat as list of numbers

• number (path, required) — Number associated with Do Not Contact (DNC) entry.

/contacts/dncs/{number}

Get do not contact (dnc)

• number (path, required) — Number associated with Do Not Contact (DNC) entry.

/contacts/dncs/{number}

Update an individual do not contact (dnc) number

• number (path, required) — ~

/contacts/lists/{id}

Find a specific contact list

• id (path, required) — An id of a contact list to return
• fields (query) — Limit fields received in response. E.g. fields: id, name or fields items (id, name), see more at [partial response](https://developers.callfire.com/docs.html#partial-response) page.

/contacts/lists/{id}

Update a contact list

• id (path, required) — An id of contact list to update

/contacts/lists/{id}/items

Delete contacts from a contact list

• id (path, required) — A id of a contact list
• contactId (query) — An id of a contact entity in the CallFire system

/keywords/leases/id/{id}

Find a keyword by id

• id (path, required) — ~
• fields (query) — Limit fields received in response. E.g. fields: id, name or fields items (id, name), see more at [partial response](https://developers.callfire.com/docs.html#partial-response) page.

/keywords/leases/{keyword}

Find a specific lease

• keyword (path, required) — Keyword text that a lease is desired for
• fields (query) — Limit fields received in response. E.g. fields: id, name or fields items (id, name), see more at [partial response](https://developers.callfire.com/docs.html#partial-response) page.

/keywords/leases/{keyword}

Update a lease

• keyword (path, required) — To update a keyword lease

/keywords/{keyword}/available

Check for a specific keyword

• keyword (path, required) — To specify a keyword to search for. Example: SUN, MOON

/me/account

Find account details

• fields (query) — Limit fields received in response. E.g. fields: id, name or fields items (id, name), see more at [partial response](https://developers.callfire.com/docs.html#partial-response) page.

/texts/auto-replys/{id}

Delete an auto reply

• id (path, required) — An id of a text auto reply

/texts/auto-replys/{id}

Find a specific auto reply

• id (path, required) — An id of a text auto reply
• fields (query) — Limit fields received in response. E.g. fields: id, name or fields items (id, name), see more at [partial response](https://developers.callfire.com/docs.html#partial-response) page.

/texts/{id}

Find a specific text

• id (path, required) — An id of a text
• fields (query) — Limit fields received in response. E.g. fields: id, name or fields items (id, name), see more at [partial response](https://developers.callfire.com/docs.html#partial-response) page.

/contacts/lists/{id}/items

Find contacts in a contact list

• id (path, required) — An id of a contact list
• fields (query) — Limit fields received in response. E.g. fields: id, name or fields items (id, name), see more at [partial response](https://developers.callfire.com/docs.html#partial-response) page.
• limit (query, limit) — To set the maximum number of records to return in a paged list response. The default is 100
• offset (query, offset) — Offset to the start of a given page. The default is 0. Check [pagination](https://developers.callfire.com/docs.html#pagination) page for more information about pagination in CallFire API.

/contacts/lists/{id}/items

Add contacts to a contact list

• id (path, required) — An id of a contact list

/contacts/lists/{id}/items/{contactId}

Delete a contact from a contact list

• id (path, required) — An id of a contact list
• contactId (path, required) — An id of a contact

/contacts/{id}

Delete a contact

• id (path, required) — An Id of a contact

/contacts/{id}

Find a specific contact

• id (path, required) — An id of a contact
• fields (query) — Limit fields received in response. E.g. fields: id, name or fields items (id, name), see more at [partial response](https://developers.callfire.com/docs.html#partial-response) page.

/contacts/{id}

Update a contact

• id (path, required) — An id of a contact

/contacts/{id}/history

Find a contact's history

• id (path, required) — An Id of a contact
• limit (query, limit) — To set the maximum number of records to return in a paged list response. The default is 100
• offset (query, offset) — Offset to the start of a given page. The default is 0. Check [pagination](https://developers.callfire.com/docs.html#pagination) page for more information about pagination in CallFire API.
• fields (query) — Limit fields received in response. E.g. fields: id, name or fields items (id, name), see more at [partial response](https://developers.callfire.com/docs.html#partial-response) page.

/keywords

Find keywords

• keywords (query) — A keyword to search for

/keywords/leases

Find keyword leases

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

/keywords/leases/configs

Find keyword lease configs

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

/keywords/leases/configs/{keyword}

Find a specific keyword lease config

• keyword (path, required) — A Keyword to get KeywordConfig by
• fields (query) — Limit fields received in response. E.g. fields: id, name or fields items (id, name), see more at [partial response](https://developers.callfire.com/docs.html#partial-response) page.

/keywords/leases/configs/{keyword}

Update a keyword lease config

• keyword (path, required) — To update a keyword lease config

/contacts/lists

Find contact lists

• fields (query) — Limit fields received in response. E.g. fields: id, name or fields items (id, name), see more at [partial response](https://developers.callfire.com/docs.html#partial-response) page.
• limit (query, limit) — To set the maximum number of records to return in a paged list response. The default is 100
• offset (query, offset) — Offset to the start of a given page. The default is 0. Check [pagination](https://developers.callfire.com/docs.html#pagination) page for more information about pagination in CallFire API.
• name (query) — A name or a partial name of a contact list
• exactMatch (query) — ~
• contactCount (query) — ~
• orderBy (query) — ~

/contacts/lists

Create contact lists

• fields (query) — Limit fields received in response. E.g. fields: id, name or fields items (id, name), see more at [partial response](https://developers.callfire.com/docs.html#partial-response) page.

/contacts/lists/upload

Create contact list from file

/contacts/lists/{id}

Delete a contact list

• id (path, required) — An id of the contact list to be deleted

/calls

Find calls

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

/calls

Send calls

• fields (query) — Limit fields received in response. E.g. fields: id, name or fields items (id, name), see more at [partial response](https://developers.callfire.com/docs.html#partial-response) page.
• campaignId (query) — Specifies a campaignId to send calls quickly on a previously created campaign
• defaultLiveMessage (query) — Text to be turned into a sound, this text will be played when the phone is answered. Parameter can be overridden for any particular CallRecipient
• defaultMachineMessage (query) — Text to be turned into a sound, this text will be played when answering machine is detected. Parameter can be overridden for any particular CallRecipient
• defaultLiveMessageSoundId (query) — Id of sound file to play if phone is answered. Parameter can be overridden for any particular CallRecipient
• defaultMachineMessageSoundId (query) — An id of a sound file to play if answering machine is detected. Parameter can be overridden for any particular CallRecipient
• defaultVoice (query) — The voice set by default for all text-to-speech messages defined in CallRecipient objects or as default *Message properties
• strictValidation (query) — Turns on strict validation for recipients. System will reply with BAD_REQUEST(400) if strictValidation = true and one of numbers didn't pass validation

/calls/broadcasts

Find call broadcasts

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

/calls/broadcasts

Create a call broadcast

• start (query) — Specify whether to immediately start this campaign (not required)
• strictValidation (query) — Turns on strict validation for recipients. System will reply with BAD_REQUEST(400) if strictValidation = true and one of numbers didn't pass validation

/calls/broadcasts/{id}

Find a specific call broadcast

• id (path, required) — An id of a CallBroadcast
• fields (query) — Limit fields received in response. E.g. fields: id, name or fields items (id, name), see more at [partial response](https://developers.callfire.com/docs.html#partial-response) page.

/calls/broadcasts/{id}

Update a call broadcast

• id (path, required) — An id of a voice broadcast
• strictValidation (query) — Turns on strict validation for recipients. System will reply with BAD_REQUEST(400) if strictValidation = true and one of numbers didn't pass validation

/calls/broadcasts/{id}/archive

Archive voice broadcast

• id (path, required) — An id of a voice broadcast to archive

/calls/broadcasts/{id}/batches

Find batches in a call broadcast

• id (path, required) — An id of a call broadcast
• fields (query) — Limit fields received in response. E.g. fields: id, name or fields items (id, name), see more at [partial response](https://developers.callfire.com/docs.html#partial-response) page.
• limit (query, limit) — To set the maximum number of records to return in a paged list response. The default is 100
• offset (query, offset) — Offset to the start of a given page. The default is 0. Check [pagination](https://developers.callfire.com/docs.html#pagination) page for more information about pagination in CallFire API.

/campaigns/sounds

Find sounds

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

/campaigns/sounds/calls

Add sound via call

• fields (query) — Limit fields received in response. E.g. fields: id, name or fields items (id, name), see more at [partial response](https://developers.callfire.com/docs.html#partial-response) page.

/campaigns/sounds/files

Add sound via file

• fields (query) — Limit fields received in response. E.g. fields: id, name or fields items (id, name), see more at [partial response](https://developers.callfire.com/docs.html#partial-response) page.

/campaigns/sounds/tts

Add sound via text-to-speech

• fields (query) — Limit fields received in response. E.g. fields: id, name or fields items (id, name), see more at [partial response](https://developers.callfire.com/docs.html#partial-response) page.

/campaigns/sounds/{id}

Delete a specific sound

• id (path, required) — An id of a campaign sound

/campaigns/sounds/{id}

Find a specific sound

• id (path, required) — An id of a sound campaign
• fields (query) — Limit fields received in response. E.g. fields: id, name or fields items (id, name), see more at [partial response](https://developers.callfire.com/docs.html#partial-response) page.

/campaigns/sounds/{id}.mp3

Download a MP3 sound

• id (path, required) — An id of a campaign sound

/campaigns/sounds/{id}.wav

Download a WAV sound

• id (path, required) — An id of a campaign sound

/contacts

Find contacts

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

/contacts

Create contacts

/contacts/dncs

Find do not contact (dnc) items

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

/contacts/dncs

Add do not contact (dnc) numbers

/contacts/dncs/sources/{source}

Delete do not contact (dnc) numbers contained in source.

• source (path, required) — Source associated with Do Not Contact (DNC) entry.

/me/api/credentials

Find api credentials

• name (query) — Filter by name
• fields (query) — Limit fields received in response. E.g. fields: id, name or fields items (id, name), see more at [partial response](https://developers.callfire.com/docs.html#partial-response) page.
• limit (query, limit) — To set the maximum number of records to return in a paged list response. The default is 100
• offset (query, offset) — Offset to the start of a given page. The default is 0. Check [pagination](https://developers.callfire.com/docs.html#pagination) page for more information about pagination in CallFire API.

/me/api/credentials

Create api credentials

/me/api/credentials/{id}

Delete api credentials

• id (path, required) — An id of an API credential

/me/api/credentials/{id}

Find a specific api credential

• id (path, required) — An id of an API credential
• fields (query) — Limit fields received in response. E.g. fields: id, name or fields items (id, name), see more at [partial response](https://developers.callfire.com/docs.html#partial-response) page.

/me/api/credentials/{id}/disable

Disable specified API credentials

• id (path, required) — An id of an API credential

/me/api/credentials/{id}/enable

Enable specified API credentials

• id (path, required) — An id of an API credential

/me/billing/credit-usage

Find credit usage

• intervalBegin (query) — Beginning of usage period formatted in unix time milliseconds. Example: 1473781817000
• intervalEnd (query) — End of usage period formatted in unix time milliseconds. Example: 1473781817000

/me/billing/plan-usage

Find plan usage

/me/callerids

Find caller ids

/me/callerids/{callerid}

Create a caller id

• callerid (path, required) — A phone number in E.164 format (11-digit) which needs to be verified. Example: 12132000384

/me/callerids/{callerid}/verification-code

Verify a caller id

• callerid (path, required) — A phone number in E.164 format (11-digit) which needs to be verified. Example: 12132000384

/media

Find media

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

/media

Create media

/media/public/{key}.{extension}

Download media by extension

• key (path, required) — A hash-key of a media resource
• extension (path, required) — Media file type, available types: bmp, gif, jpg, m4a, mp3, mp4, png, wav

/media/{id}

Get a specific media

• id (path, required) — An id of a media resource
• fields (query) — Limit fields received in response. E.g. fields: id, name or fields items (id, name), see more at [partial response](https://developers.callfire.com/docs.html#partial-response) page.

/media/{id}.{extension}

Download media by extension

• id (path, required) — An id of a media resource
• extension (path, required) — Media file type. Available types: bmp, gif, jpg, m4a, mp3, mp4, png, wav

/media/{id}/file

Download a MP3 media

• id (path, required) — An id of a media resource

/texts/broadcasts/{id}/texts

Find texts in a text broadcast

• id (path, required) — An id of a text broadcast
• batchId (query) — ~
• fields (query) — Limit fields received in response. E.g. fields: id, name or fields items (id, name), see more at [partial response](https://developers.callfire.com/docs.html#partial-response) page.
• limit (query, limit) — To set the maximum number of records to return in a paged list response. The default is 100
• offset (query, offset) — Offset to the start of a given page. The default is 0. Check [pagination](https://developers.callfire.com/docs.html#pagination) page for more information about pagination in CallFire API.

/numbers/leases

Find leases

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

/numbers/leases/configs

Find lease configs

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

/numbers/leases/configs/{number}

Find a specific lease config

• number (path, required) — A phone number in E.164 format (11-digit). Example: 12132000384
• fields (query) — Limit fields received in response. E.g. fields: id, name or fields items (id, name), see more at [partial response](https://developers.callfire.com/docs.html#partial-response) page.

/numbers/leases/configs/{number}

Update a lease config

• number (path, required) — A phone number in E.164 format (11-digit) which needs to be verified. Example: 12132000384

/numbers/leases/{number}

Find a specific lease

• number (path, required) — A phone number in E.164 format (11-digit). Example: 12132000384
• fields (query) — Limit fields received in response. E.g. fields: id, name or fields items (id, name), see more at [partial response](https://developers.callfire.com/docs.html#partial-response) page.

/numbers/leases/{number}

Update a lease

• number (path, required) — A phone number in E.164 format (11-digit). Example: 12132000384

/numbers/local

Find local numbers

• limit (query, limit) — To set the maximum number of records to return in a paged list response. The default is 100
• prefix (query) — A 4-7 digit prefix
• city (query) — A city name
• state (query) — A two-letter state code. Example: CA, IL, etc.
• zipcode (query) — A five-digit Zipcode
• fields (query) — Limit fields received in response. E.g. fields: id, name or fields items (id, name), see more at [partial response](https://developers.callfire.com/docs.html#partial-response) page.

/numbers/regions

Find number regions

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

/numbers/tollfree

Find tollfree numbers

• pattern (query) — Filter toll free numbers by prefix, pattern must be 3 char long and should end with '*'. Examples: 8**, 85*, 87* (but 855 will fail because pattern must end with '*').
• limit (query, limit) — To set the maximum number of records to return in a paged list response. The default is 100
• fields (query) — Limit fields received in response. E.g. fields: id, name or fields items (id, name), see more at [partial response](https://developers.callfire.com/docs.html#partial-response) page.

/orders

Find orders

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

/orders/keywords

Purchase keywords

• fields (query) — Limit fields received in response. E.g. fields: id, name or fields items (id, name), see more at [partial response](https://developers.callfire.com/docs.html#partial-response) page.

/orders/numbers

Purchase numbers

• fields (query) — Limit fields received in response. E.g. fields: id, name or fields items (id, name), see more at [partial response](https://developers.callfire.com/docs.html#partial-response) page.

/orders/{id}

Find a specific order

• id (path, required) — An id of an order
• fields (query) — Limit fields received in response. E.g. fields: id, name or fields items (id, name), see more at [partial response](https://developers.callfire.com/docs.html#partial-response) page.

/reports/delivery

Get delivery reports by ad hoc criteria

• startDate (query) — ~
• endDate (query) — ~
• limit (query, limit) — To set the maximum number of records to return in a paged list response. The default is 100
• offset (query, offset) — Offset to the start of a given page. The default is 0. Check [pagination](https://developers.callfire.com/docs.html#pagination) page for more information about pagination in CallFire API.
• campaignId (query) — ~
• fromNumber (query) — ~
• toNumber (query) — ~
• deliveryCategory (query) — ~
• deliveryState (query) — ~
• carrier (query) — ~
• messageText (query) — ~

/texts

Find texts

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

/texts

Send texts

• fields (query) — Limit fields received in response. E.g. fields: id, name or fields items (id, name), see more at [partial response](https://developers.callfire.com/docs.html#partial-response) page.
• campaignId (query) — Specifies a campaignId to send texts through a previously created campaign
• defaultMessage (query) — Text message can be overridden by TextRecipient.message field. If multiple recipients have the same text message to a different recipients it is better to specify a single default message and do not duplicate it in each recipient.
• strictValidation (query) — Turns on strict validation for recipients

/texts/auto-replys

Find auto replies

• fields (query) — Limit fields received in response. E.g. fields: id, name or fields items (id, name), see more at [partial response](https://developers.callfire.com/docs.html#partial-response) page.
• limit (query, limit) — To set the maximum number of records to return in a paged list response. The default is 100
• offset (query, offset) — Offset to the start of a given page. The default is 0. Check [pagination](https://developers.callfire.com/docs.html#pagination) page for more information about pagination in CallFire API.
• number (query) — Phone number in E.164 format (11-digit) which contains a TextAutoReply. Example: 12132000384. If number is empty then operator returns all autoreplies configured for the user's account

/texts/auto-replys

Create an auto reply

/texts/broadcasts

Find text broadcasts

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

/texts/broadcasts

Create a text broadcast

• start (query) — If true then starts the campaign immediately (not required).
• strictValidation (query) — Turns on strict validation for recipients. System will reply with BAD_REQUEST(400) if strictValidation = true and one of numbers didn't pass validation

/texts/broadcasts/{id}

Find a specific text broadcast

• id (path, required) — An id of a text broadcast
• fields (query) — Limit fields received in response. E.g. fields: id, name or fields items (id, name), see more at [partial response](https://developers.callfire.com/docs.html#partial-response) page.

/texts/broadcasts/{id}

Update a text broadcast

• id (path, required) — An id of a text broadcast
• strictValidation (query) — Turns on strict validation for recipients. System will reply with BAD_REQUEST(400) if strictValidation = true and one of numbers didn't pass validation

/texts/broadcasts/{id}/archive

Archive text broadcast

• id (path, required) — An id of a text broadcast to archive

/texts/broadcasts/{id}/batches

Find batches in a text broadcast

• id (path, required) — An id of a text broadcast
• fields (query) — Limit fields received in response. E.g. fields: id, name or fields items (id, name), see more at [partial response](https://developers.callfire.com/docs.html#partial-response) page.
• limit (query, limit) — To set the maximum number of records to return in a paged list response. The default is 100
• offset (query, offset) — Offset to the start of a given page. The default is 0. Check [pagination](https://developers.callfire.com/docs.html#pagination) page for more information about pagination in CallFire API.

/texts/broadcasts/{id}/batches

Add batches to a text broadcast

• id (path, required) — An id of a text broadcast
• strictValidation (query) — Turns on strict validation for recipients. System will reply with BAD_REQUEST(400) if strictValidation = true and one of numbers didn't pass validation

/texts/broadcasts/{id}/recipients

Add recipients to a text broadcast

• id (path, required) — An id of a text broadcast
• fields (query) — Limit fields received in response. E.g. fields: id, name or fields items (id, name), see more at [partial response](https://developers.callfire.com/docs.html#partial-response) page.
• strictValidation (query) — Turns on strict validation for recipients. System will reply with BAD_REQUEST(400) if strictValidation = true and one of numbers didn't pass validation

/texts/broadcasts/{id}/start

Start text broadcast

• id (path, required) — An id of a text broadcast to start

/texts/broadcasts/{id}/stats

Get statistics on text broadcast

• id (path, required) — An id of a text broadcast
• fields (query) — Limit fields received in response. E.g. fields: id, name or fields items (id, name), see more at [partial response](https://developers.callfire.com/docs.html#partial-response) page.
• begin (query) — Start of a search find time interval, formatted in unix time milliseconds. Example: 1473781817000 for Sat, 05 Jan 1985 14:03:37 GMT
• end (query) — End of a search time interval, formatted in unix time milliseconds. Example: 1473781817000 for Sat, 05 Jan 1985 14:03:37 GMT

/texts/broadcasts/{id}/stop

Stop text broadcast

• id (path, required) — An Id of a text broadcast. To stop the broadcast

/texts/broadcasts/{id}/toggleRecipientsStatus

Disable/enable undialed recipients in broadcast

• id (path, required) — An id of a text broadcast
• enable (query) — Flag which indicate what to do with texts (true will enable texts in DISABLED status and vice versa)

/webhooks

Find webhooks

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

/webhooks

Create a webhook

/webhooks/resources

Find webhook resources

• fields (query) — Limit fields received in response. E.g. fields: id, name or fields items (id, name), see more at [partial response](https://developers.callfire.com/docs.html#partial-response) page.

/webhooks/resources/{resource}

Find specific webhook resource

• resource (path, required) — A name of a webhook resource. Available resources include 'CccCampaign': ['started', 'stopped', 'finished'], 'CallBroadcast': ['started', 'stopped', 'finished'], 'TextBroadcast': ['started', 'stopped', 'finished'], 'OutboundCall': ['finished'], 'InboundCall': ['finished'], 'OutboundText': ['finished'], 'InboundText': ['finished'], 'ContactList': ['validationFinished', 'validationFailed'], 'MonthlyRenewal': ['failed', 'finished'], 'LowBalance': ['failed', 'finished']
• fields (query) — Limit fields received in response. E.g. fields: id, name or fields items (id, name), see more at [partial response](https://developers.callfire.com/docs.html#partial-response) page.

/webhooks/{id}

Delete a webhook

• id (path, required) — An Id of a webhook

/webhooks/{id}

Find a specific webhook

• id (path, required) — An id of a webhook
• fields (query) — Limit fields received in response. E.g. fields: id, name or fields items (id, name), see more at [partial response](https://developers.callfire.com/docs.html#partial-response) page.

/webhooks/{id}

Update a webhook

• id (path, required) — An id of a webhook