Integrate the Aircall cloud phone system into the workflow. Start a call from a rep's Aircall app, transfer live calls, add notes and tags, search call history, manage shared contacts, list users and numbers, and read AI transcripts, summaries, and sentiment. Can also run workflows on Aircall call, contact, user, and AI events. Requires an Aircall API ID and API token.
Start a call from a user's Aircall Workspace (desktop app) to a phone number, using one of the user's Aircall numbers. The user must be available, not on a call, and assigned to the number.
| Parameter | Type | Required | Description |
|---|
apiId | string | Yes | Aircall API ID (the Basic auth username), from Company Settings > API Keys |
apiToken | string | Yes | Aircall API token (the Basic auth password), from Company Settings > API Keys |
userId | string | Yes | ID of the Aircall user whose Workspace places the call |
numberId | string | Yes | ID of the Aircall number to call from. The user must be assigned to it. |
to | string | Yes | Phone number to dial, in E.164 format (e.g. +18001231234) |
| Parameter | Type | Description |
|---|
started | boolean | Whether Aircall accepted the call; it now rings in the user's Workspace |
userId | string | User whose Workspace places the call |
numberId | string | Aircall number the call is placed from |
to | string | Number being dialed |
Cold-transfer an ongoing call to one user, one team, or one external number. External transfers only work for inbound calls that have not been answered yet.
| Parameter | Type | Required | Description |
|---|
apiId | string | Yes | Aircall API ID (the Basic auth username), from Company Settings > API Keys |
apiToken | string | Yes | Aircall API token (the Basic auth password), from Company Settings > API Keys |
callId | string | Yes | Aircall Call ID |
userId | string | No | ID of the user to transfer to. Set only one of userId, teamId, or number. |
teamId | string | No | ID of the team to transfer to. Set only one of userId, teamId, or number. |
number | string | No | External number to transfer to, in E.164 format. Set only one of userId, teamId, or number. |
dispatchingStrategy | string | No | For team transfers only: "simultaneous" (default), "random", or "longest_idle" |
| Parameter | Type | Description |
|---|
transferred | boolean | Whether Aircall accepted the transfer. A failed transfer later sends a call.unsuccessful_transfer webhook event. |
callId | string | The transferred call |
Get one call with its direction, status, duration, external number, user, recording, voicemail, comments, and tags.
| Parameter | Type | Required | Description |
|---|
apiId | string | Yes | Aircall API ID (the Basic auth username), from Company Settings > API Keys |
apiToken | string | Yes | Aircall API token (the Basic auth password), from Company Settings > API Keys |
callId | string | Yes | Aircall Call ID |
fetchContact | boolean | No | Include the contact attached to the call |
| Parameter | Type | Description |
|---|
call | object | The call |
List calls in the Aircall account, optionally within a creation-date window. Only the last six months are available.
| Parameter | Type | Required | Description |
|---|
apiId | string | Yes | Aircall API ID (the Basic auth username), from Company Settings > API Keys |
apiToken | string | Yes | Aircall API token (the Basic auth password), from Company Settings > API Keys |
createdAfter | string | No | Only return items created at or after this time, as a UNIX timestamp in seconds or an ISO 8601 date |
createdBefore | string | No | Only return items created at or before this time, as a UNIX timestamp in seconds or an ISO 8601 date |
order | string | No | Sort by creation date: "asc" (default) or "desc" for newest first |
page | number | No | Page number, starting at 1 |
perPage | number | No | Results per page, 1 to 50 (default 20) |
fetchContact | boolean | No | Include the contact attached to each call |
| Parameter | Type | Description |
|---|
calls | array | Calls in this page |
Search calls by external phone number, user, direction, or creation date. Only the last six months are available.
| Parameter | Type | Required | Description |
|---|
apiId | string | Yes | Aircall API ID (the Basic auth username), from Company Settings > API Keys |
apiToken | string | Yes | Aircall API token (the Basic auth password), from Company Settings > API Keys |
phoneNumber | string | No | Calling or receiving phone number, ideally in E.164 format |
userId | string | No | ID of the Aircall user who made or received the calls |
direction | string | No | "inbound" or "outbound" |
createdAfter | string | No | Only return items created at or after this time, as a UNIX timestamp in seconds or an ISO 8601 date |
createdBefore | string | No | Only return items created at or before this time, as a UNIX timestamp in seconds or an ISO 8601 date |
order | string | No | Sort by creation date: "asc" (default) or "desc" for newest first |
page | number | No | Page number, starting at 1 |
perPage | number | No | Results per page, 1 to 50 (default 20) |
fetchContact | boolean | No | Include the contact attached to each call |
| Parameter | Type | Description |
|---|
calls | array | Matching calls in this page |
Add a note to a call. A call holds at most five notes, and notes cannot be edited or deleted afterwards. Emojis are removed.
| Parameter | Type | Required | Description |
|---|
apiId | string | Yes | Aircall API ID (the Basic auth username), from Company Settings > API Keys |
apiToken | string | Yes | Aircall API token (the Basic auth password), from Company Settings > API Keys |
callId | string | Yes | Aircall Call ID |
content | string | Yes | Text of the note |
| Parameter | Type | Description |
|---|
commented | boolean | Whether the note was added |
callId | string | The commented call |
Tag a call with one or more existing tags by ID. Tags are created by admins in the Aircall Dashboard.
| Parameter | Type | Required | Description |
|---|
apiId | string | Yes | Aircall API ID (the Basic auth username), from Company Settings > API Keys |
apiToken | string | Yes | Aircall API token (the Basic auth password), from Company Settings > API Keys |
callId | string | Yes | Aircall Call ID |
tagIds | string | Yes | Tag IDs to add, comma-separated (e.g. "545, 546") |
| Parameter | Type | Description |
|---|
tagged | boolean | Whether the tags were added |
callId | string | The tagged call |
tagIds | array | Tag IDs added |
Mark a call as archived. In Aircall Workspace this only sets the archived flag on the call record; it does not close the conversation.
| Parameter | Type | Required | Description |
|---|
apiId | string | Yes | Aircall API ID (the Basic auth username), from Company Settings > API Keys |
apiToken | string | Yes | Aircall API token (the Basic auth password), from Company Settings > API Keys |
callId | string | Yes | Aircall Call ID |
| Parameter | Type | Description |
|---|
call | object | The archived call |
Create a shared contact in Aircall so reps see the caller name and details. Sending the same payload twice creates a duplicate, so search first.
| Parameter | Type | Required | Description |
|---|
apiId | string | Yes | Aircall API ID (the Basic auth username), from Company Settings > API Keys |
apiToken | string | Yes | Aircall API token (the Basic auth password), from Company Settings > API Keys |
firstName | string | No | First name (max 255 characters) |
lastName | string | No | Last name (max 255 characters) |
companyName | string | No | Company name (max 255 characters) |
information | string | No | Extra information, such as an external CRM ID |
phoneNumbers | string | Yes | Phone numbers, comma-separated (labeled "Work"), or a JSON array of {"label", "value"} objects. Up to 20. |
emails | string | No | Email addresses, comma-separated (labeled "Work"), or a JSON array of {"label", "value"} objects. Up to 20. |
| Parameter | Type | Description |
|---|
contact | object | The created contact |
Update a shared contact's name, company, or information. Phone numbers and emails are not changed.
| Parameter | Type | Required | Description |
|---|
apiId | string | Yes | Aircall API ID (the Basic auth username), from Company Settings > API Keys |
apiToken | string | Yes | Aircall API token (the Basic auth password), from Company Settings > API Keys |
contactId | string | Yes | Aircall Contact ID |
firstName | string | No | New first name |
lastName | string | No | New last name |
companyName | string | No | New company name |
information | string | No | New extra information |
| Parameter | Type | Description |
|---|
contact | object | The updated contact |
Get a shared contact with its phone numbers and emails.
| Parameter | Type | Required | Description |
|---|
apiId | string | Yes | Aircall API ID (the Basic auth username), from Company Settings > API Keys |
apiToken | string | Yes | Aircall API token (the Basic auth password), from Company Settings > API Keys |
contactId | string | Yes | Aircall Contact ID |
| Parameter | Type | Description |
|---|
contact | object | The contact |
Find shared contacts by phone number or email. Contacts synced from third-party integrations are not visible to the API.
| Parameter | Type | Required | Description |
|---|
apiId | string | Yes | Aircall API ID (the Basic auth username), from Company Settings > API Keys |
apiToken | string | Yes | Aircall API token (the Basic auth password), from Company Settings > API Keys |
phoneNumber | string | No | Phone number of the contact. Set this, email, or both. |
email | string | No | Email address of the contact. Set this, phone number, or both. |
orderBy | string | No | Sort field: "created_at" (default) or "updated_at" |
createdAfter | string | No | Only return items created at or after this time, as a UNIX timestamp in seconds or an ISO 8601 date |
createdBefore | string | No | Only return items created at or before this time, as a UNIX timestamp in seconds or an ISO 8601 date |
order | string | No | Sort by creation date: "asc" (default) or "desc" for newest first |
page | number | No | Page number, starting at 1 |
perPage | number | No | Results per page, 1 to 50 (default 20) |
| Parameter | Type | Description |
|---|
contacts | array | Matching contacts |
List the users (agents and admins) of the Aircall account with their availability.
| Parameter | Type | Required | Description |
|---|
apiId | string | Yes | Aircall API ID (the Basic auth username), from Company Settings > API Keys |
apiToken | string | Yes | Aircall API token (the Basic auth password), from Company Settings > API Keys |
createdAfter | string | No | Only return items created at or after this time, as a UNIX timestamp in seconds or an ISO 8601 date |
createdBefore | string | No | Only return items created at or before this time, as a UNIX timestamp in seconds or an ISO 8601 date |
order | string | No | Sort by creation date: "asc" (default) or "desc" for newest first |
page | number | No | Page number, starting at 1 |
perPage | number | No | Results per page, 1 to 50 (default 20) |
| Parameter | Type | Description |
|---|
users | array | Users in this page |
Get one Aircall user by ID or email, including availability and default number ID.
| Parameter | Type | Required | Description |
|---|
apiId | string | Yes | Aircall API ID (the Basic auth username), from Company Settings > API Keys |
apiToken | string | Yes | Aircall API token (the Basic auth password), from Company Settings > API Keys |
userId | string | Yes | User ID or the email address of the user |
| Parameter | Type | Description |
|---|
user | object | The user |
List the phone numbers of the Aircall account. Use a number ID to start an outbound call.
| Parameter | Type | Required | Description |
|---|
apiId | string | Yes | Aircall API ID (the Basic auth username), from Company Settings > API Keys |
apiToken | string | Yes | Aircall API token (the Basic auth password), from Company Settings > API Keys |
createdAfter | string | No | Only return items created at or after this time, as a UNIX timestamp in seconds or an ISO 8601 date |
createdBefore | string | No | Only return items created at or before this time, as a UNIX timestamp in seconds or an ISO 8601 date |
order | string | No | Sort by creation date: "asc" (default) or "desc" for newest first |
page | number | No | Page number, starting at 1 |
perPage | number | No | Results per page, 1 to 50 (default 20) |
| Parameter | Type | Description |
|---|
numbers | array | Numbers in this page |
Get the transcript of an ended call or voicemail, split into timed utterances by speaker. Requires the Aircall AI Assist package.
| Parameter | Type | Required | Description |
|---|
apiId | string | Yes | Aircall API ID (the Basic auth username), from Company Settings > API Keys |
apiToken | string | Yes | Aircall API token (the Basic auth password), from Company Settings > API Keys |
callId | string | Yes | Aircall Call ID |
mode | string | No | Transcription mode: "async" or "realtime" (realtime needs AI Assist Pro) |
| Parameter | Type | Description |
|---|
transcription | object | The transcription |
↳ id | number | Transcription ID |
↳ callId | number | Call ID |
↳ callCreatedAt | string | When the call was created (ISO 8601) |
↳ type | string | "call" or "voicemail" |
↳ language | string | Detected language |
↳ utterances | array | Utterances in order |
↳ startTime | number | Start offset in seconds |
↳ endTime | number | End offset in seconds |
↳ text | string | What was said |
↳ participantType | string | "internal" (Aircall user) or "external" |
↳ phoneNumber | string | Number of an external participant |
↳ userId | number | User ID of an internal participant |
transcriptText | string | The utterances joined as "speaker: text" lines, where the speaker is "agent <userId>" or the external phone number |
Get the AI-generated summary of an ended call. Requires the Aircall AI Assist package.
| Parameter | Type | Required | Description |
|---|
apiId | string | Yes | Aircall API ID (the Basic auth username), from Company Settings > API Keys |
apiToken | string | Yes | Aircall API token (the Basic auth password), from Company Settings > API Keys |
callId | string | Yes | Aircall Call ID |
| Parameter | Type | Description |
|---|
summary | object | The call summary |
↳ id | number | Summary ID |
↳ callId | number | Call ID |
↳ createdAt | string | When the summary was created (ISO 8601) |
↳ content | string | Summary text |
Get the AI sentiment of each external participant of an ended call. Requires the Aircall AI Assist package.
| Parameter | Type | Required | Description |
|---|
apiId | string | Yes | Aircall API ID (the Basic auth username), from Company Settings > API Keys |
apiToken | string | Yes | Aircall API token (the Basic auth password), from Company Settings > API Keys |
callId | string | Yes | Aircall Call ID |
| Parameter | Type | Description |
|---|
sentiment | object | The call sentiment |
↳ id | number | Sentiment ID |
↳ callId | number | Call ID |
↳ participants | array | Sentiment per participant |
↳ phoneNumber | string | Participant phone number |
↳ value | string | Sentiment, e.g. POSITIVE |
↳ type | string | Participant type, e.g. external |
A Trigger is a block that starts a workflow when an event happens in this service.
Trigger a workflow on Aircall call, voicemail, contact, user, number, message, and AI events.