Table of Contents
Cloud based phone system and call center software all-in-one with Cloud Telephony Integrations (CTI) with your favorite CRM & Helpdesk software. No hardware or deskphone needed; instant setup.
API Overview
Aircall is a cloud-based call center software designed to enhance communication and customer support operations. It offers a comprehensive suite of features, including call routing, IVR, call recording, analytics, and integrations with popular CRM and help desk systems. Aircall's intuitive interface and customizable settings allow businesses to tailor the platform to their specific needs, improving agent productivity, enhancing customer satisfaction, and streamlining call center management.
Aircall's API provides developers with a robust set of tools to integrate Aircall's functionality into their own applications and systems. The API documentation offers extensive resources, including code samples, tutorials, and reference materials, making it easy for developers to get started. Aircall's REST APIs enable programmatic access to key call center functions, such as call management, contact management, and reporting. Webhooks allow developers to receive real-time notifications for specific events, such as incoming calls or call status changes. To ensure optimal performance and prevent abuse, Aircall implements rate limits to control the frequency of API requests.
API Request Limits
Free
200 requests per minute
Essential
1000 requests per minute
Professional
2000 requests per minute
Enterprise
Unlimited requests per minute
SDKs
APIs
Method: GET
Description: Get a specific call by its ID..
Endpoint: /v1/calls/{call_id}
Parameters: call_id
Method: POST
Description: Create a new call..
Endpoint: /v1/calls
Parameters: to, from, direction, start_time, end_time, duration, recording_url, notes
Method: PUT
Description: Update a specific call by its ID..
Endpoint: /v1/calls/{call_id}
Parameters: call_id, to, from, direction, start_time, end_time, duration, recording_url, notes
Method: DELETE
Description: Delete a specific call by its ID..
Endpoint: /v1/calls/{call_id}
Parameters: call_id
Method: GET
Description: Get a list of all calls..
Endpoint: /v1/calls
Parameters: page, per_page, sort, direction
Method: GET
Description: Get a specific contact by its ID..
Endpoint: /v1/contacts/{contact_id}
Parameters: contact_id
Method: POST
Description: Create a new contact..
Endpoint: /v1/contacts
Parameters: first_name, last_name, email, phone_number, notes
Method: PUT
Description: Update a specific contact by its ID..
Endpoint: /v1/contacts/{contact_id}
Parameters: contact_id, first_name, last_name, email, phone_number, notes
Method: DELETE
Description: Delete a specific contact by its ID..
Endpoint: /v1/contacts/{contact_id}
Parameters: contact_id
Method: GET
Description: Get a list of all contacts..
Endpoint: /v1/contacts
Parameters: page, per_page, sort, direction
Method: GET
Description: Get a specific number by its ID..
Endpoint: /v1/numbers/{number_id}
Parameters: number_id
Method: POST
Description: Create a new number..
Endpoint: /v1/numbers
Parameters: number, type, country, inbound_call_routing, inbound_sms_routing, voice_mail_greeting_id, fax_greeting_id
Method: PUT
Description: Update a specific number by its ID..
Endpoint: /v1/numbers/{number_id}
Parameters: number_id, number, type, country, inbound_call_routing, inbound_sms_routing, voice_mail_greeting_id, fax_greeting_id
Method: DELETE
Description: Delete a specific number by its ID..
Endpoint: /v1/numbers/{number_id}
Parameters: number_id
Method: GET
Description: Get a list of all numbers..
Endpoint: /v1/numbers
Parameters: page, per_page, sort, direction
Method: GET
Description: Get a specific team by its ID..
Endpoint: /v1/teams/{team_id}
Parameters: team_id
Method: POST
Description: Create a new team..
Endpoint: /v1/teams
Parameters: name, description
Method: PUT
Description: Update a specific team by its ID..
Endpoint: /v1/teams/{team_id}
Parameters: team_id, name, description
Method: DELETE
Description: Delete a specific team by its ID..
Endpoint: /v1/teams/{team_id}
Parameters: team_id
Method: GET
Description: Get a list of all teams..
Endpoint: /v1/teams
Parameters: page, per_page, sort, direction
FAQ
How do I authenticate to the Aircall API?
You can authenticate to the Aircall API using an API key or an OAuth 2.0 access token.
What are the rate limits for the Aircall API?
The Aircall API has a rate limit of 100 requests per minute per API key.
How do I create a sandbox account?
You can create a sandbox account by signing up for a free trial at https://aircall.io/.
How do I get a developer account?
You can get a developer account by signing up at https://developer.aircall.io/.
How do I use the Aircall API to make a phone call?
You can use the Aircall API to make a phone call by creating a new call object and then calling the <code>createCall</code> method.