The Aircall connector lets your AI agent act in each user's Aircall account. Each user signs in to Aircall once, and Scalekit stores and refreshes their tokens, so your agent never handles credentials. It comes with 78 tools.
- Tools
- 78
- What they doRead · write · destructive
- 43 · 28 · 743 read28 write7 destructive
- Users sign in with
- OAuth
- OAuth app
- Your own Aircall app
Setup
Install the SDK
Terminal window npm install @scalekit-sdk/node dotenvTerminal window pip install scalekit-sdk-python python-dotenvSet your credentials
Add your Scalekit credentials to your
.envfile. Find values in app.scalekit.com > Developers > API Credentials..env SCALEKIT_ENVIRONMENT_URL=<your-environment-url>SCALEKIT_CLIENT_ID=<your-client-id>SCALEKIT_CLIENT_SECRET=<your-client-secret>Create the Aircall connection
In AgentKit > Connections, create an Aircall connection and copy its redirect URI. The name you give it is the
connection_nameyour code passes. See Configure connections.Register an OAuth app
Aircall connections use your own OAuth app. Register one with Aircall and add the redirect URI you copied.
Then enter the app's Client ID and Client Secret on the Aircall connection.
Authorize a user and make your first call
quickstart.mts import { ScalekitClient } from '@scalekit-sdk/node'import 'dotenv/config'import { createInterface } from 'node:readline/promises'const scalekit = new ScalekitClient(process.env.SCALEKIT_ENVIRONMENT_URL,process.env.SCALEKIT_CLIENT_ID,process.env.SCALEKIT_CLIENT_SECRET,)const actions = scalekit.actionsconst connector = 'aircall'const identifier = 'user_123'// Generate an authorization link for the userconst { link } = await actions.getAuthorizationLink({ connectionName: connector, identifier })console.log('Authorize Aircall:', link)const rl = createInterface({ input: process.stdin, output: process.stdout })await rl.question('Press Enter after authorizing...')rl.close()// Make your first callconst result = await actions.executeTool({connector,identifier,toolName: 'aircall_calls_list',toolInput: {},})console.log(result)Terminal window npx tsx quickstart.mtsquickstart.py import osfrom scalekit import ScalekitClientfrom dotenv import load_dotenvload_dotenv()scalekit_client = ScalekitClient(env_url=os.getenv("SCALEKIT_ENVIRONMENT_URL"),client_id=os.getenv("SCALEKIT_CLIENT_ID"),client_secret=os.getenv("SCALEKIT_CLIENT_SECRET"),)actions = scalekit_client.actionsconnection_name = "aircall"identifier = "user_123"# Generate an authorization link for the userlink_response = actions.get_authorization_link(connection_name=connection_name,identifier=identifier,)print("Authorize Aircall:", link_response.link)input("Press Enter after authorizing...")# Make your first callresult = actions.execute_tool(tool_input={},tool_name="aircall_calls_list",connection_name=connection_name,identifier=identifier,)print(result)Terminal window python quickstart.pyEach user signs in once. See Authorize a user for the full flow and statuses.
Tools
Pass the exact name toexecute_toolaircall_analytics_export_getGet the status of an Analytics report export and, once completed, a time-limited download URL for the CSV.Read-onlyGet Analytics Export
Get the status of an Analytics report export and, once completed, a time-limited download URL for the CSV. Returns status (PENDING, COMPLETED or FAILED), downloadUrl and downloadUrlExpiresAt when completed, or errorMessage when failed. Use aircall_analytics_export_get to poll about once a minute after aircall_analytics_export_create. Call it again to get a fresh URL after the old one expires.
Inputs
export_idstringrequired- UUID of the export job, from aircall_analytics_export_create's exportID. Example: 9d3f2a1e-2b6c-4f0a-9c3e-1a2b3c4d5e6f
aircall_call_action_items_getGet the action items AI extracted from a call.Read-onlyGet Call Action Items
Get the action items AI extracted from a call. Requires the Aircall AI Assist or AI Assist Pro package. Returns action_items with id, call_id, created_at, created_by, updated_at and content. Use aircall_call_action_items_get for follow-ups to log after a call.
Inputs
call_idintegerrequired- Unique Aircall ID of the call. Example: 812
aircall_call_custom_summary_result_getGet the result of the company's custom summary template for a call.Read-onlyGet Call Custom Summary Result
Get the result of the company's custom summary template for a call. Requires the AI Assist Pro package. Returns the custom summary result for the call. Use aircall_call_custom_summary_result_get when the company uses custom summary templates. Use aircall_call_summary_get for the standard summary.
Inputs
call_idintegerrequired- Unique Aircall ID of the call. Example: 812
aircall_call_evaluations_getGet the AI call evaluations (scorecards with question-level scores and feedback) for a call.Read-onlyGet Call Evaluations
Get the AI call evaluations (scorecards with question-level scores and feedback) for a call. Requires the Aircall AI Assist or AI Assist Pro package. Returns the call's evaluations. Use aircall_call_evaluations_get for quality-review scores. Use aircall_call_playbook_result_get for playbook adherence.
Inputs
call_idintegerrequired- Unique Aircall ID of the call. Example: 812
aircall_call_getGet one call by ID with its duration, direction, status, timestamps, recording, voicemail, comments, tags and participants.Read-onlyGet Call
Get one call by ID with its duration, direction, status, timestamps, recording, voicemail, comments, tags and participants. Returns the call object. Use aircall_call_get when you know the call ID. Use aircall_calls_list or aircall_calls_search to find calls.
Inputs
call_idintegerrequired- Unique Aircall ID of the call. Example: 812
fetch_aiva_convboolean- Set to true to include ai_voice_agents (the AI Voice Agent segments that handled the call) on each call. Default: false.
fetch_call_timelineboolean- Set to true to include ivr_options_selected (the IVR options the caller pressed) on each call. Default: false.
fetch_contactboolean- Set to true to include the matched contact's details in each call. Default: false.
fetch_short_urlsboolean- Set to true to include short URLs (for example for recordings and voicemails) in the response. Default: false.
aircall_call_playbook_result_getGet the playbook result for a call: how the agent followed the company's call playbook.Read-onlyGet Call Playbook Result
Get the playbook result for a call: how the agent followed the company's call playbook. Requires the AI Assist Pro package. Returns the playbook result, and the playbook details when fetch_playbook is true. Use aircall_call_playbook_result_get for playbook adherence. Use aircall_call_evaluations_get for scored call evaluations.
Inputs
call_idintegerrequired- Unique Aircall ID of the call. Example: 812
fetch_playbookboolean- Set to true to include the playbook's details in the response. Default: false.
aircall_call_predicted_csat_getGet the AI-predicted customer satisfaction (CSAT) score for a call.Read-onlyGet Call Predicted CSAT
Get the AI-predicted customer satisfaction (CSAT) score for a call. Requires the Aircall AI Assist or AI Assist Pro package. Returns the predicted CSAT result for the call. Use aircall_call_predicted_csat_get for a satisfaction estimate. Use aircall_call_sentiments_get for per-participant sentiment.
Inputs
call_idintegerrequired- Unique Aircall ID of the call. Example: 812
aircall_call_sentiments_getGet the AI sentiment analysis of a call's participants.Read-onlyGet Call Sentiments
Get the AI sentiment analysis of a call's participants. Requires the Aircall AI Assist or AI Assist Pro package. Returns sentiment with id, call_id and participants[] with their sentiment value. Use aircall_call_sentiments_get for sentiment. Use aircall_call_predicted_csat_get for a predicted satisfaction score.
Inputs
call_idintegerrequired- Unique Aircall ID of the call. Example: 812
aircall_call_summary_getGet the AI-generated summary of a call.Read-onlyGet Call Summary
Get the AI-generated summary of a call. Requires the Aircall AI Assist or AI Assist Pro package. Returns summary with id, call_id, created_at and content. Use aircall_call_summary_get for a short recap. Use aircall_call_custom_summary_result_get for a custom-template summary, and aircall_call_transcription_get for the full text.
Inputs
call_idintegerrequired- Unique Aircall ID of the call. Example: 812
aircall_call_topics_getGet the key topics AI detected in a call.Read-onlyGet Call Topics
Get the key topics AI detected in a call. Requires the Aircall AI Assist or AI Assist Pro package. Returns topics with id, call_id, created_at and content (the list of topics). Use aircall_call_topics_get to see what a call was about.
Inputs
call_idintegerrequired- Unique Aircall ID of the call. Example: 812
aircall_call_transcription_getGet the transcription of a call or voicemail after it has ended.Read-onlyGet Call Transcription
Get the transcription of a call or voicemail after it has ended. Requires the Aircall AI Assist or AI Assist Pro package. Returns transcription with id, call_id, type, call_created_at and content (utterances with speaker, timing and text). Use aircall_call_transcription_get for the full text. Use aircall_call_summary_get for a short summary.
Inputs
call_idintegerrequired- Unique Aircall ID of the call. Example: 812
modestring- Transcription mode: async (post-call transcription) or realtime (requires AI Assist Pro). Omit for the default.one of
asyncrealtime
aircall_calls_listList the company's calls from the last six months, optionally limited to a creation date range.Read-onlyList Calls
List the company's calls from the last six months, optionally limited to a creation date range. Returns calls[] with id, direction, status, duration, started_at, answered_at, ended_at, raw_digits, user, number, recording, voicemail, comments and tags, plus pagination meta. Use aircall_calls_list to browse recent calls (set order=desc for the latest first). Use aircall_calls_search to filter by user, phone number or direction, and aircall_call_get for one call.
Inputs
fetch_aiva_convboolean- Set to true to include ai_voice_agents (the AI Voice Agent segments that handled the call) on each call. Default: false.
fetch_call_timelineboolean- Set to true to include ivr_options_selected (the IVR options the caller pressed) on each call. Default: false.
fetch_contactboolean- Set to true to include the matched contact's details in each call. Default: false.
fetch_short_urlsboolean- Set to true to include short URLs (for example for recordings and voicemails) in the response. Default: false.
fromstring- Only return calls created at or after this time, as a UNIX timestamp in seconds. Example: 1704067200 (2024-01-01).
orderstring- Sort order by creation date: asc (oldest first) or desc (newest first). Default: asc.one of
ascdescdefaultasc pageinteger- Page number of results to return, starting at 1. Aircall returns meta.next_page_link when more pages exist. Default: 1.default
1 per_pageinteger- Number of results per page, between 1 and 50. Default: 20.default
20 tostring- Only return calls created at or before this time, as a UNIX timestamp in seconds. Example: 1735689599 (2024-12-31).
aircall_calls_searchSearch the company's calls from the last six months by user, phone number, direction or creation date range.Read-onlySearch Calls
Search the company's calls from the last six months by user, phone number, direction or creation date range. Returns matching calls[] with the same fields as aircall_calls_list, plus pagination meta. Use aircall_calls_search to filter calls. Use aircall_calls_list to browse all calls.
Inputs
directionstring- Only return calls in this direction: inbound or outbound.one of
inboundoutbound fetch_aiva_convboolean- Set to true to include ai_voice_agents (the AI Voice Agent segments that handled the call) on each call. Default: false.
fetch_call_timelineboolean- Set to true to include ivr_options_selected (the IVR options the caller pressed) on each call. Default: false.
fetch_contactboolean- Set to true to include the matched contact's details in each call. Default: false.
fetch_short_urlsboolean- Set to true to include short URLs (for example for recordings and voicemails) in the response. Default: false.
fromstring- Only return calls created at or after this time, as a UNIX timestamp in seconds. Example: 1704067200 (2024-01-01).
orderstring- Sort order by creation date: asc (oldest first) or desc (newest first). Default: asc.one of
ascdescdefaultasc pageinteger- Page number of results to return, starting at 1. Aircall returns meta.next_page_link when more pages exist. Default: 1.default
1 per_pageinteger- Number of results per page, between 1 and 50. Default: 20.default
20 phone_numberstring- Only return calls to or from this phone number. Example: +18001231234
tostring- Only return calls created at or before this time, as a UNIX timestamp in seconds. Example: 1735689599 (2024-12-31).
user_idinteger- Only return calls made or received by this user ID. Example: 456
aircall_campaign_call_outcomes_listList the latest call attempt and recorded outcome for each contact in an Outbound Campaign.Read-onlyList Campaign Call Outcomes
List the latest call attempt and recorded outcome for each contact in an Outbound Campaign. Returns call_outcomes[] with id, call_id, phone_number, attempt_number, max_attempts, is_final, status, duration, outcome and timestamps, plus meta.next_cursor. Use aircall_campaign_call_outcomes_list to log campaign results in a CRM. Use aircall_campaign_stats_get for totals.
Inputs
campaign_idstringrequired- UUID of the Outbound Campaign, as returned by aircall_campaigns_list. Example: 019f3614-18e7-7b49-aef3-93159c4ed9e3
cursorstring- Opaque cursor from the previous response's meta.next_cursor, to fetch the next page. Omit it for the first page. Cursors are not interchangeable between endpoints.
per_pageinteger- Number of results per page, up to 50 (higher values are capped at 50). Default: 20.default
20
aircall_campaign_contacts_listList the contacts in an Outbound Campaign's call queue, or look up one contact by phone number.Read-onlyList Campaign Contacts
List the contacts in an Outbound Campaign's call queue, or look up one contact by phone number. Returns contacts[] with phone_number, first_name, last_name, email, company_name and note, plus meta.next_cursor. Use aircall_campaign_contacts_list to see who a campaign will call. Use aircall_campaign_call_outcomes_list for call results.
Inputs
campaign_idstringrequired- UUID of the Outbound Campaign, as returned by aircall_campaigns_list. Example: 019f3614-18e7-7b49-aef3-93159c4ed9e3
cursorstring- Opaque cursor from the previous response's meta.next_cursor, to fetch the next page. Omit it for the first page. Cursors are not interchangeable between endpoints.
per_pageinteger- Number of results per page, up to 50 (higher values are capped at 50). Default: 20.default
20 phone_numberstring- Return only the contact with this phone number. Example: 33612345678
aircall_campaign_getGet one Outbound Campaign by ID with its status, run mode, caller ID strategy, retry settings and calling hours.Read-onlyGet Campaign
Get one Outbound Campaign by ID with its status, run mode, caller ID strategy, retry settings and calling hours. Returns the campaign object. Use aircall_campaign_get when you know the campaign ID. Use aircall_campaigns_list to find campaigns.
Inputs
campaign_idstringrequired- UUID of the Outbound Campaign, as returned by aircall_campaigns_list. Example: 019f3614-18e7-7b49-aef3-93159c4ed9e3
aircall_campaign_outcomes_listList the company's catalogue of custom Campaign Outcomes (disposition labels shared by every Outbound Campaign).Read-onlyList Campaign Outcomes
List the company's catalogue of custom Campaign Outcomes (disposition labels shared by every Outbound Campaign). Returns campaign_outcomes[] with id, name, color, created_at and updated_at, plus meta.next_cursor. Use aircall_campaign_outcomes_list to resolve the custom outcome ids that aircall_campaign_call_outcomes_list returns.
Inputs
cursorstring- Opaque cursor from the previous response's meta.next_cursor, to fetch the next page. Omit it for the first page. Cursors are not interchangeable between endpoints.
per_pageinteger- Number of results per page, up to 50 (higher values are capped at 50). Default: 20.default
20 searchstring- Only return outcomes whose name contains this text (case-insensitive). Example: callback
aircall_campaign_stats_getGet progress statistics for an Outbound Campaign.Read-onlyGet Campaign Stats
Get progress statistics for an Outbound Campaign. Computed on read; poll at most once a minute. Returns stats with total_contacts, completed_percentage, connected_contacts, average_call_duration, active_time, active_at and active_calls_count. Use aircall_campaign_stats_get for totals. Use aircall_campaign_call_outcomes_list for per-contact results.
Inputs
campaign_idstringrequired- UUID of the Outbound Campaign, as returned by aircall_campaigns_list. Example: 019f3614-18e7-7b49-aef3-93159c4ed9e3
aircall_campaigns_listList the company's Outbound Campaigns, optionally filtered by status, name or creator.Read-onlyList Campaigns
List the company's Outbound Campaigns, optionally filtered by status, name or creator. Returns campaigns[] with id, name, description, status, run_mode, agent_type and dialing settings, plus meta.next_cursor for the next page. Use aircall_campaigns_list to find a campaign. Use aircall_campaign_get for one campaign and aircall_campaign_stats_get for its progress.
Inputs
created_bystring- Only return campaigns created by these Aircall user IDs, comma-separated. Example: 456,457
cursorstring- Opaque cursor from the previous response's meta.next_cursor, to fetch the next page. Omit it for the first page. Cursors are not interchangeable between endpoints.
namestring- Only return campaigns whose name contains this text (case-insensitive). Example: Q3
per_pageinteger- Number of results per page, up to 50 (higher values are capped at 50). Default: 20.default
20 statusstring- Only return campaigns in these statuses, comma-separated: draft, in_progress, paused, completed, archived. Example: in_progress,paused
aircall_company_getGet the Aircall company (account) the connection belongs to.Read-onlyGet Company
Get the Aircall company (account) the connection belongs to. Returns the company with its name, users_count and numbers_count. Use aircall_company_get to confirm which Aircall account is connected.
Inputs
This tool takes no inputs.
aircall_contact_getGet one shared contact by ID.Read-onlyGet Contact
Get one shared contact by ID. Returns the contact with id, first_name, last_name, company_name, information, phone_numbers[] and emails[]. Use aircall_contact_get when you know the contact ID. Use aircall_contacts_search to find one by phone or email.
Inputs
contact_idintegerrequired- Unique Aircall ID of the contact. Example: 719
aircall_contacts_listList the company's shared Aircall contacts with their phone numbers and emails.Read-onlyList Contacts
List the company's shared Aircall contacts with their phone numbers and emails. Returns contacts[] with id, first_name, last_name, company_name, information, phone_numbers[] and emails[], plus pagination meta. Use aircall_contacts_list to browse contacts. Use aircall_contacts_search to find a contact by phone number or email, and aircall_contact_get for one contact.
Inputs
fromstring- Only return contacts created at or after this time, as a UNIX timestamp in seconds. Example: 1704067200 (2024-01-01).
orderstring- Sort order by creation date: asc (oldest first) or desc (newest first). Default: asc.one of
ascdescdefaultasc order_bystring- Field to sort by: created_at or updated_at. Default: created_at.one of
created_atupdated_atdefaultcreated_at pageinteger- Page number of results to return, starting at 1. Aircall returns meta.next_page_link when more pages exist. Default: 1.default
1 per_pageinteger- Number of results per page, between 1 and 50. Default: 20.default
20 tostring- Only return contacts created at or before this time, as a UNIX timestamp in seconds. Example: 1735689599 (2024-12-31).
aircall_contacts_searchSearch the company's shared contacts by phone number or email address.Read-onlySearch Contacts
Search the company's shared contacts by phone number or email address. Returns matching contacts[] with the same fields as aircall_contacts_list, plus pagination meta. Use aircall_contacts_search to look up a caller. Use aircall_contacts_list to browse all contacts.
Inputs
emailstring- Email address of the contact to find. Example: gary.jennings@example.com
fromstring- Only return contacts created at or after this time, as a UNIX timestamp in seconds. Example: 1704067200 (2024-01-01).
orderstring- Sort order by creation date: asc (oldest first) or desc (newest first). Default: asc.one of
ascdescdefaultasc order_bystring- Field to sort by: created_at or updated_at. Default: created_at.one of
created_atupdated_atdefaultcreated_at pageinteger- Page number of results to return, starting at 1. Aircall returns meta.next_page_link when more pages exist. Default: 1.default
1 per_pageinteger- Number of results per page, between 1 and 50. Default: 20.default
20 phone_numberstring- Phone number of the contact to find. Example: +19001112222
tostring- Only return contacts created at or before this time, as a UNIX timestamp in seconds. Example: 1735689599 (2024-12-31).
aircall_dialer_campaign_getGet a user's active Power Dialer campaign.Read-onlyGet Dialer Campaign
Get a user's active Power Dialer campaign. A user has at most one. Returns id, number_id and created_at, or 404 when the user has no active campaign. Use aircall_dialer_campaign_get to check for a campaign. Use aircall_dialer_campaign_phone_numbers_list for its numbers. Power Dialer campaigns are separate from Outbound Campaigns (aircall_campaigns_list).
Inputs
user_idintegerrequired- Unique Aircall ID of the user. Example: 456
aircall_dialer_campaign_phone_numbers_listList the phone numbers in a user's active Power Dialer campaign.Read-onlyList Dialer Campaign Phone Numbers
List the phone numbers in a user's active Power Dialer campaign. Returns numbers[] with id, number, called and created_at. Use aircall_dialer_campaign_phone_numbers_list to see progress or find a number id to remove.
Inputs
user_idintegerrequired- Unique Aircall ID of the user. Example: 456
aircall_integration_getGet the Aircall integration behind this OAuth connection: its name, status, connected numbers and the admin who installed it.Read-onlyGet Integration
Get the Aircall integration behind this OAuth connection: its name, status, connected numbers and the admin who installed it. Returns integration with name, custom_name, status, active, company_id, number_ids, numbers_count and user. Use aircall_integration_get to check which numbers this connection has access to. Works with OAuth connections only.
Inputs
This tool takes no inputs.
aircall_number_getGet one Aircall number by ID, including its settings and assigned users.Read-onlyGet Number
Get one Aircall number by ID, including its settings and assigned users. Returns the number with id, name, digits, country, time_zone, live_recording_activated, priority, messages and users[]. Use aircall_number_get when you know the number ID. Use aircall_numbers_list to find numbers.
Inputs
number_idintegerrequired- Unique Aircall ID of the number. Example: 673
aircall_number_registration_status_getGet a number's US messaging compliance registration status (A2P 10DLC, or toll-free registration in the US and Canada).Read-onlyGet Number Registration Status
Get a number's US messaging compliance registration status (A2P 10DLC, or toll-free registration in the US and Canada). Returns status and updatedAt. Use aircall_number_registration_status_get to check whether a US number can send SMS before using aircall_message_send.
Inputs
number_idintegerrequired- Unique Aircall ID of the number. Example: 673
aircall_numbers_listList the company's Aircall phone numbers (lines).Read-onlyList Numbers
List the company's Aircall phone numbers (lines). Returns numbers[] with id, name, digits, country, time_zone, live_recording_activated, priority and messages, plus pagination meta. Use aircall_numbers_list to find a number ID for messaging or calls. Use aircall_number_get for one number, and aircall_user_numbers_list for one user's numbers.
Inputs
fromstring- Only return numbers created at or after this time, as a UNIX timestamp in seconds. Example: 1704067200 (2024-01-01).
orderstring- Sort order by creation date: asc (oldest first) or desc (newest first). Default: asc.one of
ascdescdefaultasc pageinteger- Page number of results to return, starting at 1. Aircall returns meta.next_page_link when more pages exist. Default: 1.default
1 per_pageinteger- Number of results per page, between 1 and 50. Default: 20.default
20 tostring- Only return numbers created at or before this time, as a UNIX timestamp in seconds. Example: 1735689599 (2024-12-31).
aircall_sms_templates_listList the company's saved SMS templates, across all agents, optionally filtered by text.Read-onlyList SMS Templates
List the company's saved SMS templates, across all agents, optionally filtered by text. Returns templates[] with each template's name and body, plus pagination meta. Use aircall_sms_templates_list to reuse approved wording in aircall_message_send. Use aircall_whatsapp_templates_list for WhatsApp templates.
Inputs
pageinteger- Page number of results to return, starting at 1. Aircall returns meta.next_page_link when more pages exist. Default: 1.default
1 per_pageinteger- Number of templates per page, up to 100. Default: 20.default
20 searchstring- Free-text search across template name and body (case- and accent-insensitive). Example: follow-up
aircall_tag_getGet one call tag by ID.Read-onlyGet Tag
Get one call tag by ID. Returns the tag with id, name, color and description. Use aircall_tag_get when you know the tag ID. Use aircall_tags_list to find tags.
Inputs
tag_idintegerrequired- Unique Aircall ID of the tag. Example: 545
aircall_team_getGet one Aircall team by ID.Read-onlyGet Team
Get one Aircall team by ID. Returns the team with id, name, created_at and its users[]. Use aircall_team_get when you know the team ID. Use aircall_teams_list to find teams.
Inputs
team_idintegerrequired- Unique Aircall ID of the team. Example: 678
aircall_teams_listList the teams in the Aircall company with their members.Read-onlyList Teams
List the teams in the Aircall company with their members. Returns teams[] with id, name, created_at and users[], plus pagination meta. Use aircall_teams_list to find a team_id (for example for aircall_call_transfer). Use aircall_team_get for one team.
Inputs
orderstring- Sort order by creation date: asc (oldest first) or desc (newest first). Default: asc.one of
ascdescdefaultasc pageinteger- Page number of results to return, starting at 1. Aircall returns meta.next_page_link when more pages exist. Default: 1.default
1 per_pageinteger- Number of results per page, between 1 and 50. Default: 20.default
20
aircall_tracker_getGet one Tracker and the calls that currently match its filters.Read-onlyGet Tracker
Get one Tracker and the calls that currently match its filters. Requires the Aircall AI Assist or AI Assist Pro package. Returns the tracker and calls[] with call_id, start_time, duration_seconds and direction, plus meta.next_token for the next page. Use aircall_tracker_get to find calls where tracked keywords came up. Use aircall_trackers_list to find trackers.
Inputs
tracker_idintegerrequired- Unique Aircall ID of the Tracker. Example: 321
agent_idsstring- Only match calls handled by these user IDs, comma-separated. Example: 123,456
directionstring- Only match calls in this direction: inbound or outbound.one of
inboundoutbound end_timeinteger- Only match calls before this time, as a Unix timestamp in milliseconds. Defaults to now and can't be in the future. Example: 1767830400000
limitinteger- Number of matched calls per page, up to 50. Default: 20.default
20 line_idsstring- Only match calls on these number (line) IDs, comma-separated. Example: 673,719
next_tokenstring- Pagination cursor: the meta.next_token value from the previous response.
start_timeinteger- Only match calls after this time, as a Unix timestamp in milliseconds. Defaults to 7 days before end_time. Example: 1767225600000
aircall_trackers_listList the conversation Trackers (keyword and phrase monitors) configured for the company.Read-onlyList Trackers
List the conversation Trackers (keyword and phrase monitors) configured for the company. Requires the Aircall AI Assist or AI Assist Pro package. Returns trackers with id, title, type, filters and query terms. Use aircall_trackers_list to find a tracker_id. Use aircall_tracker_get to see the calls that match a tracker.
Inputs
This tool takes no inputs.
aircall_user_availability_getGet the current detailed availability of one user, as shown in the Dashboard activity feed.Read-onlyGet User Availability
Get the current detailed availability of one user, as shown in the Dashboard activity feed. Returns availability: available, offline, do_not_disturb, in_call or after_call_work. Use aircall_user_availability_get for one user. Use aircall_users_availabilities_list for everyone.
Inputs
user_idintegerrequired- Unique Aircall ID of the user. Example: 456
aircall_user_getGet one Aircall user by user ID or email address.Read-onlyGet User
Get one Aircall user by user ID or email address. Returns the user with id, name, email, availability_status, substatus, time_zone, language and wrap_up_time. Use aircall_user_get when you know the user. Use aircall_users_list to find users.
Inputs
user_idstringrequired- Unique Aircall ID of the user, or the user's email address. Example: 456 or john.doe@example.com
aircall_user_numbers_listList the Aircall phone numbers (lines) a user is assigned to.Read-onlyList User Numbers
List the Aircall phone numbers (lines) a user is assigned to. Returns numbers[] with id, name, digits, country and time_zone. Use aircall_user_numbers_list to find which number_id a user can call from (for aircall_user_call_start). Use aircall_numbers_list for every number in the company.
Inputs
user_idintegerrequired- Unique Aircall ID of the user. Example: 456
orderstring- Sort order by creation date: asc (oldest first) or desc (newest first). Default: asc.one of
ascdescdefaultasc pageinteger- Page number of results to return, starting at 1. Aircall returns meta.next_page_link when more pages exist. Default: 1.default
1 per_pageinteger- Number of results per page, between 1 and 50. Default: 20.default
20
aircall_users_availabilities_listList the current detailed availability of every user in the company.Read-onlyList Users Availabilities
List the current detailed availability of every user in the company. Returns users[] with id and availability (available, offline, do_not_disturb, in_call or after_call_work). Use aircall_users_availabilities_list to see who can take a call now. Use aircall_user_availability_get for a single user.
Inputs
fromstring- Only return users created at or after this time, as a UNIX timestamp in seconds. Example: 1704067200 (2024-01-01).
orderstring- Sort order by creation date: asc (oldest first) or desc (newest first). Default: asc.one of
ascdescdefaultasc pageinteger- Page number of results to return, starting at 1. Aircall returns meta.next_page_link when more pages exist. Default: 1.default
1 per_pageinteger- Number of results per page, between 1 and 50. Default: 20.default
20 tostring- Only return users created at or before this time, as a UNIX timestamp in seconds. Example: 1735689599 (2024-12-31).
aircall_users_listList the users (admins and agents) in the Aircall company, with their availability status, time zone and language.Read-onlyList Users
List the users (admins and agents) in the Aircall company, with their availability status, time zone and language. Returns users[] with id, name, email, available, availability_status and substatus, plus pagination meta. Use aircall_users_list to browse users. Use aircall_user_get for one user by ID or email, and aircall_users_availabilities_list for live availability of every user.
Inputs
fromstring- Only return users created at or after this time, as a UNIX timestamp in seconds. Example: 1704067200 (2024-01-01).
orderstring- Sort order by creation date: asc (oldest first) or desc (newest first). Default: asc.one of
ascdescdefaultasc pageinteger- Page number of results to return, starting at 1. Aircall returns meta.next_page_link when more pages exist. Default: 1.default
1 per_pageinteger- Number of results per page, between 1 and 50. Default: 20.default
20 tostring- Only return users created at or before this time, as a UNIX timestamp in seconds. Example: 1735689599 (2024-12-31).
aircall_whatsapp_status_getGet the WhatsApp registration status of an Aircall number and whether it can send messages.Read-onlyGet WhatsApp Status
Get the WhatsApp registration status of an Aircall number and whether it can send messages. Returns wabaId, status (ONLINE, OFFLINE or NOT_REGISTERED), canSendMessage and business verification details. Use aircall_whatsapp_status_get before aircall_whatsapp_message_send to check the line is ready.
Inputs
number_idintegerrequired- Unique Aircall ID of the number. Example: 673
aircall_whatsapp_templates_listList the WhatsApp message templates of a WhatsApp-registered Aircall number, optionally filtered by status or category.Read-onlyList WhatsApp Templates
List the WhatsApp message templates of a WhatsApp-registered Aircall number, optionally filtered by status or category. Returns templates with their id, name, status, category and components, plus a nextToken for the next page. Use aircall_whatsapp_templates_list to find a template id for aircall_whatsapp_message_send.
Inputs
number_idintegerrequired- Unique Aircall ID of the WhatsApp-capable number. Example: 673
categorystring- Only return templates in this category.one of
UTILITYMARKETINGAUTHENTICATION limitinteger- Maximum number of templates to return per page. Example: 20
sortstring- Sort direction: asc or desc.one of
ascdesc statusstring- Only return templates with this approval status.one of
APPROVEDREJECTEDPAUSEDFLAGGEDPENDING_DELETION tokeninteger- Pagination cursor: the nextToken value from the previous response. Example: 20
aircall_ai_voice_agent_call_triggerAsk an Aircall Outbound AI Voice Agent to call a contact, for example for an appointment reminder or a follow-up.WriteTrigger AI Voice Agent Call
Ask an Aircall Outbound AI Voice Agent to call a contact, for example for an appointment reminder or a follow-up. The request is queued and placed when a calling slot is free. Returns id, idempotency_key, status (PENDING) and virtual_agent_id (HTTP 202). Use aircall_ai_voice_agent_call_trigger for AI-placed calls. Use aircall_user_call_start for a call placed by a human user. The agent must be configured in the Aircall Dashboard with a phone number and a first message.
Inputs
agent_idstringrequired- ID of the Outbound Voice Agent, from the Outbound Call Workflow tab of the agent's configuration page. Example: agent-abc123
contact_phonestringrequired- Phone number to call, with country code. A leading + is optional. Example: +15551234567
idempotency_keystringrequired- Unique key for this call request; sending the same key twice won't create a second call. Use a new key for every retry. Example: appt-reminder-2026-03-15-cust-12345
contextobject- Values for the {{variable}} placeholders in the agent's first message, voicemail message and guidelines. Every variable in the first message and voicemail message must be present. Add a timezone key (IANA, such as America/New_York) when a value is a UTC datetime. Example: {"first_name": "Jane", "appointment_date": "March 20th at 2:00 PM"}
expiration_secondsinteger- How long, in seconds, to keep trying to place the call if the concurrency limit is reached: 60 to 86400. Default: 3600.default
3600
aircall_analytics_export_createStart an asynchronous Analytics report export (CSV), such as the call history or user status history for a date range.WriteCreate Analytics Export
Start an asynchronous Analytics report export (CSV), such as the call history or user status history for a date range. Requires the Analytics+ entitlement. Returns exportID, createdAt and status (PENDING). Use aircall_analytics_export_create to request a report, then poll aircall_analytics_export_get with the exportID until it is COMPLETED.
Inputs
filterobjectrequired- Report filters. Required: timezone (IANA, such as Europe/Paris) and dateFilter with exactly one of relative (LAST_MONTH, LAST_WEEK, THIS_MONTH, THIS_WEEK, TODAY or YESTERDAY) or absoluteRange (fromDate and toDate as YYYY-MM-DD). Optional array filters include userIDs, teamIDs, lineIDs, tagIDs, callIDs and customerNumbers (always arrays, even for one value), plus callTypes, duration, hours and voicemail or AI flags. Example: {"timezone": "Europe/Paris", "dateFilter": {"absoluteRange": {"fromDate": "2026-05-01", "toDate": "2026-05-15"}}, "teamIDs": [4242]}
report_namestringrequired- Report to export. CALLS_HISTORY is the raw call log; USER_STATUS_HISTORY is raw status changes; USER_ACTIVITY_* reports aggregate per user.one of
CALLS_HISTORYUSER_STATUS_HISTORYUSER_ACTIVITY_AVAILABILITY_BREAKDOWNUSER_ACTIVITY_AVERAGE_AFTER_CALL_WORK_TIME_PER_USERUSER_ACTIVITY_AVERAGE_INBOUND_IN_CALL_TIME_PER_USERUSER_ACTIVITY_AVERAGE_OUTBOUND_IN_CALL_TIME_PER_USERUSER_ACTIVITY_CALL_VOLUME_AND_TIMEUSER_ACTIVITY_CALLS_HANDLEDUSER_ACTIVITY_PERCENTAGE_OF_TIME_IN_EACH_STATUSUSER_ACTIVITY_RINGING_ATTEMPTS_PER_USERUSER_ACTIVITY_WORK_TIME_AND_AVAILABILITYUSER_ACTIVITY_RINGING_ATTEMPTS export_optionsobject- File options: format (only CSV is supported) and exportName, a name echoed back on retrieve. Example: {"format": "CSV", "exportName": "calls-history-may-2026"}
optionsobject- Report options: dateBreakdown (HOURLY, DAILY, WEEKLY or MONTHLY) for USER_ACTIVITY_* reports, and SLA settings slaTimeToAnswerInSeconds and slaIncludedCallUnansweredReasons for call-based metrics. Example: {"dateBreakdown": "DAILY", "slaTimeToAnswerInSeconds": 20}
aircall_call_comment_createAdd a comment (note) to a call.WriteComment on Call
Add a comment (note) to a call. A call holds at most five comments, and comments can't be edited or deleted afterwards. Returns HTTP 201 when the comment is added. Use aircall_call_comment_create to log a note on a call. Use aircall_call_tags_add to categorize the call instead.
Inputs
call_idintegerrequired- Unique Aircall ID of the call. Example: 812
contentstringrequired- Text of the comment. Emojis are removed. Example: Please call back this customer.
aircall_call_insight_card_createShow an Insight Card with custom data to the agent in Aircall Workspace during an ongoing call.WriteCreate Call Insight Card
Show an Insight Card with custom data to the agent in Aircall Workspace during an ongoing call. Cards are not stored after the call ends. Returns HTTP 201 when the card is displayed. Use aircall_call_insight_card_create to surface CRM context (account, owner, links) to the agent on a live call. The payload must be under 10 KB.
Inputs
call_idintegerrequired- Unique Aircall ID of the ongoing call. Example: 812
contentsarrayrequired- Lines of the Insight Card, in display order. Each line has a type: title (a large heading with text and an optional link), shortText (a line with text, an optional label and an optional link) or user (a user card with a label and a user_id). Example: [{"type": "title", "text": "My CRM", "link": "https://crm.example.com"}, {"type": "shortText", "label": "Account ID", "text": "6789"}, {"type": "user", "label": "Account Owner", "user_id": 12345}]
aircall_call_recording_pausePause live recording on an ongoing call.WritePause Call Recording
Pause live recording on an ongoing call. Returns no content (HTTP 204) when recording is paused. Use aircall_call_recording_pause during a call, for example before sensitive details are shared. Use aircall_call_recording_resume to start recording again.
Inputs
call_idintegerrequired- Unique Aircall ID of the ongoing call. Example: 812
aircall_call_recording_resumeResume live recording on an ongoing call after it was paused.WriteResume Call Recording
Resume live recording on an ongoing call after it was paused. Returns no content (HTTP 204) when recording resumes. Use aircall_call_recording_resume after aircall_call_recording_pause.
Inputs
call_idintegerrequired- Unique Aircall ID of the ongoing call. Example: 812
aircall_call_transferTransfer an ongoing call to a user, a team, or an external phone number.WriteTransfer Call
Transfer an ongoing call to a user, a team, or an external phone number. Returns no content (HTTP 204) when the transfer starts. Use aircall_call_transfer on a live call. Set exactly one of user_id, team_id or number. External-number transfers only work for inbound calls that have not been answered yet.
Inputs
call_idintegerrequired- Unique Aircall ID of the ongoing call. Example: 812
dispatching_strategystring- How a team transfer rings team members: simultaneous (everyone at once, the default), random (one by one in random order) or longest_idle (one by one, longest idle first). Only valid with team_id.one of
simultaneousrandomlongest_idle numberstring- External phone number to transfer the call to, in E.164 format. Only works for unanswered inbound calls. Set only one of user_id, team_id or number. Example: +18001231234
team_idstring- ID of the team to transfer the call to. Set only one of user_id, team_id or number. Example: 678
user_idstring- ID of the user to transfer the call to. Set only one of user_id, team_id or number. Example: 456
aircall_campaign_contacts_addAdd up to 100 contacts to an Outbound Campaign and queue them for dialing.WriteAdd Campaign Contacts
Add up to 100 contacts to an Outbound Campaign and queue them for dialing. Safe to retry: numbers already in the campaign are reported, not added twice. Returns queued_count, rejected_count and contacts[] (one result per submitted contact, in the same order) with status and, if rejected, reason. Use aircall_campaign_contacts_add to feed contacts into a campaign. Use aircall_campaign_contact_remove to take one out.
Inputs
campaign_idstringrequired- UUID of the Outbound Campaign, as returned by aircall_campaigns_list. Example: 019f3614-18e7-7b49-aef3-93159c4ed9e3
contactsarrayrequired- Contacts to add, 1 to 100. Each needs a phone_number. Human-agent campaigns also accept first_name, last_name, email, company_name and note; AI Voice Agent campaigns accept aiva_variables (string keys to string values) instead. Example: [{"phone_number": "+13105550123", "first_name": "Gary", "last_name": "Jennings"}]
country_codestringrequired- ISO 3166-1 alpha-2 country used to read numbers written in national format. A wrong country silently produces numbers in another country. Example: US
positionstring- Where the contacts go in the existing queue: bottom (default) or top (ahead of everyone waiting).one of
topbottomdefaultbottom
aircall_campaign_launchLaunch a draft Outbound Campaign: build its call queue and start dialing.WriteLaunch Campaign
Launch a draft Outbound Campaign: build its call queue and start dialing. Returns the campaign with status in_progress. Use aircall_campaign_launch once, on a draft campaign. Use aircall_campaign_resume for a paused one. You must set compliance_acknowledged to true.
Inputs
campaign_idstringrequired- UUID of the Outbound Campaign, as returned by aircall_campaigns_list. Example: 019f3614-18e7-7b49-aef3-93159c4ed9e3
compliance_acknowledgedbooleanrequired- Must be true. Confirms your company has the right to call every contact in the campaign and accepts responsibility for consent, do-not-call rules and calling hours.one of
true
aircall_campaign_pausePause an in-progress Outbound Campaign.WritePause Campaign
Pause an in-progress Outbound Campaign. New attempts stop; calls already in progress finish. Returns the campaign with status paused. Use aircall_campaign_pause to stop dialing temporarily. Use aircall_campaign_resume to restart.
Inputs
campaign_idstringrequired- UUID of the Outbound Campaign, as returned by aircall_campaigns_list. Example: 019f3614-18e7-7b49-aef3-93159c4ed9e3
aircall_campaign_resumeResume a paused Outbound Campaign.WriteResume Campaign
Resume a paused Outbound Campaign. Returns the campaign with status in_progress. Use aircall_campaign_resume after aircall_campaign_pause. Use aircall_campaign_launch for a draft campaign.
Inputs
campaign_idstringrequired- UUID of the Outbound Campaign, as returned by aircall_campaigns_list. Example: 019f3614-18e7-7b49-aef3-93159c4ed9e3
aircall_contact_createCreate a shared contact in Aircall with at least one phone number.WriteCreate Contact
Create a shared contact in Aircall with at least one phone number. Sending the same payload twice creates a duplicate. Returns the new contact with its id and the ids of its phone numbers and emails. Use aircall_contact_create for a new contact. Use aircall_contacts_search first to avoid duplicates, and aircall_contact_update to change an existing one.
Inputs
phone_numbersarrayrequired- The contact's phone numbers (at least one, at most 20). Each item needs a label (such as Work or Mobile) and a value (the phone number). Example: [{"label": "Work", "value": "+19001112222"}]
company_namestring- The contact's company name, up to 255 characters. Example: Acme Corp
emailsarray- The contact's email addresses (at most 20). Each item needs a label (such as Office) and a value (the email address). Example: [{"label": "Office", "value": "gary.jennings@example.com"}]
first_namestring- The contact's first name, up to 255 characters. Example: Gary
informationstring- Extra free-text information about the contact, for example an external CRM ID. Example: external_custom_id:87123
last_namestring- The contact's last name, up to 255 characters. Example: Jennings
aircall_contact_email_addAdd an email address to a contact (at most 20 per contact).WriteAdd Contact Email
Add an email address to a contact (at most 20 per contact). Returns the created email with its id. Use aircall_contact_email_add to add an email. Use aircall_contact_email_update to change an existing one.
Inputs
contact_idintegerrequired- Unique Aircall ID of the contact. Example: 719
valuestringrequired- The email address. Example: gary.jennings@example.com
labelstring- Label for the email, such as Office or Personal. Example: Office
aircall_contact_email_updateUpdate one of a contact's email addresses.WriteUpdate Contact Email
Update one of a contact's email addresses. The value must be sent every time. Returns the updated email. Use aircall_contact_email_update to change an email. Get email_id from aircall_contact_get.
- Idempotent
Inputs
contact_idintegerrequired- Unique Aircall ID of the contact. Example: 719
email_idintegerrequired- Unique Aircall ID of the contact email (from the contact's emails[].id). Example: 9170
valuestringrequired- The email address, sent every time. Example: gary.jennings@example.com
labelstring- Label for the email, such as Office or Personal. Example: Office
aircall_contact_phone_number_addAdd a phone number to a contact (at most 20 per contact).WriteAdd Contact Phone Number
Add a phone number to a contact (at most 20 per contact). The number is normalized before it is stored. Returns the created phone number with its id. Use aircall_contact_phone_number_add to add a number. Use aircall_contact_phone_number_update to change an existing one.
Inputs
contact_idintegerrequired- Unique Aircall ID of the contact. Example: 719
valuestringrequired- The phone number. It should be a valid number so agents can dial it. Example: +19001112222
labelstring- Label for the number, such as Work, Mobile or Home. Example: Mobile
aircall_contact_phone_number_updateUpdate one of a contact's phone numbers.WriteUpdate Contact Phone Number
Update one of a contact's phone numbers. The value must be sent every time. Returns the updated phone number. Use aircall_contact_phone_number_update to change a number. Get phone_number_id from aircall_contact_get.
- Idempotent
Inputs
contact_idintegerrequired- Unique Aircall ID of the contact. Example: 719
phone_number_idintegerrequired- Unique Aircall ID of the contact phone number (from the contact's phone_numbers[].id). Example: 9171
valuestringrequired- The phone number, sent every time. Example: +19001112222
labelstring- Label for the number, such as Work, Mobile or Home. Example: Work
aircall_contact_updateUpdate a shared contact's name, company or information.WriteUpdate Contact
Update a shared contact's name, company or information. Only the fields you send change. Returns the updated contact. Use aircall_contact_update for name and company fields. Use aircall_contact_phone_number_add / aircall_contact_phone_number_update and aircall_contact_email_add / aircall_contact_email_update to change phone numbers and emails.
Inputs
contact_idintegerrequired- Unique Aircall ID of the contact. Example: 719
company_namestring- New company name. Can't be blank. Example: Acme Corp
first_namestring- New first name. Can't be blank. Example: Gary
informationstring- New free-text information. Can't be blank. Example: external_custom_id:87123
last_namestring- New last name. Can't be blank. Example: Jennings
aircall_dialer_campaign_createCreate an active Power Dialer campaign for a user with a list of phone numbers to call.WriteCreate Dialer Campaign
Create an active Power Dialer campaign for a user with a list of phone numbers to call. A user can have only one active campaign. Returns no content (HTTP 204) when the campaign is created. Use aircall_dialer_campaign_create to queue numbers for one agent. Use aircall_dialer_campaign_phone_numbers_add to add to an existing campaign.
Inputs
phone_numbersarrayrequired- Phone numbers to call, at least one valid number. Example: ["+19161112222", "+18001112222"]
user_idintegerrequired- Unique Aircall ID of the user. Example: 456
aircall_dialer_campaign_phone_numbers_addAdd phone numbers to a user's active Power Dialer campaign.WriteAdd Dialer Campaign Phone Numbers
Add phone numbers to a user's active Power Dialer campaign. They are appended in Aircall Workspace. Returns no content (HTTP 204) when the numbers are added. Use aircall_dialer_campaign_phone_numbers_add for an existing campaign. Use aircall_dialer_campaign_create when the user has none.
Inputs
phone_numbersarrayrequired- Phone numbers to add, at least one valid number. Example: ["+19161112222"]
user_idintegerrequired- Unique Aircall ID of the user. Example: 456
aircall_group_message_sendSend a group SMS from an SMS-capable Aircall number into a group conversation in the agents' inbox, creating it if needed.WriteSend Group Message
Send a group SMS from an SMS-capable Aircall number into a group conversation in the agents' inbox, creating it if needed. Up to 10 participants including the sender. Returns the message with id, status, participants, body and timestamps. Use aircall_group_message_send for a group thread. Use aircall_message_send for one recipient.
Inputs
bodystringrequired- Text of the message, up to 1600 characters. Example: Hi all, here is the meeting link.
number_idintegerrequired- Unique Aircall ID of the SMS-capable number to send from. Example: 673
participantsarrayrequired- Phone numbers to include in the group conversation, in E.164 format (up to 9 besides the sender). Example: ["+13105550123", "+13105550124"]
agent_idinteger- ID of the user to attribute the message to. Example: 456
aircall_message_sendSend an SMS from an SMS-capable Aircall number into the agents' conversation inbox, creating the conversation if needed.WriteSend Message
Send an SMS from an SMS-capable Aircall number into the agents' conversation inbox, creating the conversation if needed. Agents on the number can see it and continue the conversation. Returns the message with id, status, direction, raw_digits, body and timestamps. Use aircall_message_send for one-to-one conversational SMS. Use aircall_group_message_send for a group conversation and aircall_whatsapp_message_send for WhatsApp. Not for high-volume sending.
Inputs
bodystringrequired- Text of the message, up to 1600 characters. Example: Hi, thanks for your call today!
number_idintegerrequired- Unique Aircall ID of the SMS-capable number to send from. Example: 673
tostringrequired- Recipient phone number in E.164 format. Example: +13105550123
agent_idinteger- ID of the user to attribute the message to. Example: 456
aircall_number_updateUpdate an Aircall number's name, call recording setting or priority.WriteUpdate Number
Update an Aircall number's name, call recording setting or priority. Only the fields you send change. Returns the updated number. Use aircall_number_update to rename a line or turn call recording on or off.
- Idempotent
Inputs
number_idintegerrequired- Unique Aircall ID of the number. Example: 673
live_recording_activatedboolean- Set to true to record calls on this number (inbound and outbound), or false to stop.
namestring- New name for the number. Can't be empty. Example: French Office
priorityinteger- Routing priority of the number: 0 (no priority) or 1 (top priority).one of
01
aircall_tag_createCreate a call tag with a unique name and a color.WriteCreate Tag
Create a call tag with a unique name and a color. Returns the new tag with its id. Use aircall_tag_create when the tag doesn't exist yet. Use aircall_tags_list first to check, and aircall_call_tags_add to apply it to a call.
Inputs
colorstringrequired- Tag color as a hexadecimal code. Example: #00B388
namestringrequired- Tag name. Must be unique in the company. Example: Follow-up
aircall_tag_updateRename or recolor a call tag.WriteUpdate Tag
Rename or recolor a call tag. Aircall requires both name and color on every update. Returns the updated tag. Use aircall_tag_update to change a tag. Use aircall_tag_create for a new one.
- Idempotent
Inputs
colorstringrequired- Tag color as a hexadecimal code. Example: #00B388
namestringrequired- Tag name. Must be unique in the company. Example: Follow-up
tag_idintegerrequired- Unique Aircall ID of the tag. Example: 545
aircall_user_call_startStart an outbound call from a user's Aircall Workspace (click-to-call) to a phone number, using one of the user's Aircall numbers.WriteStart Outbound Call
Start an outbound call from a user's Aircall Workspace (click-to-call) to a phone number, using one of the user's Aircall numbers. Returns no content (HTTP 204) when the call starts. Use aircall_user_call_start to place the call immediately. Use aircall_user_dial to only pre-fill the number and let the user press call. The user must be available, not on a call, using Aircall Workspace on desktop, and assigned to the number. Run aircall_user_numbers_list first to get a number_id the user can call from.
Inputs
number_idintegerrequired- ID of the Aircall number to call from. The user must be assigned to it and it must be active. Get it from aircall_user_numbers_list. Example: 673
tostringrequired- Phone number to call, in E.164 format. Example: +18001231234
user_idintegerrequired- Unique Aircall ID of the user who places the call. Example: 456
aircall_user_dialPre-fill a phone number in a user's Aircall Workspace dialer (click-to-dial) so they can start the call and pick the number to call from.WriteDial Number in Workspace
Pre-fill a phone number in a user's Aircall Workspace dialer (click-to-dial) so they can start the call and pick the number to call from. Returns no content (HTTP 204) when the dialer is filled. Use aircall_user_dial to let the user confirm the call. Use aircall_user_call_start to place it right away. The user must be available, not on a call, and using Aircall Workspace on desktop.
Inputs
tostringrequired- Phone number to dial, in E.164 format. Example: +18001231234
user_idintegerrequired- Unique Aircall ID of the user whose dialer is filled. Example: 456
aircall_whatsapp_message_sendSend a WhatsApp text or template message from a WhatsApp-capable Aircall number into the agents' conversation inbox.WriteSend WhatsApp Message
Send a WhatsApp text or template message from a WhatsApp-capable Aircall number into the agents' conversation inbox. Returns the message with id, status, direction, raw_digits, body and timestamps. Use aircall_whatsapp_message_send for WhatsApp. Set text inside an open 24-hour conversation window, or template_params to start or re-open one (get template IDs from aircall_whatsapp_templates_list). Use aircall_message_send for SMS.
Inputs
external_numberstringrequired- Recipient phone number in E.164 format. Example: +13105550123
line_idintegerrequired- ID of the WhatsApp-capable Aircall number to send from. Example: 673
agent_idinteger- ID of the user to attribute the message to. Example: 456
template_paramsobject- Template to send instead of text: the template id, plus optional body and buttons arrays of key/value substitutions and an optional header object. Set either text or template_params, not both. Example: {"id": "1234", "body": [{"key": "{{1}}", "value": "Jordan"}]}
textstring- Text of the message, up to 4096 characters. Only works inside an open 24-hour conversation window. Set either text or template_params, not both. Example: Your order has shipped.
aircall_campaign_contact_removeRemove a contact from an Outbound Campaign so it won't be dialed.DestructiveRemove Campaign Contact
Remove a contact from an Outbound Campaign so it won't be dialed. A contact with no attempts is deleted; one with attempts has its remaining retries cancelled. Returns no content (HTTP 204) when the contact is removed. Use aircall_campaign_contact_remove to undo aircall_campaign_contacts_add for one number.
- Idempotent
Inputs
campaign_idstringrequired- UUID of the Outbound Campaign, as returned by aircall_campaigns_list. Example: 019f3614-18e7-7b49-aef3-93159c4ed9e3
phone_numberstringrequired- The contact's phone number in international format as digits without the leading +, as returned by aircall_campaign_contacts_list. Example: 33612345678
aircall_contact_deleteDelete a shared contact from the company.DestructiveDelete Contact
Delete a shared contact from the company. This can't be undone. Returns no content (HTTP 204) when the contact is deleted. Use aircall_contact_delete to remove a contact entirely. Use aircall_contact_phone_number_delete or aircall_contact_email_delete to remove one detail.
- Idempotent
Inputs
contact_idintegerrequired- Unique Aircall ID of the contact to delete. Example: 719
aircall_contact_email_deleteRemove one email address from a contact.DestructiveDelete Contact Email
Remove one email address from a contact. Returns no content (HTTP 204) when the email is removed. Use aircall_contact_email_delete to remove an email. Get email_id from aircall_contact_get.
- Idempotent
Inputs
contact_idintegerrequired- Unique Aircall ID of the contact. Example: 719
email_idintegerrequired- Unique Aircall ID of the contact email (from the contact's emails[].id). Example: 9170
aircall_contact_phone_number_deleteRemove one phone number from a contact.DestructiveDelete Contact Phone Number
Remove one phone number from a contact. Returns no content (HTTP 204) when the number is removed. Use aircall_contact_phone_number_delete to remove a number. Get phone_number_id from aircall_contact_get.
- Idempotent
Inputs
contact_idintegerrequired- Unique Aircall ID of the contact. Example: 719
phone_number_idintegerrequired- Unique Aircall ID of the contact phone number (from the contact's phone_numbers[].id). Example: 9171
aircall_dialer_campaign_deleteDelete a user's active Power Dialer campaign and all of its phone numbers.DestructiveDelete Dialer Campaign
Delete a user's active Power Dialer campaign and all of its phone numbers. Returns no content (HTTP 204) when the campaign is deleted. Use aircall_dialer_campaign_delete to clear a campaign. Use aircall_dialer_campaign_phone_number_delete to remove one number.
- Idempotent
Inputs
user_idintegerrequired- Unique Aircall ID of the user. Example: 456
aircall_dialer_campaign_phone_number_deleteRemove one phone number from a user's active Power Dialer campaign.DestructiveDelete Dialer Campaign Phone Number
Remove one phone number from a user's active Power Dialer campaign. Returns no content (HTTP 204) when the number is removed. Use aircall_dialer_campaign_phone_number_delete to drop one number. Get its id from aircall_dialer_campaign_phone_numbers_list.
- Idempotent
Inputs
phone_number_idintegerrequired- Unique Aircall ID of the campaign phone number (from aircall_dialer_campaign_phone_numbers_list). Example: 4671488
user_idintegerrequired- Unique Aircall ID of the user. Example: 456
aircall_tag_deleteDelete a call tag.DestructiveDelete Tag
Delete a call tag. The tag is also removed from every call that has it. Returns no content (HTTP 204) when the tag is deleted. Use aircall_tag_delete to retire a tag everywhere.
- Idempotent
Inputs
tag_idintegerrequired- Unique Aircall ID of the tag to delete. Example: 545
No tools match.
