Aircall

App · 26 actions

Manage shared contacts, call notes and tags, place and transfer calls, and look up your phone system.

Actions

ActionWhat it does
Add call commentAdd call comment.
Create contactCreate contact.
Create tagCreate tag.
Delete contactDelete contact.
Delete tagDelete tag.
Get callGet one call by its ID.
Get contactGet contact.
Get numberGet number.
Get tagGet tag.
Get userGet user.
Get user availabilityRead the current detailed availability of an Aircall user.
List callsList calls from the last six months, optionally only those that started in a time range.
List contactsList contacts.
List numbersList numbers.
List tagsList tags.
List teamsList teams.
List usersList users.
Search callsFind calls by time range, direction, team member, number, the other person's phone number or tags.
Search contactsSearch contacts.
Send a text messageText someone from one of your Aircall numbers.
Set user availabilitySet user availability.
Start callStart call.
Tag callTag call.
Transfer callTransfer call.
Update contactUpdate contact.
Update tagUpdate tag.

Add call comment

Add call comment.

Inputs

Call idcall_idtextRequired
Call id.
ContentcontenttextRequired
Content.

Outputs

dataobject
Aircall confirms success with no documented response fields.
Example output
{
  "data": {}
}

Create contact

Create contact.

Inputs

First namefirst_nametext
First name.
Last namelast_nametext
Last name.
Company namecompany_nametext
Company name.
Informationinformationtext
Information.
Phone numbersphone_numberslistRequired
Phone numbers.
Emailsemailslist
Emails.

Outputs

dataobject
Aircall response data.
Example output
{
  "data": {
    "contact": {
      "company_name": "example",
      "created_at": 1,
      "emails": [],
      "first_name": "example",
      "id": 1,
      "information": "example",
      "is_shared": false,
      "last_name": "example",
      "phone_numbers": [],
      "updated_at": 1
    }
  }
}

Create tag

Create tag.

Inputs

NamenametextRequired
Name.
ColorcolortextRequired
Tag color as a hexadecimal value, for example #00B388.

Outputs

dataobject
Aircall response data.
Example output
{
  "data": {
    "tag": {
      "color": "example",
      "description": "example",
      "id": 1,
      "name": "example"
    }
  }
}

Delete contact

Delete contact.

Inputs

Contactcontact_idtextRequired
Contact id.

Outputs

dataobject
Aircall response data.
Example output
{
  "data": {
    "contact": {
      "company_name": "example",
      "created_at": 1,
      "emails": [],
      "first_name": "example",
      "id": 1,
      "information": "example",
      "last_name": "example",
      "phone_numbers": [],
      "updated_at": 1
    }
  }
}

Delete tag

Delete tag.

Inputs

Tagtag_idtextRequired
Tag id.

Outputs

dataobject
Aircall response data.
Example output
{
  "data": {
    "tag": {
      "color": "example",
      "id": 1,
      "name": "example"
    }
  }
}

Get call

Get one call by its ID. Each call comes ready to read: the other person's number as +15551234567 (phone_number), the saved contact, which of your numbers it was on, who answered, when it started and ended, why it was missed, and links to the voicemail and recording.

Inputs

Call idcall_idtextRequired
Call id.

Outputs

