> For the complete documentation index, see [llms.txt](https://docs.stackai.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.stackai.com/integrations/catalog/aircall.md).

# Aircall

Connect to Aircall to place calls, create contacts, and add comments or tags to calls.

### Connectors

Choose the connector that matches your authentication method. The options below use the names shown in StackAI.

| Connector | Authentication |
| --------- | -------------- |
| Aircall   | Credentials    |

#### Aircall

Connect to Aircall with an API ID and Token to place calls, create contacts, and add comments or tags to calls.

**Set up in Aircall**

1. Prepare the Aircall account or service that the workflow will access. Grant access to the required resources and operations.
2. **API ID:** Your Aircall API ID from the Aircall dashboard under Integrations & API > API Keys.
3. **API Token:** Your Aircall API Token, generated alongside the API ID in the Aircall dashboard. Treat it as a secret.

**Set up in StackAI**

1. Open **Settings → Connections**, add a connection, and select **Aircall**.
2. Enter the credentials and connection details in the fields below.
3. Save the connection and check its connection status. Select this saved connection when configuring an action or feature that uses it.

**Connection fields**

| StackAI field | Required | What to enter                                                                                                                                                                       |
| ------------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| API ID        | Yes      | Your Aircall API ID from the Aircall dashboard under Integrations & API > API Keys. [Provider instructions](https://dashboard.aircall.io/integrations/api-keys).                    |
| API Token     | Yes      | Your Aircall API Token, generated alongside the API ID in the Aircall dashboard. Treat it as a secret. [Provider instructions](https://dashboard.aircall.io/integrations/api-keys). |

#### Verify the connection

Check that the connection is healthy. Then run a read operation against a resource the connected account can access. A successful connection check confirms authentication; it does not guarantee permission for every action.

If access is denied, check the credential or OAuth permissions, the selected account or environment, and access to the specific resource. Update expired credentials or reconnect after permissions change.

### Use an action

1. Add the required **Aircall** action to the workflow.
2. Select a connection when the action requests one.
3. Complete the required fields. Use the reference picker when a value comes from another workflow step.
4. Run the workflow and inspect the action’s output. Check the result before using it in a later step.

### Actions

#### Place Call

Start an outbound call from an Aircall agent.

**Inputs**

| Field  | Type            | Required | Description                                                                           |
| ------ | --------------- | -------- | ------------------------------------------------------------------------------------- |
| Agent  | select (string) | Yes      | The Aircall agent who will place the call. Options load from the selected connection. |
| Number | select (string) | Yes      | The Aircall number to place the call from. Options load from the selected connection. |
| To     | string          | Yes      | The phone number to dial, in E.164 format.                                            |

**Outputs**

| Field   | Type    | Description                                |
| ------- | ------- | ------------------------------------------ |
| Success | boolean | Whether the call was successfully started. |
| To      | string  | The number that was dialed.                |

#### Add Call Comment

Add a comment to an Aircall call.

**Inputs**

| Field   | Type     | Required | Description                          |
| ------- | -------- | -------- | ------------------------------------ |
| Call ID | string   | Yes      | The id of the call to comment on.    |
| Comment | textarea | Yes      | The comment text to add to the call. |

**Outputs**

| Field   | Type    | Description                               |
| ------- | ------- | ----------------------------------------- |
| Success | boolean | Whether the comment was added.            |
| Call ID | integer | The id of the call that was commented on. |

#### Tag Call

Apply tags to an Aircall call.

**Inputs**

| Field   | Type                      | Required | Description                                                               |
| ------- | ------------------------- | -------- | ------------------------------------------------------------------------- |
| Call ID | string                    | Yes      | The id of the call to tag.                                                |
| Tags    | multiple\_select (string) | Yes      | The tags to apply to the call. Options load from the selected connection. |

**Outputs**

| Field   | Type    | Description                         |
| ------- | ------- | ----------------------------------- |
| Success | boolean | Whether the tags were applied.      |
| Call ID | integer | The id of the call that was tagged. |
| Tag IDs | array   | The tag ids that were applied.      |

#### Create Contact

Create a contact in Aircall.

**Inputs**

| Field        | Type   | Required | Description                                                 |
| ------------ | ------ | -------- | ----------------------------------------------------------- |
| Phone Number | string | Yes      | The contact's phone number (Aircall requires at least one). |
| First Name   | string | No       | The contact's first name.                                   |
| Last Name    | string | No       | The contact's last name.                                    |
| Company      | string | No       | The contact's company name.                                 |
| Email        | string | No       | The contact's email address.                                |
| Information  | string | No       | Free-form information stored on the contact.                |

**Outputs**

| Field      | Type    | Description                    |
| ---------- | ------- | ------------------------------ |
| Contact    | object  | The created Aircall contact.   |
| Contact ID | integer | The id of the created contact. |

### Important behavior

Actions that create, update, send, or delete data can change the connected service. Review their inputs before running them. A retry can repeat an operation; consider this when configuring retries for actions that change data.

The catalog lists the fields and capabilities available in the supplied provider definition. Availability can also depend on your deployment and organization’s Feature Access settings.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.stackai.com/integrations/catalog/aircall.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
