openapi-directory/api/callfire.com.json

Building & bundling https://github.com/APIs-guru/openapi-directory for easy use from JS

{"openapi":"3.0.0","servers":[{"url":"https://api.callfire.com/v2"}],"info":{"contact":{"email":"support@callfire.com","name":"CallFire","url":"https://www.callfire.com"},"description":"CallFire","license":{"name":"Apache 2.0","url":"http://www.apache.org/licenses/LICENSE-2.0.html"},"termsOfService":"https://www.callfire.com/terms","title":"CallFire API Documentation","version":"V2","x-apisguru-categories":["telecom"],"x-logo":{"backgroundColor":"#FFFFFF","url":"https://pbs.twimg.com/profile_images/537371596508258305/zP_eP2ec_400x400.png"},"x-origin":[{"format":"openapi","url":"https://www.callfire.com/v2/api-docs/swagger.json","version":"3.0"}],"x-providerName":"callfire.com"},"tags":[{"name":"calls"},{"name":"campaigns"},{"name":"contacts"},{"name":"keywords"},{"name":"me"},{"name":"media"},{"name":"numbers"},{"name":"orders"},{"name":"reports"},{"name":"texts"},{"name":"ticket"},{"name":"webhooks"}],"paths":{"/calls":{"get":{"description":"To search for all calls sent or received by the user. Use \"id=0\" for the campaignId parameter to query for all calls sent through the POST /calls API. See [call states and results](https://developers.callfire.com/results-responses-errors.html)","operationId":"findCalls","parameters":[{"description":"Limit fields received in response. E.g. fields: id, name or fields items (id, name), see more at [partial response](https://developers.callfire.com/docs.html#partial-response) page.","in":"query","name":"fields","required":false,"schema":{"type":"string"}},{"description":"To set the maximum number of records to return in a paged list response. The default is 100","in":"query","name":"limit","required":false,"schema":{"default":100,"format":"int32","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 more information about pagination in CallFire API.","in":"query","name":"offset","required":false,"schema":{"default":0,"format":"int32","type":"integer"}},{"description":"Lists the Call ids to search for. If calls ids are specified then other query parameters can be ignored","explode":true,"in":"query","name":"id","required":false,"schema":{"items":{"format":"int64","type":"integer"},"type":"array"}},{"description":"An id of a campaign, queries for calls included to a particular campaign. Specify null for all campaigns and 0 for default campaign","in":"query","name":"campaignId","required":false,"schema":{"format":"int64","type":"integer"}},{"description":"An id of a contact batch, queries for calls of a particular contact batch","in":"query","name":"batchId","required":false,"schema":{"format":"int64","type":"integer"}},{"description":"Phone number in E.164 format (11-digit) that call was from. Example: 12132000384","in":"query","name":"fromNumber","required":false,"schema":{"type":"string"}},{"description":"Phone number in E.164 format (11-digit) that call was sent to. Example: 12132000384","in":"query","name":"toNumber","required":false,"schema":{"type":"string"}},{"description":"A label for a specific call","in":"query","name":"label","required":false,"schema":{"type":"string"}},{"description":"Searches for all calls which correspond to statuses listed in a comma separated string. Available values: READY, SELECTED, CALLBACK, FINISHED, DISABLED, DNC, DUP, INVALID, TIMEOUT, PERIOD_LIMIT. See [call states and results](https://developers.callfire.com/results-responses-errors.html)","in":"query","name":"states","required":false,"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, CARRIER_ERROR, CARRIER_TEMP_ERROR, UNDIALED. See [call states and results](https://developers.callfire.com/results-responses-errors.html)","in":"query","name":"results","required":false,"schema":{"type":"string"}},{"description":"Filters inbound calls for \"true\" value and outbound calls for \"false\" value","in":"query","name":"inbound","required":false,"schema":{"type":"boolean"}},{"description":"Start of the find time interval, formatted in unix time milliseconds. Example: 1473781817000 for Sat, 05 Jan 1985 14:03:37 GMT","in":"query","name":"intervalBegin","required":false,"schema":{"format":"int64","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","in":"query","name":"intervalEnd","required":false,"schema":{"format":"int64","type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CallPage"}}},"description":"successful operation"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Not found"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Internal Server Error"}},"security":[{"basicAuth":[]}],"summary":"Find calls","tags":["calls"],"x-sample-csharp-url":"/csharp/calls/findCalls.cs","x-sample-curl-request-url":"/curl/calls/findCalls.sh","x-sample-curl-response-url":"/curl/calls/findCalls.json","x-sample-description-url":"/description/calls/findCalls.md","x-sample-go-url":"/go/calls/findCalls.go","x-sample-java-url":"/java/calls/findCalls.java","x-sample-js-url":"/js/calls/findCalls.js","x-sample-php-url":"/php/calls/findCalls.php","x-sample-python-url":"/python/calls/findCalls.py"},"post":{"description":"Use the /calls API to send individual calls quickly. A verified Caller ID and sufficient credits are required to make a call. CallRecipient represents a single recipient identified by phone number or contact id in CallFire system. You can attach user-defined attributes to a Call action via CallRecipient.attributes property, attributes are available in Call action response","operationId":"sendCalls","parameters":[{"description":"Limit fields received in response. E.g. fields: id, name or fields items (id, name), see more at [partial response](https://developers.callfire.com/docs.html#partial-response) page.","in":"query","name":"fields","required":false,"schema":{"type":"string"}},{"description":"Specifies a campaignId to send calls quickly on a previously created campaign","in":"query","name":"campaignId","required":false,"schema":{"format":"int64","type":"integer"}},{"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 CallRecipient","in":"query","name":"defaultLiveMessage","required":false,"schema":{"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 particular CallRecipient","in":"query","name":"defaultMachineMessage","required":false,"schema":{"type":"string"}},{"description":"Id of sound file to play if phone is answered. Parameter can be overridden for any particular CallRecipient","in":"query","name":"defaultLiveMessageSoundId","required":false,"schema":{"format":"int64","type":"integer"}},{"description":"An id of a sound file to play if answering machine is detected. Parameter can be overridden for any particular CallRecipient","in":"query","name":"defaultMachineMessageSoundId","required":false,"schema":{"format":"int64","type":"integer"}},{"description":"The voice set by default for all text-to-speech messages defined in CallRecipient objects or as default *Message properties","in":"query","name":"defaultVoice","required":false,"schema":{"enum":["MALE1","FEMALE1","FEMALE2","SPANISH1","FRENCHCANADIAN1"],"type":"string"}},{"description":"Turns on strict validation for recipients. System will reply with BAD_REQUEST(400) if strictValidation = true and one of numbers didn't pass validation","in":"query","name":"strictValidation","required":false,"schema":{"type":"boolean"}}],"requestBody":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/CallRecipient"},"type":"array"}}},"description":"An array of CallRecipient objects. \nLimitations:\n1. Max number of CallRecipient objects is 10\n"},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CallList"}}},"description":"successful operation"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Not found"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Internal Server Error"}},"security":[{"basicAuth":[]}],"summary":"Send calls","tags":["calls"],"x-sample-csharp-url":"/csharp/calls/sendCalls.cs","x-sample-curl-request-url":"/curl/calls/sendCalls.sh","x-sample-curl-response-url":"/curl/calls/sendCalls.json","x-sample-description-url":"/description/calls/sendCalls.md","x-sample-go-url":"/go/calls/sendCalls.go","x-sample-java-url":"/java/calls/sendCalls.java","x-sample-js-url":"/js/calls/sendCalls.js","x-sample-php-url":"/php/calls/sendCalls.php","x-sample-python-url":"/python/calls/sendCalls.py"}},"/calls/broadcasts":{"get":{"description":"Searches for all voice broadcasts created by user. Can query on label, name, and the current running status of the campaign. Returns a paged list of voice broadcasts","operationId":"findCallBroadcasts","parameters":[{"description":"Limit fields received in response. E.g. fields: id, name or fields items (id, name), see more at [partial response](https://developers.callfire.com/docs.html#partial-response) page.","in":"query","name":"fields","required":false,"schema":{"type":"string"}},{"description":"To set the maximum number of records to return in a paged list response. The default is 100","in":"query","name":"limit","required":false,"schema":{"default":10,"format":"int32","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 more information about pagination in CallFire API.","in":"query","name":"offset","required":false,"schema":{"default":0,"format":"int32","type":"integer"}},{"description":"A label of a voice broadcast","in":"query","name":"label","required":false,"schema":{"type":"string"}},{"description":"A name of voice broadcast","in":"query","name":"name","required":false,"schema":{"type":"string"}},{"description":"Specify whether the campaigns should be running or not","in":"query","name":"running","required":false,"schema":{"type":"boolean"}},{"description":"Specify whether the campaigns should be scheduled or not","in":"query","name":"scheduled","required":false,"schema":{"type":"boolean"}},{"description":"Start of the find time interval, formatted in unix time milliseconds. Example: 1473781817000 for Sat, 05 Jan 1985 14:03:37 GMT","in":"query","name":"intervalBegin","required":false,"schema":{"format":"int64","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","in":"query","name":"intervalEnd","required":false,"schema":{"format":"int64","type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CallBroadcastPage"}}},"description":"successful operation"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Not found"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Internal Server Error"}},"security":[{"basicAuth":[]}],"summary":"Find call broadcasts","tags":["calls"],"x-sample-csharp-url":"/csharp/calls/findCallBroadcasts.cs","x-sample-curl-request-url":"/curl/calls/findCallBroadcasts.sh","x-sample-curl-response-url":"/curl/calls/findCallBroadcasts.json","x-sample-description-url":"/description/calls/findCallBroadcasts.md","x-sample-go-url":"/go/calls/findCallBroadcasts.go","x-sample-java-url":"/java/calls/findCallBroadcasts.java","x-sample-js-url":"/js/calls/findCallBroadcasts.js","x-sample-php-url":"/php/calls/findCallBroadcasts.php","x-sample-python-url":"/python/calls/findCallBroadcasts.py"},"post":{"description":"Creates a call broadcast campaign using the Call Broadcast API. Send a CallBroadcast in the message body to add details in a voice broadcast campaign. The campaign can be created without contacts and bare minimum configuration, but contacts will have to be added further on to use the campaign","operationId":"createCallBroadcast","parameters":[{"description":"Specify whether to immediately start this campaign (not required)","in":"query","name":"start","required":false,"schema":{"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 pass validation","in":"query","name":"strictValidation","required":false,"schema":{"type":"boolean"}}],"requestBody":{"$ref":"#/components/requestBodies/CallBroadcast"},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceId"}}},"description":"successful operation"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Not found"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Internal Server Error"}},"security":[{"basicAuth":[]}],"summary":"Create a call broadcast","tags":["calls"],"x-sample-csharp-url":"/csharp/calls/createCallBroadcast.cs","x-sample-curl-request-url":"/curl/calls/createCallBroadcast.sh","x-sample-curl-response-url":"/curl/calls/createCallBroadcast.json","x-sample-description-url":"/description/calls/createCallBroadcast.md","x-sample-go-url":"/go/calls/createCallBroadcast.go","x-sample-java-url":"/java/calls/createCallBroadcast.java","x-sample-js-url":"/js/calls/createCallBroadcast.js","x-sample-php-url":"/php/calls/createCallBroadcast.php","x-sample-python-url":"/python/calls/createCallBroadcast.py"}},"/calls/broadcasts/{id}":{"get":{"description":"Returns a single CallBroadcast instance for a given call broadcast campaign id","operationId":"getCallBroadcast","parameters":[{"description":"An id of a CallBroadcast","in":"path","name":"id","required":true,"schema":{"format":"int64","type":"integer"}},{"description":"Limit fields received in response. E.g. fields: id, name or fields items (id, name), see more at [partial response](https://developers.callfire.com/docs.html#partial-response) page.","in":"query","name":"fields","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CallBroadcast"}}},"description":"successful operation"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Not found"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Internal Server Error"}},"security":[{"basicAuth":[]}],"summary":"Find a specific call broadcast","tags":["calls"],"x-sample-csharp-url":"/csharp/calls/getCallBroadcast.cs","x-sample-curl-request-url":"/curl/calls/getCallBroadcast.sh","x-sample-curl-response-url":"/curl/calls/getCallBroadcast.json","x-sample-description-url":"/description/calls/getCallBroadcast.md","x-sample-go-url":"/go/calls/getCallBroadcast.go","x-sample-java-url":"/java/calls/getCallBroadcast.java","x-sample-js-url":"/js/calls/getCallBroadcast.js","x-sample-php-url":"/php/calls/getCallBroadcast.php","x-sample-python-url":"/python/calls/getCallBroadcast.py"},"put":{"description":"This operation lets the user modify the configuration of a voice broadcast campaign after call broadcast campaign is created. See CallBroadcast for more information on what can/can't be updated on this API","operationId":"updateCallBroadcast","parameters":[{"description":"An id of a voice broadcast","in":"path","name":"id","required":true,"schema":{"format":"int64","type":"integer"}},{"description":"Turns on strict validation for recipients. System will reply with BAD_REQUEST(400) if strictValidation = true and one of numbers didn't pass validation","in":"query","name":"strictValidation","required":false,"schema":{"type":"boolean"}}],"requestBody":{"$ref":"#/components/requestBodies/CallBroadcast"},"responses":{"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Not found"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Internal Server Error"}},"security":[{"basicAuth":[]}],"summary":"Update a call broadcast","tags":["calls"],"x-sample-csharp-url":"/csharp/calls/updateCallBroadcast.cs","x-sample-curl-request-url":"/curl/calls/updateCallBroadcast.sh","x-sample-curl-response-url":"/curl/calls/updateCallBroadcast.json","x-sample-description-url":"/description/calls/updateCallBroadcast.md","x-sample-go-url":"/go/calls/updateCallBroadcast.go","x-sample-java-url":"/java/calls/updateCallBroadcast.java","x-sample-js-url":"/js/calls/updateCallBroadcast.js","x-sample-php-url":"/php/calls/updateCallBroadcast.php","x-sample-python-url":"/python/calls/updateCallBroadcast.py"}},"/calls/broadcasts/{id}/archive":{"post":{"description":"Archives a voice broadcast (voice broadcast will be hidden in search results)","operationId":"archiveVoiceBroadcast","parameters":[{"description":"An id of a voice broadcast to archive","in":"path","name":"id","required":true,"schema":{"format":"int64","type":"integer"}}],"responses":{"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Not found"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Internal Server Error"}},"security":[{"basicAuth":[]}],"summary":"Archive voice broadcast","tags":["calls"],"x-sample-csharp-url":"/csharp/calls/archiveVoiceBroadcast.cs","x-sample-curl-request-url":"/curl/calls/archiveVoiceBroadcast.sh","x-sample-curl-response-url":"/curl/calls/archiveVoiceBroadcast.json","x-sample-description-url":"/description/calls/archiveVoiceBroadcast.md","x-sample-go-url":"/go/calls/archiveVoiceBroadcast.go","x-sample-java-url":"/java/calls/archiveVoiceBroadcast.java","x-sample-js-url":"/js/calls/archiveVoiceBroadcast.js","x-sample-php-url":"/php/calls/archiveVoiceBroadcast.php","x-sample-python-url":"/python/calls/archiveVoiceBroadcast.py"}},"/calls/broadcasts/{id}/batches":{"get":{"description":"This endpoint will enable the user to page through all of the batches for a particular voice broadcast campaign","operationId":"getCallBroadcastBatches","parameters":[{"description":"An id of a call broadcast","in":"path","name":"id","required":true,"schema":{"format":"int64","type":"integer"}},{"description":"Limit fields received in response. E.g. fields: id, name or fields items (id, name), see more at [partial response](https://developers.callfire.com/docs.html#partial-response) page.","in":"query","name":"fields","required":false,"schema":{"type":"string"}},{"description":"To set the maximum number of records to return in a paged list response. The default is 100","in":"query","name":"limit","required":false,"schema":{"default":100,"format":"int32","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 more information about pagination in CallFire API.","in":"query","name":"offset","required":false,"schema":{"default":0,"format":"int32","type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BatchPage"}}},"description":"successful operation"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Not found"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Internal Server Error"}},"security":[{"basicAuth":[]}],"summary":"Find batches in a call broadcast","tags":["calls"],"x-sample-csharp-url":"/csharp/calls/getCallBroadcastBatches.cs","x-sample-curl-request-url":"/curl/calls/getCallBroadcastBatches.sh","x-sample-curl-response-url":"/curl/calls/getCallBroadcastBatches.json","x-sample-description-url":"/description/calls/getCallBroadcastBatches.md","x-sample-go-url":"/go/calls/getCallBroadcastBatches.go","x-sample-java-url":"/java/calls/getCallBroadcastBatches.java","x-sample-js-url":"/js/calls/getCallBroadcastBatches.js","x-sample-php-url":"/php/calls/getCallBroadcastBatches.php","x-sample-python-url":"/python/calls/getCallBroadcastBatches.py"},"post":{"description":"The 'add batch' API allows user to add additional batches to an already created voice broadcast campaign. The added batch will go through the CallFire validation process, unlike in the recipients version of this API. That is why you can use the scrubDuplicates flag to remove duplicates from your batch. Batches may be added as a contact list id, a list of contact ids, or a list of numbers","operationId":"addCallBroadcastBatch","parameters":[{"description":"An id of a call broadcast","in":"path","name":"id","required":true,"schema":{"format":"int64","type":"integer"}},{"description":"Turns on strict validation for recipients. System will reply with BAD_REQUEST(400) if strictValidation = true and one of numbers didn't pass validation","in":"query","name":"strictValidation","required":false,"schema":{"type":"boolean"}}],"requestBody":{"$ref":"#/components/requestBodies/BatchRequest"},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceId"}}},"description":"successful operation"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Not found"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Internal Server Error"}},"security":[{"basicAuth":[]}],"summary":"Add batches to a call broadcast","tags":["calls"],"x-sample-csharp-url":"/csharp/calls/addCallBroadcastBatch.cs","x-sample-curl-request-url":"/curl/calls/addCallBroadcastBatch.sh","x-sample-curl-response-url":"/curl/calls/addCallBroadcastBatch.json","x-sample-description-url":"/description/calls/addCallBroadcastBatch.md","x-sample-go-url":"/go/calls/addCallBroadcastBatch.go","x-sample-java-url":"/java/calls/addCallBroadcastBatch.java","x-sample-js-url":"/js/calls/addCallBroadcastBatch.js","x-sample-php-url":"/php/calls/addCallBroadcastBatch.php","x-sample-python-url":"/python/calls/addCallBroadcastBatch.py"}},"/calls/broadcasts/{id}/calls":{"get":{"description":"This endpoint will enable the user to page through all calls for a particular call broadcast campaign","operationId":"getCallBroadcastCalls","parameters":[{"description":"An Id of a call broadcast","in":"path","name":"id","required":true,"schema":{"format":"int64","type":"integer"}},{"description":"An id of a particular batch associated with broadcast","in":"query","name":"batchId","required":false,"schema":{"format":"int64","type":"integer"}},{"description":"Limit fields received in response. E.g. fields: id, name or fields items (id, name), see more at [partial response](https://developers.callfire.com/docs.html#partial-response) page.","in":"query","name":"fields","required":false,"schema":{"type":"string"}},{"description":"To set the maximum number of records to return in a paged list response. The default is 100","in":"query","name":"limit","required":false,"schema":{"default":100,"format":"int32","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 more information about pagination in CallFire API.","in":"query","name":"offset","required":false,"schema":{"default":0,"format":"int32","type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CallPage"}}},"description":"successful operation"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Not found"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Internal Server Error"}},"security":[{"basicAuth":[]}],"summary":"Find calls in a call broadcast","tags":["calls"],"x-sample-csharp-url":"/csharp/calls/getCallBroadcastCalls.cs","x-sample-curl-request-url":"/curl/calls/getCallBroadcastCalls.sh","x-sample-curl-response-url":"/curl/calls/getCallBroadcastCalls.json","x-sample-description-url":"/description/calls/getCallBroadcastCalls.md","x-sample-go-url":"/go/calls/getCallBroadcastCalls.go","x-sample-java-url":"/java/calls/getCallBroadcastCalls.java","x-sample-js-url":"/js/calls/getCallBroadcastCalls.js","x-sample-php-url":"/php/calls/getCallBroadcastCalls.php","x-sample-python-url":"/python/calls/getCallBroadcastCalls.py"}},"/calls/broadcasts/{id}/recipients":{"post":{"description":"Use this API to add the recipients to an existing voice broadcast. Post a list of Recipient objects to be added to the voice broadcast campaign. These contacts will not go through validation process, and will be acted upon as they are added. Recipients may be added as a list of contact ids, or list of numbers","operationId":"addCallBroadcastRecipients","parameters":[{"description":"An id of a call broadcast","in":"path","name":"id","required":true,"schema":{"format":"int64","type":"integer"}},{"description":"Limit fields received in response. E.g. fields: id, name or fields items (id, name), see more at [partial response](https://developers.callfire.com/docs.html#partial-response) page.","in":"query","name":"fields","required":false,"schema":{"type":"string"}},{"description":"Turns on strict validation for recipients. System will reply with BAD_REQUEST(400) if strictValidation = true and one of numbers didn't pass validation","in":"query","name":"strictValidation","required":false,"schema":{"type":"boolean"}}],"requestBody":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/Recipient"},"type":"array"}}},"description":"A list of CallRecipient objects"},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CallList"}}},"description":"successful operation"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Not found"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Internal Server Error"}},"security":[{"basicAuth":[]}],"summary":"Add recipients to a call broadcast","tags":["calls"],"x-sample-csharp-url":"/csharp/calls/addCallBroadcastRecipients.cs","x-sample-curl-request-url":"/curl/calls/addCallBroadcastRecipients.sh","x-sample-curl-response-url":"/curl/calls/addCallBroadcastRecipients.json","x-sample-description-url":"/description/calls/addCallBroadcastRecipients.md","x-sample-go-url":"/go/calls/addCallBroadcastRecipients.go","x-sample-java-url":"/java/calls/addCallBroadcastRecipients.java","x-sample-js-url":"/js/calls/addCallBroadcastRecipients.js","x-sample-php-url":"/php/calls/addCallBroadcastRecipients.php","x-sample-python-url":"/python/calls/addCallBroadcastRecipients.py"}},"/calls/broadcasts/{id}/start":{"post":{"description":"Start a voice broadcast","operationId":"startVoiceBroadcast","parameters":[{"description":"An id of voice broadcast to start","in":"path","name":"id","required":true,"schema":{"format":"int64","type":"integer"}}],"responses":{"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Not found"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Internal Server Error"}},"security":[{"basicAuth":[]}],"summary":"Start voice broadcast","tags":["calls"],"x-sample-csharp-url":"/csharp/calls/startVoiceBroadcast.cs","x-sample-curl-request-url":"/curl/calls/startVoiceBroadcast.sh","x-sample-curl-response-url":"/curl/calls/startVoiceBroadcast.json","x-sample-description-url":"/description/calls/startVoiceBroadcast.md","x-sample-go-url":"/go/calls/startVoiceBroadcast.go","x-sample-java-url":"/java/calls/startVoiceBroadcast.java","x-sample-js-url":"/js/calls/startVoiceBroadcast.js","x-sample-php-url":"/php/calls/startVoiceBroadcast.php","x-sample-python-url":"/python/calls/startVoiceBroadcast.py"}},"/calls/broadcasts/{id}/stats":{"get":{"description":"Returns broadcast statistics like total number of sent/received actions, total cost, number of remaining outbound actions, error count, etc","operationId":"getCallBroadcastStats","parameters":[{"description":"An id of a call broadcast","in":"path","name":"id","required":true,"schema":{"format":"int64","type":"integer"}},{"description":"Limit fields received in response. E.g. fields: id, name or fields items (id, name), see more at [partial response](https://developers.callfire.com/docs.html#partial-response) page.","in":"query","name":"fields","required":false,"schema":{"type":"string"}},{"description":"Start of the search time interval, formatted in unix time milliseconds. Example: 1473781817000 for Sat, 05 Jan 1985 14:03:37 GMT","in":"query","name":"begin","required":false,"schema":{"format":"int64","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","in":"query","name":"end","required":false,"schema":{"format":"int64","type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CallBroadcastStats"}}},"description":"successful operation"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Not found"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Internal Server Error"}},"security":[{"basicAuth":[]}],"summary":"Get statistics on call broadcast","tags":["calls"],"x-sample-csharp-url":"/csharp/calls/getCallBroadcastStats.cs","x-sample-curl-request-url":"/curl/calls/getCallBroadcastStats.sh","x-sample-curl-response-url":"/curl/calls/getCallBroadcastStats.json","x-sample-description-url":"/description/calls/getCallBroadcastStats.md","x-sample-go-url":"/go/calls/getCallBroadcastStats.go","x-sample-java-url":"/java/calls/getCallBroadcastStats.java","x-sample-js-url":"/js/calls/getCallBroadcastStats.js","x-sample-php-url":"/php/calls/getCallBroadcastStats.php","x-sample-python-url":"/python/calls/getCallBroadcastStats.py"}},"/calls/broadcasts/{id}/stop":{"post":{"description":"Stop a voice broadcast","operationId":"stopVoiceBroadcast","parameters":[{"description":"An id of voice broadcast to stop","in":"path","name":"id","required":true,"schema":{"format":"int64","type":"integer"}}],"responses":{"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Not found"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Internal Server Error"}},"security":[{"basicAuth":[]}],"summary":"Stop voice broadcast","tags":["calls"],"x-sample-csharp-url":"/csharp/calls/stopVoiceBroadcast.cs","x-sample-curl-request-url":"/curl/calls/stopVoiceBroadcast.sh","x-sample-curl-response-url":"/curl/calls/stopVoiceBroadcast.json","x-sample-description-url":"/description/calls/stopVoiceBroadcast.md","x-sample-go-url":"/go/calls/stopVoiceBroadcast.go","x-sample-java-url":"/java/calls/stopVoiceBroadcast.java","x-sample-js-url":"/js/calls/stopVoiceBroadcast.js","x-sample-php-url":"/php/calls/stopVoiceBroadcast.php","x-sample-python-url":"/python/calls/stopVoiceBroadcast.py"}},"/calls/broadcasts/{id}/toggleRecipientsStatus":{"post":{"description":"This operation lets the user to disable/enable undialed recipients in created broadcast","operationId":"toggleCallBroadcastRecipientsStatus","parameters":[{"description":"An id of a voice broadcast","in":"path","name":"id","required":true,"schema":{"format":"int64","type":"integer"}},{"description":"Flag which indicate what to do with calls (true will enable call in DISABLED status and vice versa)","in":"query","name":"enable","required":false,"schema":{"default":false,"type":"boolean"}}],"requestBody":{"$ref":"#/components/requestBodies/RecipientArray"},"responses":{"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Not found"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Internal Server Error"}},"security":[{"basicAuth":[]}],"summary":"Disable/enable undialed recipients in broadcast","tags":["calls"],"x-sample-csharp-url":"/csharp/calls/toggleCallBroadcastRecipientsStatus.cs","x-sample-curl-request-url":"/curl/calls/toggleCallBroadcastRecipientsStatus.sh","x-sample-curl-response-url":"/curl/calls/toggleCallBroadcastRecipientsStatus.json","x-sample-description-url":"/description/calls/toggleCallBroadcastRecipientsStatus.md","x-sample-go-url":"/go/calls/toggleCallBroadcastRecipientsStatus.go","x-sample-java-url":"/java/calls/toggleCallBroadcastRecipientsStatus.java","x-sample-js-url":"/js/calls/toggleCallBroadcastRecipientsStatus.js","x-sample-php-url":"/php/calls/toggleCallBroadcastRecipientsStatus.php","x-sample-python-url":"/python/calls/toggleCallBroadcastRecipientsStatus.py"}},"/calls/recordings/{id}":{"get":{"description":"Returns metadata of recording of a particular call. Metadata contains a link to a MP3 recording","operationId":"getCallRecording","parameters":[{"description":"~","in":"path","name":"id","required":true,"schema":{"format":"int64","type":"integer"}},{"description":"Limit fields received in response. E.g. fields: id, name or fields items (id, name), see more at [partial response](https://developers.callfire.com/docs.html#partial-response) page.","in":"query","name":"fields","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CallRecording"}}},"description":"successful operation"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Not found"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Internal Server Error"}},"security":[{"basicAuth":[]}],"summary":"Get call recording by id","tags":["calls"],"x-sample-csharp-url":"/csharp/calls/getCallRecording.cs","x-sample-curl-request-url":"/curl/calls/getCallRecording.sh","x-sample-curl-response-url":"/curl/calls/getCallRecording.json","x-sample-description-url":"/description/calls/getCallRecording.md","x-sample-go-url":"/go/calls/getCallRecording.go","x-sample-java-url":"/java/calls/getCallRecording.java","x-sample-js-url":"/js/calls/getCallRecording.js","x-sample-php-url":"/php/calls/getCallRecording.php","x-sample-python-url":"/python/calls/getCallRecording.py"}},"/calls/recordings/{id}.mp3":{"get":{"description":"Returns an MP3 recording of particular call, response contains binary data, content type is 'audio/mpeg'","operationId":"getCallRecordingMp3","parameters":[{"description":"An id of a call","in":"path","name":"id","required":true,"schema":{"format":"int64","type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InputStream"}}},"description":"successful operation"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Not found"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Internal Server Error"}},"security":[{"basicAuth":[]}],"summary":"Get call recording in mp3 format","tags":["calls"],"x-sample-csharp-url":"/csharp/calls/getCallRecordingMp3.cs","x-sample-curl-request-url":"/curl/calls/getCallRecordingMp3.sh","x-sample-curl-response-url":"/curl/calls/getCallRecordingMp3.json","x-sample-description-url":"/description/calls/getCallRecordingMp3.md","x-sample-go-url":"/go/calls/getCallRecordingMp3.go","x-sample-java-url":"/java/calls/getCallRecordingMp3.java","x-sample-js-url":"/js/calls/getCallRecordingMp3.js","x-sample-php-url":"/php/calls/getCallRecordingMp3.php","x-sample-python-url":"/python/calls/getCallRecordingMp3.py"}},"/calls/{id}":{"get":{"description":"Returns a single Call instance for a given call id.","operationId":"getCall","parameters":[{"description":"An id of a call","in":"path","name":"id","required":true,"schema":{"format":"int64","type":"integer"}},{"description":"Limit fields received in response. E.g. fields: id, name or fields items (id, name), see more at [partial response](https://developers.callfire.com/docs.html#partial-response) page.","in":"query","name":"fields","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Call"}}},"description":"successful operation"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Not found"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Internal Server Error"}},"security":[{"basicAuth":[]}],"summary":"Find a specific call","tags":["calls"],"x-sample-csharp-url":"/csharp/calls/getCall.cs","x-sample-curl-request-url":"/curl/calls/getCall.sh","x-sample-curl-response-url":"/curl/calls/getCall.json","x-sample-description-url":"/description/calls/getCall.md","x-sample-go-url":"/go/calls/getCall.go","x-sample-java-url":"/java/calls/getCall.java","x-sample-js-url":"/js/calls/getCall.js","x-sample-php-url":"/php/calls/getCall.php","x-sample-python-url":"/python/calls/getCall.py"}},"/calls/{id}/recordings":{"get":{"description":"Returns a list of recordings metadata of particular call. Metadata contains link to a MP3 recording","operationId":"getCallRecordings","parameters":[{"description":"An id of a call","in":"path","name":"id","required":true,"schema":{"format":"int64","type":"integer"}},{"description":"Limit fields received in response. E.g. fields: id, name or fields items (id, name), see more at [partial response](https://developers.callfire.com/docs.html#partial-response) page.","in":"query","name":"fields","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CallRecordingList"}}},"description":"successful operation"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Not found"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Internal Server Error"}},"security":[{"basicAuth":[]}],"summary":"Get call recordings for a call","tags":["calls"],"x-sample-csharp-url":"/csharp/calls/getCallRecordings.cs","x-sample-curl-request-url":"/curl/calls/getCallRecordings.sh","x-sample-curl-response-url":"/curl/calls/getCallRecordings.json","x-sample-description-url":"/description/calls/getCallRecordings.md","x-sample-go-url":"/go/calls/getCallRecordings.go","x-sample-java-url":"/java/calls/getCallRecordings.java","x-sample-js-url":"/js/calls/getCallRecordings.js","x-sample-php-url":"/php/calls/getCallRecordings.php","x-sample-python-url":"/python/calls/getCallRecordings.py"}},"/calls/{id}/recordings/{name}":{"get":{"description":"Returns recording metadata of particular call. Metadata contains link to a MP3 recording","operationId":"getCallRecordingByName","parameters":[{"description":"An id of a call","in":"path","name":"id","required":true,"schema":{"format":"int64","type":"integer"}},{"description":"A name of a recording","in":"path","name":"name","required":true,"schema":{"type":"string"}},{"description":"Limit fields received in response. E.g. fields: id, name or fields items (id, name), see more at [partial response](https://developers.callfire.com/docs.html#partial-response) page.","in":"query","name":"fields","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CallRecording"}}},"description":"successful operation"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Not found"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Internal Server Error"}},"security":[{"basicAuth":[]}],"summary":"Get call recording by name","tags":["calls"],"x-sample-csharp-url":"/csharp/calls/getCallRecordingByName.cs","x-sample-curl-request-url":"/curl/calls/getCallRecordingByName.sh","x-sample-curl-response-url":"/curl/calls/getCallRecordingByName.json","x-sample-description-url":"/description/calls/getCallRecordingByName.md","x-sample-go-url":"/go/calls/getCallRecordingByName.go","x-sample-java-url":"/java/calls/getCallRecordingByName.java","x-sample-js-url":"/js/calls/getCallRecordingByName.js","x-sample-php-url":"/php/calls/getCallRecordingByName.php","x-sample-python-url":"/python/calls/getCallRecordingByName.py"}},"/calls/{id}/recordings/{name}.mp3":{"get":{"description":"Returns a MP3 recording of a particular call, response contains binary data, content type is 'audio/mpeg'","operationId":"getCallRecordingMp3ByName","parameters":[{"description":"An id of a call","in":"path","name":"id","required":true,"schema":{"format":"int64","type":"integer"}},{"description":"A name of a recording","in":"path","name":"name","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"audio/mpeg":{"schema":{"$ref":"#/components/schemas/InputStream"}}},"description":"successful operation"},"400":{"content":{"audio/mpeg":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad request"},"401":{"content":{"audio/mpeg":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Unauthorized"},"403":{"content":{"audio/mpeg":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Forbidden"},"404":{"content":{"audio/mpeg":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Not found"},"500":{"content":{"audio/mpeg":{"schema":{"$r