Skip to main content
Aircall logo
  • Category: communication
  • Auth: OAUTH2, BASIC
  • Composio-managed OAuth available? Yes
  • Tools: 48
  • Triggers: 0
  • Slug: AIRCALL
  • Version: 20261101_00

Tools

Slug: AIRCALL_ADD_CONTACT_METHODAdd 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.

Input Parameters

string
Optional label for the method. For a phone: ‘Work’, ‘Mobile’, ‘Home’. For an email: ‘Work’, ‘Personal’. If omitted, Aircall defaults the label to ‘Main’.
string
required
Nonblank phone number or email value. Aircall accepts and normalizes multiple phone formats and stores any email format.
integer
required
Numeric id of the contact to add the method to.
string ("email" | "phone")
required
Which kind of contact method to add: ‘phone’ for a phone number, ‘email’ for an email address. This selects the Aircall endpoint.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AIRCALL_ADD_USER_TO_TEAMAdd a User to a Team (membership change). Returns the updated team.

Input Parameters

integer
required
Team numeric id.
integer
required
Numeric id of the user to add to the team.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AIRCALL_COMMENT_CALLAdd 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.

Input Parameters

integer
required
Numeric id of the call to comment on.
string
required
Comment text to attach to the call (emojis are stripped by Aircall).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AIRCALL_CREATE_CONTACTCreate 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.

Input Parameters

array
Optional email addresses to attach, each {label, value}; at most 20. Emails alone are not sufficient — phone_numbers is still required.
string
Contact last name.
string
Contact first name.
string
Free-text note about the contact.
string
Company name.
array
required
Required. Phone numbers to attach, each with nonblank {label, value}; 1-20 entries. Aircall rejects a create with no phone_numbers (HTTP 400) even when emails are supplied.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AIRCALL_CREATE_TAGCreate a Tag. name must be unique per company; color is a hex string (e.g. #00B388). Aircall does not accept a mutable description field.

Input Parameters

string
required
Tag name (unique per company).
string
required
Tag color as a hex string, e.g. ‘#00B388’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AIRCALL_CREATE_TEAMCreate a new Team. Requires a name.

Input Parameters

string
required
Unique nonblank team name, fewer than 64 characters.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AIRCALL_CREATE_USERCreate 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.

Input Parameters

string
required
Email address for the new user; the invite email is sent here.
array
Optional roles to assign to the new user. Aircall documents this as an array of role NAME strings, not numeric ids: owner, supervisor, admin, or agent. Omit to let Aircall apply its documented default of agent.
string
required
The new user’s nonblank last name.
string
required
The new user’s nonblank first name.
integer
Optional number of seconds of wrap-up time after a call. Aircall documents a default of 0 seconds, and that this applies only to a user whose role_ids include agent.
integer
Optional id of the existing user recorded as having invited this one. On V2, this value is ignored when the inviter is not an admin.
string ("available" | "custom" | "unavailable")
Optional starting availability for the new user: available, custom, or unavailable. Omit to let Aircall apply its documented default of available.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AIRCALL_CREATE_WEBHOOKCreate 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.

Input Parameters

string
required
Public HTTPS endpoint that will receive Aircall events.
array
Events from Aircall’s documented webhook event set. Required unless subscribe_to_all_events=true.
string
Optional webhook display name.
boolean
Set true only when intentionally subscribing to every Aircall event. Aircall represents this on the wire as an empty events array.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AIRCALL_DELETE_CALL_MEDIARequest 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.

Input Parameters

integer
required
Numeric id of the call whose media to delete.
string ("recording" | "voicemail")
required
Which media artefact to remove: ‘recording’ for the call’s audio recording, or ‘voicemail’ for the voicemail message left on it. A call may have one, both, or neither. Recording deletion also permanently removes transcription and AI insights on AI Assist/Pro accounts.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AIRCALL_DELETE_CONTACTPermanently delete a shared contact by ID, including its phone numbers and email addresses. The tool returns a success confirmation when deletion succeeds.

Input Parameters

integer
required
Contact numeric id to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AIRCALL_DELETE_CONTACT_METHODPermanently 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.

Input Parameters

integer
required
Id of the phone or email entry to remove. Get it from the contact’s phone_numbers[] / emails[] via AIRCALL_GET_CONTACT, or from the id returned by AIRCALL_ADD_CONTACT_METHOD.
integer
required
Numeric id of the contact that owns the method.
string ("email" | "phone")
required
Which kind of contact method method_id refers to: ‘phone’ for a phone number, ‘email’ for an email address. This selects the Aircall endpoint, so it must match the id — a phone id with method_type=‘email’ will 404.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AIRCALL_DELETE_TAGDelete a Tag by id, removing it from Calls. The tool returns a success confirmation.

Input Parameters

integer
required
Tag numeric id to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AIRCALL_DELETE_TEAMDelete a Team by id, removing it from Numbers’ call distribution without deleting its users. The tool returns a success confirmation.

Input Parameters

integer
required
Team numeric id to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AIRCALL_DELETE_USERPermanently 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.

Input Parameters

integer
required
Numeric id of the user to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AIRCALL_DELETE_WEBHOOKPermanently 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.

Input Parameters

string
required
UUID of the webhook to delete, or its legacy numeric Aircall id.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AIRCALL_GET_CALLRetrieve a single Call by id, with optional contact / short-url / timeline enrichment via the fetch_* flags.

Input Parameters

integer
required
Call numeric id.
boolean
Include the matched contact object.
boolean
Include AI Voice Agent segments in call.ai_voice_agents.
boolean
Include shortened asset URLs.
boolean
Include the per-call event timeline.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AIRCALL_GET_COMPANYRetrieve 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.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AIRCALL_GET_CONTACTRetrieve a single shared Contact by id, with its nested phone_numbers[] and emails[]. NOTE: contact created_at/updated_at are UNIX-epoch INTEGERS.

Input Parameters

integer
required
Contact numeric id.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AIRCALL_GET_NUMBERRetrieve a single Aircall phone Number by its numeric id.

Input Parameters

integer
required
Numeric id of the Aircall number to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AIRCALL_GET_NUMBER_REGISTRATION_STATUSCheck 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).

