Overview
Configuration is provided for establishing connections with Aircall service. The configuration is used in the REST Connection Manager.
Setup
Press 
icon to get more information about the connection parameters.
Obtain data
Use REST Source component to get data from the service resource.
Insert data
Use REST Destination component to insert data into service resource.
Demonstration
Quick Start
In this task, we will show you step-by-step how to create a connection to Aircall REST API using COZYROC's REST Connection Manager.
Step 1. Run "Visual Studio" under "Administrator account". Right click on Connection managers Tab and Select New Connection. In Add SSIS Connection Manager scroll down and select Connection managers for REST Connection and click Add.
Step 2. From drop-down menu Configuration select Aircall. Then click New in the Token File parameter to create a new token file.
Step 3. In the next wizard click on the Next Button to initiate the Token generation process
Step 4. In the next wizard provide your Email and Password and click on the Sign in Button
Step 5. In the next wizard click on Authorize Button to continue the Token generation process
Step 6. In the next wizard you can either choose the number (1a) and click on Button Add Number (1b) you choose will be shared with COZYROC or you can click on skip for now. Don't worry, you can change this or connect more numbers later in your Aircall Dashboard
Step 7: Save generated access token to file. Specify token protection password. Click OK.
Step 8. Click "Test Connection" to Test your connection.
Congratulations! You have now established a connection to your Aircall instance.
In this guide, we will show how to read data from the Aircall service resource using the COZYROC REST Source component.
Step 1. Select an existing "Data Flow task" or create a new "Data Flow Task".
Step 2. Open "SSIS Toolbox" and drag and drop COZYROC "REST Source" component.
Step 3. Double click on the "REST Source" component and select Aircall connection from the combo. Select from available Aircall resources listed in the second combo below.
Optionally you can include extra parameters in the grid below if needed.
Step 4. Click on the "Columns tab" and select Aircall resource columns you want to read.
Step 5. Click Preview to make sure all necessary resource columns are included.
Bravo! You have now learned how to read data from Aircall service.
In this guide, we will show how to write data to the Aircall service resource using the COZYROC REST Destination component.
Step 1. Select an existing "Data Flow task" or create a new "Data Flow Task".
Step 2. Open the "SSIS Toolbox" and drag and drop COZYROC "REST Destination" component.
Step 3. Double click on the "REST Destination" component and select Aircall connection from the combo. Also, select resource action and Aircall resource you want to work on.
Step 4. Click on the "Mapping" tab and map the input columns for the process you are configuring.
If you want to provide input for other resource composite objects, change the input above and map the columns.
Done. You have now learned how to write data into the Aircall resource.
Configuration
Base URL address: https://api.aircall.io/v1.
- OAuth 2
-
The authentication uses an authorized token.
The authentication has the following user-defined parameters:
- Scope:
The following request parameters will be automatically processed during the authentication process:
-
Authorization:
Bearer {{=token.Access}}
Documentation: https://developer.aircall.io/api-references/#oauth-technology-partners.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/users.
The result is extracted from:{{=response.users}}.Documentation: https://developer.aircall.io/api-references/#list-all-users.
- [Read Single] action
-
Endpoint URL address:
/users/{{=parameters.id}}.
The result is extracted from:{{= [response.user]}}.The action has the following user-defined parameters:
- id: Required. Specify the user_id.
Documentation: https://developer.aircall.io/api-references/#retrieve-a-user.
- [Read team] action (alias: "/teams/{{=parameters.team_id}}")
-
The result is extracted from:{{=response.team.users}}.Documentation: https://developer.aircall.io/api-references/#retrieve-a-team.
- [Create] action
-
Endpoint URL address:
/users.Documentation: https://developer.aircall.io/api-references/#create-a-user.
- [Update] action
-
Endpoint URL address:
/users/{{=item.id}}.Documentation: https://developer.aircall.io/api-references/#update-a-user.
- [Delete] action
-
Endpoint URL address:
/users/{{=item.id}}.Documentation: https://developer.aircall.io/api-references/#delete-a-user.
The resource includes the fields from the generalUserT template.
- first_name
Template: ShortText.
- last_name
Template: ShortText.
- numbers
A read-only field. The value is gathered from
/users/{{=item.id}}address. The gathered value is processed with{{=response.user.numbers}}expression. Field components:- An array.
-
Uses template:
numberT.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/teams.
The result is extracted from:{{=response.teams}}.Documentation: https://developer.aircall.io/api-references/#list-all-teams.
- [Read Single] action
-
Endpoint URL address:
/teams/{{=parameters.id}}.
The result is extracted from:{{= [response.team]}}.The action has the following user-defined parameters:
- id: Required. Specify the team_id.
Documentation: https://developer.aircall.io/api-references/#retrieve-a-team.
- [Create] action
-
Endpoint URL address:
/teams.Documentation: https://developer.aircall.io/api-references/#create-a-team.
- [Delete] action
-
Endpoint URL address:
/teams/{{=item.id}}.Documentation: https://developer.aircall.io/api-references/#delete-a-team.
- id
A key field. Data type: DT_I4
- name
Template: ShortText.
- direct_link
Template: ShortText.
- created_at
Template: DateTime. A read-only field.
- users
Field components:
- An array.
-
Uses template:
userT.
Based on resource template Base.
- [Create] action
-
Endpoint URL address:
/teams/{{=item.id}}/users/{{=item.user_id}}.Documentation: https://developer.aircall.io/api-references/#add-a-user-to-a-team.
- [Delete] action
-
Endpoint URL address:
/teams/{{=item.id}}/users/{{=item.user_id}}.Documentation: https://developer.aircall.io/api-references/#remove-a-user-from-a-team.
- id
A key field. Data type: DT_I4
- user_id
A key field. Data type: DT_I4
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/calls.
The result is extracted from:{{=response.calls}}.Documentation: https://developer.aircall.io/api-references/#list-all-calls.
- [Read Single] action
-
Endpoint URL address:
/calls/{{=parameters.id}}.
The result is extracted from:{{= [response.call]}}.The action has the following user-defined parameters:
- id: Required. Specify the call_id.
Documentation: https://developer.aircall.io/api-references/#retrieve-a-call.
- [Read Search] action
-
Endpoint URL address:
/calls/search.
The result is extracted from:{{= response.calls }}.Documentation: https://developer.aircall.io/api-references/#retrieve-a-call.
- id
Data type: DT_I4
- direct_link
Template: ShortText.
- direction
Template: ShortText.
- status
Template: ShortText.
- missed_call_reason
Template: ShortText.
- started_at
Template: UnixTime.
- answered_at
Template: UnixTime.
- ended_at
Template: UnixTime.
- duration
Data type: DT_I4
- voicemail
Template: ShortText.
- recording
Template: ShortText.
- asset
Template: ShortText.
- raw_digits
Template: ShortText.
- user
Template: generalUserT.
- contact
Template: contactT.
- archived
Data type: DT_BOOL
- assigned_to
Template: ShortText.
- transferred_to
Template: ShortText.
- cost
Data type: DT_R8
- number
Template: numberT.
- comments
Field components:
- An array.
- Contains the following components: id, content, posted_at, posted_by.
- tags
Field components:
- An array.
- Contains the following components: id, name, created_at, tagged_by.
- participants
Template: valueLabelT.
- teams
Template: LongText. A composite field.
Based on resource template Base.
- [Create] action
-
Endpoint URL address:
/calls/{{=item.id}}/transfers.Documentation: https://developer.aircall.io/api-references/#transfer-a-call.
- id
A key field. Data type: DT_I4
- user_id
A key field. Data type: DT_I4
- team_id
A key field. Data type: DT_I4
Based on resource template Base.
- [Create] action
-
Endpoint URL address:
/calls/{{=item.id}}/comments.Documentation: https://developer.aircall.io/api-references/#comment-a-call.
- id
A key field. Data type: DT_I4
- content
Template: ShortText.
Based on resource template Base.
- [Create] action
-
Endpoint URL address:
/calls/{{=item.id}}/tags.Documentation: https://developer.aircall.io/api-references/#tag-a-call.
- id
A key field. Data type: DT_I4
- tags
Template: LongText. A composite field.
Based on resource template Base.
- [Update] action
-
Endpoint URL address:
/calls/{{=item.id}}/archive.Documentation: https://developer.aircall.io/api-references/#archive-a-call.
- id
A key field. Data type: DT_I4
Based on resource template Base.
- [Update] action
-
Endpoint URL address:
/calls/{{=item.id}}/unarchive.Documentation: https://developer.aircall.io/api-references/#unarchive-a-call.
- id
A key field. Data type: DT_I4
Based on resource template Base.
- [Update] action
-
Endpoint URL address:
/calls/{{=item.id}}/pause_recording.Documentation: https://developer.aircall.io/api-references/#pause-recording-on-a-call.
- id
A key field. Data type: DT_I4
Based on resource template Base.
- [Update] action
-
Endpoint URL address:
/calls/{{=item.id}}/resume_recording.Documentation: https://developer.aircall.io/api-references/#resume-recording-on-a-call.
- id
A key field. Data type: DT_I4
Based on resource template Base.
- [Delete] action
-
Endpoint URL address:
/calls/{{=item.id}}/recording.Documentation: https://developer.aircall.io/api-references/#delete-call-recording.
- id
A key field. Data type: DT_I4
Based on resource template Base.
- [Delete] action
-
Endpoint URL address:
/calls/{{=item.id}}/voicemail.Documentation: https://developer.aircall.io/api-references/#delete-call-voicemail.
- id
A key field. Data type: DT_I4
Based on resource template Base.
- [Update] action
-
Endpoint URL address:
/calls/{{=item.id}}/insight_cards.The following request parameters will be automatically processed:
-
application/json:
{{={ contents: item } }}
Documentation: https://developer.aircall.io/api-references/#insight-cards.
-
application/json:
- id
A key field. Data type: DT_I4
- type
Template: ShortText.
- label
Template: ShortText.
- text
Template: ShortText.
- link
Template: ShortText.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/users/{{=parameters.user_id}}/dialer_campaign.The action has the following user-defined parameters:
- user_id: Required. Specify the user_id.
Documentation: https://developer.aircall.io/api-references/#retrieve-a-dialer-campaign.
- [Create] action
-
Endpoint URL address:
/users/{{=item.user_id}}/dialer_campaign.Documentation: https://developer.aircall.io/api-references/#create-a-dialer-campaign.
- [Delete] action
-
Endpoint URL address:
/users/{{=item.user_id}}/dialer_campaign.Documentation: https://developer.aircall.io/api-references/#delete-a-dialer-campaign.
- id
A key field. Data type: DT_I4
- user_id
A key field. Data type: DT_I4
- number_id
Template: ShortText.
- created_at
Template: DateTime. A read-only field.
- phone_numbers
Template: LongText. A composite field.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/users/{{=parameters.user_id}}/dialer_campaign/phone_numbers.
The result is extracted from:{{=response.numbers}}.The action has the following user-defined parameters:
- user_id: Required. Specify the user_id.
Documentation: https://developer.aircall.io/api-references/#retrieve-phone-numbers.
- [Create] action
-
Endpoint URL address:
/users/{{=item.user_id}}/dialer_campaign/phone_numbers.Documentation: https://developer.aircall.io/api-references/#add-phone-numbers.
- [Delete] action
-
Endpoint URL address:
/users/{{=item.user_id}}/dialer_campaign/phone_numbers/{{=item.id}}.Documentation: https://developer.aircall.io/api-references/#delete-a-phone-number.
- id
A key field. Data type: DT_I4
- number
Template: ShortText.
- called
Data type: DT_BOOL
- created_at
Template: DateTime. A read-only field.
- user_id
A key field. Data type: DT_I4
- phone_numbers
Template: LongText. A composite field.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/contacts.
The result is extracted from:{{=response.contacts}}.Documentation: https://developer.aircall.io/api-references/#list-all-contacts.
- [Read Single] action
-
Endpoint URL address:
/contacts/{{=parameters.id}}.
The result is extracted from:{{=[response.contact]}}.The action has the following user-defined parameters:
- id: Required. Specify the contact id.
Documentation: https://developer.aircall.io/api-references/#retrieve-a-contact.
- [Read Search] action
-
Endpoint URL address:
/contacts/search.
The result is extracted from:{{=response.contacts}}.Documentation: https://developer.aircall.io/api-references/#search-contacts.
- [Create] action
-
Endpoint URL address:
/contacts.Documentation: https://developer.aircall.io/api-references/#create-a-contact.
- [Update] action
-
Endpoint URL address:
/contacts/{{=item.id}}.
The action uses POST method.Documentation: https://developer.aircall.io/api-references/#update-a-contact.
- [Delete] action
-
Endpoint URL address:
/contacts/{{=item._id}}.Documentation: https://developer.aircall.io/api-references/#delete-a-contact.
The resource includes the fields from the contactT template.
Based on resource template Base.
- [Create] action
-
Endpoint URL address:
/contacts/{{=item.id}}/phone_details.Documentation: https://developer.aircall.io/api-references/#add-phone-number-to-a-contact.
- [Update] action
-
Endpoint URL address:
/contacts/{{=item.id}}/phone_details/{{=item.phone_number_id}}.Documentation: https://developer.aircall.io/api-references/#update-a-phone-number-from-a-contact.
- [Delete] action
-
Endpoint URL address:
/contacts/{{=item.id}}/phone_details/{{=item.phone_number_id}}.Documentation: https://developer.aircall.io/api-references/#update-a-phone-number-from-a-contact.
- id
A key field. Data type: DT_I4
- phone_number_id
A key field. Data type: DT_I4
- label
Template: ShortText.
- value
Template: ShortText.
Based on resource template Base.
- [Create] action
-
Endpoint URL address:
/contacts/{{=item.id}}/email_details.Documentation: https://developer.aircall.io/api-references/#add-email-to-a-contact.
- [Update] action
-
Endpoint URL address:
/contacts/{{=item.id}}/email_details/{{=item.email_id}}.Documentation: https://developer.aircall.io/api-references/#update-an-email-from-a-contact.
- [Delete] action
-
Endpoint URL address:
/contacts/{{=item.id}}/email_details/{{=item.email_id}}.Documentation: https://developer.aircall.io/api-references/#delete-an-email-form-a-contact.
- id
A key field. Data type: DT_I4
- email_id
A key field. Data type: DT_I4
- label
Template: ShortText.
- value
Template: ShortText.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/numbers.
The result is extracted from:{{=response.numbers}}.Documentation: https://developer.aircall.io/api-references/#list-all-numbers.
- [Read Single] action
-
Endpoint URL address:
/numbers/{{=parameters.id}}.
The result is extracted from:{{= [response.number]}}.The action has the following user-defined parameters:
- id: Required. Specify the number_id.
Documentation: https://developer.aircall.io/api-references/#retrieve-a-number.
- [Read user] action
-
Endpoint URL address:
/users/{{=item.id}}.
The result is extracted from:{{=response.user.numbers}}.Documentation: https://developer.aircall.io/api-references/#retrieve-a-user.
- [Update] action
-
Endpoint URL address:
/numbers/{{=item.id}}.Documentation: https://developer.aircall.io/api-references/#update-a-number.
The resource includes the fields from the numberT template.
- users
Field components:
- An array.
-
Uses template:
userT.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/tags.
The result is extracted from:{{= response.tags }}.Documentation: https://developer.aircall.io/api-references/#list-all-tags.
- [Read Single] action
-
Endpoint URL address:
/tags/{{=parameters.id}}.
The result is extracted from:{{=[response.tag]}}.The action has the following user-defined parameters:
- id: Required. Specify the tag_id.
Documentation: https://developer.aircall.io/api-references/#retrieve-a-tag.
- [Create] action
-
Endpoint URL address:
/tags.Documentation: https://developer.aircall.io/api-references/#create-a-tag.
- [Update] action
-
Endpoint URL address:
/tags/{{=item.id}}.Documentation: https://developer.aircall.io/api-references/#update-a-tag.
- [Delete] action
-
Endpoint URL address:
/tags/{{=item.id}}.Documentation: https://developer.aircall.io/api-references/#delete-a-tag.
- id
A key field. Data type: DT_I4
- name
Template: ShortText.
- color
Template: ShortText.
- description
Template: ShortText.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/webhooks.
The result is extracted from:{{=response.webhooks}}.Documentation: https://developer.aircall.io/api-references/#list-all-webhooks.
- [Read Single] action
-
Endpoint URL address:
/webhooks/{{=parameters.id}}.
The result is extracted from:{{= [response.webhook]}}.The action has the following user-defined parameters:
- id: Required. Specify the webhook_id.
Documentation: https://developer.aircall.io/api-references/#retrieve-a-webhook.
- [Create] action
-
Endpoint URL address:
/webhooks.Documentation: https://developer.aircall.io/api-references/#create-a-webhook.
- [Update] action
-
Endpoint URL address:
/webhooks/{{=item.id}}.Documentation: https://developer.aircall.io/api-references/#update-a-webhook.
- [Delete] action
-
Endpoint URL address:
/webhooks/{{=item.id}}.Documentation: https://developer.aircall.io/api-references/#delete-a-webhook.
- id
A key field. Data type: DT_I4
- direct_link
Template: ShortText.
- custom_name
Template: ShortText.
- created_at
Template: DateTime. A read-only field.
- url
Template: ShortText.
- active
Data type: DT_BOOL
- token
Template: ShortText.
- events
Template: LongText. A composite field.
- [Read] action
-
The result is extracted from:{{=[response]}}.
The result is paginated.The following request parameters will be automatically processed:
-
page:
{{=parameters.iterator}} -
per_page:
{{=parameters.batchSize}} -
_includeUserParameters:
{{=parameters}}
-
page:
- [Create] action
-
The action uses POST method.The following request parameters will be automatically processed:
-
_includeUserParameters:
{{=parameters}} -
application/json:
{{=item}}
-
_includeUserParameters:
- [Update] action
-
The action uses PUT method.The following request parameters will be automatically processed:
-
_includeUserParameters:
{{=parameters}} -
application/json:
{{=item}}
-
_includeUserParameters:
- [Delete] action
-
The action uses DELETE method.
- ShortText
Data type: DT_WSTR ( length 255 )
- LongText
Data type: DT_WSTR ( length 1000 )
- DateTime
Data type: DT_DBTIMESTAMP
- Date
Data type: DT_DBDATE
- UnixTime
Data type: DT_DBTIMESTAMP The gathered value is processed with
{{=value && new Date(value * 1000).toUTCString()}}expression.- valueLabelT
Field components:
- An array.
- Contains the following components: id, label, value.
- userT
Field components:
-
Uses template:
ShortText. - Contains the following components: id, direct_link, name, email, available, availability_status, created_at, time_zone.
-
Uses template:
- generalUserT
Template: userT. Field components:
-
Uses template:
ShortText. - Contains the following components: language.
-
Uses template:
- messageT
Field components:
-
Uses template:
ShortText. - Contains the following components: welcome, waiting, ivr, voicemail, closed, callback_later, unanswered_call, after_hours, ringing_tone.
-
Uses template:
- numberT
Field components:
-
Uses template:
ShortText. - Contains the following components: id, direct_link, name, digits, created_at, country, time_zone, open, availability_status, is_ivr, live_recording_activated, messages.
-
Uses template:
- contactT
Field components:
-
Uses template:
ShortText. - Contains the following components: id, direct_link, first_name, last_name, company_name, information, is_shared, created_at, updated_at, emails, phone_numbers.
-
Uses template:
What's New
- New: Introduced connection.
COZYROC SSIS+ Components Suite is free for testing in your development environment.
A licensed version can be deployed on-premises, on Azure-SSIS IR and on COZYROC Cloud.