dataobject
Aircall response data.
Example output
{
  "data": {
    "call": {
      "agent_email": "example",
      "agent_id": "example",
      "agent_name": "example",
      "answered": "example",
      "answered_at": 1,
      "archived": false,
      "asset": "example",
      "assigned_to": {
        "availability_status": "example",
        "available": false,
        "created_at": "example",
        "default_number_id": 1,
        "email": "example",
        "extension": "example",
        "id": 1,
        "language": "example",
        "name": "example",
        "substatus": "example",
        "time_zone": "example",
        "wrap_up_time": 1
      },
      "assigned_to_email": "example",
      "assigned_to_id": "example",
      "assigned_to_name": "example",
      "call_id": "example",
      "comments": [],
      "contact": {
        "company_name": "example",
        "created_at": 1,
        "emails": [],
        "first_name": "example",
        "id": 1,
        "information": "example",
        "is_shared": false,
        "last_name": "example",
        "phone_numbers": [],
        "updated_at": 1
      },
      "contact_company": "example",
      "contact_email": "example",
      "contact_first_name": "example",
      "contact_id": "example",
      "contact_name": "example",
      "cost": "example",
      "direct_link": "example",
      "direction": "example",
      "duration": 1,
      "duration_display": "example",
      "duration_seconds": 1,
      "ended": "example",
      "ended_at": 1,
      "ended_display": "example",
      "has_voicemail": false,
      "id": 1,
      "line_id": "example",
      "line_name": "example",
      "line_number": "example",
      "line_number_display": "example",
      "missed": false,
      "missed_call_reason": "example",
      "missed_reason_display": "example",
      "number": {
        "availability_status": "example",
        "country": "example",
        "created_at": "example",
        "digits": "example",
        "id": 1,
        "is_ivr": false,
        "live_recording_activated": false,
        "name": "example",
        "open": false,
        "priority": 1,
        "time_zone": "example"
      },
      "number_withheld": false,
      "phone_number": "example",
      "phone_number_display": "example",
      "raw_digits": "example",
      "recording": "example",
      "recording_link": "example",
      "recording_page_link": "example",
      "recording_short_url": "example",
      "started": "example",
      "started_at": 1,
      "started_display": "example",
      "status": "example",
      "tag_names": [],
      "tags": [],
      "teams": [],
      "user": {
        "availability_status": "example",
        "available": false,
        "created_at": "example",
        "default_number_id": 1,
        "email": "example",
        "extension": "example",
        "id": 1,
        "language": "example",
        "name": "example",
        "substatus": "example",
        "time_zone": "example",
        "wrap_up_time": 1
      },
      "voicemail": "example",
      "voicemail_link": "example",
      "voicemail_short_url": "example"
    }
  }
}

Get contact

Get contact.

Inputs

Contactcontact_idtextRequired
Contact id.

Outputs

dataobject
Aircall response data.
Example output
{
  "data": {
    "contact": {
      "company_name": "example",
      "created_at": 1,
      "emails": [],
      "first_name": "example",
      "id": 1,
      "information": "example",
      "is_shared": false,
      "last_name": "example",
      "phone_numbers": [],
      "updated_at": 1
    }
  }
}

Get number

Get number.

Inputs

Numbernumber_idtextRequired
Number id.

Outputs

dataobject
Aircall response data.
Example output
{
  "data": {
    "number": {
      "availability_status": "example",
      "country": "example",
      "created_at": "example",
      "digits": "example",
      "id": 1,
      "is_ivr": false,
      "live_recording_activated": false,
      "name": "example",
      "open": false,
      "priority": 1,
      "time_zone": "example"
    }
  }
}

Get tag

Get tag.

Inputs

Tagtag_idtextRequired
Tag id.

Outputs

dataobject
Aircall response data.
Example output
{
  "data": {
    "tag": {
      "color": "example",
      "description": "example",
      "id": 1,
      "name": "example"
    }
  }
}

Get user

Get user.

Inputs

Useraircall_user_idtextRequired
User id.

Outputs

dataobject
Aircall response data.
Example output
{
  "data": {
    "user": {
      "availability_status": "example",
      "available": false,
      "created_at": "example",
      "default_number_id": 1,
      "email": "example",
      "extension": "example",
      "id": 1,
      "language": "example",
      "name": "example",
      "substatus": "example",
      "time_zone": "example",
      "wrap_up_time": 1
    }
  }
}

Get user availability

Read the current detailed availability of an Aircall user.

Inputs

Aircall useraircall_user_idtextRequired
Choose the Aircall user.

Outputs

dataobject
Aircall response data.
Example output
{
  "data": {
    "availability": "example"
  }
}

List calls

List calls from the last six months, optionally only those that started in a time range. Gets one page; to see more, run it again with the next page it gives. Each call comes ready to read: the other person's number as +15551234567 (phone_number), the saved contact, which of your numbers it was on, who answered, when it started and ended, why it was missed, and links to the voicemail and recording.

Inputs