Input Parameters

integer
required
Numeric id of the Aircall number whose registration status to fetch.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AIRCALL_GET_TAGRetrieve a single Tag by id.

Input Parameters

integer
required
Tag numeric id.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AIRCALL_GET_TEAMRetrieve a single Team by id, including its member users.

Input Parameters

integer
required
Team numeric id.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AIRCALL_GET_USERRetrieve 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.

Input Parameters

string
required
User numeric id OR email address — both are accepted in the path. The numeric id may be passed as an int (as returned by AIRCALL_LIST_USERS) or a string.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AIRCALL_GET_USER_AVAILABILITYCheck the current availability of one User. Returns availability ∈ available | offline | do_not_disturb | in_call | after_call_work.

Input Parameters

integer
required
User numeric id whose availability to check.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AIRCALL_GET_WEBHOOKRetrieve 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.

Input Parameters

string
required
Webhook UUID returned by LIST_WEBHOOKS or CREATE_WEBHOOK, or the legacy numeric webhook id that Aircall still accepts.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AIRCALL_LIST_CALLSList 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.

Input Parameters

integer
Only calls created at/before this UNIX timestamp (seconds).
integer
Only calls created at/after this UNIX timestamp (seconds). Use to page past the 10,000-item cap.
integer
1-based page number.
string ("asc" | "desc")
Sort by created_at: ‘asc’ (default) or ‘desc’.
string
Continuation cursor from a prior response’s next_cursor. Omit for the first page.
integer
Items per page (1-50; Mercury default 10).
boolean
Include the matched contact object on each call.
boolean
Include AI Voice Agent segments in each call.
boolean
Include shortened asset URLs.
boolean
Include the per-call event timeline.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AIRCALL_LIST_CONTACTSList 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.

Input Parameters

integer
Only contacts created at/before this UNIX timestamp (seconds).
integer
Only contacts created at/after this UNIX timestamp (seconds).
integer
1-based page number to fetch (default 1).
string ("asc" | "desc")
Sort order: ‘asc’ (default) or ‘desc’.
string
Continuation cursor from a prior response’s next_cursor. Omit for the first page.
string ("created_at" | "updated_at")
Field to sort by: ‘created_at’ (default) or ‘updated_at’.
integer
Items per page (1-50; Mercury default 10).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AIRCALL_LIST_NUMBERSList 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).

Input Parameters

integer
Only numbers created at/before this UNIX timestamp (seconds).
integer
Only numbers created at/after this UNIX timestamp (seconds).
integer
1-based page number to fetch (default 1).
string ("asc" | "desc")
Sort by created_at: ‘asc’ or ‘desc’.
string
Continuation cursor from a prior response’s next_cursor. Omit for the first page.
integer
Items per page (1-50; Mercury default 10).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AIRCALL_LIST_TAGSList 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).

Input Parameters

integer
1-based page number to fetch (default 1).
string
Continuation cursor from a prior response’s next_cursor. Omit for the first page.
integer
Items per page (1-50; Mercury default 10).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AIRCALL_LIST_TEAMSList 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).

