Skip to main content

Aircall

Use Aircall to perform various operations such as managing calls, contacts, numbers, teams, and users. With these operations, you can list, create, update, and delete entities in Aircall, as well as perform specific tasks like adding a phone number to a contact or managing team members.

Prerequisites​

To use Aircall, you need an Aircall account and API credentials (API Key or OAuth 2.0) to access Aircall's API. You can obtain your credentials by creating an application in your Aircall account. For detailed instructions, refer to the Aircall API documentation.

Supported Authentication Methods​

  • API Key

Basic Operations​

Call​

  • List Calls: Retrieve a list of all calls in your Aircall account.
  • Get Call: Retrieve detailed information about a specific call using its unique identifier.
  • Search Call: Search for calls based on specific criteria like duration, caller ID, or status.

Contact​

  • List Contacts: Retrieve a list of all contacts stored in your Aircall account.
  • Get Contact: Retrieve detailed information about a specific contact by their ID.
  • Create Contact: Add a new contact to your Aircall account with their relevant details.
  • Update Contact: Modify the information of an existing contact in your account.
  • Delete Contact: Remove a contact from your Aircall account.
  • Add Phone Number: Add a phone number to an existing contact.

Number​

  • List Numbers: Retrieve a list of all phone numbers available in your Aircall account.
  • Get Number: Retrieve details of a specific phone number.
  • Update Number: Modify settings or details associated with a phone number.

Team​

  • List Teams: Retrieve a list of all teams in your Aircall account.
  • Get Team: Retrieve details of a specific team by its ID.
  • Create Team: Add a new team to your Aircall organization.
  • Delete Team: Remove a team from your account.
  • Add User to Team: Add an existing user to a team in your Aircall account.
  • Remove User from Team: Remove a user from a specific team.

User​

  • Search Users: Search for users based on specific criteria such as email or role.
  • Get User: Retrieve details of a specific user by their ID.
  • Create User: Add a new user to your Aircall account.
  • Update User: Modify the details of an existing user.
  • Delete User: Remove a user from your Aircall account.

Parameters​

Each operation requires the specification of an operation parameter. Below is a list of available options for the operation parameter in Aircall:

Call Operations​

  • call.list: List Calls
  • call.get: Get Call
  • call.search: Search Call

Contact Operations​

  • contact.list: List Contacts
  • contact.get: Get Contact
  • contact.create: Create Contact
  • contact.update: Update Contact
  • contact.delete: Delete Contact
  • contact.addphone: Add Phone Number

Number Operations​

  • number.list: List Numbers
  • number.get: Get Number
  • number.update: Update Number

Team Operations​

  • team.list: List Teams
  • team.get: Get Team
  • team.create: Create Team
  • team.delete: Delete Team
  • team.addUser: Add User to Team
  • team.removeUser: Remove User from Team

User Operations​

  • user.search: Search Users
  • user.get: Get User
  • user.create: Create User
  • user.update: Update User
  • user.delete: Delete User

Further Reading​

For more information on the Aircall API and detailed steps to implement these operations, refer to the Aircall API documentation.