Pagepagenumber
Page.At least 1.
Per pageper_pagenumber
Per page.From 1 to 50.
Orderordertext
Order.One of: asc, desc.
Fromfrom_timedate and time
Only calls that started at or after this time.
Toto_timedate and time
Only calls that started at or before this time.

Outputs

dataobject
Aircall response data.
Example output
{
  "data": {
    "calls": [],
    "meta": {
      "count": 1,
      "current_page": 1,
      "next_page_link": "example",
      "per_page": 1,
      "previous_page_link": "example",
      "total": 1
    }
  }
}

List contacts

List contacts. Gets one page; to see more, run it again with the next page it gives.

Inputs

Pagepagenumber
Page.At least 1.
Per pageper_pagenumber
Per page.From 1 to 50.
Orderordertext
Order.One of: asc, desc.

Outputs

dataobject
Aircall response data.
Example output
{
  "data": {
    "contacts": [],
    "meta": {
      "count": 1,
      "current_page": 1,
      "next_page_link": "example",
      "per_page": 1,
      "previous_page_link": "example",
      "total": 1
    }
  }
}

List numbers

List numbers. Gets one page; to see more, run it again with the next page it gives.

Inputs

Pagepagenumber
Page.At least 1.
Per pageper_pagenumber
Per page.From 1 to 50.
Orderordertext
Order.One of: asc, desc.

Outputs

dataobject
Aircall response data.
Example output
{
  "data": {
    "meta": {
      "count": 1,
      "current_page": 1,
      "next_page_link": "example",
      "per_page": 1,
      "previous_page_link": "example",
      "total": 1
    },
    "numbers": []
  }
}

List tags

List tags. Gets one page; to see more, run it again with the next page it gives.

Inputs

Pagepagenumber
Page.At least 1.
Per pageper_pagenumber
Per page.From 1 to 50.
Orderordertext
Order.One of: asc, desc.

Outputs

dataobject
Aircall response data.
Example output
{
  "data": {
    "meta": {
      "count": 1,
      "current_page": 1,
      "next_page_link": "example",
      "per_page": 1,
      "previous_page_link": "example",
      "total": 1
    },
    "tags": []
  }
}

List teams

List teams. Gets one page; to see more, run it again with the next page it gives.

Inputs

Pagepagenumber
Page.At least 1.
Per pageper_pagenumber
Per page.From 1 to 50.
Orderordertext
Order.One of: asc, desc.

Outputs

dataobject
Aircall response data.
Example output
{
  "data": {
    "meta": {
      "count": 1,
      "current_page": 1,
      "next_page_link": "example",
      "per_page": 1,
      "previous_page_link": "example",
      "total": 1
    },
    "teams": []
  }
}

List users

List users. Gets one page; to see more, run it again with the next page it gives.

Inputs

Pagepagenumber
Page.At least 1.
Per pageper_pagenumber
Per page.From 1 to 50.
Orderordertext
Order.One of: asc, desc.

Outputs

dataobject
Aircall response data.
Example output
{
  "data": {
    "meta": {
      "count": 1,
      "current_page": 1,
      "next_page_link": "example",
      "per_page": 1,
      "previous_page_link": "example",
      "total": 1
    },
    "users": []
  }
}

Search calls

Find calls by time range, direction, team member, number, the other person's phone number or tags. Each call comes ready to read: the other person's number as +15551234567 (phone_number), the saved contact, which of your numbers it was on, who answered, when it started and ended, why it was missed, and links to the voicemail and recording.

Inputs

Pagepagenumber
Page.At least 1.
Per pageper_pagenumber
Per page.From 1 to 50.
Orderordertext
Order.One of: asc, desc.
Fromfrom_timedate and time
Only calls that started at or after this time.
Toto_timedate and time
Only calls that started at or before this time.
Directiondirectiontext
Direction.One of: inbound, outbound.
Aircall useraircall_user_idtext
Aircall user id.
Numbernumber_idtext
Number id.
Phone numberphone_numbertext
Phone number.
Tagstagslist
Tags.

Outputs

dataobject
Aircall response data.
Example output
{
  "data": {
    "calls": [],
    "meta": {
      "count": 1,
      "current_page": 1,
      "next_page_link": "example",
      "per_page": 1,
      "previous_page_link": "example",
      "total": 1
    }
  }
}

