{"note":"OpenAPI conversion -- returning structured metadata","name":"callfire-com","description":"CallFire API Documentation","version":"V2","base_url":"https://api.callfire.com/v2","endpoints":123,"raw":"@lap v0.3\n# Machine-readable API spec. Each @endpoint block is one API call.\n@api CallFire API Documentation\n@base https://api.callfire.com/v2\n@version V2\n@auth basic\n@endpoints 123\n@hint download_for_search\n@toc calls(21), campaigns(10), contacts(23), keywords(9), me(13), media(6), numbers(9), orders(4), reports(1), texts(20), webhooks(7)\n\n@group calls\n@endpoint GET /calls\n@desc Find calls\n@optional {fields: any # 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: any # To set the maximum number of records to return in a paged list response. The default is 100, offset: any # 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: any # Lists the Call ids to search for. If calls ids are specified then other query parameters can be ignored, campaignId: any # An id of a campaign, queries for calls included to a particular campaign. Specify null for all campaigns and 0 for default campaign, batchId: any # An id of a contact batch, queries for calls of a particular contact batch, fromNumber: any # Phone number in E.164 format (11-digit) that call was from. Example: 12132000384, toNumber: any # Phone number in E.164 format (11-digit) that call was sent to. Example: 12132000384, label: any # A label for a specific call, states: any # 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: any # 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: any # Filters inbound calls for \"true\" value and outbound calls for \"false\" value, intervalBegin: any # Start of the find time interval, formatted in unix time milliseconds. Example: 1473781817000 for Sat, 05 Jan 1985 14:03:37 GMT, intervalEnd: any # End of the find time interval, formatted in unix time milliseconds. Example: 1473781817000 for Sat, 05 Jan 1985 14:03:37 GMT}\n@returns(200) successful operation\n@errors {400: Bad request, 401: Unauthorized, 403: Forbidden, 404: Not found, 500: Internal Server Error}\n\n@endpoint POST /calls\n@desc Send calls\n@optional {fields: any # 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: any # Specifies a campaignId to send calls quickly on a previously created campaign, defaultLiveMessage: any # 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: any # 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: any # Id of sound file to play if phone is answered. Parameter can be overridden for any particular CallRecipient, defaultMachineMessageSoundId: any # An id of a sound file to play if answering machine is detected. Parameter can be overridden for any particular CallRecipient, defaultVoice: any # The voice set by default for all text-to-speech messages defined in CallRecipient objects or as default *Message properties, strictValidation: any # Turns on strict validation for recipients. System will reply with BAD_REQUEST(400) if strictValidation = true and one of numbers didn't pass validation, body: [map] # An array of CallRecipient objects.  Limitations: 1. Max number of CallRecipient objects is 10}\n@returns(200) successful operation\n@errors {400: Bad request, 401: Unauthorized, 403: Forbidden, 404: Not found, 500: Internal Server Error}\n\n@endpoint GET /calls/broadcasts\n@desc Find call broadcasts\n@optional {fields: any # 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: any # To set the maximum number of records to return in a paged list response. The default is 100, offset: any # 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: any # A label of a voice broadcast, name: any # A name of voice broadcast, running: any # Specify whether the campaigns should be running or not, scheduled: any # Specify whether the campaigns should be scheduled or not, intervalBegin: any # Start of the find time interval, formatted in unix time milliseconds. Example: 1473781817000 for Sat, 05 Jan 1985 14:03:37 GMT, intervalEnd: any # End of the find time interval, formatted in unix time milliseconds. Example: 1473781817000 for Sat, 05 Jan 1985 14:03:37 GMT}\n@returns(200) successful operation\n@errors {400: Bad request, 401: Unauthorized, 403: Forbidden, 404: Not found, 500: Internal Server Error}\n\n@endpoint POST /calls/broadcasts\n@desc Create a call broadcast\n@optional {start: any # Specify whether to immediately start this campaign (not required), strictValidation: any # Turns on strict validation for recipients. System will reply with BAD_REQUEST(400) if strictValidation = true and one of numbers didn't pass validation, body: map # A CallBroadcast object}\n@returns(201) successful operation\n@errors {400: Bad request, 401: Unauthorized, 403: Forbidden, 404: Not found, 500: Internal Server Error}\n\n@endpoint GET /calls/broadcasts/{id}\n@desc Find a specific call broadcast\n@required {id: any # An id of a CallBroadcast}\n@optional {fields: any # 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.}\n@returns(200) successful operation\n@errors {400: Bad request, 401: Unauthorized, 403: Forbidden, 404: Not found, 500: Internal Server Error}\n\n@endpoint PUT /calls/broadcasts/{id}\n@desc Update a call broadcast\n@required {id: any # An id of a voice broadcast}\n@optional {strictValidation: any # Turns on strict validation for recipients. System will reply with BAD_REQUEST(400) if strictValidation = true and one of numbers didn't pass validation, body: map # A CallBroadcast object}\n@errors {400: Bad request, 401: Unauthorized, 403: Forbidden, 404: Not found, 500: Internal Server Error}\n\n@endpoint POST /calls/broadcasts/{id}/archive\n@desc Archive voice broadcast\n@required {id: any # An id of a voice broadcast to archive}\n@errors {400: Bad request, 401: Unauthorized, 403: Forbidden, 404: Not found, 500: Internal Server Error}\n\n@endpoint GET /calls/broadcasts/{id}/batches\n@desc Find batches in a call broadcast\n@required {id: any # An id of a call broadcast}\n@optional {fields: any # 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: any # To set the maximum number of records to return in a paged list response. The default is 100, offset: any # 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.}\n@returns(200) successful operation\n@errors {400: Bad request, 401: Unauthorized, 403: Forbidden, 404: Not found, 500: Internal Server Error}\n\n@endpoint POST /calls/broadcasts/{id}/batches\n@desc Add batches to a call broadcast\n@required {id: any # An id of a call broadcast}\n@optional {strictValidation: any # Turns on strict validation for recipients. System will reply with BAD_REQUEST(400) if strictValidation = true and one of numbers didn't pass validation, body: map # A request object}\n@returns(201) successful operation\n@errors {400: Bad request, 401: Unauthorized, 403: Forbidden, 404: Not found, 500: Internal Server Error}\n\n@endpoint GET /calls/broadcasts/{id}/calls\n@desc Find calls in a call broadcast\n@required {id: any # An Id of a call broadcast}\n@optional {batchId: any # An id of a particular batch associated with broadcast, fields: any # 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: any # To set the maximum number of records to return in a paged list response. The default is 100, offset: any # 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.}\n@returns(200) successful operation\n@errors {400: Bad request, 401: Unauthorized, 403: Forbidden, 404: Not found, 500: Internal Server Error}\n\n@endpoint POST /calls/broadcasts/{id}/recipients\n@desc Add recipients to a call broadcast\n@required {id: any # An id of a call broadcast}\n@optional {fields: any # 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: any # Turns on strict validation for recipients. System will reply with BAD_REQUEST(400) if strictValidation = true and one of numbers didn't pass validation, body: [map] # A list of CallRecipient objects}\n@returns(200) successful operation\n@errors {400: Bad request, 401: Unauthorized, 403: Forbidden, 404: Not found, 500: Internal Server Error}\n\n@endpoint POST /calls/broadcasts/{id}/start\n@desc Start voice broadcast\n@required {id: any # An id of voice broadcast to start}\n@errors {400: Bad request, 401: Unauthorized, 403: Forbidden, 404: Not found, 500: Internal Server Error}\n\n@endpoint GET /calls/broadcasts/{id}/stats\n@desc Get statistics on call broadcast\n@required {id: any # An id of a call broadcast}\n@optional {fields: any # 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: any # Start of the search time interval, formatted in unix time milliseconds. Example: 1473781817000 for Sat, 05 Jan 1985 14:03:37 GMT, end: any # End of the search time interval, formatted in unix time milliseconds. Example: 1473781817000 for Sat, 05 Jan 1985 14:03:37 GMT}\n@returns(200) successful operation\n@errors {400: Bad request, 401: Unauthorized, 403: Forbidden, 404: Not found, 500: Internal Server Error}\n\n@endpoint POST /calls/broadcasts/{id}/stop\n@desc Stop voice broadcast\n@required {id: any # An id of voice broadcast to stop}\n@errors {400: Bad request, 401: Unauthorized, 403: Forbidden, 404: Not found, 500: Internal Server Error}\n\n@endpoint POST /calls/broadcasts/{id}/toggleRecipientsStatus\n@desc Disable/enable undialed recipients in broadcast\n@required {id: any # An id of a voice broadcast}\n@optional {enable: any # Flag which indicate what to do with calls (true will enable call in DISABLED status and vice versa), body: [map] # List of Recipient objects. By recipient we mean either phone number or contact id.}\n@errors {400: Bad request, 401: Unauthorized, 403: Forbidden, 404: Not found, 500: Internal Server Error}\n\n@endpoint GET /calls/recordings/{id}\n@desc Get call recording by id\n@required {id: any # ~}\n@optional {fields: any # 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.}\n@returns(200) successful operation\n@errors {400: Bad request, 401: Unauthorized, 403: Forbidden, 404: Not found, 500: Internal Server Error}\n\n@endpoint GET /calls/recordings/{id}.mp3\n@desc Get call recording in mp3 format\n@required {id: any # An id of a call}\n@returns(200) successful operation\n@errors {400: Bad request, 401: Unauthorized, 403: Forbidden, 404: Not found, 500: Internal Server Error}\n\n@endpoint GET /calls/{id}\n@desc Find a specific call\n@required {id: any # An id of a call}\n@optional {fields: any # 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.}\n@returns(200) successful operation\n@errors {400: Bad request, 401: Unauthorized, 403: Forbidden, 404: Not found, 500: Internal Server Error}\n\n@endpoint GET /calls/{id}/recordings\n@desc Get call recordings for a call\n@required {id: any # An id of a call}\n@optional {fields: any # 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.}\n@returns(200) successful operation\n@errors {400: Bad request, 401: Unauthorized, 403: Forbidden, 404: Not found, 500: Internal Server Error}\n\n@endpoint GET /calls/{id}/recordings/{name}\n@desc Get call recording by name\n@required {id: any # An id of a call, name: any # A name of a recording}\n@optional {fields: any # 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.}\n@returns(200) successful operation\n@errors {400: Bad request, 401: Unauthorized, 403: Forbidden, 404: Not found, 500: Internal Server Error}\n\n@endpoint GET /calls/{id}/recordings/{name}.mp3\n@desc Get call mp3 recording by name\n@required {id: any # An id of a call, name: any # A name of a recording}\n@returns(200) successful operation\n@errors {400: Bad request, 401: Unauthorized, 403: Forbidden, 404: Not found, 500: Internal Server Error}\n\n@endgroup\n\n@group campaigns\n@endpoint GET /campaigns/batches/{id}\n@desc Find a specific batch\n@required {id: any # An id of a batch}\n@optional {fields: any # 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.}\n@returns(200) successful operation\n@errors {400: Bad request, 401: Unauthorized, 403: Forbidden, 404: Not found, 500: Internal Server Error}\n\n@endpoint PUT /campaigns/batches/{id}\n@desc Update a batch\n@required {id: any # An id of a batch to update}\n@optional {body: map # A batch instance}\n@errors {400: Bad request, 401: Unauthorized, 403: Forbidden, 404: Not found, 500: Internal Server Error}\n\n@endpoint GET /campaigns/sounds\n@desc Find sounds\n@optional {limit: any # To set the maximum number of records to return in a paged list response. The default is 100, offset: any # 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: any # value to filter file names again; this value is used to check if the filename contains the filter value., includeArchived: any # Includes ARCHIVED sounds for \"true\" value, includePending: any # Includes UPLOAD/RECORDING sounds for \"true\" value, includeScrubbed: any # Includes SCRUBBED sounds for \"true\" value, fields: any # 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.}\n@returns(200) successful operation\n@errors {400: Bad request, 401: Unauthorized, 403: Forbidden, 404: Not found, 500: Internal Server Error}\n\n@endpoint POST /campaigns/sounds/calls\n@desc Add sound via call\n@optional {fields: any # 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., body: map # Request object containing the name of a new campaign sound and phone number to call up}\n@returns(200) successful operation\n@errors {400: Bad request, 401: Unauthorized, 403: Forbidden, 404: Not found, 500: Internal Server Error}\n\n@endpoint POST /campaigns/sounds/files\n@desc Add sound via file\n@required {file: any # A sound file encoded in binary form}\n@optional {fields: any # 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., name: any # Optional name of a sound file, if the name is empty than it will be taken from a file}\n@returns(200) successful operation\n@errors {400: Bad request, 401: Unauthorized, 403: Forbidden, 404: Not found, 500: Internal Server Error}\n\n@endpoint POST /campaigns/sounds/tts\n@desc Add sound via text-to-speech\n@optional {fields: any # 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., body: map # textToSpeech}\n@returns(200) successful operation\n@errors {400: Bad request, 401: Unauthorized, 403: Forbidden, 404: Not found, 500: Internal Server Error}\n\n@endpoint GET /campaigns/sounds/{id}\n@desc Find a specific sound\n@required {id: any # An id of a sound campaign}\n@optional {fields: any # 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.}\n@returns(200) successful operation\n@errors {400: Bad request, 401: Unauthorized, 403: Forbidden, 404: Not found, 500: Internal Server Error}\n\n@endpoint DELETE /campaigns/sounds/{id}\n@desc Delete a specific sound\n@required {id: any # An id of a campaign sound}\n@errors {400: Bad request, 401: Unauthorized, 403: Forbidden, 404: Not found, 500: Internal Server Error}\n\n@endpoint GET /campaigns/sounds/{id}.mp3\n@desc Download a MP3 sound\n@required {id: any # An id of a campaign sound}\n@returns(200) successful operation\n@errors {400: Bad request, 401: Unauthorized, 403: Forbidden, 404: Not found, 500: Internal Server Error}\n\n@endpoint GET /campaigns/sounds/{id}.wav\n@desc Download a WAV sound\n@required {id: any # An id of a campaign sound}\n@returns(200) successful operation\n@errors {400: Bad request, 401: Unauthorized, 403: Forbidden, 404: Not found, 500: Internal Server Error}\n\n@endgroup\n\n@group contacts\n@endpoint GET /contacts\n@desc Find contacts\n@optional {fields: any # 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: any # To set the maximum number of records to return in a paged list response. The default is 100, offset: any # 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: any # A list of contact IDs. If the id parameter is included, the other query parameters are ignored., number: any # Multiple contact numbers can be specified. If the number parameter is included, the other query parameters are ignored., contactListId: any # Filters contacts by a particular contact list, propertyName: any # Name of a contact property to search by, propertyValue: any # Value of a contact property to search by}\n@returns(200) successful operation\n@errors {400: Bad request, 401: Unauthorized, 403: Forbidden, 404: Not found, 500: Internal Server Error}\n\n@endpoint POST /contacts\n@desc Create contacts\n@optional {body: [map] # A list of a contact objects}\n@returns(200) successful operation\n@errors {400: Bad request, 401: Unauthorized, 403: Forbidden, 404: Not found, 500: Internal Server Error}\n\n@endpoint GET /contacts/dncs\n@desc Find do not contact (dnc) items\n@optional {fields: any # 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: any # To set the maximum number of records to return in a paged list response. The default is 100, offset: any # 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: any # Prefix (1-10 digits) of phone numbers, campaignId: any # A campaign id which was used to send a message to a DNC number, source: any # A DNC source name to search for DNCs, call: any # Show only Do-Not-Call numbers, text: any # Show only Do-Not-Text numbers, inboundCall: any # ~, inboundText: any # ~, number: any # ~}\n@returns(200) successful operation\n@errors {400: Bad request, 401: Unauthorized, 403: Forbidden, 404: Not found, 500: Internal Server Error}\n\n@endpoint POST /contacts/dncs\n@desc Add do not contact (dnc) numbers\n@optional {body: map # AddDoNotContactsRequest object}\n@errors {400: Bad request, 401: Unauthorized, 403: Forbidden, 404: Not found, 500: Internal Server Error}\n\n@endpoint DELETE /contacts/dncs/sources/{source}\n@desc Delete do not contact (dnc) numbers contained in source.\n@required {source: any # Source associated with Do Not Contact (DNC) entry.}\n@errors {400: Bad request, 401: Unauthorized, 403: Forbidden, 404: Not found, 500: Internal Server Error}\n\n@endpoint GET /contacts/dncs/universals/{toNumber}\n@desc Find universal do not contacts (udnc) associated with toNumber\n@required {toNumber: any # A required destination phone number in E.164 format (11-digit). Example: 12132000384}\n@optional {fromNumber: any # An optional destination/source number for DNC, specified in E.164 format (11-digit). Example: 12132000384, fields: any # 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.}\n@returns(200) successful operation\n@errors {400: Bad request, 401: Unauthorized, 403: Forbidden, 404: Not found, 500: Internal Server Error}\n\n@endpoint GET /contacts/dncs/{number}\n@desc Get do not contact (dnc)\n@required {number: any # Number associated with Do Not Contact (DNC) entry.}\n@returns(200) successful operation\n@errors {400: Bad request, 401: Unauthorized, 403: Forbidden, 404: Not found, 500: Internal Server Error}\n\n@endpoint PUT /contacts/dncs/{number}\n@desc Update an individual do not contact (dnc) number\n@required {number: any # ~}\n@optional {body: map # DoNotContact object}\n@errors {400: Bad request, 401: Unauthorized, 403: Forbidden, 404: Not found, 500: Internal Server Error}\n\n@endpoint DELETE /contacts/dncs/{number}\n@desc Delete do not contact (dnc) number. If number contains commas treat as list of numbers\n@required {number: any # Number associated with Do Not Contact (DNC) entry.}\n@errors {400: Bad request, 401: Unauthorized, 403: Forbidden, 404: Not found, 500: Internal Server Error}\n\n@endpoint GET /contacts/lists\n@desc Find contact lists\n@optional {fields: any # 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: any # To set the maximum number of records to return in a paged list response. The default is 100, offset: any # 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: any # A name or a partial name of a contact list, exactMatch: any # ~, contactCount: any # ~, orderBy: any # ~}\n@returns(200) successful operation\n@errors {400: Bad request, 401: Unauthorized, 403: Forbidden, 404: Not found, 500: Internal Server Error}\n\n@endpoint POST /contacts/lists\n@desc Create contact lists\n@optional {body: map # A request object, fields: any # 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.}\n@returns(200) successful operation\n@errors {400: Bad request, 401: Unauthorized, 403: Forbidden, 404: Not found, 500: Internal Server Error}\n\n@endpoint POST /contacts/lists/upload\n@desc Create contact list from file\n@required {file: any # CSV file to be uploaded}\n@optional {name: any # A name of a contact list, useCustomFields: any # A flag to indicate how to define property names for contacts. If true, uses the field and property names exactly as defined. If false will assign custom properties and fields to A, B, C, etc}\n@returns(200) successful operation\n@errors {400: Bad request, 401: Unauthorized, 403: Forbidden, 404: Not found, 500: Internal Server Error}\n\n@endpoint GET /contacts/lists/{id}\n@desc Find a specific contact list\n@required {id: any # An id of a contact list to return}\n@optional {fields: any # 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.}\n@returns(200) successful operation\n@errors {400: Bad request, 401: Unauthorized, 403: Forbidden, 404: Not found, 500: Internal Server Error}\n\n@endpoint PUT /contacts/lists/{id}\n@desc Update a contact list\n@required {id: any # An id of contact list to update}\n@optional {body: map # A request object}\n@errors {400: Bad request, 401: Unauthorized, 403: Forbidden, 404: Not found, 500: Internal Server Error}\n\n@endpoint DELETE /contacts/lists/{id}\n@desc Delete a contact list\n@required {id: any # An id of the contact list to be deleted}\n@errors {400: Bad request, 401: Unauthorized, 403: Forbidden, 404: Not found, 500: Internal Server Error}\n\n@endpoint GET /contacts/lists/{id}/items\n@desc Find contacts in a contact list\n@required {id: any # An id of a contact list}\n@optional {fields: any # 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: any # To set the maximum number of records to return in a paged list response. The default is 100, offset: any # 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.}\n@returns(200) successful operation\n@errors {400: Bad request, 401: Unauthorized, 403: Forbidden, 404: Not found, 500: Internal Server Error}\n\n@endpoint POST /contacts/lists/{id}/items\n@desc Add contacts to a contact list\n@required {id: any # An id of a contact list}\n@optional {body: map # A request object}\n@errors {400: Bad request, 401: Unauthorized, 403: Forbidden, 404: Not found, 500: Internal Server Error}\n\n@endpoint DELETE /contacts/lists/{id}/items\n@desc Delete contacts from a contact list\n@required {id: any # A id of a contact list}\n@optional {contactId: any # An id of a contact entity in the CallFire system}\n@errors {400: Bad request, 401: Unauthorized, 403: Forbidden, 404: Not found, 500: Internal Server Error}\n\n@endpoint DELETE /contacts/lists/{id}/items/{contactId}\n@desc Delete a contact from a contact list\n@required {id: any # An id of a contact list, contactId: any # An id of a contact}\n@errors {400: Bad request, 401: Unauthorized, 403: Forbidden, 404: Not found, 500: Internal Server Error}\n\n@endpoint GET /contacts/{id}\n@desc Find a specific contact\n@required {id: any # An id of a contact}\n@optional {fields: any # 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.}\n@returns(200) successful operation\n@errors {400: Bad request, 401: Unauthorized, 403: Forbidden, 404: Not found, 500: Internal Server Error}\n\n@endpoint PUT /contacts/{id}\n@desc Update a contact\n@required {id: any # An id of a contact}\n@optional {body: map # A contact object}\n@errors {400: Bad request, 401: Unauthorized, 403: Forbidden, 404: Not found, 500: Internal Server Error}\n\n@endpoint DELETE /contacts/{id}\n@desc Delete a contact\n@required {id: any # An Id of a contact}\n@errors {400: Bad request, 401: Unauthorized, 403: Forbidden, 404: Not found, 500: Internal Server Error}\n\n@endpoint GET /contacts/{id}/history\n@desc Find a contact's history\n@required {id: any # An Id of a contact}\n@optional {limit: any # To set the maximum number of records to return in a paged list response. The default is 100, offset: any # 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: any # 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.}\n@returns(200) successful operation\n@errors {400: Bad request, 401: Unauthorized, 403: Forbidden, 404: Not found, 500: Internal Server Error}\n\n@endgroup\n\n@group keywords\n@endpoint GET /keywords\n@desc Find keywords\n@optional {keywords: any # A keyword to search for}\n@returns(200) successful operation\n@errors {400: Bad request, 401: Unauthorized, 403: Forbidden, 404: Not found, 500: Internal Server Error}\n\n@endpoint GET /keywords/leases\n@desc Find keyword leases\n@optional {limit: any # To set the maximum number of records to return in a paged list response. The default is 100, offset: any # 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: any # Filter by part of Keyword name or Label name of Keyword, labelName: any # An exact label name to search by, fields: any # 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.}\n@returns(200) successful operation\n@errors {400: Bad request, 401: Unauthorized, 403: Forbidden, 404: Not found, 500: Internal Server Error}\n\n@endpoint GET /keywords/leases/configs\n@desc Find keyword lease configs\n@optional {limit: any # To set the maximum number of records to return in a paged list response. The default is 100, offset: any # 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: any # Filter by part of Keyword name or Label name of Keyword, labelName: any # An exact label name to search by, fields: any # 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.}\n@returns(200) successful operation\n@errors {400: Bad request, 401: Unauthorized, 403: Forbidden, 404: Not found, 500: Internal Server Error}\n\n@endpoint GET /keywords/leases/configs/{keyword}\n@desc Find a specific keyword lease config\n@required {keyword: any # A Keyword to get KeywordConfig by}\n@optional {fields: any # 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.}\n@returns(200) successful operation\n@errors {400: Bad request, 401: Unauthorized, 403: Forbidden, 404: Not found, 500: Internal Server Error}\n\n@endpoint PUT /keywords/leases/configs/{keyword}\n@desc Update a keyword lease config\n@required {keyword: any # To update a keyword lease config}\n@optional {body: map # The configuration of a keyword lease object.}\n@errors {400: Bad request, 401: Unauthorized, 403: Forbidden, 404: Not found, 500: Internal Server Error}\n\n@endpoint GET /keywords/leases/id/{id}\n@desc Find a keyword by id\n@required {id: any # ~}\n@optional {fields: any # 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.}\n@returns(200) successful operation\n@errors {400: Bad request, 401: Unauthorized, 403: Forbidden, 404: Not found, 500: Internal Server Error}\n\n@endpoint GET /keywords/leases/{keyword}\n@desc Find a specific lease\n@required {keyword: any # Keyword text that a lease is desired for}\n@optional {fields: any # 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.}\n@returns(200) successful operation\n@errors {400: Bad request, 401: Unauthorized, 403: Forbidden, 404: Not found, 500: Internal Server Error}\n\n@endpoint PUT /keywords/leases/{keyword}\n@desc Update a lease\n@required {keyword: any # To update a keyword lease}\n@optional {body: map # A keyword lease object}\n@errors {400: Bad request, 401: Unauthorized, 403: Forbidden, 404: Not found, 500: Internal Server Error}\n\n@endpoint GET /keywords/{keyword}/available\n@desc Check for a specific keyword\n@required {keyword: any # To specify a keyword to search for. Example: SUN, MOON}\n@returns(200) successful operation\n@errors {400: Bad request, 401: Unauthorized, 403: Forbidden, 404: Not found, 500: Internal Server Error}\n\n@endgroup\n\n@group me\n@endpoint GET /me/account\n@desc Find account details\n@optional {fields: any # 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.}\n@returns(200) successful operation\n@errors {400: Bad request, 401: Unauthorized, 403: Forbidden, 404: Not found, 500: Internal Server Error}\n\n@endpoint GET /me/api/credentials\n@desc Find api credentials\n@optional {name: any # Filter by name, fields: any # 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: any # To set the maximum number of records to return in a paged list response. The default is 100, offset: any # 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.}\n@returns(200) successful operation\n@errors {400: Bad request, 401: Unauthorized, 403: Forbidden, 404: Not found, 500: Internal Server Error}\n\n@endpoint POST /me/api/credentials\n@desc Create api credentials\n@optional {body: map # To create the API credentials}\n@returns(200) successful operation\n@errors {400: Bad request, 401: Unauthorized, 403: Forbidden, 404: Not found, 500: Internal Server Error}\n\n@endpoint GET /me/api/credentials/{id}\n@desc Find a specific api credential\n@required {id: any # An id of an API credential}\n@optional {fields: any # 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.}\n@returns(200) successful operation\n@errors {400: Bad request, 401: Unauthorized, 403: Forbidden, 404: Not found, 500: Internal Server Error}\n\n@endpoint DELETE /me/api/credentials/{id}\n@desc Delete api credentials\n@required {id: any # An id of an API credential}\n@errors {400: Bad request, 401: Unauthorized, 403: Forbidden, 404: Not found, 500: Internal Server Error}\n\n@endpoint POST /me/api/credentials/{id}/disable\n@desc Disable specified API credentials\n@required {id: any # An id of an API credential}\n@errors {400: Bad request, 401: Unauthorized, 403: Forbidden, 404: Not found, 500: Internal Server Error}\n\n@endpoint POST /me/api/credentials/{id}/enable\n@desc Enable specified API credentials\n@required {id: any # An id of an API credential}\n@errors {400: Bad request, 401: Unauthorized, 403: Forbidden, 404: Not found, 500: Internal Server Error}\n\n@endpoint GET /me/billing/credit-usage\n@desc Find credit usage\n@optional {intervalBegin: any # Beginning of usage period formatted in unix time milliseconds. Example: 1473781817000, intervalEnd: any # End of usage period formatted in unix time milliseconds. Example: 1473781817000}\n@returns(200) successful operation\n@errors {400: Bad request, 401: Unauthorized, 403: Forbidden, 404: Not found, 500: Internal Server Error}\n\n@endpoint GET /me/billing/credit-usage/grouped/{rollupBinType}\n@desc Find credit usage grouped by period\n@required {rollupBinType: any # Grouping period: YEARS, MONTHS, WEEKS, DAYS, etc.}\n@optional {intervalBegin: any # Beginning of usage period formatted in unix time milliseconds. Example: 1473781817000, intervalEnd: any # End of usage period formatted in unix time milliseconds. Example: 1473781817000}\n@returns(200) successful operation\n@errors {400: Bad request, 401: Unauthorized, 403: Forbidden, 404: Not found, 500: Internal Server Error}\n\n@endpoint GET /me/billing/plan-usage\n@desc Find plan usage\n@returns(200) successful operation\n@errors {400: Bad request, 401: Unauthorized, 403: Forbidden, 404: Not found, 500: Internal Server Error}\n\n@endpoint GET /me/callerids\n@desc Find caller ids\n@returns(200) successful operation\n@errors {400: Bad request, 401: Unauthorized, 403: Forbidden, 404: Not found, 500: Internal Server Error}\n\n@endpoint POST /me/callerids/{callerid}\n@desc Create a caller id\n@required {callerid: any # A phone number in E.164 format (11-digit) which needs to be verified. Example: 12132000384}\n@errors {400: Bad request, 401: Unauthorized, 403: Forbidden, 404: Not found, 500: Internal Server Error}\n\n@endpoint POST /me/callerids/{callerid}/verification-code\n@desc Verify a caller id\n@required {callerid: any # A phone number in E.164 format (11-digit) which needs to be verified. Example: 12132000384}\n@optional {body: map # request}\n@returns(200) successful operation\n@errors {400: Bad request, 401: Unauthorized, 403: Forbidden, 404: Not found, 500: Internal Server Error}\n\n@endgroup\n\n@group media\n@endpoint GET /media\n@desc Find media\n@optional {limit: any # To set the maximum number of records to return in a paged list response. The default is 100, offset: any # 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: any # value to filter file names again; this value is used to check if the filename contains the filter value., fields: any # 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.}\n@returns(200) successful operation\n@errors {400: Bad request, 401: Unauthorized, 403: Forbidden, 404: Not found, 500: Internal Server Error}\n\n@endpoint POST /media\n@desc Create media\n@required {file: any # Binary media file}\n@optional {name: any # A name of a media file}\n@returns(200) successful operation\n@errors {400: Bad request, 401: Unauthorized, 403: Forbidden, 404: Not found, 500: Internal Server Error}\n\n@endpoint GET /media/public/{key}.{extension}\n@desc Download media by extension\n@required {key: any # A hash-key of a media resource, extension: any # Media file type, available types: bmp, gif, jpg, m4a, mp3, mp4, png, wav}\n@returns(200) successful operation\n@errors {400: Bad request, 401: Unauthorized, 403: Forbidden, 404: Not found, 500: Internal Server Error}\n\n@endpoint GET /media/{id}\n@desc Get a specific media\n@required {id: any # An id of a media resource}\n@optional {fields: any # 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.}\n@returns(200) successful operation\n@errors {400: Bad request, 401: Unauthorized, 403: Forbidden, 404: Not found, 500: Internal Server Error}\n\n@endpoint GET /media/{id}.{extension}\n@desc Download media by extension\n@required {id: any # An id of a media resource, extension: any # Media file type. Available types: bmp, gif, jpg, m4a, mp3, mp4, png, wav}\n@returns(200) successful operation\n@errors {400: Bad request, 401: Unauthorized, 403: Forbidden, 404: Not found, 500: Internal Server Error}\n\n@endpoint GET /media/{id}/file\n@desc Download a MP3 media\n@required {id: any # An id of a media resource}\n@returns(200) successful operation\n@errors {400: Bad request, 401: Unauthorized, 403: Forbidden, 404: Not found, 500: Internal Server Error}\n\n@endgroup\n\n@group numbers\n@endpoint GET /numbers/leases\n@desc Find leases\n@optional {limit: any # To set the maximum number of records to return in a paged list response. The default is 100, offset: any # 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: any # A 4-7 digit prefix, city: any # A city name, state: any # A two-letter state code. Example: CA, IL, etc., zipcode: any # A five-digit Zipcode, labelName: any # A label name, tollFree: any # ~, fields: any # 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.}\n@returns(200) successful operation\n@errors {400: Bad request, 401: Unauthorized, 403: Forbidden, 404: Not found, 500: Internal Server Error}\n\n@endpoint GET /numbers/leases/configs\n@desc Find lease configs\n@optional {limit: any # To set the maximum number of records to return in a paged list response. The default is 100, offset: any # 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: any # A 4-7 digit prefix, city: any # A city name, state: any # A two-letter state code. Example: CA, IL, etc., zipcode: any # A five-digit Zipcode, labelName: any # A label name, fields: any # 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.}\n@returns(200) successful operation\n@errors {400: Bad request, 401: Unauthorized, 403: Forbidden, 404: Not found, 500: Internal Server Error}\n\n@endpoint GET /numbers/leases/configs/{number}\n@desc Find a specific lease config\n@required {number: any # A phone number in E.164 format (11-digit). Example: 12132000384}\n@optional {fields: any # 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.}\n@returns(200) successful operation\n@errors {400: Bad request, 401: Unauthorized, 403: Forbidden, 404: Not found, 500: Internal Server Error}\n\n@endpoint PUT /numbers/leases/configs/{number}\n@desc Update a lease config\n@required {number: any # A phone number in E.164 format (11-digit) which needs to be verified. Example: 12132000384}\n@optional {body: map # The configuration of a number lease object. There are two available types of configuration: IVR, TRACKING}\n@errors {400: Bad request, 401: Unauthorized, 403: Forbidden, 404: Not found, 500: Internal Server Error}\n\n@endpoint GET /numbers/leases/{number}\n@desc Find a specific lease\n@required {number: any # A phone number in E.164 format (11-digit). Example: 12132000384}\n@optional {fields: any # 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.}\n@returns(200) successful operation\n@errors {400: Bad request, 401: Unauthorized, 403: Forbidden, 404: Not found, 500: Internal Server Error}\n\n@endpoint PUT /numbers/leases/{number}\n@desc Update a lease\n@required {number: any # A phone number in E.164 format (11-digit). Example: 12132000384}\n@optional {body: map # A NumberLease object to update}\n@errors {400: Bad request, 401: Unauthorized, 403: Forbidden, 404: Not found, 500: Internal Server Error}\n\n@endpoint GET /numbers/local\n@desc Find local numbers\n@optional {limit: any # To set the maximum number of records to return in a paged list response. The default is 100, prefix: any # A 4-7 digit prefix, city: any # A city name, state: any # A two-letter state code. Example: CA, IL, etc., zipcode: any # A five-digit Zipcode, fields: any # 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.}\n@returns(200) successful operation\n@errors {400: Bad request, 401: Unauthorized, 403: Forbidden, 404: Not found, 500: Internal Server Error}\n\n@endpoint GET /numbers/regions\n@desc Find number regions\n@optional {limit: any # To set the maximum number of records to return in a paged list response. The default is 100, offset: any # 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: any # A 4-7 digit prefix, city: any # A city name, cityPrefix: any # ~, state: any # A two-letter state code. Example: CA, IL, etc., zipcode: any # A five-digit Zipcode, country: any # ~, fields: any # 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.}\n@returns(200) successful operation\n@errors {400: Bad request, 401: Unauthorized, 403: Forbidden, 404: Not found, 500: Internal Server Error}\n\n@endpoint GET /numbers/tollfree\n@desc Find tollfree numbers\n@optional {pattern: any # 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: any # To set the maximum number of records to return in a paged list response. The default is 100, fields: any # 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.}\n@returns(200) successful operation\n@errors {400: Bad request, 401: Unauthorized, 403: Forbidden, 404: Not found, 500: Internal Server Error}\n\n@endgroup\n\n@group orders\n@endpoint GET /orders\n@desc Find orders\n@optional {limit: any # To set the maximum number of records to return in a paged list response. The default is 100, offset: any # 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: any # 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: any # 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: any # Start of the find time interval, formatted in unix time milliseconds. Example: 1473781817000, intervalEnd: any # End of the find time interval, formatted in unix time milliseconds. Example: 1473781817000}\n@returns(200) successful operation\n@errors {400: Bad request, 401: Unauthorized, 403: Forbidden, 404: Not found, 500: Internal Server Error}\n\n@endpoint POST /orders/keywords\n@desc Purchase keywords\n@optional {body: map # Request object which contains a list of keywords to buy, fields: any # 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.}\n@returns(201) successful operation\n@errors {400: Bad request, 401: Unauthorized, 403: Forbidden, 404: Not found, 500: Internal Server Error}\n\n@endpoint POST /orders/numbers\n@desc Purchase numbers\n@optional {body: map # Request object contains a list of numbers to buy, you can filter the numbers by their region information: city, state, zipcode, etc, fields: any # 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.}\n@returns(201) successful operation\n@errors {400: Bad request, 401: Unauthorized, 403: Forbidden, 404: Not found, 500: Internal Server Error}\n\n@endpoint GET /orders/{id}\n@desc Find a specific order\n@required {id: any # An id of an order}\n@optional {fields: any # 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.}\n@returns(200) successful operation\n@errors {400: Bad request, 401: Unauthorized, 403: Forbidden, 404: Not found, 500: Internal Server Error}\n\n@endgroup\n\n@group reports\n@endpoint GET /reports/delivery\n@desc Get delivery reports by ad hoc criteria\n@optional {startDate: any # ~, endDate: any # ~, limit: any # To set the maximum number of records to return in a paged list response. The default is 100, offset: any # 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: any # ~, fromNumber: any # ~, toNumber: any # ~, deliveryCategory: any # ~, deliveryState: any # ~, carrier: any # ~, messageText: any # ~}\n@returns(200) successful operation\n@errors {400: Bad request, 401: Unauthorized, 403: Forbidden, 404: Not found, 500: Internal Server Error}\n\n@endgroup\n\n@group texts\n@endpoint GET /texts\n@desc Find texts\n@optional {id: any # List of Text ids to search for, if ids specified other query params ignored, campaignId: any # 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: any # An Id of a contact batch, queries for texts which are used in the particular contact batch, fromNumber: any # A phone number in E.164 format (11-digit). Example: 12132000384, 67076, toNumber: any # A phone number in E.164 format (11-digit). Example: 12132000384, 67076, label: any # A label of a text message, states: any # 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: any # 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: any # 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: any # Start of the find time interval, formatted in unix time milliseconds. Example: 1473781817000, intervalEnd: any # End of the find time interval, formatted in unix time milliseconds. Example: 1473781817000, limit: any # To set the maximum number of records to return in a paged list response. The default is 100, offset: any # 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: any # 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.}\n@returns(200) successful operation\n@errors {400: Bad request, 401: Unauthorized, 403: Forbidden, 404: Not found, 500: Internal Server Error}\n\n@endpoint POST /texts\n@desc Send texts\n@optional {fields: any # 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: any # Specifies a campaignId to send texts through a previously created campaign, defaultMessage: any # 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: any # Turns on strict validation for recipients, body: [map] # List of TextRecipient objects. By recipient we mean either phone number or contact with user-defined attributes added to action. Text messaging supports media files, provide a list of ids of media files for recipient to attach media to the message.}\n@returns(200) successful operation\n@errors {400: Bad request, 401: Unauthorized, 403: Forbidden, 404: Not found, 500: Internal Server Error}\n\n@endpoint GET /texts/auto-replys\n@desc Find auto replies\n@optional {fields: any # 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: any # To set the maximum number of records to return in a paged list response. The default is 100, offset: any # 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: any # 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}\n@returns(200) successful operation\n@errors {400: Bad request, 401: Unauthorized, 403: Forbidden, 404: Not found, 500: Internal Server Error}\n\n@endpoint POST /texts/auto-replys\n@desc Create an auto reply\n@optional {body: map # TextAutoReply object, keyword or number should be specified with response message and text to match if needed}\n@returns(201) successful operation\n@errors {400: Bad request, 401: Unauthorized, 403: Forbidden, 404: Not found, 500: Internal Server Error}\n\n@endpoint GET /texts/auto-replys/{id}\n@desc Find a specific auto reply\n@required {id: any # An id of a text auto reply}\n@optional {fields: any # 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.}\n@returns(200) successful operation\n@errors {400: Bad request, 401: Unauthorized, 403: Forbidden, 404: Not found, 500: Internal Server Error}\n\n@endpoint DELETE /texts/auto-replys/{id}\n@desc Delete an auto reply\n@required {id: any # An id of a text auto reply}\n@errors {400: Bad request, 401: Unauthorized, 403: Forbidden, 404: Not found, 500: Internal Server Error}\n\n@endpoint GET /texts/broadcasts\n@desc Find text broadcasts\n@optional {name: any # A name of text broadcast, label: any # A label of a text broadcast, running: any # Returns broadcasts only in running state., scheduled: any # Specify whether the campaigns should be scheduled or not, intervalBegin: any # Start of the find time interval, formatted in unix time milliseconds. Example: 1473781817000 for Sat, 05 Jan 1985 14:03:37 GMT, intervalEnd: any # End of the find time interval, formatted in unix time milliseconds. Example: 1473781817000 for Sat, 05 Jan 1985 14:03:37 GMT, limit: any # To set the maximum number of records to return in a paged list response. The default is 100, offset: any # 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: any # 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.}\n@returns(200) successful operation\n@errors {400: Bad request, 401: Unauthorized, 403: Forbidden, 404: Not found, 500: Internal Server Error}\n\n@endpoint POST /texts/broadcasts\n@desc Create a text broadcast\n@optional {start: any # If true then starts the campaign immediately (not required)., strictValidation: any # Turns on strict validation for recipients. System will reply with BAD_REQUEST(400) if strictValidation = true and one of numbers didn't pass validation, body: map # A TextBroadcast object}\n@returns(201) successful operation\n@errors {400: Bad request, 401: Unauthorized, 403: Forbidden, 404: Not found, 500: Internal Server Error}\n\n@endpoint GET /texts/broadcasts/{id}\n@desc Find a specific text broadcast\n@required {id: any # An id of a text broadcast}\n@optional {fields: any # 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.}\n@returns(200) successful operation\n@errors {400: Bad request, 401: Unauthorized, 403: Forbidden, 404: Not found, 500: Internal Server Error}\n\n@endpoint PUT /texts/broadcasts/{id}\n@desc Update a text broadcast\n@required {id: any # An id of a text broadcast}\n@optional {strictValidation: any # Turns on strict validation for recipients. System will reply with BAD_REQUEST(400) if strictValidation = true and one of numbers didn't pass validation, body: map # A TextBroadcast object}\n@returns(200) successful operation\n@errors {400: Bad request, 401: Unauthorized, 403: Forbidden, 404: Not found, 500: Internal Server Error}\n\n@endpoint POST /texts/broadcasts/{id}/archive\n@desc Archive text broadcast\n@required {id: any # An id of a text broadcast to archive}\n@errors {400: Bad request, 401: Unauthorized, 403: Forbidden, 404: Not found, 500: Internal Server Error}\n\n@endpoint GET /texts/broadcasts/{id}/batches\n@desc Find batches in a text broadcast\n@required {id: any # An id of a text broadcast}\n@optional {fields: any # 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: any # To set the maximum number of records to return in a paged list response. The default is 100, offset: any # 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.}\n@returns(200) successful operation\n@errors {400: Bad request, 401: Unauthorized, 403: Forbidden, 404: Not found, 500: Internal Server Error}\n\n@endpoint POST /texts/broadcasts/{id}/batches\n@desc Add batches to a text broadcast\n@required {id: any # An id of a text broadcast}\n@optional {strictValidation: any # Turns on strict validation for recipients. System will reply with BAD_REQUEST(400) if strictValidation = true and one of numbers didn't pass validation, body: map # A request object}\n@returns(201) successful operation\n@errors {400: Bad request, 401: Unauthorized, 403: Forbidden, 404: Not found, 500: Internal Server Error}\n\n@endpoint POST /texts/broadcasts/{id}/recipients\n@desc Add recipients to a text broadcast\n@required {id: any # An id of a text broadcast}\n@optional {fields: any # 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: any # Turns on strict validation for recipients. System will reply with BAD_REQUEST(400) if strictValidation = true and one of numbers didn't pass validation, sendImmediately: any # ~, body: [map] # A list of the TextRecipient objects}\n@returns(200) successful operation\n@errors {400: Bad request, 401: Unauthorized, 403: Forbidden, 404: Not found, 500: Internal Server Error}\n\n@endpoint POST /texts/broadcasts/{id}/start\n@desc Start text broadcast\n@required {id: any # An id of a text broadcast to start}\n@errors {400: Bad request, 401: Unauthorized, 403: Forbidden, 404: Not found, 500: Internal Server Error}\n\n@endpoint GET /texts/broadcasts/{id}/stats\n@desc Get statistics on text broadcast\n@required {id: any # An id of a text broadcast}\n@optional {fields: any # 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: any # Start of a search find time interval, formatted in unix time milliseconds. Example: 1473781817000 for Sat, 05 Jan 1985 14:03:37 GMT, end: any # End of a search time interval, formatted in unix time milliseconds. Example: 1473781817000 for Sat, 05 Jan 1985 14:03:37 GMT}\n@returns(200) successful operation\n@errors {400: Bad request, 401: Unauthorized, 403: Forbidden, 404: Not found, 500: Internal Server Error}\n\n@endpoint POST /texts/broadcasts/{id}/stop\n@desc Stop text broadcast\n@required {id: any # An Id of a text broadcast. To stop the broadcast}\n@errors {400: Bad request, 401: Unauthorized, 403: Forbidden, 404: Not found, 500: Internal Server Error}\n\n@endpoint GET /texts/broadcasts/{id}/texts\n@desc Find texts in a text broadcast\n@required {id: any # An id of a text broadcast}\n@optional {batchId: any # ~, fields: any # 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: any # To set the maximum number of records to return in a paged list response. The default is 100, offset: any # 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.}\n@returns(200) successful operation\n@errors {400: Bad request, 401: Unauthorized, 403: Forbidden, 404: Not found, 500: Internal Server Error}\n\n@endpoint POST /texts/broadcasts/{id}/toggleRecipientsStatus\n@desc Disable/enable undialed recipients in broadcast\n@required {id: any # An id of a text broadcast}\n@optional {enable: any # Flag which indicate what to do with texts (true will enable texts in DISABLED status and vice versa), body: [map] # List of Recipient objects. By recipient we mean either phone number or contact id.}\n@errors {400: Bad request, 401: Unauthorized, 403: Forbidden, 404: Not found, 500: Internal Server Error}\n\n@endpoint GET /texts/{id}\n@desc Find a specific text\n@required {id: any # An id of a text}\n@optional {fields: any # 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.}\n@returns(200) successful operation\n@errors {400: Bad request, 401: Unauthorized, 403: Forbidden, 404: Not found, 500: Internal Server Error}\n\n@endgroup\n\n@group webhooks\n@endpoint GET /webhooks\n@desc Find webhooks\n@optional {fields: any # 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: any # To set the maximum number of records to return in a paged list response. The default is 100, offset: any # 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: any # A name of a webhook, resource: any # A name of a resource, available values: 'CccCampaign', 'CallBroadcast', 'TextBroadcast',  'OutboundCall', 'OutboundText', 'InboundCall', 'InboundText', 'ContactList', event: any # A name of event, available values: 'started', 'stopped', 'finished', callback: any # A callback URL, enabled: any # Specifies whether webhook is enabled}\n@returns(200) successful operation\n@errors {400: Bad request, 401: Unauthorized, 403: Forbidden, 404: Not found, 500: Internal Server Error}\n\n@endpoint POST /webhooks\n@desc Create a webhook\n@optional {body: map # A webhook object}\n@returns(201) successful operation\n@errors {400: Bad request, 401: Unauthorized, 403: Forbidden, 404: Not found, 500: Internal Server Error}\n\n@endpoint GET /webhooks/resources\n@desc Find webhook resources\n@optional {fields: any # 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.}\n@returns(200) successful operation\n@errors {400: Bad request, 401: Unauthorized, 403: Forbidden, 404: Not found, 500: Internal Server Error}\n\n@endpoint GET /webhooks/resources/{resource}\n@desc Find specific webhook resource\n@required {resource: any # 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']}\n@optional {fields: any # 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.}\n@returns(200) successful operation\n@errors {400: Bad request, 401: Unauthorized, 403: Forbidden, 404: Not found, 500: Internal Server Error}\n\n@endpoint GET /webhooks/{id}\n@desc Find a specific webhook\n@required {id: any # An id of a webhook}\n@optional {fields: any # 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.}\n@returns(200) successful operation\n@errors {400: Bad request, 401: Unauthorized, 403: Forbidden, 404: Not found, 500: Internal Server Error}\n\n@endpoint PUT /webhooks/{id}\n@desc Update a webhook\n@required {id: any # An id of a webhook}\n@optional {body: map # A webhook object}\n@errors {400: Bad request, 401: Unauthorized, 403: Forbidden, 404: Not found, 500: Internal Server Error}\n\n@endpoint DELETE /webhooks/{id}\n@desc Delete a webhook\n@required {id: any # An Id of a webhook}\n@errors {400: Bad request, 401: Unauthorized, 403: Forbidden, 404: Not found, 500: Internal Server Error}\n\n@endgroup\n\n@end\n"}