← Back to toolkits
Aircall logo

Aircall

Aircall is a cloud-based phone and call-center platform. This toolkit manages users, teams, phone numbers, calls, contacts, and tags on a single Aircall company account via the Public API.

call trackingcommunicationphone & sms

Tools (48)

  • Add Contact Method

    Add a phone number or an email address to an existing Aircall contact. Set method_type='phone' to add a phone number or method_type='email' to add an email address. The value and any supplied label must be nonblank, but this tool does not impose E.164 or strict email formatting. If the label is omitted, Aircall defaults it to 'Main'. Use when a contact already exists and needs another way to be reached; not for creating the contact itself (AIRCALL_CREATE_CONTACT), and not for changing a method that is already on the contact (AIRCALL_UPDATE_CONTACT_METHOD). Returns the created method as 'contact_method' ({id, method_type, label, value}) — keep its id to update or delete it later.

    Inputs: label, value, contact_id, method_type

  • Add User to Team

    Add a User to a Team (membership change). Returns the updated team.

    Inputs: team_id, user_id

  • Add Comment to Call

    Add a comment or note to a call. A call can have at most five comments, and once posted a comment cannot be updated or deleted.

    Inputs: id, content

  • Create Contact

    Create a shared Aircall contact. Use when adding someone to the shared address book; not for editing an existing one (AIRCALL_UPDATE_CONTACT), and not for attaching a phone number or email address to a contact that already exists — that is AIRCALL_ADD_CONTACT_METHOD with method_type='phone' or method_type='email'. At least one phone_numbers[] entry is required (1-20); emails[] is optional (max 20). Aircall rejects a name-only contact AND an email-only contact with HTTP 400.

    Inputs: emails, last_name, first_name, information, company_name, phone_numbers

  • Create Tag

    Create a Tag. name must be unique per company; color is a hex string (e.g. #00B388). Aircall does not accept a mutable description field.

    Inputs: name, color

  • Create Team

    Create a new Team. Requires a name.

    Inputs: name

  • Create User

    Create an Aircall user and send them a real invitation email, consuming a licensed seat. Use when adding a new teammate to the account; not for changing someone who already exists (AIRCALL_UPDATE_USER). Requires email, first_name and last_name. role_ids takes role NAME strings, one of owner, supervisor, admin or agent, not numeric ids.

    Inputs: email, role_ids, last_name, first_name, wrap_up_time, inviter_user_id, availability_status

  • Create Webhook

    Create an Aircall webhook targeting a public HTTPS URL. Select one or more events, or explicitly set subscribe_to_all_events=true; omission never silently subscribes the destination to every company event. Aircall permits at most 100 webhooks per company.

    Inputs: url, events, custom_name, subscribe_to_all_events

  • Delete Call Media

    Request permanent deletion of a Call's audio recording or voicemail, for compliance or data governance. Set media_type='recording' or media_type='voicemail'; a call may have one, both, or neither. The call record is retained, but deleting a recording on an AI Assist/Pro account also permanently removes its transcription and AI insights. Use when an audio artefact and its derived AI data must be purged; not for reading call details (AIRCALL_GET_CALL). Once processed, deletion is irreversible. A successful response means Aircall accepted the request, not that deletion is complete: recordings take 10-15 minutes and voicemails up to 1 minute, and existing download URLs may work during propagation. A recording can arrive up to 24 hours after the call, so retry later when it is not present yet.

    Inputs: call_id, media_type

  • Delete Contact

    Permanently delete a shared contact by ID, including its phone numbers and email addresses. The tool returns a success confirmation when deletion succeeds.

    Inputs: id

  • Delete Contact Method

    Permanently remove one phone number or email address from an Aircall contact. Set method_type='phone' or method_type='email' to say which kind method_id refers to. Use when a contact should no longer be reachable that way; not for deleting the whole contact (AIRCALL_DELETE_CONTACT), and not for correcting a method's value or label (AIRCALL_UPDATE_CONTACT_METHOD). IRREVERSIBLE: the method is gone and re-adding it mints a new id. Returns {success: true} on HTTP 204.

    Inputs: method_id, contact_id, method_type

  • Delete Tag

    Delete a Tag by id, removing it from Calls. The tool returns a success confirmation.

    Inputs: id

  • Delete Team

    Delete a Team by id, removing it from Numbers' call distribution without deleting its users. The tool returns a success confirmation.

    Inputs: id

  • Delete User

    Permanently delete a user and their associated data, which cannot be recovered. Deletion is asynchronous and triggers a user.deleted webhook; the tool returns a success confirmation with the requested user ID.

    Inputs: id

  • Delete Webhook

    Permanently delete an accessible Aircall webhook, stopping delivery and losing its configuration. With OAuth, access is limited to the webhook linked to the token; Basic Auth accesses webhooks created through the dashboard and Basic Auth API requests.

    Inputs: webhook_id

  • Get Call

    Retrieve a single Call by id, with optional contact / short-url / timeline enrichment via the fetch_* flags.

    Inputs: id, fetch_contact, fetch_aiva_conv, fetch_short_urls, fetch_call_timeline

  • Get Company

    Retrieve information about the connected Aircall company (name, users_count, numbers_count). This is the best true auth-verify endpoint: a 200 confirms the Basic Auth credentials are valid.

  • Get Contact

    Retrieve a single shared Contact by id, with its nested phone_numbers[] and emails[]. NOTE: contact created_at/updated_at are UNIX-epoch INTEGERS.

    Inputs: id

  • Get Number

    Retrieve a single Aircall phone Number by its numeric id.

    Inputs: id

  • Get Number Registration Status

    Check whether an Aircall phone number is registered for compliance (10DLC or other regulatory registration) by reading the `status` field. Use for regulatory registration state only; not for the number's name, availability or Music & Messages (AIRCALL_GET_NUMBER).

    Inputs: id

  • Get Tag

    Retrieve a single Tag by id.

    Inputs: id

  • Get Team

    Retrieve a single Team by id, including its member users.

    Inputs: id

  • Get User

    Retrieve one Aircall user by numeric id or by email address. Both work in the id field. Use when you already have the id or email; not for browsing the roster (AIRCALL_LIST_USERS). The user's assigned phone numbers are not included. Get them from AIRCALL_LIST_USER_NUMBERS.

    Inputs: id

  • Get User Availability

    Check the current availability of one User. Returns availability ∈ available | offline | do_not_disturb | in_call | after_call_work.

    Inputs: id

  • Get Webhook

    Retrieve an accessible Aircall webhook by UUID or legacy numeric ID. With OAuth, access is limited to the webhook linked to the token; Basic Auth accesses webhooks created through the dashboard and Basic Auth API requests.

    Inputs: webhook_id

  • List Calls

    List the account's calls in chronological order, covering about 6 months of history and at most 10,000 items via pagination. Window past that with the `from` UNIX timestamp. Use for plain date-ordered browsing of call activity; not when filtering by direction, user, phone number or tag, which is what AIRCALL_SEARCH_CALLS is for. An account with no calls returns an empty list with HTTP 200, never 404.

    Inputs: to, from, page, order, cursor, per_page, fetch_contact, fetch_aiva_conv, fetch_short_urls, fetch_call_timeline

  • List Contacts

    List shared contacts with their phone numbers and email addresses, with contact timestamps as UNIX-epoch integers. Results are paginated, with up to 10,000 items accessible via pagination; use the from timestamp to window past that limit.

    Inputs: to, from, page, order, cursor, order_by, per_page

  • List Numbers

    List all Aircall phone Numbers in the account. Each number includes id, digits, name, country, availability and a `messages` object of audio URLs. Paginated via page/per_page; to page, pass the response's next_cursor back as cursor (has_more signals whether more pages remain).

    Inputs: to, from, page, order, cursor, per_page

  • List Tags

    List all Tags in the account. Each tag = {id, name, color (hex), description}. Paginated via page/per_page; to page, pass the response's next_cursor back as cursor (has_more signals whether more pages remain).

    Inputs: page, cursor, per_page

  • List Teams

    List all Teams in the account. Each team embeds its member users (nested user objects). Paginated via page/per_page; to page, pass the response's next_cursor back as cursor (has_more signals whether more pages remain).

    Inputs: page, order, cursor, per_page

  • List User Numbers (V2)

    List all Aircall Numbers assigned to a specific User (V2, paginated). Returns one page plus a next_cursor to fetch the next. The number ids feed AIRCALL_START_OUTBOUND_CALL. Targets the /v2 API.

    Inputs: id, page, order, cursor, per_page

  • List Users

    List the users in the Aircall account, one page at a time with a next_cursor to continue. Use when you need user ids, names, emails, availability or default_number_id; not for a single known user (AIRCALL_GET_USER), and not for the phone numbers a user can call from (AIRCALL_LIST_USER_NUMBERS).

    Inputs: to, from, page, order, cursor, per_page

  • List Users Availability

    List the detailed availability of all Users (whether each user is available/offline/on a call, etc.). Paginated via page/per_page; to page, pass the response's next_cursor back as cursor (has_more signals whether more pages remain).

    Inputs: to, from, page, order, cursor, per_page

  • List Webhooks

    List one page of webhook subscriptions, with OAuth limited to the webhook linked to the token and Basic Auth accessing dashboard- and Basic Auth-created webhooks. Pass a non-null next_cursor to retrieve the next page and discover webhook UUIDs.

    Inputs: page, order, cursor, per_page

  • Publish Call Insight Card

    Display contextual title, short text, links, or Aircall user details to the agent handling an ongoing call. Cards are ephemeral: only ongoing calls show them and Aircall does not store them after the call. The JSON payload must be strictly less than 10KB.

    Inputs: id, contents

  • Remove User from Team

    Remove a User from a Team (membership change). Returns the updated team when Aircall sends HTTP 200, or a success confirmation for an empty HTTP 204. Does not delete the user.

    Inputs: team_id, user_id

  • Search Calls

    Search calls by direction, user, phone number or tag IDs, optionally narrowed by a date window; at least one of those filters is required. For transferred calls, phone-number filtering matches the destination rather than the original number.

    Inputs: to, from, page, tags, order, cursor, user_id, per_page, direction, phone_number, fetch_contact, fetch_aiva_conv, fetch_short_urls, fetch_call_timeline

  • Search Contacts

    Search shared Contacts by phone number and/or email, optionally within a date window; third-party integration contacts are inaccessible and pagination retrieves up to 10,000 contacts. Pass next_cursor as cursor while has_more is true; contact timestamps are UNIX-epoch integers.

    Inputs: to, from, page, email, order, cursor, order_by, per_page, phone_number

  • Set Call Recording State

    Pause or resume recording on an ongoing Aircall call. This is destructive: audio from a paused interval is never recorded and cannot be recovered by resuming later. The call must still be live and live recording must be enabled on its Aircall number.

    Inputs: id, state

  • Start Outbound Call

    Place a real, billable outbound phone call from an Aircall user's desktop Workspace to an external number. Use when a specific user should dial someone now. Requires the user's desktop Workspace app to be open, the user to be available, and a number_id the user owns, from AIRCALL_LIST_USER_NUMBERS. Returns acceptance only. No call id comes back and the call may still fail to connect; locate it afterwards with AIRCALL_SEARCH_CALLS. Calling again places a second call.

    Inputs: id, to, number_id

  • Tag Call

    Tag a Call with one or more existing Tag ids (create tags first with AIRCALL_CREATE_TAG). Returns success on HTTP 201.

    Inputs: id, tags

  • Transfer Call

    Cold-transfer a live call to one user, team, or external phone number, with an optional team dispatching strategy; external-number transfers work only for unanswered inbound calls. A successful request indicates acceptance, but the transfer may fail to connect.

    Inputs: id, number, team_id, user_id, dispatching_strategy

  • Update Contact

    Update a Contact's core fields (first_name, last_name, company_name, information). Phone numbers and emails are edited via the dedicated contact-method tools (AIRCALL_ADD_CONTACT_METHOD / AIRCALL_UPDATE_CONTACT_METHOD / AIRCALL_DELETE_CONTACT_METHOD), not here.

    Inputs: id, last_name, first_name, information, company_name

  • Update Contact Method

    Update one phone number or email address that is already on an Aircall contact. Set method_type='phone' or method_type='email' to say which kind method_id refers to, and always send a nonblank value — Aircall requires it on every update even when only the label changes. Use when changing a method that already exists; not for adding a new one (AIRCALL_ADD_CONTACT_METHOD), and not for removing one (AIRCALL_DELETE_CONTACT_METHOD). Answers HTTP 202 Accepted and returns the updated method as 'contact_method'.

    Inputs: label, value, method_id, contact_id, method_type

  • Update Number

    Update an Aircall Number's name, availability status, recording, routing priority, or Music & Messages URLs. Changes can affect live call routing, recording and caller audio; previous values are not automatically restored, and Aircall does not document whether omitted fields or message slots are preserved.

    Inputs: id, name, messages, priority, availability_status, live_recording_activated

  • Update Tag

    Update a Tag's name and color by id. Both fields are required by this tool, and the name must remain unique.

    Inputs: id, name, color

  • Update User

    Update an existing Aircall user's name, availability_status, substatus, roles or wrap-up time in place. Use when changing a user who already exists; not for creating one (AIRCALL_CREATE_USER), and not for reading their current availability (AIRCALL_GET_USER_AVAILABILITY). substatus applies only when availability_status is 'unavailable'.

    Inputs: id, role_ids, last_name, substatus, first_name, wrap_up_time, availability_status

  • Update Webhook

    Update an accessible Aircall webhook's URL, name, active state, or event subscriptions, using preserve, replace, add, remove, or all modes; preserve is the default. OAuth access is limited to the webhook linked to the token, while Basic Auth accesses dashboard- and Basic Auth-created webhooks.

    Inputs: url, active, events, webhook_id, custom_name, event_update_mode