Search contacts

Search contacts.

Inputs

Pagepagenumber
Page.At least 1.
Per pageper_pagenumber
Per page.From 1 to 50.
Orderordertext
Order.One of: asc, desc.
Phone numberphone_numbertext
Phone number.
Emailemailtext
Email.

Outputs

dataobject
Aircall response data.
Example output
{
  "data": {
    "contacts": [],
    "meta": {
      "count": 1,
      "current_page": 1,
      "next_page_link": "example",
      "per_page": 1,
      "previous_page_link": "example",
      "total": 1
    }
  }
}

Send a text message

Text someone from one of your Aircall numbers. The text joins the conversation your team sees in Aircall, so they can carry it on there. Needs a number that can send texts, and texting through Aircall's API switched on for your Aircall account (Aircall's support can do it). Up to 1,600 characters. Meant for a few texts at a time, not bulk sending.

Inputs

Send fromnumber_idtextRequired
The Aircall number to text from. Pick one, or use a call's line_id to reply from the number the call came in on.
TototextRequired
The mobile number to text, in international format such as +14155550123. A call's phone_number is already written this way.
MessagemessagetextRequired
The text to send, up to 1,600 characters.

Outputs

dataobject
Aircall response data.
Example output
{
  "data": {
    "body": "example",
    "created_at": 1,
    "direct_link": "example",
    "direction": "example",
    "id": "example",
    "message_id": "example",
    "raw_digits": "example",
    "sent_at": 1,
    "sent_from_number_id": "example",
    "status": "example",
    "to": "example",
    "updated_at": 1
  }
}

Set user availability

Set user availability.

Inputs

Aircall useraircall_user_idtextRequired
Aircall user id.
Availability statusavailability_statustextRequired
Availability status.One of: available, custom, unavailable.

Outputs

dataobject
Aircall response data.
Example output
{
  "data": {
    "user": {
      "availability_status": "example",
      "available": false,
      "created_at": "example",
      "default_number_id": 1,
      "email": "example",
      "extension": "example",
      "id": 1,
      "language": "example",
      "name": "example",
      "substatus": "example",
      "time_zone": "example",
      "wrap_up_time": 1
    }
  }
}

Start call

Start call.

Inputs

Aircall useraircall_user_idtextRequired
Aircall user id.
Numbernumber_idtextRequired
Number id.
TototextRequired
Destination phone number in international format, for example +14155550123.

Outputs

dataobject
Aircall confirms success with no documented response fields.
Example output
{
  "data": {}
}

Tag call

Tag call.

Inputs

Call idcall_idtextRequired
Call id.
TagstagslistRequired
Tags.

Outputs

dataobject
Aircall response data.
Example output
{
  "data": {}
}

Transfer call

Transfer call.

Inputs

Call idcall_idtextRequired
Call id.
Aircall useraircall_user_idtext
Aircall user id.
Aircall teamaircall_team_idtext
Aircall team id.
Numbernumbertext
Number.

Outputs

dataobject
Aircall response data.
Example output
{
  "data": {}
}

Update contact

Update contact.

Inputs

Contactcontact_idtextRequired
Contact id.
First namefirst_nametext
First name.
Last namelast_nametext
Last name.
Company namecompany_nametext
Company name.
Informationinformationtext
Information.

Outputs

dataobject
Aircall response data.
Example output
{
  "data": {
    "contact": {
      "company_name": "example",
      "created_at": 1,
      "emails": [],
      "first_name": "example",
      "id": 1,
      "information": "example",
      "is_shared": false,
      "last_name": "example",
      "phone_numbers": [],
      "updated_at": 1
    }
  }
}

Update tag

Update tag.

Inputs

Tagtag_idtextRequired
Tag id.
NamenametextRequired
Name.
ColorcolortextRequired
Tag color as a hexadecimal value, for example #00B388.

Outputs

dataobject
Aircall response data.
Example output
{
  "data": {
    "tag": {
      "color": "example",
      "description": "example",
      "id": 1,
      "name": "example"
    }
  }
}

On this page