Input Parameters

integer
1-based page number to fetch (default 1).
string ("asc" | "desc")
Sort by created_at: ‘asc’ or ‘desc’.
string
Continuation cursor from a prior response’s next_cursor. Omit for the first page.
integer
Items per page (1-50; Mercury default 10).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AIRCALL_LIST_USER_NUMBERSList 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.

Input Parameters

integer
required
Numeric id of the user whose numbers to list — pass the int as returned by AIRCALL_LIST_USERS (a numeric string is also accepted).
integer
1-based page number for the first request.
string ("asc" | "desc")
Sort by created_at: ‘asc’ or ‘desc’.
string
Opaque pagination cursor from a prior response’s next_cursor. Omit for the first page.
integer
Items per page (1-50; Mercury default 10).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AIRCALL_LIST_USERSList 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).

Input Parameters

integer
Only return users created at/before this UNIX timestamp (seconds). The legacy name created_before is still accepted.
integer
Only return users created at/after this UNIX timestamp (seconds). Sent as the from query param. The legacy name created_after is still accepted.
integer
1-based page number for the first request.
string ("asc" | "desc")
Sort by created_at: ‘asc’ (default) or ‘desc’.
string
Continuation cursor from a previous response’s next_cursor. Omit for the first page; pass the returned value back verbatim to fetch the next page.
integer
Number of users per page (1-50; Mercury default 10).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AIRCALL_LIST_USERS_AVAILABILITYList 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).

Input Parameters

integer
Only include users created at/before this UNIX timestamp (seconds).
integer
Only include users created at/after this UNIX timestamp (seconds).
integer
1-based page number to fetch (default 1).
string ("asc" | "desc")
Sort by created_at: ‘asc’ or ‘desc’.
string
Continuation cursor from a prior response’s next_cursor. Omit for the first page.
integer
Items per page (1-50; Mercury default 10).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AIRCALL_LIST_WEBHOOKSList 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.

Input Parameters

integer
1-based page number.
string ("asc" | "desc")
Order by created_at: ‘asc’ or ‘desc’.
string
Continuation cursor from next_cursor. Omit for the first page.
integer
Items per page (1-50, default 10).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AIRCALL_PUBLISH_CALL_INSIGHT_CARDDisplay 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.

Input Parameters

integer
required
Numeric ID of the ongoing Aircall call.
array
required
Lines displayed to the agent: title, shortText, and/or user entries.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AIRCALL_REMOVE_USER_FROM_TEAMRemove 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.

Input Parameters

integer
required
Team numeric id.
integer
required
Numeric id of the user to remove from the team.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AIRCALL_SEARCH_CALLSSearch 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.

Input Parameters

integer
Only calls created at/before this UNIX timestamp (seconds).
integer
Only calls created at/after this UNIX timestamp (seconds).
integer
1-based page number.
array
Tag ids to filter by, AND-matched (serialized as repeated ?tags= params).
string ("asc" | "desc")
Sort by created_at: ‘asc’ or ‘desc’.
string
Continuation cursor from a prior response’s next_cursor. Omit for the first page.
integer
Filter by the id of the user who handled the call.
integer
Items per page (1-50; Mercury default 10).
string ("inbound" | "outbound")
Filter by call direction: ‘inbound’ or ‘outbound’.
string
Filter by external phone number.
boolean
Include the matched contact object on each call.
boolean
Include AI Voice Agent segments in each call.
boolean
Include shortened asset URLs.
boolean
Include the per-call event timeline.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AIRCALL_SEARCH_CONTACTSSearch 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.

Input Parameters

integer
Only contacts created at/before this UNIX timestamp (seconds).
integer
Only contacts created at/after this UNIX timestamp (seconds).
integer
1-based page number to fetch (default 1).
string
Email address to match.
string ("asc" | "desc")
Sort order: ‘asc’ or ‘desc’.
string
Continuation cursor from a prior response’s next_cursor. Omit for the first page.
string ("created_at" | "updated_at")
Field to sort by: ‘created_at’ or ‘updated_at’.
integer
Items per page (1-50; Mercury default 10).
string
Phone number to match (E.164).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AIRCALL_SET_CALL_RECORDING_STATEPause 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.

Input Parameters

integer
required
Numeric ID of an ongoing Aircall call.
string ("paused" | "recording")
required
Desired live-recording state: paused or recording (resumed).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AIRCALL_START_OUTBOUND_CALLPlace 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.

Input Parameters

