# Aircall

### Snapshot

| Features                        | Details                                  |
| ------------------------------- | ---------------------------------------- |
| Release Status                  | Released                                 |
| Source API Version              | v2                                       |
| Table Selection                 | Yes                                      |
| Column Selection                | Yes                                      |
| Edit Integration                | Yes                                      |
| Replication Type Selection      | No                                       |
| Authentication Parameters       | <p>Aircall Email<br>Aircall password</p> |
| Replication Type                | Key based Replication                    |
| Replication Key                 | DATE                                     |
| Suggested Replication Frequency | 24 hrs                                   |

| Tables/APIs Supported |       |
| --------------------- | ----- |
| Users                 | Tags  |
| Numbers               | Teams |
| Contacts              | Calls |

CompanyInfo

### Integrate Aircall with Daton

1. Signin to Daton
2. Select Aircall from Integrations page
3. Provide Integration Name Replication Frequency and History. Integration name would be used in creating tables for the integration and cannot be changed later
4. Provide your Aircall account Email and Password and provide your store URL
5. After providing the Email,password authorize Daton to periodically extract data from Aircall.
6. Post successful authentication you will be prompted to choose from the list of available tables
7. Then select all required fields for each table
8. Submit the integration.

### Workflow

1. Integrations would be in Pending state initially and will be moved to Active state as soon as the first job loads data successfully on to the configured warehouse
2. Users would be able to edit/pause/re-activate/delete integration anytime
3. Users can view job status and process logs from the integration details page by clicking on the integration name from the active list

### Aircall Data

**Users**

Purpose: Fetch all Users associated to a Company and their information.

Source API Documentation  <https://developer.aircall.io/api-references/#list-all-users>

Replication: Key-Based Replication

Replication Key: lastRunDate

**Fields**

| Name                 | Target Datatype |
| -------------------- | --------------- |
| id                   | NUMERIC         |
| direct\_link         | STRING          |
| name                 | STRING          |
| email                | STRING          |
| available            | BOOLEAN         |
| availability\_status | STRING          |
| created\_at          | TIMESTAMP       |
| time\_zone           | STRING          |
| language             | STRING          |

**Tags**

Purpose: Fetch all Tags associated to a company and their information.

Source API Documentation <https://developer.aircall.io/api-references/#list-all-tags>

Replication: Full Replication

Replication Key: NA

**Fields**

| Name        | Target Datatype |
| ----------- | --------------- |
| id          | NUMERIC         |
| name        | STRING          |
| color       | STRING          |
| description | STRING          |

**Numbers**

Purpose: Fetch all Numbers associated to a company and their information.

Source API Documentation  <https://developer.aircall.io/api-references/#list-all-numbers>

Replication: Key-Based Replication

Replication Key: lastRunDate

**Fields**

| Name                       | Target Datatype |
| -------------------------- | --------------- |
| id                         | NUMERIC         |
| direct\_link               | STRING          |
| name                       | STRING          |
| digits                     | STRING          |
| created\_at                | TIMESTAMP       |
| country                    | STRING          |
| time\_zone                 | STRING          |
| open                       | BOOLEAN         |
| availability\_status       | STRING          |
| is\_ivr                    | BOOLEAN         |
| live\_recording\_activated | BOOLEAN         |
| messages                   | RECORD          |
| users                      | RECORD          |

**Teams**

Purpose: Fetch all Teams associated to a company and their information.

Source API Documentation  <https://developer.aircall.io/api-references/#list-all-teams>

Replication: Full Replication

Replication Key: NA

**Fields**

| Name         | Target Datatype |
| ------------ | --------------- |
| id           | NUMERIC         |
| name         | STRING          |
| direct\_link | STRING          |
| created\_at  | TIMESTAMP       |
| users        | RECORD          |

**Contacts**

Purpose:Fetch all the shared Contacts associated to a company with their phone numbers and emails information.

Source API Documentation <https://developer.aircall.io/api-references/#list-all-contacts>

Replication: Key-Based Replication

Replication Key: lastRunDate

**Fields**

| Name           | Target Datatype |
| -------------- | --------------- |
| id             | NUMERIC         |
| direct\_link   | STRING          |
| first\_name    | STRING          |
| last\_name     | STRING          |
| company\_name  | STRING          |
| information    | STRING          |
| is\_shared     | BOOLEAN         |
| created\_at    | TIMESTAMP       |
| updated\_at    | TIMESTAMP       |
| emails         | STRING          |
| phone\_numbers | RECORD          |

**Calls**

Purpose: Fetch all Calls associated to a company and their information.

Source API Documentation  <https://developer.aircall.io/api-references/#list-all-calls>

Replication: Key-Based Replication

Replication Key: lastRunDate

**Fields**

| Name                 | Target Datatype |
| -------------------- | --------------- |
| id                   | NUMERIC         |
| direct\_link         | STRING          |
| direction            | STRING          |
| status               | STRING          |
| missed\_call\_reason | STRING          |
| started\_at          | TIMESTAMP       |
| answered\_at         | TIMESTAMP       |
| ended\_at            | TIMESTAMP       |
| duration             | NUMERIC         |
| voicemail            | STRING          |
| recording            | STRING          |
| asset                | STRING          |
| raw\_digits          | STRING          |
| user                 | RECORD          |
| contact              | STRING          |
| archived             | BOOLEAN         |
| assigned\_to         | STRING          |
| transferred\_to      | STRING          |
| cost                 | STRING          |
| number               | RECORD          |
| comments             | RECORD          |
| tags                 | RECORD          |
| teams                | STRING          |

**CompanyInfo**

Purpose: Company information can be retrieve with this GET request.

Source API Documentation  <https://developer.aircall.io/api-references/#retrieve-company-information>

Replication: Full Replication

Replication Key: NA

**Fields**

| Name           | Target Datatype |
| -------------- | --------------- |
| name           | STRING          |
| users\_count   | NUMERIC         |
| numbers\_count | NUMERIC         |
