
Beyond-Bot.ai + dialpad
Dialpad is a cloud-based business phone system and contact center platform that enables voice, video, messages and meetings across your existing devices
What You Can Do with this Integration
Automate Data Entry
Automatically sync new contacts or deals from Beyond-Bot.ai to dialpad.
Enrich Customer Profiles
Use Beyond-Bot.ai to find and add new information to your records in dialpad.
Trigger Workflows
Start automated workflows in dialpad based on conversations with your virtual expert.
Available Actions
Here are the specific actions your virtual expert can perform within dialpad.
Access Control Policies Listing
Retrieves a list of access control policies for the authenticated dialpad company. this endpoint allows company administrators to view all custom sets of permissions defined for ai contact center settings. it should be used when auditing existing policies, preparing to assign roles to users, or before creating new policies to avoid duplication. the endpoint provides an overview of all policies but does not include detailed permission sets for each policy. for specific policy details, a separate api call may be required.
Add Blocked Phone Numbers
Adds specified phone numbers to the blocked list in dialpad. this endpoint allows users to block unwanted or spam numbers, preventing incoming calls or messages from these numbers. it accepts a list of e.164 formatted phone numbers and adds them to the user's blocked list. this tool should be used when there's a need to block multiple phone numbers at once, enhancing the platform's call and message filtering capabilities. it's particularly useful for maintaining communication hygiene and reducing unwanted interactions. note that this operation is additive; it doesn't replace the existing blocked list but appends to it.
Add Department Operator By Id
Adds a new operator to a specific department in dialpad. this endpoint allows you to assign either a user or a room as an operator, with the option to specify their role. it's used to manage call handling and department operations by adding new operators or updating existing ones with different roles. the department id is specified in the url path. use this when setting up new departments, expanding existing ones, or adjusting operator assignments and roles within a department.
Add Member To Channel
Adds a new member to a specified channel within the dialpad communication platform. this endpoint allows you to expand the membership of a channel by providing the user id of the person you want to add. it's particularly useful for programmatically managing channel memberships, such as when onboarding new team members or reorganizing communication structures. the endpoint should be used when you need to include a user in a channel's conversations and collaborations. note that this operation only adds the user to the channel; it does not create new users or channels. ensure that both the channel id (specified in the url) and the user id (provided in the request body) exist in your dialpad organization before making this call.
Add Member To Coaching Team
Adds a new member to a specific coaching team in dialpad. this endpoint allows you to assign a user to a coaching team with a designated role, enabling effective team management and performance monitoring. use this when you need to include a new coach or trainee in an existing coaching team. the endpoint requires the coaching team id in the url path and the member details in the request body. it's particularly useful for setting up or expanding coaching teams for call center training and quality assurance purposes.
Add Operator To Call Center
This endpoint adds a new operator to a specified call center in the dialpad system. it allows for the configuration of the operator's role, skill level, and license type, as well as managing phone number retention when switching to a support license. use this endpoint when you need to expand your call center team or adjust an existing user's role within the call center. the endpoint is particularly useful for setting up new operators with specific skill levels and roles, which can help in optimizing call routing and management within the call center. note that while adding an operator, careful consideration should be given to the license type and role assigned, as these affect the operator's capabilities and the associated costs.
Add Operator To Office
This endpoint adds a new operator to a specific office within the dialpad system. it allows administrators to assign users or rooms as operators, enhancing the office's communication capabilities. the endpoint requires the office id (specified in the path), the operator's id, and the type of operator (user or room). optionally, the role of the new operator can be set to either standard operator or admin. use this endpoint when you need to expand or modify the operator team for a particular office, ensuring efficient call handling and management within the dialpad platform.
Add Participant To Call
Adds a new participant to an existing call in the dialpad system. this endpoint allows you to include additional members in an ongoing call by specifying either a phone number or a target within your dialpad organization. use this when you need to add someone to a call that is already in progress, such as bringing in an expert or including a manager in a customer service call. the endpoint requires the id of the existing call and the details of the new participant. it's important to note that the target, if used, must have a primary number assigned in the dialpad system.
Assign Fax Line To Target
Creates and assigns a new fax line to a specified target (user or department) in the dialpad system. this endpoint allows you to set up a fax line with various options, including reserved numbers, area code-based searches, or toll-free numbers. use this when you need to provision a new fax line for a user or department, or when you want to assign an existing number as a fax line. the endpoint is flexible, allowing for different types of fax line assignments based on your specific needs and available numbers. note that the assignment process is immediate, and the fax line will be ready for use once the api call is successful. however, this endpoint does not handle the actual sending or receiving of faxes; it only sets up the line for future use.
Assign Number To Call Router
This endpoint assigns a phone number to a specific call router in the dialpad system. it allows users to either provide a full phone number for assignment or specify an area code to automatically select an available number within that region. the assigned number can optionally be set as the primary number for the call router. this functionality is crucial for setting up and managing call routing within an organization, enabling efficient distribution of incoming calls to the appropriate departments or individuals.
Assign Phone Number To Office
This endpoint assigns a phone number to a specific office in the dialpad system. it allows you to either specify a particular phone number or request an available number from a given area code. the assigned number can optionally be set as the primary number for the office. use this endpoint when you need to add a new phone number to an office or change the office's primary number. it's particularly useful for setting up new offices or modifying existing office phone configurations. note that this endpoint does not handle number porting or releasing existing numbers; it's specifically for assigning available numbers within the dialpad system.
Assign Phone Number To Room
Assigns a phone number to a specified room in dialpad. this endpoint allows you to either assign a specific phone number or request a number from a given area code. it's useful for setting up new rooms or updating existing ones with additional or primary phone numbers. the assigned number can optionally be set as the primary number for the room. use this endpoint when you need to manage phone number assignments for dialpad rooms programmatically.
Assign Phone Number To Target
Assigns a phone number to a specified target within the dialpad system. this endpoint allows you to either assign a specific number or request a number from a given area code. it can be used to add new numbers to various entities such as users, departments, or call centers. the assigned number can optionally be set as the primary number for the target. this tool is particularly useful for managing phone number assignments across different parts of your dialpad organization, enabling flexible number allocation and management.
Assign Phone Number To User
This endpoint assigns a phone number to a specific dialpad user. it allows for either searching for an available number within a given area code or assigning a specific number to the user. the assigned number can optionally be set as the user's primary number. use this endpoint when you need to provide a user with a new phone number or add an additional number to their account. it's particularly useful for setting up new users or expanding the communication capabilities of existing users. note that this endpoint doesn't handle number porting or transferring existing numbers between users.
Assign Policy To User By Id
Assigns an access control policy to a specific user within the dialpad system. this endpoint allows administrators to grant customized settings permissions to users at various levels of the organization: company-wide, for specific offices, or for contact centers. it's particularly useful for implementing role-based access control (rbac) and managing user permissions across different parts of the dialpad platform. the endpoint should be used when setting up new users, modifying existing user permissions, or implementing changes in the organizational structure that require updates to access control policies. note that this feature is part of an early adopter program and may be subject to changes or limitations.
Attach Labels To Call
Creates or updates labels for a specific call in the dialpad system. this endpoint allows you to attach one or more labels to a call, which can be used for categorization, filtering, or tracking purposes. the function takes a call id and an array of label strings, replacing any existing labels on the call with the provided set. use this when you need to categorize a call or update its existing labels. the endpoint is particularly useful for integrating call labeling into automated workflows or custom applications built on top of dialpad. note that this operation will overwrite any previously existing labels on the call.
Configure Call Center Settings
This endpoint creates a new call center within the dialpad system with customizable settings for call handling, routing, operational hours, and advanced features. it allows for detailed configuration of call center behavior, including auto-recording, hold queue management, alert thresholds, and voice intelligence integration. use this endpoint when setting up a new call center or department that requires specific call routing and management capabilities. the endpoint provides extensive customization options but requires careful consideration of settings to ensure optimal call center operation.
Create Access Control Policy
Creates a new access control policy in dialpad, defining a set of permissions and their application scope. this endpoint allows administrators to establish granular control over various dialpad features and settings. it's used to manage user access and configure operational parameters across different levels of the organization. the policy created can encompass a wide range of permissions, from agent settings to ai configurations, enabling customized access control tailored to specific organizational needs. this tool is essential for setting up and maintaining a secure, well-organized communication environment within dialpad.
Create Agent Status Subscription
Creates or updates an agent status subscription for real-time monitoring of contact center agent statuses in dialpad. this endpoint allows you to configure event notifications for changes in agent availability, such as when agents become available, busy, or go off-duty. use this when setting up integrations that require up-to-date information on agent statuses for workforce management, real-time dashboards, or automated workflows. the subscription can be associated with a specific webhook or websocket endpoint for receiving the status updates. note that this endpoint only configures the subscription; you need to separately set up the webhook or websocket to receive the actual event data.
Create Callback
Creates a callback request in a dialpad call center. this endpoint allows you to initiate a callback to a specified phone number through a designated call center. it's useful for implementing features like "request a call" on websites or applications, or for scheduling return calls to customers. the endpoint doesn't immediately place the call but queues it in the specified call center for an agent to handle. note that while both parameters are optional, at least one should be provided for a meaningful request. if no call center id is specified, the system may use a default or return an error, depending on your account configuration.
Create Call Review Share Link
Creates a shareable link for a specific call review in the dialpad platform. this endpoint allows users to generate a url that can be used to share call recordings or summaries with others, either within the company or publicly. it's particularly useful for sharing important call information, training materials, or for compliance purposes. the function provides control over the privacy level of the shared content, allowing for secure sharing within an organization or broader distribution as needed.
Create Call Router Configuration
Creates a new call router in the dialpad system, allowing for custom call routing logic based on a specified url. this endpoint configures essential settings for the call router, including its name, default target for fallback scenarios, and the routing url for decision-making. it's used when setting up a new automated call distribution system or when implementing custom call routing logic for an office. the call router can be enabled or disabled, and includes an optional security feature through a signature secret. note that this endpoint only creates the call router; additional setup may be required in the dialpad interface or through other api calls to fully integrate it into the calling workflow.
Create Channel Endpoint
Creates a new communication channel within the dialpad platform. this endpoint allows users to set up a dedicated space for team collaboration, discussions, or topic-specific conversations. it's particularly useful for organizing communication within a company or project. the created channel can be either public or private, providing flexibility in managing access and information sharing. use this endpoint when you need to programmatically create channels for various teams, projects, or departments, streamlining the process of setting up communication structures within dialpad.
Create Custom Ivr With Audio File
Creates a new custom interactive voice response (ivr) system within the dialpad platform. this endpoint allows you to define and configure an ivr workflow by specifying its type, associated audio file, and target assignment. use this when setting up automated phone menus, call routing systems, or customized voice interactions for different parts of your dialpad organization. the ivr can be assigned to various entities like call centers, departments, or individual users, providing flexibility in managing call flows and customer interactions.
Create New Contact Entry
The createcontact endpoint adds a new contact to dialpad's system. use it to create local or shared contacts with comprehensive information. ideal for user onboarding, data migration, or system integrations. supports various contact details, with some fields restricted to single-line entries for consistency.
Create New Department Record
Creates a new department within the dialpad system with customizable settings for call handling, operating hours, and advanced features. this endpoint allows for detailed configuration of department properties, including automatic call recording, hold queue management, custom operating hours, call routing strategies, and voice intelligence settings. it's particularly useful for setting up complex call flow structures within an organization, enabling efficient call distribution and management. the endpoint requires specifying the department name and associated office id, with numerous optional parameters for fine-tuning department behavior. it's important to note that some default values are applied if optional parameters are not provided, ensuring a functional department setup even with minimal configuration.
Create Pin For International Room Calls
Creates a pin for protected international calls from a dialpad room. this endpoint generates a unique pin that can be used to authenticate and authorize international calls made from a specific dialpad room. it's particularly useful for businesses that want to control and track international calling capabilities within their organization. the generated pin adds an extra layer of security, ensuring that only authorized users can make international calls from the room. use this endpoint when you need to set up or refresh international calling access for a room, especially in scenarios where you want to monitor usage or restrict access to certain team members.
Create Room In Office Via Post
Creates a new room within a specified office in the dialpad system. this endpoint is used to set up physical or virtual spaces for collaboration, meetings, or other communication purposes. it allows you to define a room with a name and associate it with a specific office. this is particularly useful for organizations managing multiple locations or wanting to organize their communication spaces efficiently. the created room can then be used for various purposes such as scheduling meetings, assigning resources, or managing call routing within the dialpad platform.
Create Schedule Reports Endpoint
Creates a scheduled report in the dialpad system for various types of communication data. this endpoint allows users to automate the generation and delivery of reports on a regular basis, such as call logs, user statistics, or voicemails. it's particularly useful for managers, administrators, and analysts who need consistent, periodic insights into communication patterns and performance metrics. the endpoint offers flexible scheduling options, including daily, weekly, or monthly frequencies, and can target specific organizational units or user groups. use this when you need to set up recurring reports for monitoring, compliance, or analytical purposes. note that this endpoint creates a new schedule; to modify existing schedules, use the appropriate update endpoint.
Create Secondary Office
Creates a new office within the dialpad system with specified configurations and settings. this endpoint allows you to set up a new office location or entity, including its billing information, operational hours, routing options, and various communication preferences. use this when you need to add a new office to your dialpad organization, such as when expanding to a new location or setting up a separate department with its own communication settings. the endpoint requires several mandatory parameters for basic office setup and billing, while offering numerous optional parameters for fine-tuning office operations and call handling. note that some settings, like voice intelligence and e911 address, may have regulatory implications depending on your location and should be configured carefully.
Create Sms Event Subscription
Creates a new sms event subscription in the dialpad api, allowing users to receive notifications for inbound and/or outbound sms messages. this endpoint enables fine-grained control over sms event monitoring, including options for filtering by direction, target, and message type. it's particularly useful for integrating real-time sms notifications into external systems or applications. the subscription can be configured to include or exclude internal company messages and to provide updates on message delivery statuses. use this endpoint when setting up new sms monitoring systems or when adjusting existing subscription parameters.
Create User With Auto Assign
Creates a new user account in the dialpad system with the specified details. this endpoint allows you to add a new user to your dialpad organization, set up their basic profile information, assign them to an office, and optionally auto-assign a phone number. it's particularly useful for bulk user creation or when integrating dialpad user management with other systems. the endpoint requires at minimum an email and office id, with options to further customize the user's profile and permissions through additional parameters. note that while a license can be specified, it defaults to 'talk' if not provided, ensuring that the new user has basic dialpad functionality.
Create Webhook Post Endpoint
Creates a new webhook integration for receiving real-time event notifications from dialpad. this endpoint allows you to specify a url where dialpad will send event data when specific actions occur within the dialpad system. it's essential for building responsive, event-driven integrations with dialpad. the endpoint also supports an optional secret for verifying the authenticity of incoming webhook requests, enhancing security. use this when you need to set up automated workflows or sync dialpad events with external systems.
Deauthorize Oauth2 Session
Deauthorizes (revokes) an oauth2 access token, effectively terminating the application's access to the dialpad api. this endpoint should be used when an application needs to invalidate its current access token, such as during user logout, when suspending an integration, or in response to potential security threats. it's an essential security measure to prevent unauthorized access once a token is no longer needed or potentially compromised. note that after deauthorization, the application will need to re-authenticate to obtain a new access token for future api calls. this endpoint does not return any specific data; a successful call simply invalidates the token.
Delete Access Control Policy By Id
Deletes a specific access control policy from the dialpad system. this endpoint allows company administrators to remove custom permission settings that were previously created for managing user roles and access within the dialpad platform. it should be used when a particular access control policy is no longer needed or requires complete removal from the system. this operation is permanent and cannot be undone, so it should be used with caution. the endpoint does not return the deleted policy details; it typically returns a success status upon successful deletion.
Delete Agent Status By Id
Deletes a specific agent status subscription identified by its unique id. this endpoint is used to stop receiving real-time updates about an agent's status (e.g., available, busy, off-duty) in the dialpad system. it should be used when you no longer need to track the status changes for a particular agent or when cleaning up unused subscriptions. the operation is irreversible, so care should be taken to ensure the correct subscription id is provided. this endpoint does not return the deleted subscription details; it typically returns a success status code upon successful deletion.
Delete Call Center By Id
Deletes a specific call center from the dialpad system. this endpoint should be used when you need to permanently remove a call center from your dialpad account. it's important to note that this action is irreversible and will affect all associated resources, such as agents, call logs, and configurations linked to the specified call center. before using this endpoint, ensure that all necessary data has been backed up or migrated. this operation may have significant implications for ongoing operations, so it should be used with caution and typically requires appropriate authorization.
Delete Callreviewsharelink By Id
This endpoint deletes a specific call review share link in the dialpad system. it's used to revoke access to a previously shared call review, ensuring that the link can no longer be used to view the associated call information. this action is permanent and should be used when you want to immediately prevent further access to a shared call review, such as when sensitive information was mistakenly shared or when the review is no longer relevant. once deleted, the share link cannot be recovered, and anyone attempting to use it will receive an error.
Delete Callrouter By Id
Deletes a specific call router from the dialpad system. this endpoint should be used when you need to remove an existing call routing configuration, such as when restructuring your call flow or decommissioning outdated routing rules. the deletion is permanent and cannot be undone, so use with caution. this operation will immediately affect incoming calls that were previously handled by the deleted router, potentially disrupting call flows if not properly managed. ensure that any dependencies on the call router (e.g., dids or mainline menu routings) are updated before deletion to maintain smooth call handling.
Delete Call Subscription By Id
Deletes a specific call subscription from the dialpad system. this endpoint should be used when an application no longer needs to receive real-time notifications for a particular call-related event or functionality. it allows developers to clean up unused subscriptions, potentially freeing up resources and reducing unnecessary data processing. the deletion is permanent and cannot be undone, so use this endpoint with caution. it's important to note that this operation only affects the specified subscription and does not impact any other active subscriptions or ongoing calls.
Delete Channel By Id
Deletes a specific channel from the dialpad communication platform. this endpoint should be used when you need to remove a communication channel that is no longer needed or has become obsolete. it permanently removes the channel and all associated data, so it should be used with caution. this operation cannot be undone, and once a channel is deleted, it cannot be recovered. the endpoint is useful for maintaining a clean and organized communication structure within your dialpad account.
Delete Channel Member By Id
Removes a specified member from a dialpad channel. this endpoint allows you to delete a user from a particular channel, effectively revoking their access and participation in that channel's communications. it should be used when you need to remove a team member from a specific collaboration space, such as when an employee changes roles or leaves the organization. the endpoint requires the channel id (specified in the url path) and the user id of the member to be removed. note that this action is irreversible, and the removed member will lose access to the channel's history and future communications. it's important to ensure you have the necessary permissions to remove members before using this endpoint.
Delete Contact By Id
Deletes a specific contact from the dialpad system using the provided contact id. this endpoint should be used when you need to permanently remove a contact's information from your dialpad account. it's important to note that this action is irreversible, and once a contact is deleted, it cannot be recovered through the api. use this endpoint with caution, ensuring that you have verified the correct contact id before deletion. this operation affects both shared company contacts and user-specific local contacts, depending on the scope of the provided id.
Delete Customivr By Targettype And Ivrtype
Deletes a custom interactive voice response (ivr) configuration from a specified target in the dialpad system. this endpoint is used to remove ivr settings, allowing for the reset or reconfiguration of call routing and automated response systems. it's particularly useful when updating ivr workflows or when a specific ivr configuration is no longer needed. the operation affects the ivr settings for the specified target type and id, with an option to limit the change to either inbound or outbound calls in call center contexts. this endpoint should be used cautiously, as deleting an ivr configuration is irreversible and may impact existing call routing processes.
Delete Department Resource
Deletes a specific department from the dialpad system. this endpoint should be used when you need to remove a department that is no longer needed or has been deprecated within your organization's structure. the operation is irreversible, so it should be used with caution. once a department is deleted, all associated data, such as user assignments and resource allocations, may be affected. this endpoint is particularly useful for maintaining an up-to-date organizational structure in dialpad, especially during restructuring or when cleaning up obsolete departments.
Delete Deskphone By User Id
Deletes a specific deskphone associated with a user in the dialpad system. this endpoint should be used when you need to remove a deskphone from a user's account, such as when the device is no longer in use or needs to be reassigned. the operation is permanent and cannot be undone, so it should be used with caution. this endpoint is particularly useful for managing hardware inventory and ensuring that user accounts accurately reflect their current device assignments.
Delete Deskphone In Room
This endpoint removes a specific deskphone from a designated room within the dialpad system. it's used to unassign or decommission a deskphone from a particular shared space, such as a conference room or reception area. the operation is permanent and should be used with caution as it will disassociate the deskphone from the room, potentially affecting call routing and room communication capabilities. this endpoint is particularly useful during office reorganizations, when updating room phone setups, or when removing faulty devices from the system. note that this operation only removes the association between the deskphone and the room; it does not delete the deskphone from the overall dialpad account.
Delete Number Via Api
Deletes a specific phone number from the user's dialpad account. this endpoint should be used when a phone number is no longer needed and needs to be removed from the system. it's important to note that this action is irreversible, and once a number is deleted, it may not be possible to reclaim the same number. this endpoint is particularly useful for managing phone inventory, removing temporary numbers, or cleaning up unused numbers to optimize resource allocation. the deletion process may have implications on call routing, billing, and other phone-related features within dialpad, so it should be used with caution and only when the user is certain that the number is no longer required.
Delete Office Operator By Id
Removes a specified operator (user or room) from a particular office in the dialpad system. this endpoint is used to manage the association between operators and offices, allowing administrators to control access and permissions within the organization's structure. it should be used when you need to disassociate a user or a room from an office, such as when an employee changes departments or a shared space is no longer used for a specific office. the endpoint requires both the operator's id and type to ensure precise removal of the correct entity. note that this action does not delete the user or room from the system entirely; it only removes their association with the specified office.
Delete Operator From Call Center
Removes a specified operator from a call center in the dialpad system. this endpoint should be used when you need to disassociate an agent or user from a particular call center, such as when an employee changes roles or leaves the organization. the operation is permanent and cannot be undone through this api. if you need to re-add the operator to the call center, you would need to use a separate api call. note that this endpoint only removes the operator's association with the call center; it does not delete the user account from dialpad.
Delete Operator From Department
Removes a specified operator from a department in the dialpad system. this endpoint is used to update department operator assignments by removing either a user or a room from the list of operators for a given department. it's particularly useful for managing call routing and department resources. the endpoint requires both the operator's unique id and type (user or room) to ensure accurate removal. use this when reorganizing department structures, changing operator assignments, or updating call handling workflows. note that this action is irreversible and may affect ongoing call routing for the department.
Delete Recording Share Link By Id
Deletes a specific recording share link in the dialpad system. this endpoint is used to revoke access to a shared recording by removing the associated link. it should be called when you want to prevent further access to a recording through a previously generated share link. this action is permanent and cannot be undone, so use it cautiously. the endpoint is particularly useful for maintaining privacy and controlling access to sensitive or outdated recorded content.
Delete Room By Id
Deletes a specific room from the dialpad system using its unique identifier. this endpoint should be used when you need to remove a room that is no longer in use or has been decommissioned, such as a closed conference room or a removed reception desk. the deletion is permanent and cannot be undone, so use this endpoint with caution. it's important to note that deleting a room will also remove any associated configurations, such as room phone settings or extensions. this operation is part of dialpad's room management functionality and helps maintain an up-to-date inventory of active rooms in your organization.
Delete Schedule Report By Id
Deletes a specific scheduled report from the dialpad system. this endpoint allows users to permanently remove a previously configured report that was set up for automatic generation and delivery. it should be used when a particular scheduled report is no longer needed or when you want to stop the automatic generation of a specific report. this operation cannot be undone, so it should be used with caution. the endpoint will not provide any information about the deleted report; it will only confirm the successful deletion or return an error if the operation fails.
Delete Sms Subscription By Id
Deletes a specific sms subscription from the dialpad system. this endpoint should be used when you want to cancel or remove an existing sms subscription, such as when a user no longer needs sms services or wants to change their subscription plan. the operation is irreversible, so it should be used with caution. once deleted, the subscription and its associated settings will no longer be available. this endpoint only handles the deletion process and does not provide any information about the subscription being deleted. it's important to ensure that you have the correct subscription id before making this call, as there is no way to recover a mistakenly deleted subscription.
Delete Subscription Changelog By Id
Deletes a specific changelog entry from a subscription in the dialpad system. this endpoint is used to permanently remove a record of changes made to a subscription, which could include modifications to webhook configurations, event subscriptions, or other subscription-related settings. it should be used when you need to clean up or remove outdated or erroneous changelog entries. be cautious when using this endpoint, as deleting changelog entries may affect auditing and tracking capabilities. note that this operation is irreversible, and once a changelog entry is deleted, it cannot be recovered. this endpoint is part of dialpad's subscription management api and helps maintain an accurate and up-to-date record of subscription changes.
Delete Subscription Contact By Id
Deletes a specific subscription contact from the dialpad system. this endpoint should be used when you need to remove a contact from your subscription list, such as when a user unsubscribes or when cleaning up outdated contact information. the operation is irreversible, so use it with caution. this endpoint only handles the deletion process and does not return the deleted contact's information. it's important to note that this action may affect any ongoing subscriptions or notifications associated with the deleted contact.
Delete User By Id
Deletes a user from the dialpad system based on the provided user id. this endpoint should be used when permanently removing a user's account and associated data from dialpad. it's important to note that deleted users can be restored for up to 72 hours after deletion, after which their records are anonymized. use this endpoint with caution as it will remove the user's access to dialpad services and may affect team structures or ongoing communications. this operation cannot be undone after the 72-hour restoration period.
Delete Webhook By Id
Deletes a specific webhook subscription from the dialpad platform using its unique identifier. this endpoint should be used when you want to stop receiving real-time event notifications for a particular webhook. it's important to note that once a webhook is deleted, it cannot be recovered, and you will need to create a new webhook subscription if you wish to receive events again. this operation is useful for managing webhook subscriptions, especially when cleaning up outdated or unnecessary event listeners in your integration with dialpad.
Delete Websocket Connection By Id
Closes and removes a specific websocket connection in the dialpad system. this endpoint should be used when an application needs to programmatically terminate a real-time event subscription or clean up unused websocket connections. it's particularly useful for managing resources and ensuring that inactive or unnecessary websocket connections are properly closed. this operation is irreversible, so it should be used with caution. once a websocket is deleted, any active subscriptions or real-time data streams associated with it will be immediately terminated.
Fetch Call Byid
Retrieves detailed information about a specific call using its unique identifier. this endpoint allows developers to access comprehensive data about a particular call made through the dialpad platform. it should be used when you need to fetch specific call details for purposes such as logging, analysis, or displaying call information to users. the endpoint provides a snapshot of the call at the time of the request, including details like duration, participants, and call status. it does not provide real-time updates for ongoing calls; for that, you would need to poll the endpoint or use a different real-time communication method. this endpoint is particularly useful for applications that need to integrate call history or detailed call records from dialpad.
Fetch Call Transcript By Id
Retrieves the transcript for a specific call in the dialpad system. this endpoint allows you to fetch the text representation of the spoken content from a particular call or meeting. it's useful for reviewing conversation details, analyzing call content, or creating searchable records of communications. the transcript is generated using dialpad's ai-powered transcription feature, which provides accurate text conversion of audio content. use this endpoint when you need to access the written record of a call for purposes such as quality assurance, training, or content analysis. note that the availability and accuracy of transcripts may depend on the audio quality of the original call and the capabilities of the ai transcription system.
Fetch Custom Ivrs
Retrieves a list of all custom interactive voice response (ivr) configurations associated with the authenticated dialpad account. this endpoint allows developers to fetch comprehensive details about the custom ivrs set up in their dialpad system, including menu structures, voice prompts, and routing rules. it's particularly useful for auditing existing ivr setups, gathering information for reporting purposes, or syncing ivr configurations with external systems. the endpoint returns all custom ivrs by default, without requiring any parameters. however, it does not provide real-time analytics or call logs related to these ivrs. use this endpoint when you need an overview of your ivr landscape or when preparing to make bulk updates to your ivr configurations.
Fetch Operators For Office Id
Retrieves a list of operators associated with a specific office in dialpad. this endpoint should be used when you need to get information about the operators managing calls and operations within a particular office. it's useful for auditing office structure, managing call center operations, or gathering data for reporting purposes. the endpoint returns details about the operators, which may include their names, ids, roles, and current statuses. note that this endpoint only provides information about operators and does not allow for modifying operator data or office structure.
Fetch Scheduled Reports
Retrieves a list of scheduled reports from the dialpad system. this endpoint allows users to fetch information about reports that have been set up for automatic generation on a regular basis. it's particularly useful for administrators or users who need to review or manage the scheduled reporting configuration within their dialpad account. the endpoint supports filtering by report type, frequency, and date range, making it easy to find specific scheduled reports. it should be used when there's a need to audit existing report schedules, verify report configurations, or gather information about automated reporting processes in place. note that this endpoint only provides metadata about the scheduled reports, not the actual report content itself. it's ideal for getting an overview of reporting activities but not for accessing the report data directly.
Fetch Transcript Url By Call Id
Retrieves the url of a transcript for a specific call in the dialpad system. this endpoint allows developers to access the text version of a call's audio content by providing the unique identifier of the call. the returned url can be used to fetch the actual transcript content. this tool is particularly useful when you need to programmatically access call transcripts for analysis, record-keeping, or integration with other systems. it should be used when a user needs to obtain the transcript url for a known call id, but not for directly retrieving the transcript content itself.
Fetch User Details By Id
Retrieves detailed information about a specific user in the dialpad system. this endpoint is used to fetch comprehensive user data, including profile details, account settings, and associated communication information. it's particularly useful for user management tasks, such as verifying user information, updating records in external systems, or displaying user profiles in integrated applications. the endpoint returns a single user object based on the provided user id. it should be used when detailed information about a particular user is needed, but it will not provide aggregate data or information about multiple users simultaneously. note that the specific fields returned may depend on the requester's permissions and the user's privacy settings.
Format Phone Numbers
The format phone number endpoint is used to standardize and format phone numbers within the dialpad ecosystem. this tool takes a raw phone number input and converts it into a specified or default format, ensuring consistency across the platform. it's particularly useful when integrating new contact information, preparing numbers for display, or standardizing data for call routing purposes. the endpoint supports various input formats and can adapt to different country-specific number structures, making it versatile for international use. however, it's important to note that this tool is for formatting purposes only and does not validate the existence or operability of the phone number.
Get Available Licenses For An Office
Retrieves the number of available (unused) licenses for a specific office within a dialpad organization. this endpoint is used to check the current license capacity and availability before assigning new licenses to users or features. it provides essential information for office administrators to manage their license inventory effectively. the endpoint should be used when planning user onboarding, upgrading subscriptions, or performing license audits. note that this endpoint only returns information about unassigned licenses and does not provide details about currently assigned licenses or their usage.
Get Call Center Status By Id
Retrieves the current operational status of a specific call center in the dialpad system. this endpoint allows you to get real-time information about a call center's state, which can include details such as whether it's active, the number of agents available, current call volume, or any ongoing issues. it's particularly useful for monitoring call center performance, making informed decisions about resource allocation, or triggering automated workflows based on the call center's status. the endpoint should be used when you need up-to-the-minute information about a call center's operational condition, but it does not provide historical data or detailed analytics.
Get Call Labels
Retrieves a list of all available call labels in the dialpad system. this endpoint allows users to fetch the current set of labels that can be applied to calls for categorization and management purposes. it's particularly useful for applications that need to display or use the full range of call labeling options in their interface or logic. the endpoint returns a collection of call labels, likely including their names and any associated metadata. it should be used when initializing call management interfaces or when needing to synchronize local label data with the current state in dialpad. note that this endpoint does not provide information about which labels are applied to specific calls; it only returns the set of available labels.
Get Call Review Share Link By Id
Retrieves or generates a share link for a specific call review in the dialpad system. this endpoint allows users to obtain a unique url that can be used to share call review data, including summaries, transcripts, or analysis, with other team members or external parties. the share link provides a convenient way to collaborate on call reviews without requiring direct access to the dialpad platform. this tool should be used when a user needs to distribute call review information quickly and securely. it's particularly useful for managers sharing feedback, trainers providing examples, or team members collaborating on customer interactions. the endpoint does not provide the actual call review content, only the means to access it via the generated link.
Get Call Subscription Details
Retrieves a list of call subscriptions associated with the authenticated user's account in the dialpad platform. this endpoint allows developers to fetch details about existing call event subscriptions, which are used to receive real-time updates on call states and activities. it should be used when an application needs to monitor or manage the current set of call subscriptions, such as for auditing purposes or to verify the existence of specific subscriptions. the endpoint does not create, modify, or delete subscriptions; it only provides read access to the existing subscription data. note that the response may include various types of call subscriptions, and developers should be prepared to handle different subscription formats or filters that may be present in the returned data.
Get Channel Members By Id
Retrieves a list of members for a specific channel in dialpad. this endpoint allows you to fetch user information for all members associated with the given channel id. it's useful for obtaining an overview of channel participants, which can be helpful for managing team collaboration, assigning tasks, or analyzing channel activity. the endpoint should be used when you need to access member details for a particular channel, such as when displaying member lists, checking channel membership, or performing channel-related operations that require knowledge of its members. note that this endpoint only provides member information and does not modify the channel or its membership.
Get Departments By Office Id
Retrieves a list of all departments associated with a specific office in the dialpad system. this endpoint is essential for understanding the organizational structure within a company's dialpad account. it should be used when there's a need to view, manage, or analyze the departmental breakdown of a particular office. the endpoint provides a comprehensive overview of the office's internal structure, which can be valuable for administrative tasks, reporting, or integration with other systems. note that this endpoint only returns department information and does not provide details about individual users within those departments.
Get Deskphone By Parent Id
Retrieves detailed information about a specific deskphone within a designated room or parent entity in the dialpad system. this endpoint is useful for obtaining the current configuration, status, and attributes of a particular deskphone device. it should be used when you need to access or verify the details of a single deskphone, such as during troubleshooting, inventory management, or when updating device settings. the endpoint does not modify any data and is intended for read-only operations. keep in mind that the response will only provide information about the specified deskphone and will not include details about other devices or the parent entity itself.
Get Deskphones For User Parent Id
Retrieves a list of deskphones associated with a specific user in the dialpad system. this endpoint is useful for managing and tracking the deskphone inventory assigned to individual users within an organization. it can be used to audit user equipment, troubleshoot connectivity issues, or gather information for user setup and onboarding processes. the endpoint returns details about all deskphones linked to the specified user, which may include information such as deskphone models, serial numbers, and configuration status. this tool should be used when you need to obtain a comprehensive view of a user's assigned deskphone equipment in dialpad.
Get Deskphones In Rooms
Retrieves a list of deskphones associated with a specific room in the dialpad system. this endpoint is used to get detailed information about the communication devices deployed in shared spaces such as conference rooms, reception areas, or phone booths. it provides an overview of the deskphones' configuration and status within the context of a particular room. use this endpoint when you need to inventory, manage, or troubleshoot deskphones in a specific location. the response likely includes details such as deskphone models, serial numbers, configuration status, and any associated user information. this tool is particularly useful for it administrators and facilities managers who need to maintain an up-to-date record of communication equipment in various rooms across the organization.
Get Office Call Centers
Retrieves a list of call centers associated with a specific office in the dialpad platform. this endpoint allows administrators and developers to fetch information about all call centers within a given office, which is useful for managing and organizing communication resources. use this endpoint when you need to get an overview of call center units within an office, such as for reporting, resource allocation, or integration purposes. the endpoint returns basic information about each call center, but detailed configuration or real-time status may require additional api calls.
Get Operator Skills By Call Center And User
Retrieves the skill information for a specific operator within a designated call center. this endpoint allows you to access details about an operator's assigned skills, which are crucial for efficient call routing and task assignment in the call center environment. use this endpoint when you need to review or verify an operator's capabilities, such as language proficiency, technical expertise, or customer service specialization. the retrieved information can be valuable for workforce management, skill-based routing configurations, and ensuring optimal operator-to-task matching. note that this endpoint only provides skill data and does not allow for skill modification; separate endpoints would be required for updating skills.
Get Phone Number Details
Retrieves detailed information about a specific phone number associated with the dialpad account. this endpoint allows you to fetch comprehensive data about a single phone number, including its current status, assigned user or department, tags, and other relevant attributes. use this endpoint when you need to access or verify the details of a particular phone number within your dialpad system. it's particularly useful for auditing phone number assignments, checking number status, or retrieving associated metadata. the endpoint does not modify any data and is safe for frequent use, making it ideal for real-time information retrieval or periodic synchronization with external systems.
Get Recording Share Link By Id
Retrieves detailed information about a specific recording share link in the dialpad system. this endpoint allows you to fetch the current status, settings, and metadata associated with a previously created share link for a call recording. it's particularly useful when you need to verify the current state of a share link, check its expiration status, or retrieve the associated recording details. the endpoint should be used when you have a valid recording share link id and need to access its up-to-date information. note that this endpoint only provides information about the share link itself and does not return the actual recording content.
Get Rooms List
Retrieves a list of all available meeting rooms or spaces within the dialpad system. this endpoint is essential for managing and organizing video-enabled meetings, allowing users to view and select appropriate meeting spaces for their needs. it provides an overview of both physical conference rooms and virtual meeting spaces, supporting dialpad's hybrid team collaboration features. use this endpoint when you need to display available rooms, check room capabilities, or integrate room selection into scheduling workflows. the response likely includes details such as room names, capacities, available equipment (e.g., poly studio x integration), and potentially real-time availability status. this endpoint does not create or modify rooms; it's purely for fetching room information. keep in mind that the returned data may need to be combined with calendar integration data to provide a complete picture of room availability.
Get Subscription Contact By Id
Retrieves the subscription information for a specific contact in the dialpad system. this endpoint allows you to access details about a contact's current subscription status, type, and related information. use this when you need to check or verify the subscription details for a particular contact, such as during account management or support processes. the endpoint focuses solely on subscription data and does not provide other contact information or modify any existing data. it's particularly useful for scenarios involving subscription management, billing inquiries, or when integrating dialpad's contact subscription system with other applications.
Get User Caller Id
Retrieves the caller id information for a specific user in the dialpad system. this endpoint allows you to fetch the current caller id settings associated with a user's account, which may include their display name, phone number, or other identifying information used when making outbound calls. it's particularly useful for administrators or integrations that need to verify or display a user's current caller id configuration. the endpoint should be used when you need to check or display a user's caller id settings, but not for modifying these settings. note that this endpoint only provides read access to the caller id information and cannot be used to update or change the caller id settings.
Get User Deskphones
Retrieves detailed information about a specific deskphone associated with a particular user in the dialpad system. this endpoint is useful when you need to access or verify the configuration, status, or other attributes of a user's deskphone. it should be used when you have both the user's id and the specific deskphone id, and need to fetch the most up-to-date information about that device. this endpoint does not modify any data and is safe for frequent calls, but consider caching the results if you're making multiple requests for the same deskphone in a short period.
Get User E911 Details
Retrieves the enhanced 911 (e911) information for a specific user in the dialpad system. this endpoint provides critical location data associated with the user's account, which is essential for emergency services to accurately locate the caller during an emergency. it should be used when setting up or verifying a user's emergency contact information, ensuring compliance with e911 regulations for voip services. the tool returns the current e911 configuration for the specified user, including registered address and any additional location details. it's important to note that this endpoint only retrieves information and does not modify any e911 settings.
Get Webhooks Information
Retrieves a list of all webhooks configured for the authenticated user's dialpad account. this endpoint allows developers to view and manage their existing webhook subscriptions for various communication events such as calls, sms, contacts, and agent status changes. it should be used when you need to audit your current webhook configurations, verify the status of your integrations, or gather information before modifying existing webhooks. the endpoint provides an overview of active webhooks but does not include detailed event data or allow for webhook creation or modification.
Hangup Call Via Id
Terminates an active call in the dialpad system. this endpoint should be used when you need to programmatically end a specific ongoing call. it's particularly useful for automated call management, such as in customer service systems or when integrating dialpad's functionality into other applications. the endpoint has a rate limit of 1200 requests per minute, allowing for high-volume usage in busy call centers or large-scale communication systems. note that this action is irreversible; once a call is hung up, it cannot be reinstated, and a new call would need to be initiated if further communication is required.
Initiate Ivr Call Api Endpoint
Initiates an outbound ivr (interactive voice response) call using the dialpad api. this endpoint allows you to programmatically start a call to a specified phone number from a designated group within your dialpad organization, such as a call center, department, or office. it's particularly useful for automating outbound calls, implementing scheduled call campaigns, or integrating dialpad's calling capabilities into your own applications. the endpoint provides options for customizing the call with additional data and managing the displayed caller id, enhancing flexibility in various use cases like customer service, sales outreach, or automated notifications.
Initiate Outbound Call Via Api
The initiateoutboundcall endpoint allows you to programmatically initiate an outbound call using the dialpad api. this tool is used to place calls on behalf of a dialpad user to a specified phone number. it supports various customization options, including setting custom caller id, associating the call with a group, and enabling consult mode for handling multiple calls. use this endpoint when you need to automate outbound calling in your application, such as for customer outreach, automated notifications, or integrating calling capabilities into your workflow. the endpoint is particularly useful for scenarios requiring programmatic call initiation, but it does not handle the actual call audio or provide real-time call control. be aware that the call's success depends on the user's dialpad account status and permissions.
Initiate User Call With Group Options
Initiates an outbound call for a specified dialpad user. this endpoint allows you to programmatically start a phone call to a given number, with options to customize the call's properties such as the caller id and associated group. it's particularly useful for automating outbound calling processes or integrating dialpad's calling capabilities into other applications. the endpoint supports additional features like custom data association for call tracking and the ability to initiate calls through specific organizational groups. note that while the endpoint doesn't explicitly mark any parameters as required, a valid destination phone number is necessary to initiate a call.
List Channels Api
Retrieves a list of all available communication channels in the dialpad platform. this endpoint provides an overview of the various channels that can be used for voice, sms, and other digital engagement methods within dialpad. it should be used when you need to obtain information about the communication options available to your account or organization. the endpoint returns details about each channel, which may include channel ids, types (e.g., voice, sms), and their current status. this tool is particularly useful for applications that need to dynamically adjust their communication strategies based on available channels or for monitoring the health and availability of different communication methods in dialpad. note that this endpoint likely returns only basic channel information and may not include detailed usage statistics or real-time activity data.
List Conference Rooms
Retrieves a list of conference rooms available in the dialpad system. this endpoint allows users to fetch information about both virtual and physical conference rooms set up within their dialpad account. it can be used to gather details such as room names, capacities, and configurations for scheduling or managing meetings. the endpoint is particularly useful for applications that need to display available conference rooms or integrate dialpad's room information into third-party scheduling systems. note that this endpoint does not provide real-time availability of rooms or allow for booking; it's primarily for listing and describing the configured rooms.
List Offices Endpoint
Retrieves a list of offices within the dialpad platform. this endpoint provides access to office information, which is crucial for managing multiple offices in an organization using dialpad. it should be used when you need to obtain an overview of all offices or gather specific details about offices registered in the dialpad system. the endpoint likely returns essential information such as office names, locations, administrators, and possibly user counts or other relevant metadata. it's important to note that this endpoint does not modify any office data and is intended for read-only operations. keep in mind that the returned data may be subject to the user's permissions within the dialpad system.
List Users
Retrieves a list of users from the dialpad system. this endpoint allows you to fetch user account information, which is essential for user management and provisioning tasks. it can be used to sync user data with external systems, perform audits, or gather information for reporting purposes. the endpoint likely supports pagination and filtering options to manage large sets of user data efficiently. however, it does not provide real-time updates or webhook functionality for user changes - separate endpoints or features would be needed for those use cases.
Modify Contact Details Using Id
Updates an existing contact's information in the dialpad system. this endpoint allows for partial updates of contact details, including personal information, communication details, and associated urls. it's used when you need to modify or add information to an existing contact record. the endpoint supports updating multiple fields simultaneously, making it efficient for bulk changes or comprehensive contact updates. note that all fields are optional, allowing for targeted updates without affecting other contact information. when updating list-based fields like emails or phones, the provided lists will replace the existing data entirely.
Modify Custom Ivr Settings
Updates a custom interactive voice response (ivr) configuration for a specific target within the dialpad system. this endpoint allows you to assign an existing ivr workflow to a particular target (such as a call center or department) and specify its application for inbound, outbound, or both types of calls. it's particularly useful for customizing call routing and auto-recording settings in call centers. the endpoint requires specifying the target type, target id, and ivr type in the url path, along with the ivr id in the request body. use this when you need to modify ivr settings for specific departments or call centers in your dialpad organization.
Modify Operator Skill Level
Updates the skill level of a specific operator in a designated call center. this endpoint allows administrators to adjust an operator's proficiency rating, which can be used for call routing, performance tracking, and workforce management. the skill level is represented as an integer from 0 to 100, with higher values indicating greater expertise. use this endpoint when you need to modify an operator's skill level based on performance reviews, training completion, or changes in responsibilities. it's particularly useful for maintaining an up-to-date and accurate representation of your call center team's capabilities.
Modify Webhook Configuration
Updates an existing webhook configuration in the dialpad api. this endpoint allows you to modify the destination url and/or the secret used for request validation of a specific webhook. use this when you need to change where webhook events are sent or update the security settings of an existing webhook. the endpoint is particularly useful for maintaining webhook configurations as your integration evolves or when you need to rotate security credentials. note that updating these settings will affect all future events for this webhook, so ensure your receiving endpoint is prepared for the changes before updating.