{"openapi":"3.1.0","info":{"title":"Apizie","version":"2.0.0","description":"One API key, one envelope, many public data sources."},"servers":[{"url":"https://zieapi.vercel.app"}],"security":[{"ApiKeyAuth":[]}],"paths":{"/v1/communication:callfire/find-calls":{"get":{"operationId":"communication_callfire_find_calls","summary":"Find calls","description":"GET /calls","tags":["communication"],"parameters":[{"name":"fields","in":"query","required":false,"description":"Limit fields received in response. E.g. fields: id, name or fields items (id, name), see more at [partial…","schema":{"type":"string","description":"Limit fields received in response. E.g. fields: id, name or fields items (id, name), see more at [partial…"}},{"name":"limit","in":"query","required":false,"description":"To set the maximum number of records to return in a paged list response. The default is 100","schema":{"type":"integer","default":100,"description":"To set the maximum number of records to return in a paged list response. The default is 100"}},{"name":"offset","in":"query","required":false,"description":"Offset to the start of a given page. The default is 0. Check [pagination](https://developers.callfire.com/docs.html#pagination) page for…","schema":{"type":"integer","default":0,"description":"Offset to the start of a given page. The default is 0. Check [pagination](https://developers.callfire.com/docs.html#pagination) page for…"}},{"name":"id","in":"query","required":false,"description":"Lists the Call ids to search for. If calls ids are specified then other query parameters can be ignored","schema":{"type":"array","description":"Lists the Call ids to search for. If calls ids are specified then other query parameters can be ignored"}},{"name":"campaignId","in":"query","required":false,"description":"An id of a campaign, queries for calls included to a particular campaign. Specify null for all campaigns and 0 for default campaign","schema":{"type":"integer","description":"An id of a campaign, queries for calls included to a particular campaign. Specify null for all campaigns and 0 for default campaign"}},{"name":"batchId","in":"query","required":false,"description":"An id of a contact batch, queries for calls of a particular contact batch","schema":{"type":"integer","description":"An id of a contact batch, queries for calls of a particular contact batch"}},{"name":"fromNumber","in":"query","required":false,"description":"Phone number in E.164 format (11-digit) that call was from. Example: 12132000384","schema":{"type":"string","description":"Phone number in E.164 format (11-digit) that call was from. Example: 12132000384"}},{"name":"toNumber","in":"query","required":false,"description":"Phone number in E.164 format (11-digit) that call was sent to. Example: 12132000384","schema":{"type":"string","description":"Phone number in E.164 format (11-digit) that call was sent to. Example: 12132000384"}},{"name":"label","in":"query","required":false,"description":"A label for a specific call","schema":{"type":"string","description":"A label for a specific call"}},{"name":"states","in":"query","required":false,"description":"Searches for all calls which correspond to statuses listed in a comma separated string. Available values: READY, SELECTED, CALLBACK,…","schema":{"type":"string","description":"Searches for all calls which correspond to statuses listed in a comma separated string. Available values: READY, SELECTED, CALLBACK,…"}},{"name":"results","in":"query","required":false,"description":"Searches for all calls with statuses listed in a comma separated string. Available values: SENT, RECEIVED, DNT, TOO_BIG, INTERNAL_ERROR,…","schema":{"type":"string","description":"Searches for all calls with statuses listed in a comma separated string. Available values: SENT, RECEIVED, DNT, TOO_BIG, INTERNAL_ERROR,…"}},{"name":"inbound","in":"query","required":false,"description":"Filters inbound calls for \"true\" value and outbound calls for \"false\" value","schema":{"type":"boolean","description":"Filters inbound calls for \"true\" value and outbound calls for \"false\" value"}},{"name":"intervalBegin","in":"query","required":false,"description":"Start of the find time interval, formatted in unix time milliseconds. Example: 1473781817000 for Sat, 05 Jan 1985 14:03:37 GMT","schema":{"type":"integer","description":"Start of the find time interval, formatted in unix time milliseconds. Example: 1473781817000 for Sat, 05 Jan 1985 14:03:37 GMT"}},{"name":"intervalEnd","in":"query","required":false,"description":"End of the find time interval, formatted in unix time milliseconds. Example: 1473781817000 for Sat, 05 Jan 1985 14:03:37 GMT","schema":{"type":"integer","description":"End of the find time interval, formatted in unix time milliseconds. Example: 1473781817000 for Sat, 05 Jan 1985 14:03:37 GMT"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:callfire/send-calls":{"post":{"operationId":"communication_callfire_send_calls","summary":"Send calls","description":"POST /calls","tags":["communication"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"fields":{"type":"string","description":"Limit fields received in response. E.g. fields: id, name or fields items (id, name), see more at [partial…"},"campaignId":{"type":"integer","description":"Specifies a campaignId to send calls quickly on a previously created campaign"},"defaultLiveMessage":{"type":"string","description":"Text to be turned into a sound, this text will be played when the phone is answered. Parameter can be overridden for any particular…"},"defaultMachineMessage":{"type":"string","description":"Text to be turned into a sound, this text will be played when answering machine is detected. Parameter can be overridden for any…"},"defaultLiveMessageSoundId":{"type":"integer","description":"Id of sound file to play if phone is answered. Parameter can be overridden for any particular CallRecipient"},"defaultMachineMessageSoundId":{"type":"integer","description":"An id of a sound file to play if answering machine is detected. Parameter can be overridden for any particular CallRecipient"},"defaultVoice":{"type":"string","enum":["MALE1","FEMALE1","FEMALE2","SPANISH1","FRENCHCANADIAN1"],"description":"The voice set by default for all text-to-speech messages defined in CallRecipient objects or as default *Message properties"},"strictValidation":{"type":"boolean","description":"Turns on strict validation for recipients. System will reply with BAD_REQUEST(400) if strictValidation = true and one of numbers didn't…"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:callfire/find-call-broadcasts":{"get":{"operationId":"communication_callfire_find_call_broadcasts","summary":"Find call broadcasts","description":"GET /calls/broadcasts","tags":["communication"],"parameters":[{"name":"fields","in":"query","required":false,"description":"Limit fields received in response. E.g. fields: id, name or fields items (id, name), see more at [partial…","schema":{"type":"string","description":"Limit fields received in response. E.g. fields: id, name or fields items (id, name), see more at [partial…"}},{"name":"limit","in":"query","required":false,"description":"To set the maximum number of records to return in a paged list response. The default is 100","schema":{"type":"integer","default":10,"description":"To set the maximum number of records to return in a paged list response. The default is 100"}},{"name":"offset","in":"query","required":false,"description":"Offset to the start of a given page. The default is 0. Check [pagination](https://developers.callfire.com/docs.html#pagination) page for…","schema":{"type":"integer","default":0,"description":"Offset to the start of a given page. The default is 0. Check [pagination](https://developers.callfire.com/docs.html#pagination) page for…"}},{"name":"label","in":"query","required":false,"description":"A label of a voice broadcast","schema":{"type":"string","description":"A label of a voice broadcast"}},{"name":"name","in":"query","required":false,"description":"A name of voice broadcast","schema":{"type":"string","description":"A name of voice broadcast"}},{"name":"running","in":"query","required":false,"description":"Specify whether the campaigns should be running or not","schema":{"type":"boolean","description":"Specify whether the campaigns should be running or not"}},{"name":"scheduled","in":"query","required":false,"description":"Specify whether the campaigns should be scheduled or not","schema":{"type":"boolean","description":"Specify whether the campaigns should be scheduled or not"}},{"name":"intervalBegin","in":"query","required":false,"description":"Start of the find time interval, formatted in unix time milliseconds. Example: 1473781817000 for Sat, 05 Jan 1985 14:03:37 GMT","schema":{"type":"integer","description":"Start of the find time interval, formatted in unix time milliseconds. Example: 1473781817000 for Sat, 05 Jan 1985 14:03:37 GMT"}},{"name":"intervalEnd","in":"query","required":false,"description":"End of the find time interval, formatted in unix time milliseconds. Example: 1473781817000 for Sat, 05 Jan 1985 14:03:37 GMT","schema":{"type":"integer","description":"End of the find time interval, formatted in unix time milliseconds. Example: 1473781817000 for Sat, 05 Jan 1985 14:03:37 GMT"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:callfire/create-call-broadcast":{"post":{"operationId":"communication_callfire_create_call_broadcast","summary":"Create a call broadcast","description":"POST /calls/broadcasts","tags":["communication"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"start":{"type":"boolean","description":"Specify whether to immediately start this campaign (not required)"},"strictValidation":{"type":"boolean","description":"Turns on strict validation for recipients. System will reply with BAD_REQUEST(400) if strictValidation = true and one of numbers didn't…"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:callfire/get-call-broadcast":{"get":{"operationId":"communication_callfire_get_call_broadcast","summary":"Find a specific call broadcast","description":"GET /calls/broadcasts/{id}","tags":["communication"],"parameters":[{"name":"id","in":"query","required":true,"description":"An id of a CallBroadcast","schema":{"type":"integer","description":"An id of a CallBroadcast"}},{"name":"fields","in":"query","required":false,"description":"Limit fields received in response. E.g. fields: id, name or fields items (id, name), see more at [partial…","schema":{"type":"string","description":"Limit fields received in response. E.g. fields: id, name or fields items (id, name), see more at [partial…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:callfire/update-call-broadcast":{"post":{"operationId":"communication_callfire_update_call_broadcast","summary":"Update a call broadcast","description":"PUT /calls/broadcasts/{id}","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"integer","description":"An id of a voice broadcast"},"strictValidation":{"type":"boolean","description":"Turns on strict validation for recipients. System will reply with BAD_REQUEST(400) if strictValidation = true and one of numbers didn't…"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:callfire/archive-voice-broadcast":{"post":{"operationId":"communication_callfire_archive_voice_broadcast","summary":"Archive voice broadcast","description":"POST /calls/broadcasts/{id}/archive","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"integer","description":"An id of a voice broadcast to archive"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:callfire/get-call-broadcast-batches":{"get":{"operationId":"communication_callfire_get_call_broadcast_batches","summary":"Find batches in a call broadcast","description":"GET /calls/broadcasts/{id}/batches","tags":["communication"],"parameters":[{"name":"id","in":"query","required":true,"description":"An id of a call broadcast","schema":{"type":"integer","description":"An id of a call broadcast"}},{"name":"fields","in":"query","required":false,"description":"Limit fields received in response. E.g. fields: id, name or fields items (id, name), see more at [partial…","schema":{"type":"string","description":"Limit fields received in response. E.g. fields: id, name or fields items (id, name), see more at [partial…"}},{"name":"limit","in":"query","required":false,"description":"To set the maximum number of records to return in a paged list response. The default is 100","schema":{"type":"integer","default":100,"description":"To set the maximum number of records to return in a paged list response. The default is 100"}},{"name":"offset","in":"query","required":false,"description":"Offset to the start of a given page. The default is 0. Check [pagination](https://developers.callfire.com/docs.html#pagination) page for…","schema":{"type":"integer","default":0,"description":"Offset to the start of a given page. The default is 0. Check [pagination](https://developers.callfire.com/docs.html#pagination) page for…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:callfire/add-call-broadcast-batch":{"post":{"operationId":"communication_callfire_add_call_broadcast_batch","summary":"Add batches to a call broadcast","description":"POST /calls/broadcasts/{id}/batches","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"integer","description":"An id of a call broadcast"},"strictValidation":{"type":"boolean","description":"Turns on strict validation for recipients. System will reply with BAD_REQUEST(400) if strictValidation = true and one of numbers didn't…"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:callfire/get-call-broadcast-calls":{"get":{"operationId":"communication_callfire_get_call_broadcast_calls","summary":"Find calls in a call broadcast","description":"GET /calls/broadcasts/{id}/calls","tags":["communication"],"parameters":[{"name":"id","in":"query","required":true,"description":"An Id of a call broadcast","schema":{"type":"integer","description":"An Id of a call broadcast"}},{"name":"batchId","in":"query","required":false,"description":"An id of a particular batch associated with broadcast","schema":{"type":"integer","description":"An id of a particular batch associated with broadcast"}},{"name":"fields","in":"query","required":false,"description":"Limit fields received in response. E.g. fields: id, name or fields items (id, name), see more at [partial…","schema":{"type":"string","description":"Limit fields received in response. E.g. fields: id, name or fields items (id, name), see more at [partial…"}},{"name":"limit","in":"query","required":false,"description":"To set the maximum number of records to return in a paged list response. The default is 100","schema":{"type":"integer","default":100,"description":"To set the maximum number of records to return in a paged list response. The default is 100"}},{"name":"offset","in":"query","required":false,"description":"Offset to the start of a given page. The default is 0. Check [pagination](https://developers.callfire.com/docs.html#pagination) page for…","schema":{"type":"integer","default":0,"description":"Offset to the start of a given page. The default is 0. Check [pagination](https://developers.callfire.com/docs.html#pagination) page for…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:callfire/add-call-broadcast-recipients":{"post":{"operationId":"communication_callfire_add_call_broadcast_recipients","summary":"Add recipients to a call broadcast","description":"POST /calls/broadcasts/{id}/recipients","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"integer","description":"An id of a call broadcast"},"fields":{"type":"string","description":"Limit fields received in response. E.g. fields: id, name or fields items (id, name), see more at [partial…"},"strictValidation":{"type":"boolean","description":"Turns on strict validation for recipients. System will reply with BAD_REQUEST(400) if strictValidation = true and one of numbers didn't…"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:callfire/start-voice-broadcast":{"post":{"operationId":"communication_callfire_start_voice_broadcast","summary":"Start voice broadcast","description":"POST /calls/broadcasts/{id}/start","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"integer","description":"An id of voice broadcast to start"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:callfire/get-call-broadcast-stats":{"get":{"operationId":"communication_callfire_get_call_broadcast_stats","summary":"Get statistics on call broadcast","description":"GET /calls/broadcasts/{id}/stats","tags":["communication"],"parameters":[{"name":"id","in":"query","required":true,"description":"An id of a call broadcast","schema":{"type":"integer","description":"An id of a call broadcast"}},{"name":"fields","in":"query","required":false,"description":"Limit fields received in response. E.g. fields: id, name or fields items (id, name), see more at [partial…","schema":{"type":"string","description":"Limit fields received in response. E.g. fields: id, name or fields items (id, name), see more at [partial…"}},{"name":"begin","in":"query","required":false,"description":"Start of the search time interval, formatted in unix time milliseconds. Example: 1473781817000 for Sat, 05 Jan 1985 14:03:37 GMT","schema":{"type":"integer","description":"Start of the search time interval, formatted in unix time milliseconds. Example: 1473781817000 for Sat, 05 Jan 1985 14:03:37 GMT"}},{"name":"end","in":"query","required":false,"description":"End of the search time interval, formatted in unix time milliseconds. Example: 1473781817000 for Sat, 05 Jan 1985 14:03:37 GMT","schema":{"type":"integer","description":"End of the search time interval, formatted in unix time milliseconds. Example: 1473781817000 for Sat, 05 Jan 1985 14:03:37 GMT"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:callfire/stop-voice-broadcast":{"post":{"operationId":"communication_callfire_stop_voice_broadcast","summary":"Stop voice broadcast","description":"POST /calls/broadcasts/{id}/stop","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"integer","description":"An id of voice broadcast to stop"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:callfire/toggle-call-broadcast-recipients-status":{"post":{"operationId":"communication_callfire_toggle_call_broadcast_recipients_status","summary":"Disable/enable undialed recipients in broadcast","description":"POST /calls/broadcasts/{id}/toggleRecipientsStatus","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"integer","description":"An id of a voice broadcast"},"enable":{"type":"boolean","default":false,"description":"Flag which indicate what to do with calls (true will enable call in DISABLED status and vice versa)"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:callfire/get-call-recording":{"get":{"operationId":"communication_callfire_get_call_recording","summary":"Get call recording by id","description":"GET /calls/recordings/{id}","tags":["communication"],"parameters":[{"name":"id","in":"query","required":true,"description":"~","schema":{"type":"integer","description":"~"}},{"name":"fields","in":"query","required":false,"description":"Limit fields received in response. E.g. fields: id, name or fields items (id, name), see more at [partial…","schema":{"type":"string","description":"Limit fields received in response. E.g. fields: id, name or fields items (id, name), see more at [partial…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:callfire/get-call-recording-mp3":{"get":{"operationId":"communication_callfire_get_call_recording_mp3","summary":"Get call recording in mp3 format","description":"GET /calls/recordings/{id}.mp3","tags":["communication"],"parameters":[{"name":"id","in":"query","required":true,"description":"An id of a call","schema":{"type":"integer","description":"An id of a call"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:callfire/get-call":{"get":{"operationId":"communication_callfire_get_call","summary":"Find a specific call","description":"GET /calls/{id}","tags":["communication"],"parameters":[{"name":"id","in":"query","required":true,"description":"An id of a call","schema":{"type":"integer","description":"An id of a call"}},{"name":"fields","in":"query","required":false,"description":"Limit fields received in response. E.g. fields: id, name or fields items (id, name), see more at [partial…","schema":{"type":"string","description":"Limit fields received in response. E.g. fields: id, name or fields items (id, name), see more at [partial…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:callfire/get-call-recordings":{"get":{"operationId":"communication_callfire_get_call_recordings","summary":"Get call recordings for a call","description":"GET /calls/{id}/recordings","tags":["communication"],"parameters":[{"name":"id","in":"query","required":true,"description":"An id of a call","schema":{"type":"integer","description":"An id of a call"}},{"name":"fields","in":"query","required":false,"description":"Limit fields received in response. E.g. fields: id, name or fields items (id, name), see more at [partial…","schema":{"type":"string","description":"Limit fields received in response. E.g. fields: id, name or fields items (id, name), see more at [partial…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:callfire/get-call-recording-by-name":{"get":{"operationId":"communication_callfire_get_call_recording_by_name","summary":"Get call recording by name","description":"GET /calls/{id}/recordings/{name}","tags":["communication"],"parameters":[{"name":"id","in":"query","required":true,"description":"An id of a call","schema":{"type":"integer","description":"An id of a call"}},{"name":"name","in":"query","required":true,"description":"A name of a recording","schema":{"type":"string","description":"A name of a recording"}},{"name":"fields","in":"query","required":false,"description":"Limit fields received in response. E.g. fields: id, name or fields items (id, name), see more at [partial…","schema":{"type":"string","description":"Limit fields received in response. E.g. fields: id, name or fields items (id, name), see more at [partial…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:callfire/get-call-recording-mp3-by-name":{"get":{"operationId":"communication_callfire_get_call_recording_mp3_by_name","summary":"Get call mp3 recording by name","description":"GET /calls/{id}/recordings/{name}.mp3","tags":["communication"],"parameters":[{"name":"id","in":"query","required":true,"description":"An id of a call","schema":{"type":"integer","description":"An id of a call"}},{"name":"name","in":"query","required":true,"description":"A name of a recording","schema":{"type":"string","description":"A name of a recording"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:callfire/get-campaign-batch":{"get":{"operationId":"communication_callfire_get_campaign_batch","summary":"Find a specific batch","description":"GET /campaigns/batches/{id}","tags":["communication"],"parameters":[{"name":"id","in":"query","required":true,"description":"An id of a batch","schema":{"type":"integer","description":"An id of a batch"}},{"name":"fields","in":"query","required":false,"description":"Limit fields received in response. E.g. fields: id, name or fields items (id, name), see more at [partial…","schema":{"type":"string","description":"Limit fields received in response. E.g. fields: id, name or fields items (id, name), see more at [partial…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:callfire/update-campaign-batch":{"post":{"operationId":"communication_callfire_update_campaign_batch","summary":"Update a batch","description":"PUT /campaigns/batches/{id}","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"integer","description":"An id of a batch to update"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:callfire/find-campaign-sounds":{"get":{"operationId":"communication_callfire_find_campaign_sounds","summary":"Find sounds","description":"GET /campaigns/sounds","tags":["communication"],"parameters":[{"name":"limit","in":"query","required":false,"description":"To set the maximum number of records to return in a paged list response. The default is 100","schema":{"type":"integer","default":100,"description":"To set the maximum number of records to return in a paged list response. The default is 100"}},{"name":"offset","in":"query","required":false,"description":"Offset to the start of a given page. The default is 0. Check [pagination](https://developers.callfire.com/docs.html#pagination) page for…","schema":{"type":"integer","default":0,"description":"Offset to the start of a given page. The default is 0. Check [pagination](https://developers.callfire.com/docs.html#pagination) page for…"}},{"name":"filter","in":"query","required":false,"description":"value to filter file names again; this value is used to check if the filename contains the filter value.","schema":{"type":"string","description":"value to filter file names again; this value is used to check if the filename contains the filter value."}},{"name":"includeArchived","in":"query","required":false,"description":"Includes ARCHIVED sounds for \"true\" value","schema":{"type":"boolean","description":"Includes ARCHIVED sounds for \"true\" value"}},{"name":"includePending","in":"query","required":false,"description":"Includes UPLOAD/RECORDING sounds for \"true\" value","schema":{"type":"boolean","description":"Includes UPLOAD/RECORDING sounds for \"true\" value"}},{"name":"includeScrubbed","in":"query","required":false,"description":"Includes SCRUBBED sounds for \"true\" value","schema":{"type":"boolean","description":"Includes SCRUBBED sounds for \"true\" value"}},{"name":"fields","in":"query","required":false,"description":"Limit fields received in response. E.g. fields: id, name or fields items (id, name), see more at [partial…","schema":{"type":"string","description":"Limit fields received in response. E.g. fields: id, name or fields items (id, name), see more at [partial…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:callfire/post-call-campaign-sound":{"post":{"operationId":"communication_callfire_post_call_campaign_sound","summary":"Add sound via call","description":"POST /campaigns/sounds/calls","tags":["communication"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"fields":{"type":"string","description":"Limit fields received in response. E.g. fields: id, name or fields items (id, name), see more at [partial…"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:callfire/post-file-campaign-sound":{"post":{"operationId":"communication_callfire_post_file_campaign_sound","summary":"Add sound via file","description":"POST /campaigns/sounds/files","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"fields":{"type":"string","description":"Limit fields received in response. E.g. fields: id, name or fields items (id, name), see more at [partial…"},"body":{"type":"object","description":"Form fields as a JSON object"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:callfire/post-ttscampaign-sound":{"post":{"operationId":"communication_callfire_post_ttscampaign_sound","summary":"Add sound via text-to-speech","description":"POST /campaigns/sounds/tts","tags":["communication"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"fields":{"type":"string","description":"Limit fields received in response. E.g. fields: id, name or fields items (id, name), see more at [partial…"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:callfire/get-campaign-sound":{"get":{"operationId":"communication_callfire_get_campaign_sound","summary":"Find a specific sound","description":"GET /campaigns/sounds/{id}","tags":["communication"],"parameters":[{"name":"id","in":"query","required":true,"description":"An id of a sound campaign","schema":{"type":"integer","description":"An id of a sound campaign"}},{"name":"fields","in":"query","required":false,"description":"Limit fields received in response. E.g. fields: id, name or fields items (id, name), see more at [partial…","schema":{"type":"string","description":"Limit fields received in response. E.g. fields: id, name or fields items (id, name), see more at [partial…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:callfire/delete-campaign-sound":{"post":{"operationId":"communication_callfire_delete_campaign_sound","summary":"Delete a specific sound","description":"DELETE /campaigns/sounds/{id}","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"integer","description":"An id of a campaign sound"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:callfire/get-campaign-sound-data-mp3":{"get":{"operationId":"communication_callfire_get_campaign_sound_data_mp3","summary":"Download a MP3 sound","description":"GET /campaigns/sounds/{id}.mp3","tags":["communication"],"parameters":[{"name":"id","in":"query","required":true,"description":"An id of a campaign sound","schema":{"type":"integer","description":"An id of a campaign sound"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:callfire/get-campaign-sound-data-wav":{"get":{"operationId":"communication_callfire_get_campaign_sound_data_wav","summary":"Download a WAV sound","description":"GET /campaigns/sounds/{id}.wav","tags":["communication"],"parameters":[{"name":"id","in":"query","required":true,"description":"An id of a campaign sound","schema":{"type":"integer","description":"An id of a campaign sound"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:callfire/find-contacts":{"get":{"operationId":"communication_callfire_find_contacts","summary":"Find contacts","description":"GET /contacts","tags":["communication"],"parameters":[{"name":"fields","in":"query","required":false,"description":"Limit fields received in response. E.g. fields: id, name or fields items (id, name), see more at [partial…","schema":{"type":"string","description":"Limit fields received in response. E.g. fields: id, name or fields items (id, name), see more at [partial…"}},{"name":"limit","in":"query","required":false,"description":"To set the maximum number of records to return in a paged list response. The default is 100","schema":{"type":"integer","default":100,"description":"To set the maximum number of records to return in a paged list response. The default is 100"}},{"name":"offset","in":"query","required":false,"description":"Offset to the start of a given page. The default is 0. Check [pagination](https://developers.callfire.com/docs.html#pagination) page for…","schema":{"type":"integer","default":0,"description":"Offset to the start of a given page. The default is 0. Check [pagination](https://developers.callfire.com/docs.html#pagination) page for…"}},{"name":"id","in":"query","required":false,"description":"A list of contact IDs. If the id parameter is included, the other query parameters are ignored.","schema":{"type":"array","description":"A list of contact IDs. If the id parameter is included, the other query parameters are ignored."}},{"name":"number","in":"query","required":false,"description":"Multiple contact numbers can be specified. If the number parameter is included, the other query parameters are ignored.","schema":{"type":"array","description":"Multiple contact numbers can be specified. If the number parameter is included, the other query parameters are ignored."}},{"name":"contactListId","in":"query","required":false,"description":"Filters contacts by a particular contact list","schema":{"type":"integer","description":"Filters contacts by a particular contact list"}},{"name":"propertyName","in":"query","required":false,"description":"Name of a contact property to search by","schema":{"type":"string","description":"Name of a contact property to search by"}},{"name":"propertyValue","in":"query","required":false,"description":"Value of a contact property to search by","schema":{"type":"string","description":"Value of a contact property to search by"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:callfire/create-contacts":{"post":{"operationId":"communication_callfire_create_contacts","summary":"Create contacts","description":"POST /contacts","tags":["communication"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:callfire/find-do-not-contacts":{"get":{"operationId":"communication_callfire_find_do_not_contacts","summary":"Find do not contact (dnc) items","description":"GET /contacts/dncs","tags":["communication"],"parameters":[{"name":"fields","in":"query","required":false,"description":"Limit fields received in response. E.g. fields: id, name or fields items (id, name), see more at [partial…","schema":{"type":"string","description":"Limit fields received in response. E.g. fields: id, name or fields items (id, name), see more at [partial…"}},{"name":"limit","in":"query","required":false,"description":"To set the maximum number of records to return in a paged list response. The default is 100","schema":{"type":"integer","default":100,"description":"To set the maximum number of records to return in a paged list response. The default is 100"}},{"name":"offset","in":"query","required":false,"description":"Offset to the start of a given page. The default is 0. Check [pagination](https://developers.callfire.com/docs.html#pagination) page for…","schema":{"type":"integer","default":0,"description":"Offset to the start of a given page. The default is 0. Check [pagination](https://developers.callfire.com/docs.html#pagination) page for…"}},{"name":"prefix","in":"query","required":false,"description":"Prefix (1-10 digits) of phone numbers","schema":{"type":"string","description":"Prefix (1-10 digits) of phone numbers"}},{"name":"campaignId","in":"query","required":false,"description":"A campaign id which was used to send a message to a DNC number","schema":{"type":"integer","description":"A campaign id which was used to send a message to a DNC number"}},{"name":"source","in":"query","required":false,"description":"A DNC source name to search for DNCs","schema":{"type":"string","description":"A DNC source name to search for DNCs"}},{"name":"call","in":"query","required":false,"description":"Show only Do-Not-Call numbers","schema":{"type":"boolean","description":"Show only Do-Not-Call numbers"}},{"name":"text","in":"query","required":false,"description":"Show only Do-Not-Text numbers","schema":{"type":"boolean","description":"Show only Do-Not-Text numbers"}},{"name":"inboundCall","in":"query","required":false,"description":"~","schema":{"type":"boolean","description":"~"}},{"name":"inboundText","in":"query","required":false,"description":"~","schema":{"type":"boolean","description":"~"}},{"name":"number","in":"query","required":false,"description":"~","schema":{"type":"array","description":"~"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:callfire/add-do-not-contacts":{"post":{"operationId":"communication_callfire_add_do_not_contacts","summary":"Add do not contact (dnc) numbers","description":"POST /contacts/dncs","tags":["communication"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:callfire/delete-do-not-contacts-by-source":{"post":{"operationId":"communication_callfire_delete_do_not_contacts_by_source","summary":"Delete do not contact (dnc) numbers contained in source.","description":"DELETE /contacts/dncs/sources/{source}","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["source"],"properties":{"source":{"type":"string","description":"Source associated with Do Not Contact (DNC) entry."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:callfire/get-universal-do-not-contacts":{"get":{"operationId":"communication_callfire_get_universal_do_not_contacts","summary":"Find universal do not contacts (udnc) associated with toNumber","description":"GET /contacts/dncs/universals/{toNumber}","tags":["communication"],"parameters":[{"name":"toNumber","in":"query","required":true,"description":"A required destination phone number in E.164 format (11-digit). Example: 12132000384","schema":{"type":"string","description":"A required destination phone number in E.164 format (11-digit). Example: 12132000384"}},{"name":"fromNumber","in":"query","required":false,"description":"An optional destination/source number for DNC, specified in E.164 format (11-digit). Example: 12132000384","schema":{"type":"string","description":"An optional destination/source number for DNC, specified in E.164 format (11-digit). Example: 12132000384"}},{"name":"fields","in":"query","required":false,"description":"Limit fields received in response. E.g. fields: id, name or fields items (id, name), see more at [partial…","schema":{"type":"string","description":"Limit fields received in response. E.g. fields: id, name or fields items (id, name), see more at [partial…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:callfire/get-do-not-contact":{"get":{"operationId":"communication_callfire_get_do_not_contact","summary":"Get do not contact (dnc)","description":"GET /contacts/dncs/{number}","tags":["communication"],"parameters":[{"name":"number","in":"query","required":true,"description":"Number associated with Do Not Contact (DNC) entry.","schema":{"type":"string","description":"Number associated with Do Not Contact (DNC) entry."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:callfire/update-do-not-contact":{"post":{"operationId":"communication_callfire_update_do_not_contact","summary":"Update an individual do not contact (dnc) number","description":"PUT /contacts/dncs/{number}","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["number"],"properties":{"number":{"type":"string","description":"~"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:callfire/delete-do-not-contact":{"post":{"operationId":"communication_callfire_delete_do_not_contact","summary":"Delete do not contact (dnc) number. If number contains commas treat as list of numbers","description":"DELETE /contacts/dncs/{number}","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["number"],"properties":{"number":{"type":"string","description":"Number associated with Do Not Contact (DNC) entry."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:callfire/find-contact-lists":{"get":{"operationId":"communication_callfire_find_contact_lists","summary":"Find contact lists","description":"GET /contacts/lists","tags":["communication"],"parameters":[{"name":"fields","in":"query","required":false,"description":"Limit fields received in response. E.g. fields: id, name or fields items (id, name), see more at [partial…","schema":{"type":"string","description":"Limit fields received in response. E.g. fields: id, name or fields items (id, name), see more at [partial…"}},{"name":"limit","in":"query","required":false,"description":"To set the maximum number of records to return in a paged list response. The default is 100","schema":{"type":"integer","default":100,"description":"To set the maximum number of records to return in a paged list response. The default is 100"}},{"name":"offset","in":"query","required":false,"description":"Offset to the start of a given page. The default is 0. Check [pagination](https://developers.callfire.com/docs.html#pagination) page for…","schema":{"type":"integer","default":0,"description":"Offset to the start of a given page. The default is 0. Check [pagination](https://developers.callfire.com/docs.html#pagination) page for…"}},{"name":"name","in":"query","required":false,"description":"A name or a partial name of a contact list","schema":{"type":"string","description":"A name or a partial name of a contact list"}},{"name":"exactMatch","in":"query","required":false,"description":"~","schema":{"type":"boolean","description":"~"}},{"name":"contactCount","in":"query","required":false,"description":"~","schema":{"type":"integer","description":"~"}},{"name":"orderBy","in":"query","required":false,"description":"~","schema":{"type":"string","description":"~"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:callfire/create-contact-list":{"post":{"operationId":"communication_callfire_create_contact_list","summary":"Create contact lists","description":"POST /contacts/lists","tags":["communication"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"fields":{"type":"string","description":"Limit fields received in response. E.g. fields: id, name or fields items (id, name), see more at [partial…"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:callfire/create-contact-list-from-file":{"post":{"operationId":"communication_callfire_create_contact_list_from_file","summary":"Create contact list from file","description":"POST /contacts/lists/upload","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"Form fields as a JSON object"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:callfire/get-contact-list":{"get":{"operationId":"communication_callfire_get_contact_list","summary":"Find a specific contact list","description":"GET /contacts/lists/{id}","tags":["communication"],"parameters":[{"name":"id","in":"query","required":true,"description":"An id of a contact list to return","schema":{"type":"integer","description":"An id of a contact list to return"}},{"name":"fields","in":"query","required":false,"description":"Limit fields received in response. E.g. fields: id, name or fields items (id, name), see more at [partial…","schema":{"type":"string","description":"Limit fields received in response. E.g. fields: id, name or fields items (id, name), see more at [partial…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:callfire/update-contact-list":{"post":{"operationId":"communication_callfire_update_contact_list","summary":"Update a contact list","description":"PUT /contacts/lists/{id}","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"integer","description":"An id of contact list to update"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:callfire/delete-contact-list":{"post":{"operationId":"communication_callfire_delete_contact_list","summary":"Delete a contact list","description":"DELETE /contacts/lists/{id}","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"integer","description":"An id of the contact list to be deleted"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:callfire/get-contact-list-items":{"get":{"operationId":"communication_callfire_get_contact_list_items","summary":"Find contacts in a contact list","description":"GET /contacts/lists/{id}/items","tags":["communication"],"parameters":[{"name":"id","in":"query","required":true,"description":"An id of a contact list","schema":{"type":"integer","description":"An id of a contact list"}},{"name":"fields","in":"query","required":false,"description":"Limit fields received in response. E.g. fields: id, name or fields items (id, name), see more at [partial…","schema":{"type":"string","description":"Limit fields received in response. E.g. fields: id, name or fields items (id, name), see more at [partial…"}},{"name":"limit","in":"query","required":false,"description":"To set the maximum number of records to return in a paged list response. The default is 100","schema":{"type":"integer","description":"To set the maximum number of records to return in a paged list response. The default is 100"}},{"name":"offset","in":"query","required":false,"description":"Offset to the start of a given page. The default is 0. Check [pagination](https://developers.callfire.com/docs.html#pagination) page for…","schema":{"type":"integer","description":"Offset to the start of a given page. The default is 0. Check [pagination](https://developers.callfire.com/docs.html#pagination) page for…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:callfire/add-contact-list-items":{"post":{"operationId":"communication_callfire_add_contact_list_items","summary":"Add contacts to a contact list","description":"POST /contacts/lists/{id}/items","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"integer","description":"An id of a contact list"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:callfire/remove-contact-list-items":{"post":{"operationId":"communication_callfire_remove_contact_list_items","summary":"Delete contacts from a contact list","description":"DELETE /contacts/lists/{id}/items","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"integer","description":"A id of a contact list"},"contactId":{"type":"array","description":"An id of a contact entity in the CallFire system"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:callfire/remove-contact-list-item":{"post":{"operationId":"communication_callfire_remove_contact_list_item","summary":"Delete a contact from a contact list","description":"DELETE /contacts/lists/{id}/items/{contactId}","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id","contactId"],"properties":{"id":{"type":"integer","description":"An id of a contact list"},"contactId":{"type":"integer","description":"An id of a contact"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:callfire/get-contact":{"get":{"operationId":"communication_callfire_get_contact","summary":"Find a specific contact","description":"GET /contacts/{id}","tags":["communication"],"parameters":[{"name":"id","in":"query","required":true,"description":"An id of a contact","schema":{"type":"integer","description":"An id of a contact"}},{"name":"fields","in":"query","required":false,"description":"Limit fields received in response. E.g. fields: id, name or fields items (id, name), see more at [partial…","schema":{"type":"string","description":"Limit fields received in response. E.g. fields: id, name or fields items (id, name), see more at [partial…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:callfire/update-contact":{"post":{"operationId":"communication_callfire_update_contact","summary":"Update a contact","description":"PUT /contacts/{id}","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"integer","description":"An id of a contact"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:callfire/delete-contact":{"post":{"operationId":"communication_callfire_delete_contact","summary":"Delete a contact","description":"DELETE /contacts/{id}","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"integer","description":"An Id of a contact"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:callfire/get-contact-history":{"get":{"operationId":"communication_callfire_get_contact_history","summary":"Find a contact's history","description":"GET /contacts/{id}/history","tags":["communication"],"parameters":[{"name":"id","in":"query","required":true,"description":"An Id of a contact","schema":{"type":"integer","description":"An Id of a contact"}},{"name":"limit","in":"query","required":false,"description":"To set the maximum number of records to return in a paged list response. The default is 100","schema":{"type":"integer","description":"To set the maximum number of records to return in a paged list response. The default is 100"}},{"name":"offset","in":"query","required":false,"description":"Offset to the start of a given page. The default is 0. Check [pagination](https://developers.callfire.com/docs.html#pagination) page for…","schema":{"type":"integer","description":"Offset to the start of a given page. The default is 0. Check [pagination](https://developers.callfire.com/docs.html#pagination) page for…"}},{"name":"fields","in":"query","required":false,"description":"Limit fields received in response. E.g. fields: id, name or fields items (id, name), see more at [partial…","schema":{"type":"string","description":"Limit fields received in response. E.g. fields: id, name or fields items (id, name), see more at [partial…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:callfire/find-keywords":{"get":{"operationId":"communication_callfire_find_keywords","summary":"Find keywords","description":"GET /keywords","tags":["communication"],"parameters":[{"name":"keywords","in":"query","required":false,"description":"A keyword to search for","schema":{"type":"array","description":"A keyword to search for"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:callfire/find-keyword-leases":{"get":{"operationId":"communication_callfire_find_keyword_leases","summary":"Find keyword leases","description":"GET /keywords/leases","tags":["communication"],"parameters":[{"name":"limit","in":"query","required":false,"description":"To set the maximum number of records to return in a paged list response. The default is 100","schema":{"type":"integer","default":100,"description":"To set the maximum number of records to return in a paged list response. The default is 100"}},{"name":"offset","in":"query","required":false,"description":"Offset to the start of a given page. The default is 0. Check [pagination](https://developers.callfire.com/docs.html#pagination) page for…","schema":{"type":"integer","default":0,"description":"Offset to the start of a given page. The default is 0. Check [pagination](https://developers.callfire.com/docs.html#pagination) page for…"}},{"name":"filter","in":"query","required":false,"description":"Filter by part of Keyword name or Label name of Keyword","schema":{"type":"string","description":"Filter by part of Keyword name or Label name of Keyword"}},{"name":"labelName","in":"query","required":false,"description":"An exact label name to search by","schema":{"type":"string","description":"An exact label name to search by"}},{"name":"fields","in":"query","required":false,"description":"Limit fields received in response. E.g. fields: id, name or fields items (id, name), see more at [partial…","schema":{"type":"string","description":"Limit fields received in response. E.g. fields: id, name or fields items (id, name), see more at [partial…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:callfire/find-keyword-lease-configs":{"get":{"operationId":"communication_callfire_find_keyword_lease_configs","summary":"Find keyword lease configs","description":"GET /keywords/leases/configs","tags":["communication"],"parameters":[{"name":"limit","in":"query","required":false,"description":"To set the maximum number of records to return in a paged list response. The default is 100","schema":{"type":"integer","default":20,"description":"To set the maximum number of records to return in a paged list response. The default is 100"}},{"name":"offset","in":"query","required":false,"description":"Offset to the start of a given page. The default is 0. Check [pagination](https://developers.callfire.com/docs.html#pagination) page for…","schema":{"type":"integer","default":0,"description":"Offset to the start of a given page. The default is 0. Check [pagination](https://developers.callfire.com/docs.html#pagination) page for…"}},{"name":"filter","in":"query","required":false,"description":"Filter by part of Keyword name or Label name of Keyword","schema":{"type":"string","description":"Filter by part of Keyword name or Label name of Keyword"}},{"name":"labelName","in":"query","required":false,"description":"An exact label name to search by","schema":{"type":"string","description":"An exact label name to search by"}},{"name":"fields","in":"query","required":false,"description":"Limit fields received in response. E.g. fields: id, name or fields items (id, name), see more at [partial…","schema":{"type":"string","description":"Limit fields received in response. E.g. fields: id, name or fields items (id, name), see more at [partial…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:callfire/get-keyword-lease-config":{"get":{"operationId":"communication_callfire_get_keyword_lease_config","summary":"Find a specific keyword lease config","description":"GET /keywords/leases/configs/{keyword}","tags":["communication"],"parameters":[{"name":"keyword","in":"query","required":true,"description":"A Keyword to get KeywordConfig by","schema":{"type":"string","description":"A Keyword to get KeywordConfig by"}},{"name":"fields","in":"query","required":false,"description":"Limit fields received in response. E.g. fields: id, name or fields items (id, name), see more at [partial…","schema":{"type":"string","description":"Limit fields received in response. E.g. fields: id, name or fields items (id, name), see more at [partial…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:callfire/update-keyword-lease-config":{"post":{"operationId":"communication_callfire_update_keyword_lease_config","summary":"Update a keyword lease config","description":"PUT /keywords/leases/configs/{keyword}","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["keyword"],"properties":{"keyword":{"type":"string","description":"To update a keyword lease config"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:callfire/get-keyword-lease-by-id":{"get":{"operationId":"communication_callfire_get_keyword_lease_by_id","summary":"Find a keyword by id","description":"GET /keywords/leases/id/{id}","tags":["communication"],"parameters":[{"name":"id","in":"query","required":true,"description":"~","schema":{"type":"integer","description":"~"}},{"name":"fields","in":"query","required":false,"description":"Limit fields received in response. E.g. fields: id, name or fields items (id, name), see more at [partial…","schema":{"type":"string","description":"Limit fields received in response. E.g. fields: id, name or fields items (id, name), see more at [partial…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:callfire/get-keyword-lease":{"get":{"operationId":"communication_callfire_get_keyword_lease","summary":"Find a specific lease","description":"GET /keywords/leases/{keyword}","tags":["communication"],"parameters":[{"name":"keyword","in":"query","required":true,"description":"Keyword text that a lease is desired for","schema":{"type":"string","description":"Keyword text that a lease is desired for"}},{"name":"fields","in":"query","required":false,"description":"Limit fields received in response. E.g. fields: id, name or fields items (id, name), see more at [partial…","schema":{"type":"string","description":"Limit fields received in response. E.g. fields: id, name or fields items (id, name), see more at [partial…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:callfire/update-keyword-lease":{"post":{"operationId":"communication_callfire_update_keyword_lease","summary":"Update a lease","description":"PUT /keywords/leases/{keyword}","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["keyword"],"properties":{"keyword":{"type":"string","description":"To update a keyword lease"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:callfire/is-keyword-available":{"get":{"operationId":"communication_callfire_is_keyword_available","summary":"Check for a specific keyword","description":"GET /keywords/{keyword}/available","tags":["communication"],"parameters":[{"name":"keyword","in":"query","required":true,"description":"To specify a keyword to search for. Example: SUN, MOON","schema":{"type":"string","description":"To specify a keyword to search for. Example: SUN, MOON"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:callfire/get-account":{"get":{"operationId":"communication_callfire_get_account","summary":"Find account details","description":"GET /me/account","tags":["communication"],"parameters":[{"name":"fields","in":"query","required":false,"description":"Limit fields received in response. E.g. fields: id, name or fields items (id, name), see more at [partial…","schema":{"type":"string","description":"Limit fields received in response. E.g. fields: id, name or fields items (id, name), see more at [partial…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:callfire/find-api-credentials":{"get":{"operationId":"communication_callfire_find_api_credentials","summary":"Find api credentials","description":"GET /me/api/credentials","tags":["communication"],"parameters":[{"name":"name","in":"query","required":false,"description":"Filter by name","schema":{"type":"string","description":"Filter by name"}},{"name":"fields","in":"query","required":false,"description":"Limit fields received in response. E.g. fields: id, name or fields items (id, name), see more at [partial…","schema":{"type":"string","description":"Limit fields received in response. E.g. fields: id, name or fields items (id, name), see more at [partial…"}},{"name":"limit","in":"query","required":false,"description":"To set the maximum number of records to return in a paged list response. The default is 100","schema":{"type":"integer","default":100,"description":"To set the maximum number of records to return in a paged list response. The default is 100"}},{"name":"offset","in":"query","required":false,"description":"Offset to the start of a given page. The default is 0. Check [pagination](https://developers.callfire.com/docs.html#pagination) page for…","schema":{"type":"integer","default":0,"description":"Offset to the start of a given page. The default is 0. Check [pagination](https://developers.callfire.com/docs.html#pagination) page for…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:callfire/create-api-credential":{"post":{"operationId":"communication_callfire_create_api_credential","summary":"Create api credentials","description":"POST /me/api/credentials","tags":["communication"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:callfire/get-api-credential":{"get":{"operationId":"communication_callfire_get_api_credential","summary":"Find a specific api credential","description":"GET /me/api/credentials/{id}","tags":["communication"],"parameters":[{"name":"id","in":"query","required":true,"description":"An id of an API credential","schema":{"type":"integer","description":"An id of an API credential"}},{"name":"fields","in":"query","required":false,"description":"Limit fields received in response. E.g. fields: id, name or fields items (id, name), see more at [partial…","schema":{"type":"string","description":"Limit fields received in response. E.g. fields: id, name or fields items (id, name), see more at [partial…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:callfire/delete-api-credential":{"post":{"operationId":"communication_callfire_delete_api_credential","summary":"Delete api credentials","description":"DELETE /me/api/credentials/{id}","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"integer","description":"An id of an API credential"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:callfire/disable-api-credentials":{"post":{"operationId":"communication_callfire_disable_api_credentials","summary":"Disable specified API credentials","description":"POST /me/api/credentials/{id}/disable","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"integer","description":"An id of an API credential"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:callfire/enable-api-credentials":{"post":{"operationId":"communication_callfire_enable_api_credentials","summary":"Enable specified API credentials","description":"POST /me/api/credentials/{id}/enable","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"integer","description":"An id of an API credential"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:callfire/get-credit-usage":{"get":{"operationId":"communication_callfire_get_credit_usage","summary":"Find credit usage","description":"GET /me/billing/credit-usage","tags":["communication"],"parameters":[{"name":"intervalBegin","in":"query","required":false,"description":"Beginning of usage period formatted in unix time milliseconds. Example: 1473781817000","schema":{"type":"integer","description":"Beginning of usage period formatted in unix time milliseconds. Example: 1473781817000"}},{"name":"intervalEnd","in":"query","required":false,"description":"End of usage period formatted in unix time milliseconds. Example: 1473781817000","schema":{"type":"integer","description":"End of usage period formatted in unix time milliseconds. Example: 1473781817000"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:callfire/get-billing-plan-usage":{"get":{"operationId":"communication_callfire_get_billing_plan_usage","summary":"Find plan usage","description":"GET /me/billing/plan-usage","tags":["communication"],"parameters":[],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:callfire/get-caller-ids":{"get":{"operationId":"communication_callfire_get_caller_ids","summary":"Find caller ids","description":"GET /me/callerids","tags":["communication"],"parameters":[],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:callfire/send-verification-code-to-caller-id":{"post":{"operationId":"communication_callfire_send_verification_code_to_caller_id","summary":"Create a caller id","description":"POST /me/callerids/{callerid}","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["callerid"],"properties":{"callerid":{"type":"string","description":"A phone number in E.164 format (11-digit) which needs to be verified. Example: 12132000384"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:callfire/verify-caller-id":{"post":{"operationId":"communication_callfire_verify_caller_id","summary":"Verify a caller id","description":"POST /me/callerids/{callerid}/verification-code","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["callerid"],"properties":{"callerid":{"type":"string","description":"A phone number in E.164 format (11-digit) which needs to be verified. Example: 12132000384"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:callfire/find-media":{"get":{"operationId":"communication_callfire_find_media","summary":"Find media","description":"GET /media","tags":["communication"],"parameters":[{"name":"limit","in":"query","required":false,"description":"To set the maximum number of records to return in a paged list response. The default is 100","schema":{"type":"integer","default":100,"description":"To set the maximum number of records to return in a paged list response. The default is 100"}},{"name":"offset","in":"query","required":false,"description":"Offset to the start of a given page. The default is 0. Check [pagination](https://developers.callfire.com/docs.html#pagination) page for…","schema":{"type":"integer","default":0,"description":"Offset to the start of a given page. The default is 0. Check [pagination](https://developers.callfire.com/docs.html#pagination) page for…"}},{"name":"filter","in":"query","required":false,"description":"value to filter file names again; this value is used to check if the filename contains the filter value.","schema":{"type":"string","description":"value to filter file names again; this value is used to check if the filename contains the filter value."}},{"name":"fields","in":"query","required":false,"description":"Limit fields received in response. E.g. fields: id, name or fields items (id, name), see more at [partial…","schema":{"type":"string","description":"Limit fields received in response. E.g. fields: id, name or fields items (id, name), see more at [partial…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:callfire/create-media":{"post":{"operationId":"communication_callfire_create_media","summary":"Create media","description":"POST /media","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"Form fields as a JSON object"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:callfire/get-media-data-by-key":{"get":{"operationId":"communication_callfire_get_media_data_by_key","summary":"Download media by extension","description":"GET /media/public/{key}.{extension}","tags":["communication"],"parameters":[{"name":"key","in":"query","required":true,"description":"A hash-key of a media resource","schema":{"type":"string","description":"A hash-key of a media resource"}},{"name":"extension","in":"query","required":true,"description":"Media file type, available types: bmp, gif, jpg, m4a, mp3, mp4, png, wav","schema":{"type":"string","description":"Media file type, available types: bmp, gif, jpg, m4a, mp3, mp4, png, wav"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:callfire/get-media":{"get":{"operationId":"communication_callfire_get_media","summary":"Get a specific media","description":"GET /media/{id}","tags":["communication"],"parameters":[{"name":"id","in":"query","required":true,"description":"An id of a media resource","schema":{"type":"integer","description":"An id of a media resource"}},{"name":"fields","in":"query","required":false,"description":"Limit fields received in response. E.g. fields: id, name or fields items (id, name), see more at [partial…","schema":{"type":"string","description":"Limit fields received in response. E.g. fields: id, name or fields items (id, name), see more at [partial…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:callfire/get-media-data":{"get":{"operationId":"communication_callfire_get_media_data","summary":"Download media by extension","description":"GET /media/{id}.{extension}","tags":["communication"],"parameters":[{"name":"id","in":"query","required":true,"description":"An id of a media resource","schema":{"type":"integer","description":"An id of a media resource"}},{"name":"extension","in":"query","required":true,"description":"Media file type. Available types: bmp, gif, jpg, m4a, mp3, mp4, png, wav","schema":{"type":"string","description":"Media file type. Available types: bmp, gif, jpg, m4a, mp3, mp4, png, wav"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:callfire/get-media-data-binary":{"get":{"operationId":"communication_callfire_get_media_data_binary","summary":"Download a MP3 media","description":"GET /media/{id}/file","tags":["communication"],"parameters":[{"name":"id","in":"query","required":true,"description":"An id of a media resource","schema":{"type":"integer","description":"An id of a media resource"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:callfire/find-number-leases":{"get":{"operationId":"communication_callfire_find_number_leases","summary":"Find leases","description":"GET /numbers/leases","tags":["communication"],"parameters":[{"name":"limit","in":"query","required":false,"description":"To set the maximum number of records to return in a paged list response. The default is 100","schema":{"type":"integer","default":100,"description":"To set the maximum number of records to return in a paged list response. The default is 100"}},{"name":"offset","in":"query","required":false,"description":"Offset to the start of a given page. The default is 0. Check [pagination](https://developers.callfire.com/docs.html#pagination) page for…","schema":{"type":"integer","default":0,"description":"Offset to the start of a given page. The default is 0. Check [pagination](https://developers.callfire.com/docs.html#pagination) page for…"}},{"name":"prefix","in":"query","required":false,"description":"A 4-7 digit prefix","schema":{"type":"string","description":"A 4-7 digit prefix"}},{"name":"city","in":"query","required":false,"description":"A city name","schema":{"type":"string","description":"A city name"}},{"name":"state","in":"query","required":false,"description":"A two-letter state code. Example: CA, IL, etc.","schema":{"type":"string","description":"A two-letter state code. Example: CA, IL, etc."}},{"name":"zipcode","in":"query","required":false,"description":"A five-digit Zipcode","schema":{"type":"string","description":"A five-digit Zipcode"}},{"name":"labelName","in":"query","required":false,"description":"A label name","schema":{"type":"string","description":"A label name"}},{"name":"tollFree","in":"query","required":false,"description":"~","schema":{"type":"boolean","description":"~"}},{"name":"fields","in":"query","required":false,"description":"Limit fields received in response. E.g. fields: id, name or fields items (id, name), see more at [partial…","schema":{"type":"string","description":"Limit fields received in response. E.g. fields: id, name or fields items (id, name), see more at [partial…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:callfire/find-number-lease-configs":{"get":{"operationId":"communication_callfire_find_number_lease_configs","summary":"Find lease configs","description":"GET /numbers/leases/configs","tags":["communication"],"parameters":[{"name":"limit","in":"query","required":false,"description":"To set the maximum number of records to return in a paged list response. The default is 100","schema":{"type":"integer","default":100,"description":"To set the maximum number of records to return in a paged list response. The default is 100"}},{"name":"offset","in":"query","required":false,"description":"Offset to the start of a given page. The default is 0. Check [pagination](https://developers.callfire.com/docs.html#pagination) page for…","schema":{"type":"integer","default":0,"description":"Offset to the start of a given page. The default is 0. Check [pagination](https://developers.callfire.com/docs.html#pagination) page for…"}},{"name":"prefix","in":"query","required":false,"description":"A 4-7 digit prefix","schema":{"type":"string","description":"A 4-7 digit prefix"}},{"name":"city","in":"query","required":false,"description":"A city name","schema":{"type":"string","description":"A city name"}},{"name":"state","in":"query","required":false,"description":"A two-letter state code. Example: CA, IL, etc.","schema":{"type":"string","description":"A two-letter state code. Example: CA, IL, etc."}},{"name":"zipcode","in":"query","required":false,"description":"A five-digit Zipcode","schema":{"type":"string","description":"A five-digit Zipcode"}},{"name":"labelName","in":"query","required":false,"description":"A label name","schema":{"type":"string","description":"A label name"}},{"name":"fields","in":"query","required":false,"description":"Limit fields received in response. E.g. fields: id, name or fields items (id, name), see more at [partial…","schema":{"type":"string","description":"Limit fields received in response. E.g. fields: id, name or fields items (id, name), see more at [partial…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:callfire/get-number-lease-config":{"get":{"operationId":"communication_callfire_get_number_lease_config","summary":"Find a specific lease config","description":"GET /numbers/leases/configs/{number}","tags":["communication"],"parameters":[{"name":"number","in":"query","required":true,"description":"A phone number in E.164 format (11-digit). Example: 12132000384","schema":{"type":"string","description":"A phone number in E.164 format (11-digit). Example: 12132000384"}},{"name":"fields","in":"query","required":false,"description":"Limit fields received in response. E.g. fields: id, name or fields items (id, name), see more at [partial…","schema":{"type":"string","description":"Limit fields received in response. E.g. fields: id, name or fields items (id, name), see more at [partial…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:callfire/update-number-lease-config":{"post":{"operationId":"communication_callfire_update_number_lease_config","summary":"Update a lease config","description":"PUT /numbers/leases/configs/{number}","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["number"],"properties":{"number":{"type":"string","description":"A phone number in E.164 format (11-digit) which needs to be verified. Example: 12132000384"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:callfire/get-number-lease":{"get":{"operationId":"communication_callfire_get_number_lease","summary":"Find a specific lease","description":"GET /numbers/leases/{number}","tags":["communication"],"parameters":[{"name":"number","in":"query","required":true,"description":"A phone number in E.164 format (11-digit). Example: 12132000384","schema":{"type":"string","description":"A phone number in E.164 format (11-digit). Example: 12132000384"}},{"name":"fields","in":"query","required":false,"description":"Limit fields received in response. E.g. fields: id, name or fields items (id, name), see more at [partial…","schema":{"type":"string","description":"Limit fields received in response. E.g. fields: id, name or fields items (id, name), see more at [partial…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:callfire/update-number-lease":{"post":{"operationId":"communication_callfire_update_number_lease","summary":"Update a lease","description":"PUT /numbers/leases/{number}","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["number"],"properties":{"number":{"type":"string","description":"A phone number in E.164 format (11-digit). Example: 12132000384"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:callfire/find-numbers-local":{"get":{"operationId":"communication_callfire_find_numbers_local","summary":"Find local numbers","description":"GET /numbers/local","tags":["communication"],"parameters":[{"name":"limit","in":"query","required":false,"description":"To set the maximum number of records to return in a paged list response. The default is 100","schema":{"type":"integer","default":100,"description":"To set the maximum number of records to return in a paged list response. The default is 100"}},{"name":"prefix","in":"query","required":false,"description":"A 4-7 digit prefix","schema":{"type":"string","description":"A 4-7 digit prefix"}},{"name":"city","in":"query","required":false,"description":"A city name","schema":{"type":"string","description":"A city name"}},{"name":"state","in":"query","required":false,"description":"A two-letter state code. Example: CA, IL, etc.","schema":{"type":"string","description":"A two-letter state code. Example: CA, IL, etc."}},{"name":"zipcode","in":"query","required":false,"description":"A five-digit Zipcode","schema":{"type":"string","description":"A five-digit Zipcode"}},{"name":"fields","in":"query","required":false,"description":"Limit fields received in response. E.g. fields: id, name or fields items (id, name), see more at [partial…","schema":{"type":"string","description":"Limit fields received in response. E.g. fields: id, name or fields items (id, name), see more at [partial…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:callfire/find-number-regions":{"get":{"operationId":"communication_callfire_find_number_regions","summary":"Find number regions","description":"GET /numbers/regions","tags":["communication"],"parameters":[{"name":"limit","in":"query","required":false,"description":"To set the maximum number of records to return in a paged list response. The default is 100","schema":{"type":"integer","default":100,"description":"To set the maximum number of records to return in a paged list response. The default is 100"}},{"name":"offset","in":"query","required":false,"description":"Offset to the start of a given page. The default is 0. Check [pagination](https://developers.callfire.com/docs.html#pagination) page for…","schema":{"type":"integer","default":0,"description":"Offset to the start of a given page. The default is 0. Check [pagination](https://developers.callfire.com/docs.html#pagination) page for…"}},{"name":"prefix","in":"query","required":false,"description":"A 4-7 digit prefix","schema":{"type":"string","description":"A 4-7 digit prefix"}},{"name":"city","in":"query","required":false,"description":"A city name","schema":{"type":"string","description":"A city name"}},{"name":"cityPrefix","in":"query","required":false,"description":"~","schema":{"type":"string","description":"~"}},{"name":"state","in":"query","required":false,"description":"A two-letter state code. Example: CA, IL, etc.","schema":{"type":"string","description":"A two-letter state code. Example: CA, IL, etc."}},{"name":"zipcode","in":"query","required":false,"description":"A five-digit Zipcode","schema":{"type":"string","description":"A five-digit Zipcode"}},{"name":"country","in":"query","required":false,"description":"~","schema":{"type":"string","description":"~"}},{"name":"fields","in":"query","required":false,"description":"Limit fields received in response. E.g. fields: id, name or fields items (id, name), see more at [partial…","schema":{"type":"string","description":"Limit fields received in response. E.g. fields: id, name or fields items (id, name), see more at [partial…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:callfire/find-numbers-tollfree":{"get":{"operationId":"communication_callfire_find_numbers_tollfree","summary":"Find tollfree numbers","description":"GET /numbers/tollfree","tags":["communication"],"parameters":[{"name":"pattern","in":"query","required":false,"description":"Filter toll free numbers by prefix, pattern must be 3 char long and should end with '*'. Examples: 8**, 85*, 87* (but 855 will fail…","schema":{"type":"string","description":"Filter toll free numbers by prefix, pattern must be 3 char long and should end with '*'. Examples: 8**, 85*, 87* (but 855 will fail…"}},{"name":"limit","in":"query","required":false,"description":"To set the maximum number of records to return in a paged list response. The default is 100","schema":{"type":"integer","default":100,"description":"To set the maximum number of records to return in a paged list response. The default is 100"}},{"name":"fields","in":"query","required":false,"description":"Limit fields received in response. E.g. fields: id, name or fields items (id, name), see more at [partial…","schema":{"type":"string","description":"Limit fields received in response. E.g. fields: id, name or fields items (id, name), see more at [partial…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:callfire/find-orders":{"get":{"operationId":"communication_callfire_find_orders","summary":"Find orders","description":"GET /orders","tags":["communication"],"parameters":[{"name":"limit","in":"query","required":false,"description":"To set the maximum number of records to return in a paged list response. The default is 100","schema":{"type":"integer","default":20,"description":"To set the maximum number of records to return in a paged list response. The default is 100"}},{"name":"offset","in":"query","required":false,"description":"Offset to the start of a given page. The default is 0. Check [pagination](https://developers.callfire.com/docs.html#pagination) page for…","schema":{"type":"integer","default":0,"description":"Offset to the start of a given page. The default is 0. Check [pagination](https://developers.callfire.com/docs.html#pagination) page for…"}},{"name":"fields","in":"query","required":false,"description":"Limit fields received in response. E.g. fields: id, name or fields items (id, name), see more at [partial…","schema":{"type":"string","description":"Limit fields received in response. E.g. fields: id, name or fields items (id, name), see more at [partial…"}},{"name":"status","in":"query","required":false,"description":"Filter by order status, accepts multiple values in comma separated string, available values: [PROCESSING, FINISHED, PAYMENT_ERROR, VOID,…","schema":{"type":"array","description":"Filter by order status, accepts multiple values in comma separated string, available values: [PROCESSING, FINISHED, PAYMENT_ERROR, VOID,…"}},{"name":"intervalBegin","in":"query","required":false,"description":"Start of the find time interval, formatted in unix time milliseconds. Example: 1473781817000","schema":{"type":"integer","description":"Start of the find time interval, formatted in unix time milliseconds. Example: 1473781817000"}},{"name":"intervalEnd","in":"query","required":false,"description":"End of the find time interval, formatted in unix time milliseconds. Example: 1473781817000","schema":{"type":"integer","description":"End of the find time interval, formatted in unix time milliseconds. Example: 1473781817000"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:callfire/order-keywords":{"post":{"operationId":"communication_callfire_order_keywords","summary":"Purchase keywords","description":"POST /orders/keywords","tags":["communication"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"fields":{"type":"string","description":"Limit fields received in response. E.g. fields: id, name or fields items (id, name), see more at [partial…"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:callfire/order-numbers":{"post":{"operationId":"communication_callfire_order_numbers","summary":"Purchase numbers","description":"POST /orders/numbers","tags":["communication"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"fields":{"type":"string","description":"Limit fields received in response. E.g. fields: id, name or fields items (id, name), see more at [partial…"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:callfire/get-order":{"get":{"operationId":"communication_callfire_get_order","summary":"Find a specific order","description":"GET /orders/{id}","tags":["communication"],"parameters":[{"name":"id","in":"query","required":true,"description":"An id of an order","schema":{"type":"integer","description":"An id of an order"}},{"name":"fields","in":"query","required":false,"description":"Limit fields received in response. E.g. fields: id, name or fields items (id, name), see more at [partial…","schema":{"type":"string","description":"Limit fields received in response. E.g. fields: id, name or fields items (id, name), see more at [partial…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:callfire/get-delivery-reports":{"get":{"operationId":"communication_callfire_get_delivery_reports","summary":"Get delivery reports by ad hoc criteria","description":"GET /reports/delivery","tags":["communication"],"parameters":[{"name":"startDate","in":"query","required":false,"description":"~","schema":{"type":"string","description":"~"}},{"name":"endDate","in":"query","required":false,"description":"~","schema":{"type":"string","description":"~"}},{"name":"limit","in":"query","required":false,"description":"To set the maximum number of records to return in a paged list response. The default is 100","schema":{"type":"integer","default":100,"description":"To set the maximum number of records to return in a paged list response. The default is 100"}},{"name":"offset","in":"query","required":false,"description":"Offset to the start of a given page. The default is 0. Check [pagination](https://developers.callfire.com/docs.html#pagination) page for…","schema":{"type":"integer","default":0,"description":"Offset to the start of a given page. The default is 0. Check [pagination](https://developers.callfire.com/docs.html#pagination) page for…"}},{"name":"campaignId","in":"query","required":false,"description":"~","schema":{"type":"integer","description":"~"}},{"name":"fromNumber","in":"query","required":false,"description":"~","schema":{"type":"string","description":"~"}},{"name":"toNumber","in":"query","required":false,"description":"~","schema":{"type":"string","description":"~"}},{"name":"deliveryCategory","in":"query","required":false,"description":"~","schema":{"type":"string","enum":["NO_DATA","OPTED_OUT","BOUNCED","NO_CREDITS","DELIVERED"],"description":"~"}},{"name":"deliveryState","in":"query","required":false,"description":"~","schema":{"type":"string","description":"~"}},{"name":"carrier","in":"query","required":false,"description":"~","schema":{"type":"string","description":"~"}},{"name":"messageText","in":"query","required":false,"description":"~","schema":{"type":"string","description":"~"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:callfire/find-texts":{"get":{"operationId":"communication_callfire_find_texts","summary":"Find texts","description":"GET /texts","tags":["communication"],"parameters":[{"name":"id","in":"query","required":false,"description":"List of Text ids to search for, if ids specified other query params ignored","schema":{"type":"array","description":"List of Text ids to search for, if ids specified other query params ignored"}},{"name":"campaignId","in":"query","required":false,"description":"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","schema":{"type":"integer","description":"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"}},{"name":"batchId","in":"query","required":false,"description":"An Id of a contact batch, queries for texts which are used in the particular contact batch","schema":{"type":"integer","description":"An Id of a contact batch, queries for texts which are used in the particular contact batch"}},{"name":"fromNumber","in":"query","required":false,"description":"A phone number in E.164 format (11-digit). Example: 12132000384, 67076","schema":{"type":"string","description":"A phone number in E.164 format (11-digit). Example: 12132000384, 67076"}},{"name":"toNumber","in":"query","required":false,"description":"A phone number in E.164 format (11-digit). Example: 12132000384, 67076","schema":{"type":"string","description":"A phone number in E.164 format (11-digit). Example: 12132000384, 67076"}},{"name":"label","in":"query","required":false,"description":"A label of a text message","schema":{"type":"string","description":"A label of a text message"}},{"name":"states","in":"query","required":false,"description":"Expected text statuses in comma separated string, available values: READY, SELECTED, CALLBACK, FINISHED, DISABLED, DNC, DUP, INVALID,…","schema":{"type":"string","description":"Expected text statuses in comma separated string, available values: READY, SELECTED, CALLBACK, FINISHED, DISABLED, DNC, DUP, INVALID,…"}},{"name":"results","in":"query","required":false,"description":"Expected text results in comma separated string, available values: SENT, RECEIVED, DNT, TOO_BIG, INTERNAL_ERROR, CARRIER_ERROR,…","schema":{"type":"string","description":"Expected text results in comma separated string, available values: SENT, RECEIVED, DNT, TOO_BIG, INTERNAL_ERROR, CARRIER_ERROR,…"}},{"name":"inbound","in":"query","required":false,"description":"Specify true for inbound or false for outbounds. Do not specify this parameter if you need to get both inbound and outbound texts listed…","schema":{"type":"boolean","description":"Specify true for inbound or false for outbounds. Do not specify this parameter if you need to get both inbound and outbound texts listed…"}},{"name":"intervalBegin","in":"query","required":false,"description":"Start of the find time interval, formatted in unix time milliseconds. Example: 1473781817000","schema":{"type":"integer","description":"Start of the find time interval, formatted in unix time milliseconds. Example: 1473781817000"}},{"name":"intervalEnd","in":"query","required":false,"description":"End of the find time interval, formatted in unix time milliseconds. Example: 1473781817000","schema":{"type":"integer","description":"End of the find time interval, formatted in unix time milliseconds. Example: 1473781817000"}},{"name":"limit","in":"query","required":false,"description":"To set the maximum number of records to return in a paged list response. The default is 100","schema":{"type":"integer","default":10,"description":"To set the maximum number of records to return in a paged list response. The default is 100"}},{"name":"offset","in":"query","required":false,"description":"Offset to the start of a given page. The default is 0. Check [pagination](https://developers.callfire.com/docs.html#pagination) page for…","schema":{"type":"integer","default":0,"description":"Offset to the start of a given page. The default is 0. Check [pagination](https://developers.callfire.com/docs.html#pagination) page for…"}},{"name":"fields","in":"query","required":false,"description":"Limit fields received in response. E.g. fields: id, name or fields items (id, name), see more at [partial…","schema":{"type":"string","description":"Limit fields received in response. E.g. fields: id, name or fields items (id, name), see more at [partial…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:callfire/send-texts":{"post":{"operationId":"communication_callfire_send_texts","summary":"Send texts","description":"POST /texts","tags":["communication"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"fields":{"type":"string","description":"Limit fields received in response. E.g. fields: id, name or fields items (id, name), see more at [partial…"},"campaignId":{"type":"integer","description":"Specifies a campaignId to send texts through a previously created campaign"},"defaultMessage":{"type":"string","description":"Text message can be overridden by TextRecipient.message field. If multiple recipients have the same text message to a different recipients…"},"strictValidation":{"type":"boolean","description":"Turns on strict validation for recipients"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:callfire/find-text-auto-replys":{"get":{"operationId":"communication_callfire_find_text_auto_replys","summary":"Find auto replies","description":"GET /texts/auto-replys","tags":["communication"],"parameters":[{"name":"fields","in":"query","required":false,"description":"Limit fields received in response. E.g. fields: id, name or fields items (id, name), see more at [partial…","schema":{"type":"string","description":"Limit fields received in response. E.g. fields: id, name or fields items (id, name), see more at [partial…"}},{"name":"limit","in":"query","required":false,"description":"To set the maximum number of records to return in a paged list response. The default is 100","schema":{"type":"integer","default":100,"description":"To set the maximum number of records to return in a paged list response. The default is 100"}},{"name":"offset","in":"query","required":false,"description":"Offset to the start of a given page. The default is 0. Check [pagination](https://developers.callfire.com/docs.html#pagination) page for…","schema":{"type":"integer","default":0,"description":"Offset to the start of a given page. The default is 0. Check [pagination](https://developers.callfire.com/docs.html#pagination) page for…"}},{"name":"number","in":"query","required":false,"description":"Phone number in E.164 format (11-digit) which contains a TextAutoReply. Example: 12132000384. If number is empty then operator returns all…","schema":{"type":"string","description":"Phone number in E.164 format (11-digit) which contains a TextAutoReply. Example: 12132000384. If number is empty then operator returns all…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:callfire/create-text-auto-reply":{"post":{"operationId":"communication_callfire_create_text_auto_reply","summary":"Create an auto reply","description":"POST /texts/auto-replys","tags":["communication"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:callfire/get-text-auto-reply":{"get":{"operationId":"communication_callfire_get_text_auto_reply","summary":"Find a specific auto reply","description":"GET /texts/auto-replys/{id}","tags":["communication"],"parameters":[{"name":"id","in":"query","required":true,"description":"An id of a text auto reply","schema":{"type":"integer","description":"An id of a text auto reply"}},{"name":"fields","in":"query","required":false,"description":"Limit fields received in response. E.g. fields: id, name or fields items (id, name), see more at [partial…","schema":{"type":"string","description":"Limit fields received in response. E.g. fields: id, name or fields items (id, name), see more at [partial…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:callfire/delete-text-auto-reply":{"post":{"operationId":"communication_callfire_delete_text_auto_reply","summary":"Delete an auto reply","description":"DELETE /texts/auto-replys/{id}","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"integer","description":"An id of a text auto reply"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:callfire/find-text-broadcasts":{"get":{"operationId":"communication_callfire_find_text_broadcasts","summary":"Find text broadcasts","description":"GET /texts/broadcasts","tags":["communication"],"parameters":[{"name":"name","in":"query","required":false,"description":"A name of text broadcast","schema":{"type":"string","description":"A name of text broadcast"}},{"name":"label","in":"query","required":false,"description":"A label of a text broadcast","schema":{"type":"string","description":"A label of a text broadcast"}},{"name":"running","in":"query","required":false,"description":"Returns broadcasts only in running state.","schema":{"type":"boolean","description":"Returns broadcasts only in running state."}},{"name":"scheduled","in":"query","required":false,"description":"Specify whether the campaigns should be scheduled or not","schema":{"type":"boolean","description":"Specify whether the campaigns should be scheduled or not"}},{"name":"intervalBegin","in":"query","required":false,"description":"Start of the find time interval, formatted in unix time milliseconds. Example: 1473781817000 for Sat, 05 Jan 1985 14:03:37 GMT","schema":{"type":"integer","description":"Start of the find time interval, formatted in unix time milliseconds. Example: 1473781817000 for Sat, 05 Jan 1985 14:03:37 GMT"}},{"name":"intervalEnd","in":"query","required":false,"description":"End of the find time interval, formatted in unix time milliseconds. Example: 1473781817000 for Sat, 05 Jan 1985 14:03:37 GMT","schema":{"type":"integer","description":"End of the find time interval, formatted in unix time milliseconds. Example: 1473781817000 for Sat, 05 Jan 1985 14:03:37 GMT"}},{"name":"limit","in":"query","required":false,"description":"To set the maximum number of records to return in a paged list response. The default is 100","schema":{"type":"integer","default":10,"description":"To set the maximum number of records to return in a paged list response. The default is 100"}},{"name":"offset","in":"query","required":false,"description":"Offset to the start of a given page. The default is 0. Check [pagination](https://developers.callfire.com/docs.html#pagination) page for…","schema":{"type":"integer","default":0,"description":"Offset to the start of a given page. The default is 0. Check [pagination](https://developers.callfire.com/docs.html#pagination) page for…"}},{"name":"fields","in":"query","required":false,"description":"Limit fields received in response. E.g. fields: id, name or fields items (id, name), see more at [partial…","schema":{"type":"string","description":"Limit fields received in response. E.g. fields: id, name or fields items (id, name), see more at [partial…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:callfire/create-text-broadcast":{"post":{"operationId":"communication_callfire_create_text_broadcast","summary":"Create a text broadcast","description":"POST /texts/broadcasts","tags":["communication"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"start":{"type":"boolean","description":"If true then starts the campaign immediately (not required)."},"strictValidation":{"type":"boolean","description":"Turns on strict validation for recipients. System will reply with BAD_REQUEST(400) if strictValidation = true and one of numbers didn't…"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:callfire/get-text-broadcast":{"get":{"operationId":"communication_callfire_get_text_broadcast","summary":"Find a specific text broadcast","description":"GET /texts/broadcasts/{id}","tags":["communication"],"parameters":[{"name":"id","in":"query","required":true,"description":"An id of a text broadcast","schema":{"type":"integer","description":"An id of a text broadcast"}},{"name":"fields","in":"query","required":false,"description":"Limit fields received in response. E.g. fields: id, name or fields items (id, name), see more at [partial…","schema":{"type":"string","description":"Limit fields received in response. E.g. fields: id, name or fields items (id, name), see more at [partial…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:callfire/update-text-broadcast":{"post":{"operationId":"communication_callfire_update_text_broadcast","summary":"Update a text broadcast","description":"PUT /texts/broadcasts/{id}","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"integer","description":"An id of a text broadcast"},"strictValidation":{"type":"boolean","description":"Turns on strict validation for recipients. System will reply with BAD_REQUEST(400) if strictValidation = true and one of numbers didn't…"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:callfire/archive-text-broadcast":{"post":{"operationId":"communication_callfire_archive_text_broadcast","summary":"Archive text broadcast","description":"POST /texts/broadcasts/{id}/archive","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"integer","description":"An id of a text broadcast to archive"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:callfire/get-text-broadcast-batches":{"get":{"operationId":"communication_callfire_get_text_broadcast_batches","summary":"Find batches in a text broadcast","description":"GET /texts/broadcasts/{id}/batches","tags":["communication"],"parameters":[{"name":"id","in":"query","required":true,"description":"An id of a text broadcast","schema":{"type":"integer","description":"An id of a text broadcast"}},{"name":"fields","in":"query","required":false,"description":"Limit fields received in response. E.g. fields: id, name or fields items (id, name), see more at [partial…","schema":{"type":"string","description":"Limit fields received in response. E.g. fields: id, name or fields items (id, name), see more at [partial…"}},{"name":"limit","in":"query","required":false,"description":"To set the maximum number of records to return in a paged list response. The default is 100","schema":{"type":"integer","default":100,"description":"To set the maximum number of records to return in a paged list response. The default is 100"}},{"name":"offset","in":"query","required":false,"description":"Offset to the start of a given page. The default is 0. Check [pagination](https://developers.callfire.com/docs.html#pagination) page for…","schema":{"type":"integer","default":0,"description":"Offset to the start of a given page. The default is 0. Check [pagination](https://developers.callfire.com/docs.html#pagination) page for…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:callfire/add-text-broadcast-batch":{"post":{"operationId":"communication_callfire_add_text_broadcast_batch","summary":"Add batches to a text broadcast","description":"POST /texts/broadcasts/{id}/batches","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"integer","description":"An id of a text broadcast"},"strictValidation":{"type":"boolean","description":"Turns on strict validation for recipients. System will reply with BAD_REQUEST(400) if strictValidation = true and one of numbers didn't…"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:callfire/add-text-broadcast-recipients":{"post":{"operationId":"communication_callfire_add_text_broadcast_recipients","summary":"Add recipients to a text broadcast","description":"POST /texts/broadcasts/{id}/recipients","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"integer","description":"An id of a text broadcast"},"fields":{"type":"string","description":"Limit fields received in response. E.g. fields: id, name or fields items (id, name), see more at [partial…"},"strictValidation":{"type":"boolean","description":"Turns on strict validation for recipients. System will reply with BAD_REQUEST(400) if strictValidation = true and one of numbers didn't…"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:callfire/start-text-broadcast":{"post":{"operationId":"communication_callfire_start_text_broadcast","summary":"Start text broadcast","description":"POST /texts/broadcasts/{id}/start","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"integer","description":"An id of a text broadcast to start"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:callfire/get-text-broadcast-stats":{"get":{"operationId":"communication_callfire_get_text_broadcast_stats","summary":"Get statistics on text broadcast","description":"GET /texts/broadcasts/{id}/stats","tags":["communication"],"parameters":[{"name":"id","in":"query","required":true,"description":"An id of a text broadcast","schema":{"type":"integer","description":"An id of a text broadcast"}},{"name":"fields","in":"query","required":false,"description":"Limit fields received in response. E.g. fields: id, name or fields items (id, name), see more at [partial…","schema":{"type":"string","description":"Limit fields received in response. E.g. fields: id, name or fields items (id, name), see more at [partial…"}},{"name":"begin","in":"query","required":false,"description":"Start of a search find time interval, formatted in unix time milliseconds. Example: 1473781817000 for Sat, 05 Jan 1985 14:03:37 GMT","schema":{"type":"integer","description":"Start of a search find time interval, formatted in unix time milliseconds. Example: 1473781817000 for Sat, 05 Jan 1985 14:03:37 GMT"}},{"name":"end","in":"query","required":false,"description":"End of a search time interval, formatted in unix time milliseconds. Example: 1473781817000 for Sat, 05 Jan 1985 14:03:37 GMT","schema":{"type":"integer","description":"End of a search time interval, formatted in unix time milliseconds. Example: 1473781817000 for Sat, 05 Jan 1985 14:03:37 GMT"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:callfire/stop-text-broadcast":{"post":{"operationId":"communication_callfire_stop_text_broadcast","summary":"Stop text broadcast","description":"POST /texts/broadcasts/{id}/stop","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"integer","description":"An Id of a text broadcast. To stop the broadcast"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:callfire/get-text-broadcast-texts":{"get":{"operationId":"communication_callfire_get_text_broadcast_texts","summary":"Find texts in a text broadcast","description":"GET /texts/broadcasts/{id}/texts","tags":["communication"],"parameters":[{"name":"id","in":"query","required":true,"description":"An id of a text broadcast","schema":{"type":"integer","description":"An id of a text broadcast"}},{"name":"batchId","in":"query","required":false,"description":"~","schema":{"type":"integer","description":"~"}},{"name":"fields","in":"query","required":false,"description":"Limit fields received in response. E.g. fields: id, name or fields items (id, name), see more at [partial…","schema":{"type":"string","description":"Limit fields received in response. E.g. fields: id, name or fields items (id, name), see more at [partial…"}},{"name":"limit","in":"query","required":false,"description":"To set the maximum number of records to return in a paged list response. The default is 100","schema":{"type":"integer","default":100,"description":"To set the maximum number of records to return in a paged list response. The default is 100"}},{"name":"offset","in":"query","required":false,"description":"Offset to the start of a given page. The default is 0. Check [pagination](https://developers.callfire.com/docs.html#pagination) page for…","schema":{"type":"integer","default":0,"description":"Offset to the start of a given page. The default is 0. Check [pagination](https://developers.callfire.com/docs.html#pagination) page for…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:callfire/toggle-text-broadcast-recipients-status":{"post":{"operationId":"communication_callfire_toggle_text_broadcast_recipients_status","summary":"Disable/enable undialed recipients in broadcast","description":"POST /texts/broadcasts/{id}/toggleRecipientsStatus","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"integer","description":"An id of a text broadcast"},"enable":{"type":"boolean","default":false,"description":"Flag which indicate what to do with texts (true will enable texts in DISABLED status and vice versa)"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:callfire/get-text":{"get":{"operationId":"communication_callfire_get_text","summary":"Find a specific text","description":"GET /texts/{id}","tags":["communication"],"parameters":[{"name":"id","in":"query","required":true,"description":"An id of a text","schema":{"type":"integer","description":"An id of a text"}},{"name":"fields","in":"query","required":false,"description":"Limit fields received in response. E.g. fields: id, name or fields items (id, name), see more at [partial…","schema":{"type":"string","description":"Limit fields received in response. E.g. fields: id, name or fields items (id, name), see more at [partial…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:callfire/find-webhooks":{"get":{"operationId":"communication_callfire_find_webhooks","summary":"Find webhooks","description":"GET /webhooks","tags":["communication"],"parameters":[{"name":"fields","in":"query","required":false,"description":"Limit fields received in response. E.g. fields: id, name or fields items (id, name), see more at [partial…","schema":{"type":"string","description":"Limit fields received in response. E.g. fields: id, name or fields items (id, name), see more at [partial…"}},{"name":"limit","in":"query","required":false,"description":"To set the maximum number of records to return in a paged list response. The default is 100","schema":{"type":"integer","default":100,"description":"To set the maximum number of records to return in a paged list response. The default is 100"}},{"name":"offset","in":"query","required":false,"description":"Offset to the start of a given page. The default is 0. Check [pagination](https://developers.callfire.com/docs.html#pagination) page for…","schema":{"type":"integer","default":0,"description":"Offset to the start of a given page. The default is 0. Check [pagination](https://developers.callfire.com/docs.html#pagination) page for…"}},{"name":"name","in":"query","required":false,"description":"A name of a webhook","schema":{"type":"string","description":"A name of a webhook"}},{"name":"resource","in":"query","required":false,"description":"A name of a resource, available values: 'CccCampaign', 'CallBroadcast', 'TextBroadcast', 'OutboundCall', 'OutboundText', 'InboundCall',…","schema":{"type":"string","description":"A name of a resource, available values: 'CccCampaign', 'CallBroadcast', 'TextBroadcast', 'OutboundCall', 'OutboundText', 'InboundCall',…"}},{"name":"event","in":"query","required":false,"description":"A name of event, available values: 'started', 'stopped', 'finished'","schema":{"type":"string","description":"A name of event, available values: 'started', 'stopped', 'finished'"}},{"name":"callback","in":"query","required":false,"description":"A callback URL","schema":{"type":"string","description":"A callback URL"}},{"name":"enabled","in":"query","required":false,"description":"Specifies whether webhook is enabled","schema":{"type":"boolean","description":"Specifies whether webhook is enabled"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:callfire/create-webhook":{"post":{"operationId":"communication_callfire_create_webhook","summary":"Create a webhook","description":"POST /webhooks","tags":["communication"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:callfire/find-webhook-resources":{"get":{"operationId":"communication_callfire_find_webhook_resources","summary":"Find webhook resources","description":"GET /webhooks/resources","tags":["communication"],"parameters":[{"name":"fields","in":"query","required":false,"description":"Limit fields received in response. E.g. fields: id, name or fields items (id, name), see more at [partial…","schema":{"type":"string","description":"Limit fields received in response. E.g. fields: id, name or fields items (id, name), see more at [partial…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:callfire/get-webhook-resource":{"get":{"operationId":"communication_callfire_get_webhook_resource","summary":"Find specific webhook resource","description":"GET /webhooks/resources/{resource}","tags":["communication"],"parameters":[{"name":"resource","in":"query","required":true,"description":"A name of a webhook resource. Available resources include 'CccCampaign': ['started', 'stopped', 'finished'], 'CallBroadcast': ['started',…","schema":{"type":"string","description":"A name of a webhook resource. Available resources include 'CccCampaign': ['started', 'stopped', 'finished'], 'CallBroadcast': ['started',…"}},{"name":"fields","in":"query","required":false,"description":"Limit fields received in response. E.g. fields: id, name or fields items (id, name), see more at [partial…","schema":{"type":"string","description":"Limit fields received in response. E.g. fields: id, name or fields items (id, name), see more at [partial…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:callfire/get-webhook":{"get":{"operationId":"communication_callfire_get_webhook","summary":"Find a specific webhook","description":"GET /webhooks/{id}","tags":["communication"],"parameters":[{"name":"id","in":"query","required":true,"description":"An id of a webhook","schema":{"type":"integer","description":"An id of a webhook"}},{"name":"fields","in":"query","required":false,"description":"Limit fields received in response. E.g. fields: id, name or fields items (id, name), see more at [partial…","schema":{"type":"string","description":"Limit fields received in response. E.g. fields: id, name or fields items (id, name), see more at [partial…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:callfire/update-webhook":{"post":{"operationId":"communication_callfire_update_webhook","summary":"Update a webhook","description":"PUT /webhooks/{id}","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"integer","description":"An id of a webhook"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:callfire/delete-webhook":{"post":{"operationId":"communication_callfire_delete_webhook","summary":"Delete a webhook","description":"DELETE /webhooks/{id}","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"integer","description":"An Id of a webhook"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}}},"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"x-api-key"}},"schemas":{"RunEnvelope":{"type":"object","required":["project","data","timestamp"],"properties":{"project":{"type":"string","example":"dev-tools:hash"},"data":{},"timestamp":{"type":"string","format":"date-time"}}},"ErrorEnvelope":{"type":"object","properties":{"content":{},"message":{"type":"string"},"errors":{"type":"array","items":{}},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}}}}}},"responses":{"Error":{"description":"Invalid key, plan gate, rate limit or upstream failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}}}}