Aircall
App · 26 actions
Manage shared contacts, call notes and tags, place and transfer calls, and look up your phone system.
Actions
| Action | What it does |
|---|---|
| Add call comment | Add call comment. |
| Create contact | Create contact. |
| Create tag | Create tag. |
| Delete contact | Delete contact. |
| Delete tag | Delete tag. |
| Get call | Get one call by its ID. |
| Get contact | Get contact. |
| Get number | Get number. |
| Get tag | Get tag. |
| Get user | Get user. |
| Get user availability | Read the current detailed availability of an Aircall user. |
| List calls | List calls from the last six months, optionally only those that started in a time range. |
| List contacts | List contacts. |
| List numbers | List numbers. |
| List tags | List tags. |
| List teams | List teams. |
| List users | List users. |
| Search calls | Find calls by time range, direction, team member, number, the other person's phone number or tags. |
| Search contacts | Search contacts. |
| Send a text message | Text someone from one of your Aircall numbers. |
| Set user availability | Set user availability. |
| Start call | Start call. |
| Tag call | Tag call. |
| Transfer call | Transfer call. |
| Update contact | Update contact. |
| Update tag | Update tag. |
Add call comment
Add call comment.
Inputs
- Call id
call_idtextRequired - Call id.
- Content
contenttextRequired - Content.
Outputs
dataobject- Aircall confirms success with no documented response fields.
Example output
{
"data": {}
}Create contact
Create contact.
Inputs
- First name
first_nametext - First name.
- Last name
last_nametext - Last name.
- Company name
company_nametext - Company name.
- Information
informationtext - Information.
- Phone numbers
phone_numberslistRequired - Phone numbers.
- Emails
emailslist - 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
- Name
nametextRequired - Name.
- Color
colortextRequired - 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
- Contact
contact_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
- Tag
tag_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 id
call_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
- Contact
contact_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
- Number
number_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
- Tag
tag_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
- User
aircall_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 user
aircall_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
- Page
pagenumber - Page.At least 1.
- Per page
per_pagenumber - Per page.From 1 to 50.
- Order
ordertext - Order.One of:
asc,desc. - From
from_timedate and time - Only calls that started at or after this time.
- To
to_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
- Page
pagenumber - Page.At least 1.
- Per page
per_pagenumber - Per page.From 1 to 50.
- Order
ordertext - 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
- Page
pagenumber - Page.At least 1.
- Per page
per_pagenumber - Per page.From 1 to 50.
- Order
ordertext - 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
- Page
pagenumber - Page.At least 1.
- Per page
per_pagenumber - Per page.From 1 to 50.
- Order
ordertext - 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
- Page
pagenumber - Page.At least 1.
- Per page
per_pagenumber - Per page.From 1 to 50.
- Order
ordertext - 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
- Page
pagenumber - Page.At least 1.
- Per page
per_pagenumber - Per page.From 1 to 50.
- Order
ordertext - 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
- Page
pagenumber - Page.At least 1.
- Per page
per_pagenumber - Per page.From 1 to 50.
- Order
ordertext - Order.One of:
asc,desc. - From
from_timedate and time - Only calls that started at or after this time.
- To
to_timedate and time - Only calls that started at or before this time.
- Direction
directiontext - Direction.One of:
inbound,outbound. - Aircall user
aircall_user_idtext - Aircall user id.
- Number
number_idtext - Number id.
- Phone number
phone_numbertext - Phone number.
- Tags
tagslist - 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
- Page
pagenumber - Page.At least 1.
- Per page
per_pagenumber - Per page.From 1 to 50.
- Order
ordertext - Order.One of:
asc,desc. - Phone number
phone_numbertext - Phone number.
- Email
emailtext - 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 from
number_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.
- To
totextRequired - The mobile number to text, in international format such as +14155550123. A call's phone_number is already written this way.
- Message
messagetextRequired - 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 user
aircall_user_idtextRequired - Aircall user id.
- Availability status
availability_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 user
aircall_user_idtextRequired - Aircall user id.
- Number
number_idtextRequired - Number id.
- To
totextRequired - 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 id
call_idtextRequired - Call id.
- Tags
tagslistRequired - Tags.
Outputs
dataobject- Aircall response data.
Example output
{
"data": {}
}Transfer call
Transfer call.
Inputs
- Call id
call_idtextRequired - Call id.
- Aircall user
aircall_user_idtext - Aircall user id.
- Aircall team
aircall_team_idtext - Aircall team id.
- Number
numbertext - Number.
Outputs
dataobject- Aircall response data.
Example output
{
"data": {}
}Update contact
Update contact.
Inputs
- Contact
contact_idtextRequired - Contact id.
- First name
first_nametext - First name.
- Last name
last_nametext - Last name.
- Company name
company_nametext - Company name.
- Information
informationtext - 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
- Tag
tag_idtextRequired - Tag id.
- Name
nametextRequired - Name.
- Color
colortextRequired - 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"
}
}
}