The Dialpad connector lets your AI agent act in each user's Dialpad account. Each user signs in to Dialpad once, and Scalekit stores and refreshes their tokens, so your agent never handles credentials. It comes with 112 tools.
- Tools
- 112
- What they doRead · write · destructive
- 68 · 42 · 268 read42 write2 destructive
- Users sign in with
- OAuth
- OAuth app
- Your own Dialpad 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 Dialpad connection
In AgentKit > Connections, create a Dialpad connection and copy its redirect URI. The name you give it is the
connection_nameyour code passes. See Configure connections.Register an OAuth app
Dialpad connections use your own OAuth app. Register one with Dialpad and add the redirect URI you copied.
Then enter the app's Client ID and Client Secret on the Dialpad 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 = 'dialpad'const identifier = 'user_123'// Generate an authorization link for the userconst { link } = await actions.getAuthorizationLink({ connectionName: connector, identifier })console.log('Authorize Dialpad:', 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: 'dialpad_blocked_numbers_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 = "dialpad"identifier = "user_123"# Generate an authorization link for the userlink_response = actions.get_authorization_link(connection_name=connection_name,identifier=identifier,)print("Authorize Dialpad:", link_response.link)input("Press Enter after authorizing...")# Make your first callresult = actions.execute_tool(tool_input={},tool_name="dialpad_blocked_numbers_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_tooldialpad_agent_group_getGet one Dialpad agent group by ID.Read-onlyGet Agent Group
Get one Dialpad agent group by ID. Returns the agent group's details. Use dialpad_agent_group_get when you already have the agent group ID. Requires the agent_groups:read scope on the connection.
Inputs
agent_group_idstringrequired- The agent group ID. Example: 5719029487116288
dialpad_blocked_number_getCheck whether one phone number is blocked company-wide in Dialpad.Read-onlyGet Blocked Number
Check whether one phone number is blocked company-wide in Dialpad. Returns the number if it is blocked; responds 404 if it is not blocked or was blocked outside the API. Use dialpad_blocked_number_get for a single check. Use dialpad_blocked_numbers_list to see all.
Inputs
numberstringrequired- The phone number to check, in E.164 format. Example: +14155550123
dialpad_blocked_numbers_listList the phone numbers blocked company-wide through the Dialpad API.Read-onlyList Blocked Numbers
List the phone numbers blocked company-wide through the Dialpad API. Returns a page of blocked numbers and a cursor. Numbers blocked in the app are not included. Use dialpad_blocked_numbers_list to review blocks. Use dialpad_blocked_number_get to check one number.
Inputs
cursorstring- A token used to return the next page of a previous request. Use the cursor provided in the previous response. Example: Cg8KBG5hbWUSBxoFamFuZQ
dialpad_call_ai_recap_getGet the Dialpad AI Recap (AI-generated summary) of a call in short, medium, long or bullet format.Read-onlyGet Call AI Recap
Get the Dialpad AI Recap (AI-generated summary) of a call in short, medium, long or bullet format. Returns the recap text and action items for the call. Use dialpad_call_ai_recap_get for a summary. Use dialpad_transcript_get for the word-for-word transcript. Requires the ai_recap scope on the connection.
Inputs
call_idintegerrequired- The Dialpad call ID, from dialpad_calls_list or a call event. Example: 5719029487116288
summary_formatstring- Length/format of the recap: short, medium, long or bullet. Defaults to medium. One of: bullet, long, medium, short.one of
bulletlongmediumshortdefaultmedium
dialpad_call_assigned_operators_listList the operators assigned to a call waiting in a Dialpad contact center queue.Read-onlyList Assigned Call Operators
List the operators assigned to a call waiting in a Dialpad contact center queue. Returns the assigned operators. Use dialpad_call_assigned_operators_list after dialpad_call_operator_assign or dialpad_call_operator_unassign.
Inputs
call_idintegerrequired- The Dialpad call ID, from dialpad_calls_list or a call event. Example: 5719029487116288
dialpad_call_getGet the details of one Dialpad call by call ID.Read-onlyGet Call
Get the details of one Dialpad call by call ID. Returns direction, participants, duration, recording URLs, CSAT, voicemail data, transcription text and routing breadcrumbs. Use dialpad_call_get for one call's details. Use dialpad_transcript_get for the full AI transcript and dialpad_call_ai_recap_get for the AI summary.
Inputs
call_idintegerrequired- The Dialpad call ID, from dialpad_calls_list or a call event. Example: 5719029487116288
dialpad_call_labels_listList the call labels defined for the Dialpad company.Read-onlyList Call Labels
List the call labels defined for the Dialpad company. Returns the label names. Use dialpad_call_labels_list before dialpad_call_labels_add to pick existing labels.
Inputs
limitinteger- Maximum number of labels to return. Defaults to 1000.default
1000
dialpad_call_router_getGet one Dialpad API call router by ID.Read-onlyGet Call Router
Get one Dialpad API call router by ID. Returns its name, routing URL, default target, office and state. Use dialpad_call_router_get when you have the ID. Use dialpad_call_routers_list to find it.
Inputs
call_router_idintegerrequired- The API call router ID, from dialpad_call_routers_list. Example: 5719029487116288
dialpad_call_routers_listList the API call routers in the Dialpad company or one office.Read-onlyList Call Routers
List the API call routers in the Dialpad company or one office. Returns a page of call routers (id, name, routing URL, default target, state) and a cursor. Use dialpad_call_routers_list to find router IDs. Use dialpad_call_router_get for one router.
Inputs
cursorstring- A token used to return the next page of a previous request. Use the cursor provided in the previous response. Example: Cg8KBG5hbWUSBxoFamFuZQ
office_idinteger- The office's id. Example: 5719029487116288
dialpad_callbacks_listList callback requests waiting in a Dialpad call center queue, oldest first.Read-onlyList Callbacks
List callback requests waiting in a Dialpad call center queue, oldest first. Returns each callback's number, queued time, status (queued or timed_out) and queue position, plus a cursor. Use dialpad_callbacks_list to review the queue. Use dialpad_callback_enqueue to add one. Requires admin rights on that call center.
Inputs
call_center_idintegerrequired- The call center ID to query. Required. Example: 5719029487116288
cursorstring- A token used to return the next page of results. Example: Cg8KBG5hbWUSBxoFamFuZQ
limitinteger- Maximum results per page (default: 20, max: 100).default
20
dialpad_callcenter_getGet one Dialpad call center by ID.Read-onlyGet Call Center
Get one Dialpad call center by ID. Returns its name, office, phone numbers, hours, routing and queue settings. Use dialpad_callcenter_get for configuration. Use dialpad_callcenter_status_get for live availability and queue numbers.
Inputs
call_center_idintegerrequired- The call center ID, from dialpad_callcenters_list. Example: 5719029487116288
dialpad_callcenter_operators_listList the operators (users and rooms) assigned to a Dialpad call center.Read-onlyList Call Center Operators
List the operators (users and rooms) assigned to a Dialpad call center. Returns operator names, roles and on-duty status. Use dialpad_callcenter_operators_list to see who is in the call center. Use dialpad_operator_duty_status_get for one operator's duty status.
Inputs
call_center_idintegerrequired- The call center ID, from dialpad_callcenters_list. Example: 5719029487116288
dialpad_callcenter_status_getGet live metrics for a Dialpad call center.Read-onlyGet Call Center Status
Get live metrics for a Dialpad call center. Returns availability status, available and on-duty operator counts, pending calls and the longest current wait time. Use dialpad_callcenter_status_get for real-time queue health. Use dialpad_callcenter_get for configuration.
Inputs
call_center_idintegerrequired- The call center ID, from dialpad_callcenters_list. Example: 5719029487116288
dialpad_callcenters_listList Dialpad call centers in the company, optionally filtered by office or by a name substring.Read-onlyList Call Centers
List Dialpad call centers in the company, optionally filtered by office or by a name substring. Returns a page of call centers (id, name, office, numbers, settings) and a cursor. Use dialpad_callcenters_list to find call center IDs. Use dialpad_callcenter_get for one call center and dialpad_callcenter_status_get for live queue metrics.
Inputs
cursorstring- A token used to return the next page of a previous request. Use the cursor provided in the previous response. Example: Cg8KBG5hbWUSBxoFamFuZQ
include_alertsboolean- Set to false to leave service-level alert settings out of the response. Defaults to true.default
true name_searchstring- Return call centers whose name contains this text. Example: Support
office_idinteger- search call center by office. Example: 5719029487116288
dialpad_calls_listList concluded Dialpad calls, most recent first, optionally filtered by start time and by a target (user, office, department, call center and so on).Read-onlyList Calls
List concluded Dialpad calls, most recent first, optionally filtered by start time and by a target (user, office, department, call center and so on). Returns a page of call records (call ID, direction, numbers, duration, state, target) and a cursor. Use dialpad_calls_list to browse call history. Use dialpad_call_get for full details of one call. Requires the calls:list scope on the connection.
Inputs
cursorstring- A token used to return the next page of a previous request. Use the cursor provided in the previous response. Example: Cg8KBG5hbWUSBxoFamFuZQ
include_anonymizedboolean- If set to true, includes call records that have been anonymized (e.g., calls associated with deleted users). Defaults to false.default
false started_afterinteger- Only include calls that started after this time, as a UTC Unix timestamp in milliseconds. Example: 1735689600000
started_beforeinteger- Only include calls that started before this time, as a UTC Unix timestamp in milliseconds. Example: 1738368000000
target_idinteger- ID of a user, office, department, call center or other target to filter calls by. Must be sent with target_type. Defaults to the whole company for admins and to the authorized user otherwise. Example: 5719029487116288
target_typestring- Type of the target given in target_id. Required when target_id is set. One of: callcenter, callrouter, channel, coachinggroup, coachingteam, department, office, room, staffgroup, unknown, user.one of
callcentercallrouterchannelcoachinggroupcoachingteamdepartmentofficeroomstaffgroupunknownuser
dialpad_channel_getGet one Dialpad channel by ID.Read-onlyGet Channel
Get one Dialpad channel by ID. Returns the channel's name, hashtag, description and privacy type. Use dialpad_channel_get when you have the channel ID. The hashtag can be passed to dialpad_sms_send as channel_hashtag.
Inputs
channel_idintegerrequired- The channel ID, from dialpad_channels_list. Example: 5719029487116288
dialpad_channel_members_listList the members of a Dialpad channel.Read-onlyList Channel Members
List the members of a Dialpad channel. Returns a page of members (user ID and name) and a cursor. Use dialpad_channel_members_list to see who is in a channel. Use dialpad_channel_member_add or dialpad_channel_member_remove to change it.
Inputs
channel_idintegerrequired- The channel ID, from dialpad_channels_list. Example: 5719029487116288
cursorstring- A token used to return the next page of a previous request. Use the cursor provided in the previous response. Example: Cg8KBG5hbWUSBxoFamFuZQ
dialpad_channels_listList Dialpad channels (team messaging channels) in the company.Read-onlyList Channels
List Dialpad channels (team messaging channels) in the company. Returns a page of channels (id, name, hashtag, privacy) and a cursor. Use dialpad_channels_list to find a channel ID or hashtag. Use dialpad_channel_get for one channel.
Inputs
cursorstring- A token used to return the next page of a previous request. Use the cursor provided in the previous response. Example: Cg8KBG5hbWUSBxoFamFuZQ
statestring- Channel state to list. Defaults to active.default
active
dialpad_coaching_team_getGet one Dialpad coaching team by ID.Read-onlyGet Coaching Team
Get one Dialpad coaching team by ID. Returns the team's name, office and settings. Use dialpad_coaching_team_get for team details. Use dialpad_coaching_team_members_list for its coaches and trainees.
Inputs
coaching_team_idintegerrequired- The coaching team ID, from dialpad_coaching_teams_list. Example: 5719029487116288
dialpad_coaching_team_members_listList the members of a Dialpad coaching team, optionally filtered by role (coach or trainee) or availability.Read-onlyList Coaching Team Members
List the members of a Dialpad coaching team, optionally filtered by role (coach or trainee) or availability. Returns each member's role, contact info and availability. Use dialpad_coaching_team_members_list for membership. Use dialpad_coaching_team_get for team details.
Inputs
coaching_team_idintegerrequired- The coaching team ID, from dialpad_coaching_teams_list. Example: 5719029487116288
availableboolean- Filter members by availability. Example: true
rolestring- Only return members with this role: coach or trainee. One of: coach, trainee.one of
coachtrainee
dialpad_coaching_teams_listList Dialpad coaching teams in the company, optionally filtered by office or by a name substring.Read-onlyList Coaching Teams
List Dialpad coaching teams in the company, optionally filtered by office or by a name substring. Returns a page of coaching teams and a cursor. Use dialpad_coaching_teams_list to find team IDs. Use dialpad_coaching_team_get for one team and dialpad_coaching_team_members_list for its members.
Inputs
cursorstring- A token used to return the next page of a previous request. Use the cursor provided in the previous response. Example: Cg8KBG5hbWUSBxoFamFuZQ
name_searchstring- Return coaching teams whose name contains this text. Example: Sales
office_idinteger- Filter coaching teams by office. Example: 5719029487116288
dialpad_company_getGet the Dialpad company the connection belongs to.Read-onlyGet Company
Get the Dialpad company the connection belongs to. Returns the company ID, name, primary office, admin contact, plan state and billing address. Use dialpad_company_get for company info or to get the company ID needed by dialpad_company_sms_opt_out_list.
Inputs
This tool takes no inputs.
dialpad_company_sms_opt_out_listList external phone numbers that opted out of (or back in to) SMS from the Dialpad company, optionally for one A2P campaign.Read-onlyList SMS Opt-Outs
List external phone numbers that opted out of (or back in to) SMS from the Dialpad company, optionally for one A2P campaign. Returns a page of numbers with their opt-out state and a cursor. Use dialpad_company_sms_opt_out_list before dialpad_sms_send to confirm a recipient has not opted out. Requires a company admin. Get the company ID from dialpad_company_get.
Inputs
company_idstringrequired- Your Dialpad company ID; must match the connected company. Get it from dialpad_company_get. Example: 5719029487116288
opt_out_statestringrequired- Required opt-out state to filter results by. Only results matching this state will be returned. One of: opted_back_in, opted_out.one of
opted_back_inopted_out a2p_campaign_idinteger- Only return opt-outs for this A2P campaign ID. When set, opt_out_state must be opted_out. Example: 5719029487116288
cursorstring- Optional token used to return the next page of a previous request. Use the cursor provided in the previous response. Example: Cg8KBG5hbWUSBxoFamFuZQ
dialpad_contact_getGet one Dialpad shared or local contact by ID.Read-onlyGet Contact
Get one Dialpad shared or local contact by ID. Returns the contact's names, phones, emails, company, job title, URLs and type. Use dialpad_contact_get when you have the contact ID. Use dialpad_contacts_list to find it.
Inputs
contact_idstringrequired- The contact's ID, from dialpad_contacts_list. Example: shared_contact_crm_12345
dialpad_contacts_listList Dialpad contacts: the company's shared contacts, or a user's local contacts when owner_id is given, optionally filtered by name.Read-onlyList Contacts
List Dialpad contacts: the company's shared contacts, or a user's local contacts when owner_id is given, optionally filtered by name. Returns a page of contacts (id, name, phones, emails, company, type) and a cursor. Use dialpad_contacts_list to browse or search by name. Use dialpad_contact_get when you have the contact ID.
Inputs
cursorstring- A token used to return the next page of a previous request. Use the cursor provided in the previous response. Example: Cg8KBG5hbWUSBxoFamFuZQ
include_localboolean- true to also include local contacts. Defaults to false.default
false namestring- Filter contacts by name. Example: Jane
owner_idstring- ID of a user whose local contacts to list instead of the company's shared contacts. Example: 5719029487116288
dialpad_department_getGet one Dialpad department by ID.Read-onlyGet Department
Get one Dialpad department by ID. Returns the department's name, office, phone numbers, hours and routing settings. Use dialpad_department_get when you have the department ID. Use dialpad_departments_list to find it.
Inputs
department_idintegerrequired- The department ID, from dialpad_departments_list. Example: 5719029487116288
dialpad_department_operators_listList the operators (users and rooms) in a Dialpad department, optionally filtered by role or on-duty status.Read-onlyList Department Operators
List the operators (users and rooms) in a Dialpad department, optionally filtered by role or on-duty status. Returns the operators with names, roles and on-duty status. Use dialpad_department_operators_list for departments. Use dialpad_callcenter_operators_list for call centers.
Inputs
department_idintegerrequired- The department ID, from dialpad_departments_list. Example: 5719029487116288
on_dutyboolean- Filter operators by on-duty status. Example: true
rolestring- Only return operators with this role: operator, admin or supervisor. One of: operator, admin, supervisor.one of
operatoradminsupervisor
dialpad_departments_listList Dialpad departments in the company, optionally filtered by office or by a name substring.Read-onlyList Departments
List Dialpad departments in the company, optionally filtered by office or by a name substring. Returns a page of departments (id, name, office, numbers) and a cursor. Use dialpad_departments_list to find department IDs. Use dialpad_department_get for one department.
Inputs
cursorstring- A token used to return the next page of a previous request. Use the cursor provided in the previous response. Example: Cg8KBG5hbWUSBxoFamFuZQ
name_searchstring- Return departments whose name contains this text. Example: Sales
office_idinteger- filter departments by office. Example: 5719029487116288
dialpad_digital_sessions_listList Dialpad digital (chat and messaging channel) sessions that started or ended within a period shorter than 7 days, optionally for one office, department or call center.Read-onlyList Digital Sessions
List Dialpad digital (chat and messaging channel) sessions that started or ended within a period shorter than 7 days, optionally for one office, department or call center. Returns a page of sessions and a cursor. Use dialpad_digital_sessions_list for digital contact-center activity. Use dialpad_calls_list for voice calls. Requires the digital_sessions scope on the connection.
Inputs
end_datestringrequired- End of the range as an ISO 8601 date-time with offset. The range must be shorter than 7 days. Example: 2025-09-30T00:00:00Z
start_datestringrequired- Start of the range as an ISO 8601 date-time with offset. The range must be shorter than 7 days. Example: 2025-09-25T00:00:00Z
cursorstring- A token used to return the next page of a previous request. Use the cursor provided in the previous response. Example: Cg8KBG5hbWUSBxoFamFuZQ
target_idinteger- Optional. The numeric ID of the target to filter by. Must be provided together with target_type. Example: 5719029487116288
target_typestring- Optional. The type of the target to filter by. One of: department, office, callcenter.one of
callcenterdepartmentoffice
dialpad_disposition_getGet one Dialpad call disposition by ID.Read-onlyGet Disposition
Get one Dialpad call disposition by ID. Returns the disposition's name, targets and settings. Use dialpad_disposition_get when you have the ID. Use dialpad_dispositions_list to find it.
Inputs
disposition_idintegerrequired- The disposition ID, from dialpad_dispositions_list. Example: 5719029487116288
dialpad_dispositions_listList call dispositions (wrap-up outcomes) defined for a Dialpad office, call center or coaching team.Read-onlyList Dispositions
List call dispositions (wrap-up outcomes) defined for a Dialpad office, call center or coaching team. Returns a page of dispositions and a cursor. Use dialpad_dispositions_list to see the outcomes agents can pick. Use dialpad_disposition_get for one.
Inputs
cursorstring- A token used to return the next page of a previous request. Use the cursor provided in the previous response. Example: Cg8KBG5hbWUSBxoFamFuZQ
target_idinteger- The target's id. Example: 5719029487116288
target_typestring- The target's type. One of: callcenter, coachinggroup, coachingteam, office, unknown.one of
callcentercoachinggroupcoachingteamofficeunknown
dialpad_meeting_getGet one scheduled Dialpad Meeting by scheduled conference ID.Read-onlyGet Meeting
Get one scheduled Dialpad Meeting by scheduled conference ID. Returns the meeting's title, time, duration, recurrence, invitees and join details. Use dialpad_meeting_get when you have the ID. Use dialpad_meetings_list to find it. Requires the conference:all scope on the connection.
Inputs
scheduled_conference_idintegerrequired- The meeting's scheduled conference ID, from dialpad_meetings_list or dialpad_meeting_create. Example: 5719029487116288
user_idinteger- ID of the Dialpad user who owns the meeting. Example: 5719029487116288
dialpad_meeting_rooms_listList the Dialpad Meetings conference rooms in the company.Read-onlyList Meeting Rooms
List the Dialpad Meetings conference rooms in the company. Returns a page of rooms (room ID, name, URL) and a cursor. Use dialpad_meeting_rooms_list to find a room_id for dialpad_meeting_summaries_list. Not the same as office rooms (dialpad_rooms_list). Requires the conference:read scope on the connection.
Inputs
cursorstring- A token used to return the next page of a previous request. Use the cursor provided in the previous response. Example: Cg8KBG5hbWUSBxoFamFuZQ
dialpad_meeting_summaries_listList summaries of Dialpad Meetings that took place, optionally for one meeting room and start-date range.Read-onlyList Meeting Summaries
List summaries of Dialpad Meetings that took place, optionally for one meeting room and start-date range. Returns a page of meeting summaries (meeting ID, room, start and end time, participants) and a cursor. Use dialpad_meeting_summaries_list for past meetings. Use dialpad_meetings_list for scheduled ones. Requires the conference:read scope on the connection.
Inputs
cursorstring- A token used to return the next page of a previous request. Use the cursor provided in the previous response. Example: Cg8KBG5hbWUSBxoFamFuZQ
end_dateinteger- Only include meetings that started on or before this time, as a UTC Unix timestamp in seconds. Example: 1767830400
room_idstring- ID of the meeting room, from dialpad_meeting_rooms_list. Example: acme-sales-room
start_dateinteger- Only include meetings that started on or after this time, as a UTC Unix timestamp in seconds. Example: 1767225600
dialpad_meetings_listList a Dialpad user's scheduled Dialpad Meetings that start within a time range.Read-onlyList Meetings
List a Dialpad user's scheduled Dialpad Meetings that start within a time range. Returns a page of meetings (scheduled conference ID, title, start time, duration, invitees) and a cursor. Use dialpad_meetings_list to see upcoming meetings. Use dialpad_meeting_summaries_list for meetings that already happened in a room. Requires the conference:all scope on the connection.
Inputs
start_datetimeintegerrequired- Start of the time range, as a UTC Unix timestamp in seconds. Example: 1767225600
user_idintegerrequired- ID of the Dialpad user whose meetings to list. Example: 5719029487116288
cursorstring- A token used to return the next page of a previous request. Use the cursor provided in the previous response. Example: Cg8KBG5hbWUSBxoFamFuZQ
end_datetimeinteger- End of the time range, as a UTC Unix timestamp in seconds. Example: 1767830400
dialpad_number_getGet one Dialpad phone number's details.Read-onlyGet Number
Get one Dialpad phone number's details. Returns its type, area code, status and the target it is assigned to. Use dialpad_number_get to find who owns a number. Requires a company admin.
Inputs
numberstringrequired- The phone number to look up, in E.164 format. Example: +14155550123
dialpad_numbers_listList the phone numbers in the Dialpad company, optionally filtered by status or area code.Read-onlyList Numbers
List the phone numbers in the Dialpad company, optionally filtered by status or area code. Returns each number with its type, area code, status and assigned target, plus a cursor. Use dialpad_numbers_list to browse numbers. Use dialpad_number_get for one number. Requires a company admin.
Inputs
area_codestring- Area code to filter by, digits only (e.g. "415").
cursorstring- A token used to return the next page of a previous request. Use the cursor provided in the previous response. Example: Cg8KBG5hbWUSBxoFamFuZQ
statusstring- Only return numbers with this status. Example: available
dialpad_office_callcenters_listList the call centers in one Dialpad office.Read-onlyList Office Call Centers
List the call centers in one Dialpad office. Returns a page of call centers and a cursor. Use dialpad_office_callcenters_list for one office. Use dialpad_callcenters_list for the whole company or to search by name.
Inputs
office_idintegerrequired- The office ID, from dialpad_offices_list. Example: 5719029487116288
cursorstring- A token used to return the next page of a previous request. Use the cursor provided in the previous response. Example: Cg8KBG5hbWUSBxoFamFuZQ
dialpad_office_coaching_teams_listList the coaching teams in one Dialpad office.Read-onlyList Office Coaching Teams
List the coaching teams in one Dialpad office. Returns a page of coaching teams and a cursor. Use dialpad_office_coaching_teams_list for one office. Use dialpad_coaching_teams_list for the whole company or to search by name.
Inputs
office_idintegerrequired- The office ID, from dialpad_offices_list. Example: 5719029487116288
cursorstring- A token used to return the next page of a previous request. Use the cursor provided in the previous response. Example: Cg8KBG5hbWUSBxoFamFuZQ
dialpad_office_departments_listList the departments in one Dialpad office.Read-onlyList Office Departments
List the departments in one Dialpad office. Returns a page of departments and a cursor. Use dialpad_office_departments_list for one office. Use dialpad_departments_list for the whole company or to search by name.
Inputs
office_idintegerrequired- The office ID, from dialpad_offices_list. Example: 5719029487116288
cursorstring- A token used to return the next page of a previous request. Use the cursor provided in the previous response. Example: Cg8KBG5hbWUSBxoFamFuZQ
dialpad_office_getGet one Dialpad office by ID.Read-onlyGet Office
Get one Dialpad office by ID. Returns the office's name, phone numbers, timezone, address, routing options and state. Use dialpad_office_get when you have the office ID. Use dialpad_offices_list to find it.
Inputs
office_idintegerrequired- The office ID, from dialpad_offices_list. Example: 5719029487116288
dialpad_office_off_duty_statuses_listList the off-duty status values configured for a Dialpad office.Read-onlyList Office Off-Duty Statuses
List the off-duty status values configured for a Dialpad office. Returns the office ID and its off-duty status names. Use dialpad_office_off_duty_statuses_list to pick a valid reason before dialpad_operator_duty_status_update.
Inputs
office_idintegerrequired- The office ID, from dialpad_offices_list. Example: 5719029487116288
dialpad_office_operators_listList the mainline operators of a Dialpad office.Read-onlyList Office Operators
List the mainline operators of a Dialpad office. Returns the operators (users and rooms) with their roles. Use dialpad_office_operators_list for an office's mainline. Use dialpad_department_operators_list or dialpad_callcenter_operators_list for groups.
Inputs
office_idintegerrequired- The office ID, from dialpad_offices_list. Example: 5719029487116288
dialpad_office_primary_getGet the Dialpad company's primary office.Read-onlyGet Primary Office
Get the Dialpad company's primary office. Returns the primary office's details. Use dialpad_office_primary_get when you need the main office without knowing its ID. Use dialpad_office_get for any other office.
Inputs
This tool takes no inputs.
dialpad_offices_listList Dialpad offices.Read-onlyList Offices
List Dialpad offices. Company admins get every office; other users get only the offices they belong to. Returns a page of offices (id, name, numbers, timezone, state) and a cursor. Use dialpad_offices_list to find office IDs. Use dialpad_office_get for one office and dialpad_office_primary_get for the primary office.
Inputs
active_onlyboolean- Whether we only return active offices. Example: true
cursorstring- A token used to return the next page of a previous request. Use the cursor provided in the previous response. Example: Cg8KBG5hbWUSBxoFamFuZQ
dialpad_operator_duty_status_getGet a Dialpad call center operator's on-duty status and reason.Read-onlyGet Operator Duty Status
Get a Dialpad call center operator's on-duty status and reason. Returns whether the operator is on duty and the status reason. Use dialpad_operator_duty_status_get to check availability. Use dialpad_operator_duty_status_update to change it.
Inputs
user_idstringrequired- The operator's Dialpad user ID. Example: 5719029487116288
dialpad_operator_skill_level_getGet an operator's skill level within one Dialpad call center.Read-onlyGet Operator Skill Level
Get an operator's skill level within one Dialpad call center. Returns the call center ID, user ID and skill level (0-100). Use dialpad_operator_skill_level_get before dialpad_operator_skill_level_update.
Inputs
call_center_idintegerrequired- The call center ID, from dialpad_callcenters_list. Example: 5719029487116288
user_idintegerrequired- The operator's Dialpad user ID. Example: 5719029487116288
dialpad_room_getGet one Dialpad room by ID.Read-onlyGet Room
Get one Dialpad room by ID. Returns the room's name, office, phone numbers and state. Use dialpad_room_get when you have the room ID. Use dialpad_rooms_list to find it.
Inputs
room_idintegerrequired- The room ID, from dialpad_rooms_list. Example: 5719029487116288
dialpad_rooms_listList Dialpad rooms (shared spaces such as conference-room phones) in the company, optionally for one office.Read-onlyList Rooms
List Dialpad rooms (shared spaces such as conference-room phones) in the company, optionally for one office. Returns a page of rooms (id, name, office, numbers) and a cursor. Use dialpad_rooms_list for office rooms. Use dialpad_meeting_rooms_list for Dialpad Meetings conference rooms.
Inputs
cursorstring- A token used to return the next page of a previous request. Use the cursor provided in the previous response. Example: Cg8KBG5hbWUSBxoFamFuZQ
office_idinteger- The office's id. Example: 5719029487116288
dialpad_scheduled_message_getGet one pending Dialpad scheduled message by ID.Read-onlyGet Scheduled Message
Get one pending Dialpad scheduled message by ID. Returns its send time, timezone, recipients, sender and text. Use dialpad_scheduled_message_get to inspect a schedule. Use dialpad_scheduled_messages_list to find the ID.
Inputs
schedule_idstringrequired- The scheduled message ID, from dialpad_scheduled_messages_list or dialpad_scheduled_message_create. Example: ag9zfnV2LXZvaWNlLWFwcHIYCxILU2NoZWR1bGU
user_idinteger- ID of the user who owns the schedule. Defaults to the authorized user. Example: 5719029487116288
dialpad_scheduled_messages_listList the pending scheduled SMS/MMS messages for the authorized Dialpad user (or another user).Read-onlyList Scheduled Messages
List the pending scheduled SMS/MMS messages for the authorized Dialpad user (or another user). Returns a page of scheduled messages (id, send time, recipients, text) and a cursor. Sent or deleted schedules are not included. Use dialpad_scheduled_messages_list to review pending sends. Use dialpad_scheduled_message_get for one.
Inputs
cursorstring- Pagination cursor from previous response. Example: Cg8KBG5hbWUSBxoFamFuZQ
limitinteger- Maximum results per page (max 100). Defaults to 20.default
20 user_idinteger- ID of the user whose scheduled messages to list. Defaults to the authorized user. Example: 5719029487116288
dialpad_scorecard_getGet one Dialpad scorecard by ID.Read-onlyGet Scorecard
Get one Dialpad scorecard by ID. Returns the scorecard's name, state, targets and questions. Use dialpad_scorecard_get for its definition. Use dialpad_scorecards_export_create for graded results.
Inputs
scorecard_idstringrequired- The scorecard ID, from dialpad_scorecards_list. Example: ag9zfnV2LXZvaWNlLWFwcHIXCxIJU2NvcmVjYXJk
dialpad_scorecards_export_getGet the status and result of a Dialpad scorecards export.Read-onlyGet Scorecards Export Result
Get the status and result of a Dialpad scorecards export. Returns the processing status and, when complete, the download URL. Use dialpad_scorecards_export_get after dialpad_scorecards_export_create; poll until the status is complete.
Inputs
request_idstringrequired- The request ID returned by dialpad_scorecards_export_create. Example: ag9zfnV2LXZvaWNlLWFwcHIcCxIPU2NvcmVjYXJkRXhwb3J0
dialpad_scorecards_listList Dialpad scorecards (call quality review forms), optionally filtered by state or target.Read-onlyList Scorecards
List Dialpad scorecards (call quality review forms), optionally filtered by state or target. Returns a page of scorecards and a cursor. Use dialpad_scorecards_list to find scorecard IDs. Use dialpad_scorecard_get for one scorecard's questions.
Inputs
cursorstring- A token used to return the next page of a previous request. Use the cursor provided in the previous response. Example: Cg8KBG5hbWUSBxoFamFuZQ
statestring- The scorecard's state. One of: active, archived, draft.one of
activearchiveddraft target_idinteger- The target's id. Example: 5719029487116288
target_typestring- The target's type. One of: callcenter, coachingteam, office, unknown.one of
callcentercoachingteamofficeunknown
dialpad_stats_export_getGet the status and result of a Dialpad stats export.Read-onlyGet Stats Export Result
Get the status and result of a Dialpad stats export. Returns the processing status and, when complete, the download URL of the CSV. Use dialpad_stats_export_get after dialpad_stats_export_create; poll until the status is complete.
Inputs
request_idstringrequired- The request ID returned by dialpad_stats_export_create. Example: 4823573942693888
dialpad_transcript_getGet the Dialpad AI transcript of a call, including the detected moments.Read-onlyGet Call Transcript
Get the Dialpad AI transcript of a call, including the detected moments. Returns the call ID and transcript lines with speaker, time and text, plus moments. Use dialpad_transcript_get for the full text. Use dialpad_transcript_url_get for a link to the transcript in Dialpad and dialpad_call_ai_recap_get for a summary.
Inputs
call_idintegerrequired- The Dialpad call ID, from dialpad_calls_list or a call event. Example: 5719029487116288
dialpad_transcript_url_getGet the URL of a call's transcript page in Dialpad.Read-onlyGet Call Transcript URL
Get the URL of a call's transcript page in Dialpad. Returns the call ID and transcript URL. Use dialpad_transcript_url_get to share a link. Use dialpad_transcript_get for the transcript text.
Inputs
call_idintegerrequired- The Dialpad call ID, from dialpad_calls_list or a call event. Example: 5719029487116288
dialpad_user_caller_id_getGet the caller IDs available to a Dialpad user and the one currently active.Read-onlyGet User Caller ID
Get the caller IDs available to a Dialpad user and the one currently active. Returns the active caller ID and the list of numbers (personal and group) the user may present. Use dialpad_user_caller_id_get before dialpad_user_caller_id_set to pick a valid number.
Inputs
user_idstringrequired- The Dialpad user's ID, or 'me' for the user who authorized the connection. Example: 5719029487116288
dialpad_user_device_getGet one registered Dialpad device by ID.Read-onlyGet User Device
Get one registered Dialpad device by ID. Returns the device's type, display name, phone number and registration dates. Use dialpad_user_device_get when you have a device ID. Use dialpad_user_devices_list to find it.
Inputs
device_idstringrequired- The device ID, from dialpad_user_devices_list. Example: DeskPhone-ag9zfnV2LXZvaWNlLWFwcHI
dialpad_user_devices_listList the devices registered to a Dialpad user (desk phones, softphones, mobile apps).Read-onlyList User Devices
List the devices registered to a Dialpad user (desk phones, softphones, mobile apps). Returns each device's ID, type, display name, phone number and registration dates, plus a cursor. Use dialpad_user_devices_list to find a device_id for dialpad_call_ring_initiate. Use dialpad_user_device_get for one device.
Inputs
cursorstring- A token used to return the next page of a previous request. Use the cursor provided in the previous response. Example: Cg8KBG5hbWUSBxoFamFuZQ
user_idstring- The Dialpad user's ID, or 'me' for the user who authorized the connection. Defaults to the authorized user.
dialpad_user_getGet one Dialpad user by ID, or the authorized user with 'me'.Read-onlyGet User
Get one Dialpad user by ID, or the authorized user with 'me'. Returns identity, phone numbers and extension, status (state, do-not-disturb, on-duty), license, office membership and voicemail settings. Use dialpad_user_get when you have a user ID. Use dialpad_users_list or dialpad_users_search to find the ID first.
Inputs
user_idstringrequired- The Dialpad user's ID, or 'me' for the user who authorized the connection.
dialpad_user_personas_listList the personas a Dialpad user can call from (targets whose identity the callee sees instead of the user's).Read-onlyList User Personas
List the personas a Dialpad user can call from (targets whose identity the callee sees instead of the user's). Returns each persona's target type, ID, name and phone number. Use dialpad_user_personas_list to find a group_id/group_type to pass when placing a call on behalf of a group.
Inputs
user_idstringrequired- The Dialpad user's ID, or 'me' for the user who authorized the connection. Example: 5719029487116288
dialpad_users_listList users in the Dialpad company, optionally filtered by state, email, phone number, name prefix or admin flag.Read-onlyList Users
List users in the Dialpad company, optionally filtered by state, email, phone number, name prefix or admin flag. Returns a page of user records (id, name, emails, phone numbers, office, state) and a cursor for the next page. Use dialpad_users_list to browse or filter by exact email/number. Use dialpad_users_search for a free-text match across names, emails and numbers. Use dialpad_user_get when you already have the user ID.
Inputs
company_adminboolean- If provided, filter results by the specified value to return only company admins or only non-company admins. Example: true
cursorstring- A token used to return the next page of a previous request. Use the cursor provided in the previous response. Example: Cg8KBG5hbWUSBxoFamFuZQ
emailstring- Return the user with this email address. Example: jane.doe@example.com
first_namestring- Filter by first-name prefix (case-insensitive), e.g. 'jo' matches John and Jose. Cannot be combined with email or number.
forwarding_numberboolean- When true, `number` is also matched against the forwarding numbers users have added to their profile, instead of only the numbers assigned to them by Dialpad. Only applies together with `number`.
last_namestring- Filter by last-name prefix, e.g. 'sm' matches Smith and Smythe. Cannot be combined with email or number.
numberstring- Return the user who has this phone number, in E.164 format. Example: +14155550123
statestring- Filter results by the specified user state (e.g. active, suspended, deleted). One of: active, all, cancelled, deleted, pending, suspended. Defaults to "active".one of
activeallcancelleddeletedpendingsuspendeddefaultactive
dialpad_users_searchSearch Dialpad users with a free-text query matched against names, emails and phone numbers.Read-onlySearch Users
Search Dialpad users with a free-text query matched against names, emails and phone numbers. Returns a page of matching user records and a cursor for the next page. Use dialpad_users_search for fuzzy lookups. Use dialpad_users_list to filter by exact email, number or state.
Inputs
querystringrequired- Text matched against user names, emails and phone numbers. Phone numbers work best in E.164 format. Example: Jane Doe
cursorstring- A token used to return the next page of a previous request. Use the cursor provided in the previous response. Example: Cg8KBG5hbWUSBxoFamFuZQ
filterstring- Optional filter. The only supported filter is name_only; pass '[name_only=true]' to match the query against names only.
dialpad_wfm_activity_metrics_getGet Dialpad Workforce Management activity-level metrics for agents over a time range.Read-onlyGet WFM Activity Metrics
Get Dialpad Workforce Management activity-level metrics for agents over a time range. Returns a page of per-activity metrics per agent and a cursor. Use dialpad_wfm_activity_metrics_get for time spent per activity. Use dialpad_wfm_agent_metrics_get for overall agent performance.
Inputs
endstringrequired- End of the range (exclusive), as a UTC ISO 8601 timestamp. Example: 2025-02-23T00:00:00Z
startstringrequired- Start of the range (inclusive), as a UTC ISO 8601 timestamp. Example: 2025-02-17T00:00:00Z
cursorstring- Include the cursor returned in a previous request to get the next page of data. Example: Cg8KBG5hbWUSBxoFamFuZQ
emailsstring- Comma-separated email addresses of the agents to include. Example: jane@example.com,sam@example.com
idsstring- Comma-separated Dialpad user IDs of the agents to include. Example: 5719029487116288,6012345678901234
dialpad_wfm_agent_metrics_getGet Dialpad Workforce Management agent-level performance metrics over a time range.Read-onlyGet WFM Agent Metrics
Get Dialpad Workforce Management agent-level performance metrics over a time range. Returns a page of per-agent metrics (adherence, occupancy, handle time and more) and a cursor. Use dialpad_wfm_agent_metrics_get for agent performance. Use dialpad_wfm_activity_metrics_get for activity breakdowns.
Inputs
endstringrequired- End of the range (exclusive), as a UTC ISO 8601 timestamp. Example: 2025-02-23T00:00:00Z
startstringrequired- Start of the range (inclusive), as a UTC ISO 8601 timestamp. Example: 2025-02-17T00:00:00Z
cursorstring- Include the cursor returned in a previous request to get the next page of data. Example: Cg8KBG5hbWUSBxoFamFuZQ
emailsstring- Comma-separated email addresses of the agents to include. Example: jane@example.com,sam@example.com
idsstring- Comma-separated Dialpad user IDs of the agents to include. Example: 5719029487116288,6012345678901234
dialpad_blocked_numbers_addBlock phone numbers company-wide in Dialpad so inbound calls and texts from them are rejected for every user.WriteBlock Numbers
Block phone numbers company-wide in Dialpad so inbound calls and texts from them are rejected for every user. Returns an empty response on success. Use dialpad_blocked_numbers_add to block. Use dialpad_blocked_numbers_remove to unblock.
Inputs
numbersarrayrequired- Phone numbers to block, in E.164 format. Example: ["+14155550123"].
dialpad_blocked_numbers_removeUnblock phone numbers company-wide in Dialpad, restoring inbound calls and texts from them.WriteUnblock Numbers
Unblock phone numbers company-wide in Dialpad, restoring inbound calls and texts from them. Returns an empty response on success. Use dialpad_blocked_numbers_remove to undo dialpad_blocked_numbers_add.
Inputs
numbersarrayrequired- Phone numbers to unblock, in E.164 format. Example: ["+14155550123"].
dialpad_call_hangupHang up an active Dialpad call.WriteHang Up Call
Hang up an active Dialpad call. Returns an empty response on success. Use dialpad_call_hangup to end a live call. Use dialpad_call_transfer to move it elsewhere instead.
- Idempotent
Inputs
call_idintegerrequired- The Dialpad call ID, from dialpad_calls_list or a call event. Example: 5719029487116288
dialpad_call_ivr_initiateStart an outbound call that connects a phone number to an office, department or call center IVR workflow.WriteInitiate IVR Call
Start an outbound call that connects a phone number to an office, department or call center IVR workflow. Returns the initiated call's details. Use dialpad_call_ivr_initiate to send a callee into an IVR. Use dialpad_call_ring_initiate to connect a callee to a user.
Inputs
phone_numberstringrequired- The phone number to call, in E.164 format. Example: +14155550123
target_idintegerrequired- ID of the office, department or call center whose IVR workflow the callee is connected to. Example: 5719029487116288
target_typestringrequired- Type of the group in target_id: office, department or callcenter. One of: callcenter, department, office.one of
callcenterdepartmentoffice custom_datastring- Free-form text attached to the call and passed through to call event subscriptions. Example: campaign-oct
outbound_caller_idstring- E.164 number shown to the callee, or 'blocked' to hide it. Example: +14155550199
dialpad_call_labels_addAdd labels to a Dialpad call, keeping any labels already on it.WriteAdd Call Labels
Add labels to a Dialpad call, keeping any labels already on it. Returns the updated call record. Use dialpad_call_labels_add to tag calls. Use dialpad_call_labels_list to see the company's label names first. Labels cannot be removed with this tool.
- Idempotent
Inputs
call_idintegerrequired- The Dialpad call ID, from dialpad_calls_list or a call event. Example: 5719029487116288
labelsarrayrequired- Label names to add to the call. Existing labels are kept; labels already present are not duplicated. Example: ["follow-up", "billing"].
dialpad_call_operator_assignAssign a specific operator to a call waiting in a Dialpad contact center queue so only that operator can receive it.WriteAssign Call Operator
Assign a specific operator to a call waiting in a Dialpad contact center queue so only that operator can receive it. Returns the call ID and assigned operators. Use dialpad_call_operator_assign for queued contact-center calls only. Use dialpad_call_assigned_operators_list to check the result and dialpad_call_operator_unassign to undo it.
Inputs
call_idintegerrequired- The Dialpad call ID, from dialpad_calls_list or a call event. Example: 5719029487116288
operator_idsarrayrequired- IDs of the operators (users) to assign to the queued call. Dialpad currently accepts one operator per request. Example: [5719029487116288].
dialpad_call_operator_unassignUnassign one operator from a call waiting in a Dialpad contact center queue.WriteUnassign Call Operator
Unassign one operator from a call waiting in a Dialpad contact center queue. Returns the call ID and remaining assigned operators. Use dialpad_call_operator_unassign for one operator. Use dialpad_call_operators_unassign_all to clear every assignment.
Inputs
call_idintegerrequired- The Dialpad call ID, from dialpad_calls_list or a call event. Example: 5719029487116288
operator_idsarrayrequired- IDs of the operators to unassign from the queued call. Dialpad currently accepts one operator per request. Example: [5719029487116288].
dialpad_call_operators_unassign_allUnassign every assigned operator from a call waiting in a Dialpad contact center queue, so it routes normally again.WriteUnassign All Call Operators
Unassign every assigned operator from a call waiting in a Dialpad contact center queue, so it routes normally again. Returns the call ID. Use dialpad_call_operators_unassign_all to clear all assignments. Use dialpad_call_operator_unassign for one operator.
Inputs
call_idintegerrequired- The Dialpad call ID, from dialpad_calls_list or a call event. Example: 5719029487116288
dialpad_call_participant_addAdd a participant to an active Dialpad call by phone number or by target (user, office, department, call center).WriteAdd Call Participant
Add a participant to an active Dialpad call by phone number or by target (user, office, department, call center). Returns the call's details. Use dialpad_call_participant_add to make a conference. Use dialpad_call_transfer to hand the call off instead.
Inputs
call_idintegerrequired- The Dialpad call ID, from dialpad_calls_list or a call event. Example: 5719029487116288
participantobjectrequired- Who to add. Pass either a phone number {"number": "+14155550123"} or a user, office, department or call center {"target_id": 5719029487116288, "target_type": "user"}; a target must have a primary phone number.
dialpad_call_ring_initiateStart an outbound call by ringing all of a Dialpad user's devices (or one chosen device); the call connects to the phone number once the user answers.WriteInitiate Call via Ring
Start an outbound call by ringing all of a Dialpad user's devices (or one chosen device); the call connects to the phone number once the user answers. Returns the new call's ID and URL. Use dialpad_call_ring_initiate for any device type, including mobile and desk phones. Use dialpad_user_call_initiate to dial straight from the web/desktop app.
Inputs
phone_numberstringrequired- The phone number to call, in E.164 format. Example: +14155550123
user_idintegerrequired- ID of the Dialpad user whose devices ring and who makes the call. Find it with dialpad_users_list. Example: 5719029487116288
custom_datastring- Free-form text attached to the call and passed through to call event subscriptions, for example your own record ID. Example: ticket-4821
device_idstring- Ring only this device instead of all of the user's devices. Get it from dialpad_user_devices_list. Example: DeskPhone-ag9zfnV2LXZvaWNlLWFwcHI
group_idinteger- ID of an office, department or call center to place the call from (as that group). Must be sent with group_type. Example: 5719029487116288
group_typestring- Type of the group in group_id: office, department or callcenter. One of: callcenter, department, office.one of
callcenterdepartmentoffice is_consultboolean- true to start a second (consult) call, putting the user's current call on hold. Defaults to false.default
false outbound_caller_idstring- E.164 number shown to the callee for this call, or 'blocked' to hide it. Must be the user's number or a number of a group they belong to. Example: +14155550199
dialpad_call_transferTransfer an active Dialpad call to a phone number, another ongoing call, a user/office/department/call center, or a specific operator.WriteTransfer Call
Transfer an active Dialpad call to a phone number, another ongoing call, a user/office/department/call center, or a specific operator. Returns the transferred call's details. Use dialpad_call_transfer to hand the call off. Use dialpad_call_participant_add to bring a third party into the call instead.
Inputs
call_idintegerrequired- The Dialpad call ID, from dialpad_calls_list or a call event. Example: 5719029487116288
toobjectrequired- Where to transfer the call. Pass exactly one shape: a phone number {"number": "+14155550123"}; an ongoing call {"call_id": 5719029487116288}; a user, office, department or call center {"target_id": 5719029487116288, "target_type": "user"}; or a specific operator in a call center {"operator_id": 5719029487116288, "target_id": 6012345678901234}.
custom_datastring- Free-form text attached to the call and passed through to call event subscriptions. Example: escalated-to-tier2
transfer_statestring- State the call takes when transferred: hold, parked, preanswer or voicemail. Leave empty for a normal transfer. One of: hold, parked, preanswer, voicemail.one of
holdparkedpreanswervoicemail
dialpad_call_unparkUnpark a call that was parked on an office mainline and route it to a Dialpad user.WriteUnpark Call
Unpark a call that was parked on an office mainline and route it to a Dialpad user. Returns the call's details. Use dialpad_call_unpark for calls parked with transfer_state 'parked' (see dialpad_call_transfer).
Inputs
call_idintegerrequired- The Dialpad call ID, from dialpad_calls_list or a call event. Example: 5719029487116288
user_idintegerrequired- ID of the Dialpad user the parked call should be routed to. Example: 5719029487116288
dialpad_callback_enqueueQueue a callback to a phone number in a Dialpad call center; it dials out when the next operator is free, respecting business hours.WriteEnqueue Callback
Queue a callback to a phone number in a Dialpad call center; it dials out when the next operator is free, respecting business hours. Returns the callback request with its queue position. Use dialpad_callback_enqueue to request a callback. Use dialpad_callback_validate first to check it would succeed. International numbers and duplicates are rejected.
Inputs
call_center_idintegerrequired- The ID of a call center that will be used to fulfill the callback. Example: 5719029487116288
phone_numberstringrequired- The e164-formatted number to call back. Example: +14155550123
dialpad_callback_validateDry-run a Dialpad callback request without queueing it or placing a call.WriteValidate Callback
Dry-run a Dialpad callback request without queueing it or placing a call. Returns whether the request would succeed, with the same failures enqueueing would report (unreachable or international number, duplicate, call center closed). Use dialpad_callback_validate before dialpad_callback_enqueue.
Inputs
call_center_idintegerrequired- The ID of a call center that will be used to fulfill the callback. Example: 5719029487116288
phone_numberstringrequired- The e164-formatted number to call back. Example: +14155550123
dialpad_callcenter_operator_addAdd a user to a Dialpad call center as an operator, supervisor or admin, with an optional skill level.WriteAdd Call Center Operator
Add a user to a Dialpad call center as an operator, supervisor or admin, with an optional skill level. Returns the added operator. May consume a call center license if the user needs one; fails if none is available. Use dialpad_callcenter_operator_add to staff a queue. Use dialpad_callcenter_operator_remove to take someone out.
Inputs
call_center_idintegerrequired- The call center ID, from dialpad_callcenters_list. Example: 5719029487116288
user_idintegerrequired- The ID of the user. Example: 5719029487116288
keep_paid_numbersboolean- Whether or not to keep phone numbers when switching to a support license. Note: Phone numbers require additional number licenses under a support license. Defaults to true.default
true license_typestring- The type of license to assign to the new operator if a license is required. (`agents` or `lite_support_agents`). Defaults to `agents`. One of: agents, lite_support_agents.one of
agentslite_support_agentsdefaultagents rolestring- The role the user should assume. One of: admin, operator, supervisor. Defaults to "operator".one of
adminoperatorsupervisordefaultoperator skill_levelinteger- Skill level of the operator. Integer value in range 1 - 100. Default 100.default
100
dialpad_channel_createCreate a public or private Dialpad channel.WriteCreate Channel
Create a public or private Dialpad channel. Returns the new channel with its ID and hashtag. Use dialpad_channel_create for a new channel. Use dialpad_channel_member_add to add people afterwards.
Inputs
descriptionstringrequired- The description of the channel. Example: Escalations from the support queue
namestringrequired- The name of the channel. Example: support-escalations
privacy_typestringrequired- The privacy type of the channel. One of: private, public.one of
privatepublic user_idinteger- ID of the user who owns the channel. Only applies when the connection uses a company-level key; otherwise the authorized user owns it. Example: 5719029487116288
dialpad_channel_member_addAdd a Dialpad user to a channel.WriteAdd Channel Member
Add a Dialpad user to a channel. Returns the added member. Use dialpad_channel_member_add to add someone. Use dialpad_channel_member_remove to take them out.
Inputs
channel_idintegerrequired- The channel ID, from dialpad_channels_list. Example: 5719029487116288
user_idintegerrequired- The user id. Example: 5719029487116288
dialpad_contact_createCreate a Dialpad contact: a company shared contact, or a user's local contact when owner_id is given.WriteCreate Contact
Create a Dialpad contact: a company shared contact, or a user's local contact when owner_id is given. Returns the new contact with its ID. Use dialpad_contact_create for a new contact. Use dialpad_contact_upsert to create-or-update a shared contact by your own unique ID, and dialpad_contact_update to change an existing one.
Inputs
first_namestringrequired- The contact's first name. Example: Jane
last_namestringrequired- The contact's last name. Example: Doe
company_namestring- The contact's company name. Example: Acme Inc
emailsarray- The contact's emails. The first email in the list is the contact's primary email. Example: ["jane.doe@example.com"]
extensionstring- The contact's extension number. Example: 1234
job_titlestring- The contact's job title. Example: Account Executive
owner_idstring- The id of the user who will own this contact. If provided, a local contact will be created for this user. Otherwise, the contact will be created as a shared contact in your company. Example: 5719029487116288
phonesarray- The contact's phone numbers. The phone number must be in e164 format. The first number in the list is the contact's primary phone. Example: ["+14155550123"]
urlsarray- A list of websites associated with or belonging to this contact. Example: ["https://www.example.com"]
dialpad_contact_updateUpdate fields on an existing Dialpad contact; only the fields you pass change.WriteUpdate Contact
Update fields on an existing Dialpad contact; only the fields you pass change. Returns the updated contact. Use dialpad_contact_update when you have the contact ID. Use dialpad_contact_upsert to sync by your own unique ID.
- Idempotent
Inputs
contact_idstringrequired- The contact's ID, from dialpad_contacts_list. Example: shared_contact_crm_12345
company_namestring- The contact's company name. Example: Acme Inc
emailsarray- The contact's emails. The first email in the list is the contact's primary email. Example: ["jane.doe@example.com"]
extensionstring- The contact's extension number. Example: 1234
first_namestring- The contact's first name. Example: Jane
job_titlestring- The contact's job title. Example: Account Executive
last_namestring- The contact's last name. Example: Doe
phonesarray- The contact's phone numbers. The phone number must be in e164 format. The first number in the list is the contact's primary phone. Example: ["+14155550123"]
urlsarray- A list of websites associated with or belonging to this contact. Example: ["https://www.example.com"]
dialpad_contact_upsertCreate or update a Dialpad shared contact identified by your own unique ID (uid), for example a CRM record ID.WriteCreate or Update Contact
Create or update a Dialpad shared contact identified by your own unique ID (uid), for example a CRM record ID. Returns the contact; its ID includes the uid. Use dialpad_contact_upsert to keep contacts in sync with another system. Use dialpad_contact_create for a one-off contact or a user's local contact.
- Idempotent
Inputs
first_namestringrequired- The contact's first name. Example: Jane
last_namestringrequired- The contact's last name. Example: Doe
uidstringrequired- Your own unique ID for the contact, such as a CRM record ID; it becomes part of the contact's Dialpad ID, and calling again with the same uid updates that contact. Example: crm_12345
company_namestring- The contact's company name. Example: Acme Inc
emailsarray- The contact's emails. The first email in the list is the contact's primary email. Example: ["jane.doe@example.com"]
extensionstring- The contact's extension number. Example: 1234
job_titlestring- The contact's job title. Example: Account Executive
phonesarray- The contact's phone numbers. The phone number must be in e164 format. The first number in the list is the contact's primary phone. Example: ["+14155550123"]
urlsarray- A list of websites associated with or belonging to this contact. Example: ["https://www.example.com"]
dialpad_meeting_createSchedule a Dialpad Meeting for a user, with title, start time, optional duration, recurrence and contact invitees.WriteCreate Meeting
Schedule a Dialpad Meeting for a user, with title, start time, optional duration, recurrence and contact invitees. Returns the created meeting with its scheduled conference ID and join details. Use dialpad_meeting_create to schedule. Use dialpad_meeting_update to change it. Requires the conference:all scope on the connection.
Inputs
start_datetimeintegerrequired- Meeting start time, as a UTC Unix timestamp in seconds. Example: 1767225600
titlestringrequired- The meeting's title. Example: Quarterly business review
user_idintegerrequired- ID of the Dialpad user who hosts the meeting. Example: 5719029487116288
call_outboolean- true to have the meeting call participants when it starts.
contact_idsarray- IDs of contacts to invite, from dialpad_contacts_list. Example: ["shared_contact_crm_12345"].
durationinteger- Length of each occurrence in seconds. Defaults to 3600 (one hour). Example: 1800
end_datetimeinteger- For recurring meetings only: when the series stops, as a UTC Unix timestamp in seconds. Does not set the length of a meeting (use duration). Example: 1775001600
meeting_idstring- Custom meeting URL slug. Required when meeting_type is CUSTOM_UNIQUE_MEETING. Example: acme-qbr
meeting_typestring- The meeting's type. If omitted or null, defaults to UNIQUE_MEETING when unique meetings are enabled and supported for the organizer; otherwise, defaults to PERSONAL. One of: CUSTOM_UNIQUE_MEETING, LARGE_MEETING, PERSONAL, UNIQUE_MEETING.one of
CUSTOM_UNIQUE_MEETINGLARGE_MEETINGPERSONALUNIQUE_MEETING recurrencestring- How often the meeting repeats, such as an RRULE. Leave empty for a one-off meeting. Example: RRULE:FREQ=WEEKLY;BYDAY=MO
dialpad_meeting_updateUpdate a scheduled Dialpad Meeting (title, time, duration, recurrence or invitees).WriteUpdate Meeting
Update a scheduled Dialpad Meeting (title, time, duration, recurrence or invitees). Returns the updated meeting. Use dialpad_meeting_update for an existing meeting from dialpad_meetings_list or dialpad_meeting_create. Requires the conference:all scope on the connection.
- Idempotent
Inputs
scheduled_conference_idintegerrequired- The meeting's scheduled conference ID, from dialpad_meetings_list or dialpad_meeting_create. Example: 5719029487116288
user_idintegerrequired- ID of the Dialpad user who hosts the meeting. Example: 5719029487116288
call_outboolean- true to have the meeting call participants when it starts.
contact_idsarray- Contact IDs that replace the current invitees. Leave empty to keep the current invitees. Example: ["shared_contact_crm_12345"].
durationinteger- New length of each occurrence in seconds. Leave empty to keep the current duration. Example: 1800
end_datetimeinteger- For recurring meetings only: when the series stops, as a UTC Unix timestamp in seconds. Example: 1775001600
instance_idstring- ID of one occurrence of a recurring meeting to update instead of the whole series. Example: 20260105T160000Z
recurrencestring- How often the meeting repeats, such as an RRULE. Example: RRULE:FREQ=WEEKLY;BYDAY=MO
start_datetimeinteger- New start time, as a UTC Unix timestamp in seconds. Example: 1767229200
titlestring- The meeting's title. Example: Quarterly business review (rescheduled)
dialpad_operator_duty_status_updateSet a Dialpad operator on duty or off duty (with an optional reason) across every call center they belong to.WriteUpdate Operator Duty Status
Set a Dialpad operator on duty or off duty (with an optional reason) across every call center they belong to. Returns the operator's resulting duty status. Use dialpad_operator_duty_status_update for call-center availability. Use dialpad_user_dnd_toggle to block all calls instead.
- Idempotent
Inputs
on_dutybooleanrequired- True if this status message indicates an "on-duty" status. Example: true
user_idstringrequired- The operator's Dialpad user ID. Example: 5719029487116288
duty_status_reasonstring- Optional reason for the status, such as one of the office's off-duty statuses from dialpad_office_off_duty_statuses_list. Example: Lunch
dialpad_operator_skill_level_updateSet an operator's skill level (0-100) within one Dialpad call center; skill-based routing prefers higher levels.WriteUpdate Operator Skill Level
Set an operator's skill level (0-100) within one Dialpad call center; skill-based routing prefers higher levels. Returns the updated skill level. Use dialpad_operator_skill_level_update to tune routing. Use dialpad_operator_skill_level_get to read the current value.
- Idempotent
Inputs
call_center_idintegerrequired- The call center ID, from dialpad_callcenters_list. Example: 5719029487116288
skill_levelintegerrequired- New skill level to set the operator in the call center. It must be an integer value between 0 and 100. Example: 80
user_idintegerrequired- The operator's Dialpad user ID. Example: 5719029487116288
dialpad_phone_number_formatConvert a phone number between local and E.164 format.WriteFormat Phone Number
Convert a phone number between local and E.164 format. Returns the E.164 number, the formatted local number, the area code and the ISO country code. Use dialpad_phone_number_format to normalize a number before passing it to other Dialpad tools that need E.164.
Inputs
numberstringrequired- The phone number to convert, in local or E.164 format. Example: (415) 555-0123
country_codestring- ISO 3166-1 alpha-2 country code such as US. Required when number is in local format.
dialpad_scheduled_message_createSchedule an SMS (or MMS with base64 media) from a Dialpad user to phone numbers or a channel, sent at a future time at least 10 minutes ahead.WriteSchedule Message
Schedule an SMS (or MMS with base64 media) from a Dialpad user to phone numbers or a channel, sent at a future time at least 10 minutes ahead. Returns the scheduled message with its ID. Use dialpad_scheduled_message_create to send later. Use dialpad_sms_send to send now.
Inputs
start_dateintegerrequired- When to send the message, as a Unix timestamp in seconds; must be at least 10 minutes in the future. Example: 1767225600
channel_hashtagstring- Hashtag of a Dialpad channel to send the message to, instead of to_numbers. Example: #support-team
from_numberstring- The user's own E.164 number to send from. Example: +14155550199
is_bulkboolean- true to mark the message as bulk (max 50 recipients; affects rate limiting and delivery). Defaults to false.default
false mediastring- Optional base64-encoded image or video attachment (max 500 KiB before encoding); sends the message as MMS. Example: iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mNk+M9QDwADhgGAWjR9awAAAABJRU5ErkJggg==
textstring- The message text. Provide text, media, or both. Example: Reminder: your appointment is tomorrow at 3pm.
timezonestring- IANA timezone name for the schedule. Defaults to US/Pacific. Example: America/Los_Angelesdefault
US/Pacific to_numbersarray- Up to 50 recipient phone numbers in E.164 format. Provide either to_numbers or channel_hashtag. Example: ["+14155550123"].
user_idinteger- ID of the Dialpad user who sends the message. Defaults to the authorized user. Example: 5719029487116288
dialpad_scheduled_message_send_nowSend a pending Dialpad scheduled message immediately and remove the schedule.WriteSend Scheduled Message Now
Send a pending Dialpad scheduled message immediately and remove the schedule. Returns the send result. Use dialpad_scheduled_message_send_now to skip the wait. Use dialpad_scheduled_message_update to change the time instead.
Inputs
schedule_idstringrequired- The scheduled message ID, from dialpad_scheduled_messages_list or dialpad_scheduled_message_create. Example: ag9zfnV2LXZvaWNlLWFwcHIYCxILU2NoZWR1bGU
user_idinteger- ID of the user who owns the schedule. Defaults to the authorized user. Example: 5719029487116288
dialpad_scheduled_message_updateUpdate a pending Dialpad scheduled message; only the fields you pass change.WriteUpdate Scheduled Message
Update a pending Dialpad scheduled message; only the fields you pass change. Returns the updated scheduled message. Use dialpad_scheduled_message_update to change the time, text or recipients. Use dialpad_scheduled_message_send_now to send it immediately.
- Idempotent
Inputs
schedule_idstringrequired- The scheduled message ID, from dialpad_scheduled_messages_list or dialpad_scheduled_message_create. Example: ag9zfnV2LXZvaWNlLWFwcHIYCxILU2NoZWR1bGU
channel_hashtagstring- Hashtag of a Dialpad channel to send to instead of phone numbers. Example: #support-team
from_numberstring- The user's own E.164 number to send from. Example: +14155550199
mediastring- New base64-encoded image or video attachment (max 500 KiB before encoding). Example: iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mNk+M9QDwADhgGAWjR9awAAAABJRU5ErkJggg==
start_dateinteger- New send time, as a Unix timestamp in seconds. Example: 1767229200
textstring- New message text. Example: Updated: your appointment is now at 4pm.
timezonestring- IANA timezone name for the schedule. Example: America/Los_Angeles
to_numbersarray- New list of recipient phone numbers in E.164 format; replaces the current list. Example: ["+14155550123"].
user_idinteger- ID of the user who owns the schedule. Defaults to the authorized user. Example: 5719029487116288
dialpad_scorecards_export_createStart an asynchronous export of Dialpad scorecard results (calls, questions or leaderboards) for the company or one target over a date range.WriteStart Scorecards Export
Start an asynchronous export of Dialpad scorecard results (calls, questions or leaderboards) for the company or one target over a date range. Returns a request ID. Use dialpad_scorecards_export_create to start, then poll dialpad_scorecards_export_get with the request ID for the download link.
Inputs
scorecards_typestringrequired- The type of scorecards statistics to be returned. One of: scorecard_export_agent_leaderboard, scorecard_export_calls, scorecard_export_calls_questions, scorecard_export_leaderboard, scorecard_export_teamgroup_leaderboard.one of
scorecard_export_agent_leaderboardscorecard_export_callsscorecard_export_calls_questionsscorecard_export_leaderboardscorecard_export_teamgroup_leaderboard days_ago_endinteger- End of the date range to get statistics for. This is the number of days to look back relative to the current day. Used in conjunction with days_ago_start to specify a range. Defaults to 30.default
30 days_ago_startinteger- Start of the date range to get statistics for. This is the number of days to look back relative to the current day. Used in conjunction with days_ago_end to specify a range. Defaults to 1.default
1 graded_days_ago_endinteger- End of the graded date range to get statistics for. This is the number of days to look back relative to the current day. Used in conjunction with graded_days_ago_start to specify a range. Example: 30
graded_days_ago_startinteger- Start of the graded date range to get statistics for. This is the number of days to look back relative to the current day. Used in conjunction with graded_days_ago_end to specify a range. Example: 1
scorecard_grader_idinteger- The scorecard grader's id. Example: 5719029487116288
scorecard_idsarray- Only include these scorecard IDs. Example: [5719029487116288].
send_tostring- Optional email address to send the export to. Example: qa-lead@example.com
target_idinteger- The target's id. Example: 5719029487116288
target_typestring- The target's type. One of: callcenter, coachingteam, office, unknown, user.one of
callcentercoachingteamofficeunknownuser timezonestring- Timezone using a tz database name. Defaults to "UTC".default
UTC
dialpad_sms_sendSend an SMS (or an MMS with a base64 media attachment) from a Dialpad user or group to up to 10 phone numbers or to a Dialpad channel.WriteSend SMS
Send an SMS (or an MMS with a base64 media attachment) from a Dialpad user or group to up to 10 phone numbers or to a Dialpad channel. Returns the message ID, status, sender and recipients. Use dialpad_sms_send to send now. Use dialpad_scheduled_message_create to send later.
Inputs
channel_hashtagstring- Hashtag of a Dialpad channel to post the message to, instead of to_numbers. Get it from dialpad_channels_list. Example: #support-team
from_numberstring- E.164 number to send from; must be assigned to a user or group. Overrides user_id and sender_group_id. Example: +14155550199
infer_country_codeboolean- true to treat to_numbers as local numbers in the sender's country instead of requiring E.164. Defaults to false.default
false mediastring- Optional base64-encoded image or video attachment (max 500 KiB before encoding); sends the message as MMS. Example: iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mNk+M9QDwADhgGAWjR9awAAAABJRU5ErkJggg==
sender_group_idinteger- ID of an office, department or call center to send on behalf of. Send with sender_group_type. Example: 5719029487116288
sender_group_typestring- Type of the group in sender_group_id: office, department or callcenter. One of: callcenter, department, office.one of
callcenterdepartmentoffice textstring- The message text. Provide text, media, or both. Example: Hi Jane, your appointment is confirmed for 3pm tomorrow.
to_numbersarray- Up to 10 recipient phone numbers in E.164 format. Provide either to_numbers or channel_hashtag. Example: ["+14155550123"].
user_idinteger- ID of the Dialpad user who sends the message. Defaults to the authorized user. Example: 5719029487116288
dialpad_stats_export_createStart an asynchronous Dialpad analytics export (calls, texts, voicemails, recordings, on-duty, CSAT, dispositions or screenshare) as aggregated stats or individual records, for the company, an office or a target.WriteStart Stats Export
Start an asynchronous Dialpad analytics export (calls, texts, voicemails, recordings, on-duty, CSAT, dispositions or screenshare) as aggregated stats or individual records, for the company, an office or a target. Returns a request ID. Use dialpad_stats_export_create to start, then poll dialpad_stats_export_get with the request ID for the download link.
Inputs
export_typestringrequired- Whether to return aggregated statistics (stats), or individual rows for each record (records). NOTE: For stat_type "csat" or "dispositions", only "records" is supported. One of: records, stats.one of
recordsstats stat_typestringrequired- The type of statistics to be returned. NOTE: if the value is "csat" or "dispositions", target_id and target_type must be specified. One of: calls, csat, dispositions, onduty, recordings, screenshare, texts, voicemails.one of
callscsatdispositionsondutyrecordingsscreensharetextsvoicemails coaching_groupboolean- Whether or not the statistics should be for trainees of the coach group with the given target_id. Example: true
coaching_teamboolean- Whether or not the statistics should be for trainees of the coach team with the given target_id. Example: true
days_ago_endinteger- End of the range, as a number of days before today. Used with days_ago_start. Defaults to 30. Ignored when is_today is true.default
30 days_ago_startinteger- Start of the range, as a number of days before today (0 is today). Used with days_ago_end. Defaults to 1. Ignored when is_today is true.default
1 group_bystring- This param is only applicable when the stat_type is specified as call. For call stats, group calls by user per day (default), get total metrics by day, or break down by department and call center (office only). One of: date, group, user.one of
dategroupuser is_todayboolean- Whether or not the statistics are for the current day. NOTE: days_ago_start and days_ago_end are ignored if this is passed in. Example: true
office_idinteger- ID of the office to get statistics for. If a target_id and target_type are passed in this value is ignored and instead the target is used. Example: 5719029487116288
target_idinteger- ID of a user, office, department, call center or other target to limit stats to. Send with target_type. Required for stat_type csat and dispositions. Example: 5719029487116288
target_typestring- Type of the target in target_id. Required for stat_type csat and dispositions. One of: callcenter, coachinggroup, coachingteam, department, office, room, staffgroup, unknown, user.one of
callcentercoachinggroupcoachingteamdepartmentofficeroomstaffgroupunknownuser timezonestring- IANA timezone name used for the date range. Defaults to UTC. Example: America/New_Yorkdefault
UTC
dialpad_user_call_initiateMake a Dialpad user's web or desktop app start an outbound call to a phone number.WriteInitiate Call for User
Make a Dialpad user's web or desktop app start an outbound call to a phone number. Returns the initiated call's details. Use dialpad_user_call_initiate when the user has the web/desktop app or a CTI open. Use dialpad_call_ring_initiate to ring all of the user's devices, including mobile apps and desk phones.
Inputs
phone_numberstringrequired- The phone number to call, in E.164 format. Example: +14155550123
user_idstringrequired- The Dialpad user whose app should place the call, or 'me' for the user who authorized the connection.
custom_datastring- Free-form text attached to the call and passed through to call event subscriptions, for example your own record ID. Example: ticket-4821
group_idinteger- ID of an office, department or call center to place the call from (as that group). Must be sent with group_type. Example: 5719029487116288
group_typestring- Type of the group in group_id: office, department or callcenter. One of: callcenter, department, office.one of
callcenterdepartmentoffice outbound_caller_idstring- E.164 number shown to the callee for this call, or 'blocked' to hide it. Must be the user's number or a number of a group they belong to. Example: +14155550199
dialpad_user_call_recording_toggleStart or stop recording on a Dialpad user's current active call.WriteToggle Call Recording
Start or stop recording on a Dialpad user's current active call. Returns the active call's ID and recording state. Use dialpad_user_call_recording_toggle during a live call only. Use dialpad_user_call_vi_toggle for live transcription instead of recording.
- Idempotent
Inputs
is_recordingbooleanrequired- true to start recording the user's active call, false to stop recording.
user_idstringrequired- The Dialpad user's ID, or 'me' for the user who authorized the connection. Example: 5719029487116288
play_messageboolean- Whether or not to play a message to indicate the call is being recorded (or recording has stopped). Defaults to true.default
true recording_typestring- Whether or not to toggle recording for the operator call (personal recording), the group call (department recording), or both. Only applicable for group calls (call centers, departments, etc.). One of: all, group, user. Defaults to "user".one of
allgroupuserdefaultuser
dialpad_user_call_vi_toggleTurn Voice Intelligence (live transcription and real-time assist) on or off for a Dialpad user's current active call, optionally setting the transcription locale.WriteToggle Call Voice Intelligence
Turn Voice Intelligence (live transcription and real-time assist) on or off for a Dialpad user's current active call, optionally setting the transcription locale. Returns the active call's ID and Voice Intelligence state. Fails if the user has no active call. Use dialpad_user_call_vi_toggle for live transcription. Use dialpad_user_call_recording_toggle to record audio.
- Idempotent
Inputs
enable_vibooleanrequired- true to turn Voice Intelligence (live transcription) on for the user's active call, false to turn it off.
user_idstringrequired- The Dialpad user's ID, or 'me' for the user who authorized the connection. Example: 5719029487116288
announce_viboolean- Whether to play an announcement when vi is toggled for this call. If not provided, falls back to the office's (or group's) transcription-announcement setting. When explicitly set, this also overrides the two-party-consent area-code check that would otherwise suppress the announcement in consent-restricted regions. Example: true
vi_localestring- The locale to use for vi. One of: de-de, en-au, en-ca, en-gb, en-mx, en-nz, en-us, es-es, es-mx, es-us, fr-ca, fr-fr, id-id, it-it, ja-jp, ko-kr, nl-nl, pt-br, sv-se, vi-vn, zh-cn.one of
de-deen-auen-caen-gben-mxen-nzen-uses-eses-mxes-usfr-cafr-frid-idit-itja-jpko-krnl-nlpt-brsv-sevi-vnzh-cn
dialpad_user_caller_id_setSet the caller ID a Dialpad user presents on outbound calls, or block it.WriteSet User Caller ID
Set the caller ID a Dialpad user presents on outbound calls, or block it. Returns the user's caller ID settings after the change. Use dialpad_user_caller_id_set to change the default for all calls. To override for a single call, pass outbound_caller_id to dialpad_user_call_initiate instead. Run dialpad_user_caller_id_get first to see which numbers are allowed.
Inputs
caller_idstringrequired- The E.164 phone number to present as the user's caller ID, or 'blocked' to hide it. Must be one of the numbers returned by dialpad_user_caller_id_get. Example: +14155550123
user_idstringrequired- The Dialpad user's ID, or 'me' for the user who authorized the connection. Example: 5719029487116288
dialpad_user_dnd_toggleTurn do-not-disturb on or off for a Dialpad user, either for the user overall or for one office, department or call center.WriteToggle User Do Not Disturb
Turn do-not-disturb on or off for a Dialpad user, either for the user overall or for one office, department or call center. Returns the user's resulting do-not-disturb state. Use dialpad_user_dnd_toggle to stop or resume incoming calls. Use dialpad_operator_duty_status_update to change call-center on-duty status instead.
- Idempotent
Inputs
do_not_disturbbooleanrequired- Determines if DND is ON or OFF. Example: true
user_idstringrequired- The Dialpad user's ID, or 'me' for the user who authorized the connection. Example: 5719029487116288
group_idinteger- The ID of the group which the user's DND status will be updated for. Example: 5719029487116288
group_typestring- The type of the group which the user's DND status will be updated for. One of: callcenter, department, office.one of
callcenterdepartmentoffice
dialpad_user_screen_pop_triggerOpen a URL (for example a CRM record or ticket) on a Dialpad user's active device as a screen pop.WriteTrigger Screen Pop
Open a URL (for example a CRM record or ticket) on a Dialpad user's active device as a screen pop. Returns the device the screen pop was delivered to. Use dialpad_user_screen_pop_trigger to show an agent the caller's record. Requires the screen_pop scope on the connection.
Inputs
screen_pop_uristringrequired- The URL to open on the user's device, starting with a scheme such as https. URLs with embedded credentials (https://user:pass@host) are not supported. Example: https://crm.example.com/contacts/12345
user_idstringrequired- The Dialpad user's ID, or 'me' for the user who authorized the connection. Example: 5719029487116288
dialpad_user_status_updateSet a Dialpad user's custom status message, optionally with an expiration time.WriteUpdate User Status
Set a Dialpad user's custom status message, optionally with an expiration time. Returns the user's updated status. Use dialpad_user_status_update for the status text. Use dialpad_user_dnd_toggle for do-not-disturb and dialpad_operator_duty_status_update for call-center on/off duty.
- Idempotent
Inputs
user_idstringrequired- The Dialpad user's ID, or 'me' for the user who authorized the connection.
expirationinteger- When the status expires, as a UTC Unix timestamp in seconds. Leave empty for no expiration. Example: 1767225600
status_messagestring- The status message to show for the user. Example: In a customer workshop until 3pm
dialpad_callcenter_operator_removeRemove an operator from a Dialpad call center.DestructiveRemove Call Center Operator
Remove an operator from a Dialpad call center. Licenses are not changed or released. Returns the removed operator. Use dialpad_callcenter_operator_remove to take someone out of a queue. To pause them temporarily, use dialpad_operator_duty_status_update instead.
- Idempotent
Inputs
call_center_idintegerrequired- The call center ID, from dialpad_callcenters_list. Example: 5719029487116288
user_idintegerrequired- ID of the operator to remove. Example: 5719029487116288
dialpad_channel_member_removeRemove a Dialpad user from a channel.DestructiveRemove Channel Member
Remove a Dialpad user from a channel. Returns an empty response on success. Use dialpad_channel_member_remove to take someone out. Use dialpad_channel_member_add to add them back.
- Idempotent
Inputs
channel_idintegerrequired- The channel ID, from dialpad_channels_list. Example: 5719029487116288
user_idintegerrequired- The user id. Example: 5719029487116288
No tools match.