integer
required
Id of the user who will place the call.
string
required
Destination phone number in E.164 format (e.g. +14155550123).
integer
required
Id of the Aircall number to call from (must belong to the user).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AIRCALL_TAG_CALLTag a Call with one or more existing Tag ids (create tags first with AIRCALL_CREATE_TAG). Returns success on HTTP 201.

Input Parameters

integer
required
Numeric id of the call to tag.
array
required
Array of EXISTING Tag ids to apply to the call. Get/create tag ids via AIRCALL_LIST_TAGS / AIRCALL_CREATE_TAG.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AIRCALL_TRANSFER_CALLCold-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.

Input Parameters

integer
required
Numeric id of the live (in-progress) call to transfer.
string
External phone number to transfer an unanswered inbound call to, in E.164 format. Supply exactly one of user_id, team_id, or number.
integer
Id of the Aircall team to transfer the call to. Supply exactly one of user_id, team_id, or number.
integer
Id of the Aircall user to transfer the call to. Supply exactly one of user_id, team_id, or number.
string ("random" | "simultaneous" | "longest_idle")
Team-only dispatching strategy. Defaults to ‘simultaneous’ when team_id is selected.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AIRCALL_UPDATE_CONTACTUpdate 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.

Input Parameters

integer
required
Contact numeric id to update.
string
New last name.
string
New first name.
string
New free-text note.
string
New company name.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AIRCALL_UPDATE_CONTACT_METHODUpdate 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’.

Input Parameters

string
New label for the method, e.g. ‘Work’, ‘Mobile’, ‘Personal’. Omit to leave the label unchanged.
string
required
The nonblank phone number or email value. Aircall does not require E.164 or strict email syntax. REQUIRED on every update — Aircall rejects an update that omits it, even when only the label is changing, so re-send the current value if you are not changing it.
integer
required
Id of the phone or email entry to update. Get it from the id returned by AIRCALL_ADD_CONTACT_METHOD, or from the contact’s phone_numbers[] / emails[] via AIRCALL_GET_CONTACT.
integer
required
Numeric id of the contact that owns the method.
string ("email" | "phone")
required
Which kind of contact method method_id refers to: ‘phone’ for a phone number, ‘email’ for an email address. This selects the Aircall endpoint, so it must match the id — a phone id with method_type=‘email’ will 404.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AIRCALL_UPDATE_NUMBERUpdate 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.

Input Parameters

integer
required
Numeric id of the Aircall number to update.
string
New display name for the number.
object
Documented Music & Messages slots: welcome, waiting, ivr, voicemail, closed, callback_later, unanswered_call, after_hours, and ringing_tone. Each supplied value must be a valid public HTTP(S) URL. Aircall does not document whether a partially-supplied body preserves unlisted slots, so capture the current values with AIRCALL_GET_NUMBER first if you need to revert.
integer ("0" | "1")
Routing priority: 0 for no priority, 1 for top priority, or null to clear it.
string ("open" | "custom" | "closed")
Update the first Time Rule widget’s availability status.
boolean
Enable or disable inbound and outbound call recording for this number.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AIRCALL_UPDATE_TAGUpdate a Tag’s name and color by id. Both fields are required by this tool, and the name must remain unique.

Input Parameters

integer
required
Tag numeric id to update.
string
required
Tag name (unique per company).
string
required
Tag color as a hex string, e.g. ‘#00B388’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AIRCALL_UPDATE_USERUpdate 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’.

Input Parameters

integer
required
Numeric id of the user to update.
array
Roles to assign to the user. Aircall documents this as an array of role NAME strings, not numeric ids: owner, supervisor, admin, or agent.
string
New last name.
string ("out_for_lunch" | "on_a_break" | "in_training" | "doing_back_office" | "other")
New availability sub-status. Aircall documents these values as applying when availability_status is ‘unavailable’, so this is rejected if the same request explicitly sets availability_status to ‘available’ or ‘custom’. Sending substatus without availability_status is allowed — the user may already be unavailable server-side.
string
New first name.
integer
Post-call wrap-up time in seconds.
string ("available" | "custom" | "unavailable")
New availability status: one of available | custom | unavailable.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AIRCALL_UPDATE_WEBHOOKUpdate 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.

Input Parameters

string
New public HTTPS destination URL.
boolean
True to reactivate the webhook or false to disable it.
array
Event names used by replace/add/remove mode. Omit in preserve/all mode.
string
required
UUID of the webhook to update, or its legacy numeric Aircall id.
string
New webhook display name.
string ("preserve" | "replace" | "add" | "remove" | "all")
Explicit event-set intent: preserve leaves events unchanged; replace sets exactly events; add/remove modifies named events; all intentionally subscribes to every event.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not