Dialpad

Retrieves call information from the dialpad system. this endpoint allows you to fetch details about one or more calls, which may include call duration, participants, timestamps, and other relevant metadata. it can be used to gather historical call data for analysis, reporting, or integration with other systems. the endpoint does not provide real-time call control or the ability to initiate new calls. note that the specific details returned may vary based on user permissions and the scope of the api token used.

Action Parameters

Action Response

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.

Action Parameters

Action Response

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.

Action Parameters

Action Response

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.

Action Parameters

Action Response

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.

Action Parameters

Action Response

Updates the signature secret for a specific websocket connection in the dialpad platform. this endpoint allows you to modify the authentication mechanism used to validate incoming requests to the websocket. use this when you need to rotate the secret for security reasons or when setting up a new authentication scheme for an existing websocket. the update affects future validations and may require updating the secret on the client-side as well. be cautious when using this endpoint, as it can potentially disrupt active connections if not managed properly. note that setting the secret to null effectively removes any signature validation for the websocket, which should only be done if alternative security measures are in place.

Action Parameters

Action Response

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.

Action Parameters

Action Response

Sets or blocks the caller id for a specific dialpad user. this endpoint allows you to define the phone number that will be displayed when the user makes outgoing calls, or to block the caller id entirely. use this when you need to customize how a user’s calls appear to recipients or to ensure privacy by blocking the caller id. the endpoint is particularly useful for managing professional appearances in business communications or for compliance with privacy regulations. note that this setting affects all outgoing calls made by the user through the dialpad platform.

Action Parameters

Action Response

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.

Action Parameters

Action Response

Retrieves a list of teams associated with a specific office in the dialpad organization. this endpoint is useful for getting an overview of the team structure within a particular office, which can be valuable for administrative tasks, reporting, or integrating dialpad’s organizational structure with other systems. it should be used when you need to obtain information about multiple teams within a single office context. the endpoint will not provide detailed information about individual team members or their communications; it focuses solely on team-level data within the specified office.

Action Parameters

Action Response

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.

Action Parameters

Action Response

Creates a new call event subscription in the dialpad system, allowing real-time notifications for various call states and actions. this endpoint enables developers to set up targeted event streams for specific call centers, users, or other entities within dialpad. use this when you need to monitor call activities, automate workflows based on call states, or integrate dialpad’s call data with external systems. the subscription can be fine-tuned to listen for specific call states and target types, making it versatile for various use cases such as call monitoring, analytics, or custom integrations. note that while the subscription can be created with this endpoint, you’ll need to have a properly configured webhook or websocket to receive the events.

Action Parameters

Action Response

Retrieves detailed information about a specific webhook configuration in the dialpad system. this endpoint allows developers to fetch the current status, settings, and event subscriptions for a particular webhook identified by its unique id. use this endpoint when you need to check the configuration of an existing webhook, verify its status, or retrieve its associated event types. it’s particularly useful for troubleshooting webhook-related issues or auditing webhook configurations. the endpoint returns comprehensive data about the webhook, including its target url, subscribed events, and any custom headers or authentication settings.

Action Parameters

Action Response

Creates or updates a subscription for changelog events in the dialpad system. this endpoint allows developers to set up real-time notifications for changes and updates within dialpad, such as api modifications, feature releases, or system updates. by configuring this subscription, you can ensure your application stays informed about important changes that may affect its integration with dialpad. the subscription can be enabled or disabled as needed, and notifications are sent to a pre-configured webhook or websocket endpoint. use this when you need to monitor dialpad’s evolving features and api changes to maintain compatibility and leverage new functionalities promptly.

Action Parameters

Action Response

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.

Action Parameters

Action Response

Updates the configuration of an existing call center in the dialpad platform. this endpoint allows for comprehensive modifications to call center settings, including operational hours, routing strategies, hold queue management, alerts, and advanced features like auto call recording and voice intelligence. it’s particularly useful for adjusting call center operations to meet changing business needs or to optimize performance based on analytics. the endpoint provides granular control over various aspects of call center management, enabling customization of everything from service level alerts to dtmf menu options for both open and closed states. when using this endpoint, carefully consider the interdependencies between different settings to ensure a cohesive call center configuration.

Action Parameters

Action Response

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.

Action Parameters

Action Response

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.

Action Parameters

Action Response

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.

Action Parameters

Action Response

Retrieves detailed information about a specific user device associated with a dialpad account. this endpoint allows developers to fetch the current state and configuration of a particular device by providing its unique identifier. use this when you need to access up-to-date information about a user’s device, such as its type, status, or associated settings. the endpoint is particularly useful for device management, troubleshooting, or syncing device information across integrated systems. note that this endpoint only provides read access to device data and cannot be used to modify device settings.

Action Parameters

Action Response

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.

Action Parameters

Action Response

Retrieves a list of members belonging to a specific coaching team in dialpad. this endpoint allows you to fetch all users assigned to a particular coaching team, including both coaches and trainees. it’s useful for getting an overview of team composition, managing team members, or integrating team information into other systems. the endpoint returns member details, which may include user ids, names, roles, and other relevant information. use this when you need to review or analyze the current membership of a coaching team, or when syncing team data with external applications.

Action Parameters

Action Response

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.

Action Parameters

Action Response

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.

Action Parameters

Action Response

Retrieves a list of call centers and their associated information from the dialpad platform. this endpoint allows developers to fetch details about all call centers configured in the dialpad account, including their settings, agent statuses, and operational metrics. it’s particularly useful for applications that need to monitor or manage multiple call centers, analyze call center performance, or integrate call center data with other systems. the endpoint returns comprehensive data about each call center, which can be used for reporting, dashboard creation, or automating call center management tasks. note that this endpoint provides a high-level overview of call centers and may not include granular details about individual calls or agents.

Action Parameters

Action Response

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.

Action Parameters

Action Response

Retrieves detailed information about a specific office within the dialpad system. this endpoint should be used when you need to access comprehensive data about a particular office, such as its name, location, assigned users, or custom settings. it’s particularly useful for administrative tasks, reporting, or displaying office information in integrated applications. the endpoint returns all available details for the specified office, making it efficient for obtaining a complete office profile in a single api call. however, it does not allow for modifying office information or retrieving data for multiple offices simultaneously.

Action Parameters

Action Response

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.

Action Parameters

Action Response

Updates an existing custom interactive voice response (ivr) workflow in the dialpad system. this endpoint allows you to modify the name and description of a specific ivr identified by its unique id. use this when you need to rename an ivr or update its description to reflect changes in its purpose or functionality. the operation is partial, meaning you can update either the name, the description, or both without affecting other properties of the ivr. this endpoint is particularly useful for maintaining accurate and up-to-date documentation of your ivr systems, especially in large-scale deployments where clear labeling is crucial. note that this operation only updates metadata and does not alter the actual call flow or logic of the ivr.

Action Parameters

Action Response

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.

Action Parameters

Action Response

Updates the e911 address for a specified user in the dialpad system. this endpoint allows you to modify the emergency location information associated with a user’s account, ensuring accurate dispatch of emergency services if needed. the updated address will be used for e911 services, which provide precise location data to emergency responders. this tool should be used when a user’s physical location changes or when correcting inaccurate e911 address information. it’s crucial for maintaining compliance with e911 regulations and ensuring user safety. the endpoint requires detailed address information and offers an option for address validation to improve accuracy.

Action Parameters

Action Response

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.

Action Parameters

Action Response

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.

Action Parameters

Action Response

Retrieves subscription information for contacts in the dialpad system. this endpoint allows you to fetch details about contact event subscriptions, which are crucial for receiving real-time notifications about contact-related events such as updates, calls, or sms activities. use this endpoint when you need to monitor or manage the current contact subscriptions in your dialpad integration. it provides a comprehensive view of all active contact subscriptions, enabling you to track which contact events you’re currently listening to. note that this endpoint likely returns all contact subscriptions associated with your account, and may not support filtering or pagination in the request.

Action Parameters

Action Response

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.

Action Parameters

Action Response

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.

Action Parameters

Action Response

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.

Action Parameters

Action Response

Toggles the voice intelligence (vi) feature for a specific dialpad user. this endpoint allows administrators to enable or disable vi capabilities for individual users, which includes features like real-time transcription, sentiment analysis, and smart notes during calls. use this endpoint when you need to manage vi access on a per-user basis, such as when onboarding new team members or adjusting feature access based on user roles or requirements. the endpoint requires the user’s id in the url path and accepts a boolean parameter to set the vi status. note that this operation may affect billing or feature availability for the specified user, so it should be used judiciously and in accordance with your organization’s policies.

Action Parameters

Action Response

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.

Action Parameters

Action Response

Retrieves a list of agent status subscriptions from the dialpad system. this endpoint allows you to fetch real-time information about the current subscriptions to agent status events. it is useful for monitoring which agents or systems are subscribed to receive updates about changes in agent statuses, such as availability or activity. this tool should be used when you need to audit or manage the subscriptions related to agent status events in your dialpad integration. note that this endpoint does not provide the actual agent statuses, but rather information about the subscriptions to these status updates.

Action Parameters

Action Response

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.

Action Parameters

Action Response

Removes specified phone numbers from the blocked list in the dialpad system. this endpoint allows you to unblock multiple phone numbers in a single api call, streamlining the process of managing blocked numbers. use this when you need to restore communication capabilities with previously blocked numbers, such as when a number is no longer considered spam or when a block was applied in error. the endpoint accepts a list of e164 formatted numbers, ensuring standardized input across different countries and number formats. note that this operation is irreversible; once numbers are removed from the blocked list, they will be able to communicate with your dialpad account unless blocked again.

Action Parameters

Action Response

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.

Action Parameters

Action Response

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.

Action Parameters

Action Response

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.

Action Parameters

Action Response

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.

Action Parameters

Action Response

Retrieves a list of call routers configured in the dialpad system. this endpoint allows you to fetch information about the call routing setup in your dialpad account, including details such as router identifiers, associated dedicated dids, and routing rules. it’s particularly useful for auditing your current call routing configuration or gathering data for reporting purposes. the endpoint provides read-only access to call router information and does not allow modifications to the routing setup. use this when you need to review your call routing structure or integrate call routing information into your applications for advanced call management or analytics.

Action Parameters

Action Response

Updates the status of a specific user in the dialpad system. this endpoint allows you to set or modify a user’s status message and optionally specify an expiration time for that status. it’s particularly useful for indicating a user’s availability, current activity, or temporary absence. the endpoint should be used when you need to programmatically update a user’s status, such as integrating with calendar systems, automatic out-of-office settings, or custom workflow automations. it’s important to note that this endpoint updates the status for a single user identified by their id in the url path. the status update is immediate, and if an expiration is set, the status will automatically clear at the specified time. this tool does not retrieve the current status; it only updates it. if you need to fetch the current status before updating, you would need to use a separate get endpoint (not provided in this schema).

Action Parameters

Action Response

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.

Action Parameters

Action Response

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.

Action Parameters

Action Response

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.

Action Parameters

Action Response

Retrieves detailed information about a specific room in the dialpad system. this endpoint allows you to fetch the current state, settings, and properties of a virtual collaboration space identified by its unique id. use this when you need to access up-to-date information about a particular room, such as its name, participants, or configuration. the endpoint is particularly useful for applications that need to display room details or make decisions based on a room’s current status. note that this endpoint only provides information and does not modify the room in any way.

Action Parameters

Action Response

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.

Action Parameters

Action Response

Retrieves information about coaching teams in the dialpad platform. this endpoint allows users to fetch details about existing coaching teams, which are essential for managing call monitoring, feedback, and agent performance improvement. it provides an overview of team structures, including coaches, trainees, and associated settings. the endpoint is useful for administrators and managers who need to review or manage coaching team configurations across the organization. note that while this endpoint retrieves team information, it does not modify any team settings or structures.

Action Parameters

Action Response

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.

Action Parameters

Action Response

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.

Action Parameters

Action Response

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.

Action Parameters

Action Response

Retrieves the current application settings for the authenticated dialpad account. this endpoint provides access to various configuration options and preferences set for the dialpad application. it should be used when you need to review or audit the current app settings, such as user interface preferences, notification settings, or integration configurations. the endpoint returns a comprehensive list of all available settings, which can be useful for troubleshooting, customization, or ensuring consistency across different instances of the application. note that this endpoint is read-only and does not allow for modifying settings; separate endpoints would be required for updating individual settings.

Action Parameters

Action Response

Updates an existing sms event subscription in the dialpad api. this endpoint allows you to modify various aspects of an sms subscription, such as its direction, enabled status, associated endpoint, and target settings. use this when you need to change the configuration of an existing sms event subscription to adjust its behavior or scope. the endpoint provides flexibility in updating multiple parameters simultaneously, allowing for fine-tuned control over sms event notifications. note that all parameters are optional, so you can update only the specific fields you want to change without affecting the others.

Action Parameters

Action Response

Updates the privacy settings of an existing call review share link in dialpad. this endpoint allows you to modify the accessibility of a shared call recording, controlling whether it can be viewed only by company members or by anyone with the link. use this when you need to adjust the visibility of a previously shared call review, either to increase security by limiting access to the company or to allow broader access by making it public. it’s particularly useful for managing sensitive information in call recordings or adapting to changing collaboration needs. note that this endpoint only modifies the privacy settings and does not create new share links or alter the content of the call review itself.

Action Parameters

Action Response

Creates a shareable link for a specific recording in dialpad, such as a call recording or voicemail. this endpoint allows users to generate a link that can be used to share recordings with others, with customizable privacy settings. it should be used when you need to create a url for sharing a recording outside of the dialpad interface. the endpoint requires specifying the recording id and type, and optionally allows setting the privacy level of the share link. note that this endpoint only creates the share link; it does not modify the recording itself or its storage location.

Action Parameters

Action Response

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.

Action Parameters

Action Response

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.

Action Parameters

Action Response

Updates the duty status of a specific call center operator in dialpad. this endpoint allows you to change an operator’s availability and optionally provide a reason for their status. use this when you need to manage operator schedules, indicate break times, or adjust availability in real-time. the endpoint is crucial for maintaining up-to-date operator statuses, which directly impact call routing and overall call center efficiency. note that this operation only updates the duty status and reason; it does not modify any other operator information or settings.

Action Parameters

Action Response

Updates an existing change log event subscription in the dialpad system. this endpoint allows you to modify the status of a subscription and associate it with a specific logging endpoint. use this when you need to enable or disable notifications for system changes or when you want to change the destination for these notifications. the endpoint is particularly useful for managing event-driven integrations and maintaining up-to-date information flows between dialpad and external systems. note that updating a subscription does not create new events; it only affects future notifications for the specified change log.

Action Parameters

Action Response

This endpoint allows you to update various aspects of a user’s profile and settings in the dialpad system. it provides comprehensive control over user management, including personal information, administrative roles, communication settings, and account status. use this endpoint when you need to modify existing user data, such as changing contact details, adjusting administrative privileges, updating license types, or managing phone numbers and extensions. the endpoint is particularly useful for keeping user information up-to-date and managing user access within the dialpad platform. note that some changes, like updating license types or office assignments, may have billing implications. ensure you have the necessary permissions and understand the impact of changes before using this endpoint.

Action Parameters

Action Response

Retrieves a list of operators associated with a specific department in dialpad. this endpoint allows you to fetch detailed information about the operators assigned to a particular department, enabling efficient management of department resources and personnel. use this endpoint when you need to review, audit, or manage the operators within a specific department. the response likely includes operator details such as names, contact information, and roles. note that this endpoint does not modify any department or operator data; it is for retrieval purposes only. it’s particularly useful for administrative tasks, reporting, and ensuring proper staffing across departments.

Action Parameters

Action Response

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.

Action Parameters

Action Response

Initiates the oauth 2.0 authorization process for the dialpad api. this endpoint is the entry point for obtaining user consent and generating an authorization code, which can later be exchanged for an access token. it should be used when an application needs to request permission to access a user’s dialpad resources. the endpoint will redirect the user to dialpad’s login and consent page. after the user grants permission, they will be redirected back to the specified redirect uri with an authorization code. this endpoint is crucial for implementing secure, user-authorized access to dialpad’s api features.

Action Parameters

Action Response

Updates an existing call event subscription in the dialpad system. this endpoint allows you to modify various aspects of a subscription, including the call states to monitor, the subscription’s active status, associated logging endpoint, and event filtering criteria. use this when you need to adjust the behavior of an existing subscription, such as changing which call events you receive notifications for or updating the target of the subscription. it’s particularly useful for fine-tuning your application’s integration with dialpad’s real-time call event system. note that this endpoint updates only the specified fields; unspecified fields retain their current values.

Action Parameters

Action Response

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.

Action Parameters

Action Response

Retrieves detailed information about a specific department within the dialpad organization. this endpoint allows you to fetch comprehensive data about a department, including its name, description, member count, and other relevant attributes. use this endpoint when you need to access or display information about a particular department, such as for department management interfaces or generating reports. the endpoint returns the most up-to-date information available for the specified department. note that this endpoint only provides read access to department data and cannot be used to modify department information.

Action Parameters

Action Response

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.

Action Parameters

Action Response

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.

Action Parameters

Action Response

This endpoint updates the enhanced 911 (e911) address for a specific office in dialpad. it allows you to modify crucial location information used by emergency services to accurately locate the office in case of an emergency call. the endpoint can update the address for the office itself and optionally for all users associated with that office. it also provides an option to validate the address using dialpad’s service, ensuring the highest possible accuracy for emergency response. use this endpoint when setting up a new office, relocating an existing office, or correcting address information. it’s particularly important for maintaining compliance with e911 regulations and ensuring employee safety.

Action Parameters

Action Response

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.

Action Parameters

Action Response

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.

Action Parameters

Action Response

Retrieves the list of custom off-duty statuses for a specific office within the dialpad system. this endpoint is used to fetch and manage the availability statuses of agents assigned to a particular office. it provides administrators and supervisors with insights into why agents might be stepping away from their desks, helping to track and understand agent activity. the endpoint should be used when there’s a need to review, update, or manage the off-duty status options for a given office. it’s particularly useful for larger organizations with multiple offices that may have different sets of off-duty statuses. note that this endpoint only retrieves the statuses and does not provide real-time information about which agents are currently using each status.

Action Parameters

Action Response

Updates the call recording settings for an active call of a specific dialpad user. this endpoint allows real-time management of call recording features during an ongoing call, including enabling or disabling recording, controlling the playback of recording indication messages, and specifying the scope of recording for group calls. it should be used when there’s a need to dynamically change recording settings mid-call, such as for compliance purposes or user preferences. this endpoint is only effective for active calls and will not affect future calls or general user settings. note that all parameters are optional, allowing for granular control over specific aspects of call recording without affecting others.

Action Parameters

Action Response

Retrieves detailed information about a specific coaching team in dialpad. this endpoint allows users to fetch comprehensive data about a coaching team, including its configuration, members (coaches and trainees), settings, and potentially performance metrics. it should be used when detailed information about a particular coaching team is needed, such as for displaying team details, verifying settings, or analyzing team performance. the endpoint provides a snapshot of the coaching team’s current state and does not modify any data. it’s particularly useful for managers or administrators who need to review or audit coaching team setups.

Action Parameters

Action Response

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.

Action Parameters

Action Response

Retrieves detailed information about a specific call subscription in the dialpad system. this endpoint allows developers to access the current state and configuration of a call subscription, which is used for tracking and receiving notifications about call-related events. it’s particularly useful for monitoring the status of automated workflows or integrations that depend on call data. the endpoint should be used when you need to check the details of a single, known call subscription, such as its activation status, associated phone numbers, or event types it’s configured to track. it will not modify the subscription or return data about multiple subscriptions.

Action Parameters

Action Response

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.

Action Parameters

Action Response

Retrieves a comprehensive list of all phone numbers that have been blocked through the dialpad api. this endpoint is useful for managing call blocking settings and reviewing the current state of blocked numbers associated with your dialpad account. it provides a straightforward way to fetch all blocked numbers without the need for additional parameters. use this endpoint when you need to audit your blocked number list, verify if a specific number is blocked, or prepare for bulk operations on blocked numbers. keep in mind that this endpoint only returns numbers blocked via the api and may not include numbers blocked through other methods in the dialpad interface.

Action Parameters

Action Response

Retrieves detailed information about a specific access control policy in the dialpad system. this endpoint allows administrators to fetch the configuration and settings of a particular policy, which defines custom permissions and access levels for users within the dialpad platform. use this endpoint when you need to review or audit the settings of an existing access control policy. it’s particularly useful for verifying policy details before making modifications or when troubleshooting access-related issues. the endpoint returns comprehensive information about the policy but does not allow for modifications; separate endpoints would be used for updating policies.

Action Parameters

Action Response

Retrieves a list of phone numbers associated with the user’s dialpad account. this endpoint allows users to view all the phone numbers they have access to, which may include both assigned and unassigned numbers. it’s useful for inventory management, number allocation, and auditing purposes. the endpoint returns basic information about each number, such as its value, status, and associated user or department. it does not modify any data and is safe for frequent polling. note that the response may be paginated for large number inventories, and additional calls may be needed to retrieve the full list.

Action Parameters

Action Response

Creates a new contact event subscription in the dialpad platform, allowing you to receive real-time updates about changes to contacts. this endpoint enables you to subscribe to events for either local (personal) or shared (organization-wide) contacts. use this when you need to integrate contact management functionalities or automate workflows based on contact updates in your dialpad-connected application. the subscription can be linked to a specific logging endpoint (webhook or websocket) for event delivery and can be enabled or disabled upon creation. note that you must have previously set up a logging endpoint to receive the events if you specify an endpoint id.

Action Parameters

Action Response

Triggers a screen pop for a specific dialpad user, displaying relevant information during a call or communication event. this endpoint should be used when you need to automatically present contextual data to a user’s screen, such as customer information from a crm system. it’s particularly useful in contact center scenarios where agents need quick access to caller details. the screen pop url can be a web page or a custom uri to launch a native application. note that this endpoint does not retrieve or send any customer data directly; it only initiates the display of the specified url on the user’s device.

Action Parameters

Action Response

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.

Action Parameters

Action Response

Retrieves a list of contacts from the dialpad platform. this endpoint allows you to fetch contact information, which is crucial for managing user data and communication records within your dialpad-integrated application. it supports pagination, searching, and sorting to efficiently handle large contact lists. use this endpoint when you need to access or display contact information, sync contacts with other systems, or perform contact-related operations in your application. the endpoint returns basic contact details, but may not include sensitive information or full communication history.

Action Parameters

Action Response

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.

Action Parameters

Action Response

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.

Action Parameters

Action Response

Retrieves detailed information about a specific call router in the dialpad system. this endpoint allows developers to fetch the configuration and status of a call router by providing its unique identifier. use this when you need to check the current settings, routing rules, or other properties of a particular call router. it’s particularly useful for auditing your call routing setup or before making changes to an existing router. the endpoint returns read-only data and does not modify any settings.

Action Parameters

Action Response

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.

Action Parameters

Action Response

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.

Action Parameters

Action Response

Updates the configuration of a specific dialpad room identified by its id. this endpoint allows you to modify the room’s name and manage its assigned phone numbers. use this when you need to rename a room, update its phone number assignments, or reorder existing phone numbers. the endpoint is particularly useful for maintaining accurate room information and adjusting telephony settings as your organization’s needs change. note that this is a partial update operation, so only the fields you provide will be modified. be cautious when updating phone numbers, as reordering or removing numbers from the list will affect their assignment to the room.

Action Parameters

Action Response

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.

Action Parameters

Action Response

The getstatistics endpoint retrieves comprehensive statistics for various aspects of dialpad usage, including calls, customer satisfaction (csat), dispositions, on-duty status, recordings, screen shares, texts, and voicemails. it offers flexible options for targeting specific users, groups, or offices, and allows for customized date ranges and aggregation methods. this endpoint is particularly useful for analyzing performance metrics, tracking customer satisfaction, and gaining insights into communication patterns within an organization. it supports both aggregated statistics and individual record retrieval, making it versatile for different analytical needs. however, users should note that certain stat types (like csat and dispositions) require specific targeting parameters and only support individual record retrieval.

Action Parameters

Action Response

Retrieves detailed information about a specific scheduled report in the dialpad system. this endpoint allows you to fetch the configuration and metadata of a pre-defined report, which may include communication metrics, analytics, or other relevant data aggregated from dialpad’s communication platform. use this endpoint when you need to access or review the settings of a particular scheduled report, such as its frequency, included data points, or last run time. it’s particularly useful for auditing report configurations or preparing to update existing reports. note that this endpoint only retrieves the report configuration, not the actual report data itself. to get the latest generated report content, you may need to use a separate endpoint or check if this response includes a link to the most recent report output.

Action Parameters

Action Response

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.

Action Parameters

Action Response

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.

Action Parameters

Action Response

Retrieves the changelog for a specific subscription in the dialpad system. this endpoint allows you to access a historical record of changes made to a particular subscription, including updates, modifications, or status changes. it is useful for auditing purposes, troubleshooting issues, or tracking the evolution of a subscription over time. the endpoint returns a chronological list of changes, likely including details such as the date of change, type of change, and any relevant metadata. note that this endpoint only provides changelog information and does not allow for modifying the subscription itself.

Action Parameters

Action Response

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.

Action Parameters

Action Response

Retrieves the current duty status of a specific call center operator in dialpad. this endpoint allows you to check whether an operator is active (available to receive inbound calls) or off-duty (not available for calls). use this endpoint when you need to determine an operator’s availability in real-time, such as for load balancing, scheduling, or monitoring operator activity. the endpoint provides a snapshot of the operator’s current status and does not include historical data or future scheduled statuses. it’s particularly useful for systems that need to make routing decisions based on operator availability or for creating dashboards that display team capacity.

Action Parameters

Action Response

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.

Action Parameters

Action Response

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.

Action Parameters

Action Response

This endpoint unassigns a user from a specific access control policy in dialpad. it allows for granular control over policy assignments by supporting unassignment at different target levels (company, office, or call center). the endpoint can be used to remove a user’s access to specific settings or features defined by the policy. it’s particularly useful when modifying user permissions or during role changes within the organization. the endpoint provides flexibility in unassigning from a single target or all associated targets simultaneously.

Action Parameters

Action Response

Retrieves detailed information about a specific websocket connection using its unique identifier. this endpoint allows developers to query the status, metadata, and other relevant details of an active or recent websocket connection in the dialpad system. it’s particularly useful for monitoring real-time event subscriptions, troubleshooting connection issues, or auditing websocket usage. the endpoint should be used when you need to inspect or verify the state of a particular websocket connection, such as checking if it’s still active or retrieving its configuration. note that this endpoint provides information about the connection itself and may not include the actual event data being transmitted through the websocket.

Action Parameters

Action Response

This endpoint unassigns a specific phone number from a dialpad office. it is used to remove the association between a phone number and an office, which can be helpful for reorganizing phone number allocations or preparing a number for reassignment. the endpoint should be used when an administrator needs to free up a phone number from its current office assignment. it’s important to note that this action only unassigns the number from the office and does not delete the number from the dialpad account. after unassignment, the number becomes available for reassignment to other offices or users within the organization. ensure that unassigning a number won’t disrupt ongoing communications or routing rules associated with that number.

Action Parameters

Action Response

Retrieves the assignments of a specific access control policy in dialpad. this endpoint allows company administrators to view which users, roles, or groups have been assigned to a particular access control policy. it’s useful for auditing and managing permissions within the dialpad platform. the endpoint returns a list of assignments, which may include user ids, role names, or group identifiers associated with the specified policy. use this when you need to review or verify the current assignments of an access control policy, such as during security audits or when updating user permissions. note that this endpoint only provides assignment information and does not allow for modifying the assignments.

Action Parameters

Action Response

Retrieves all personas associated with a specific user in the dialpad system. this endpoint allows you to fetch the various identities or roles that a user can assume when making calls, providing detailed information about each persona. use this endpoint when you need to display or manage the different caller identities available to a user. the response will include a list of persona objects, each containing information such as the persona name, phone number, and any associated metadata. this endpoint is particularly useful for applications that need to offer users a choice of outbound caller identities or for administrative purposes to review a user’s available personas.

Action Parameters

Action Response

Updates a user’s office assignment within the dialpad system. this endpoint allows administrators to move a user from their current office to a different office. it should be used when there’s a need to change a user’s organizational association, such as during departmental transfers or office relocations. the operation is performed by specifying the user’s id in the url path and optionally providing the new office id in the request body. if no office id is provided, the user’s current office assignment remains unchanged. this endpoint is particularly useful for managing organizational structure and ensuring users are correctly associated with their respective offices in dialpad.

Action Parameters

Action Response

Retrieves detailed information about a specific sms subscription in dialpad. this endpoint allows developers to fetch the current status, configuration, and other relevant details of an sms subscription by providing its unique identifier. use this endpoint when you need to check the properties of an existing sms subscription, such as its active status, associated phone number, or any custom settings. it’s particularly useful for managing and monitoring sms capabilities within your dialpad integration. note that this endpoint only provides read access to subscription data and cannot be used to modify or create new subscriptions.

Action Parameters

Action Response

Retrieves the sms opt-out list for a specific company within the dialpad platform. this endpoint allows you to fetch all phone numbers that have opted out of receiving sms messages from the specified company. use this endpoint when you need to check which recipients have unsubscribed from sms communications, ensuring compliance with messaging regulations and user preferences. the returned list can be used to update your contact database or messaging system to prevent sending unwanted messages. note that this endpoint only provides the opt-out information and does not modify the opt-out status of any recipients.

Action Parameters

Action Response

The updatescheduledreport endpoint allows you to modify the settings of an existing scheduled report in dialpad. this powerful tool enables fine-tuning of report generation parameters, including frequency, timing, type, and scope. use this endpoint when you need to adjust report schedules, change report types, update target information, or modify other settings of a previously configured report. the endpoint is particularly useful for adapting reporting needs as your organization’s requirements evolve. it provides flexibility in managing various aspects of scheduled reports, from basic timing adjustments to more complex changes in report focus and delivery. keep in mind that this endpoint updates an existing report schedule; it does not create new schedules or generate reports on demand. also, note that some parameters are interdependent (e.g., frequency, at, and on day), so ensure their values are consistent when making updates.

Action Parameters

Action Response

Creates a websocket connection for real-time communication with the dialpad platform. this endpoint enables applications to establish a persistent, full-duplex connection for receiving live updates and event notifications from dialpad. use this when you need to implement features that require instant updates, such as live call status changes, message delivery notifications, or agent availability updates. the websocket connection allows for efficient, low-latency communication, reducing the need for frequent polling of other api endpoints. note that while this endpoint creates the connection, you’ll need to implement appropriate event listeners and handlers in your application to process the incoming data streams effectively.

Action Parameters

Action Response

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.

Action Parameters

Action Response

Updates the settings and configuration of a specific department in the dialpad system. this endpoint allows for comprehensive modification of department properties, including operating hours, call routing strategies, hold queue settings, and voice intelligence features. it’s particularly useful for adjusting department behavior to match changing business needs or to optimize call handling efficiency. the endpoint supports partial updates, allowing you to modify only the specific fields you need to change without affecting other settings.

Action Parameters

Action Response

Updates an existing contact event subscription in the dialpad system. this endpoint allows you to modify the configuration of a subscription, including changing the contact type it listens for, enabling or disabling the subscription, and associating it with a different logging endpoint. use this when you need to adjust the behavior of an existing contact event subscription, such as changing its scope from local to shared contacts or temporarily disabling event notifications. the subscription id must be provided in the url path. note that this endpoint only updates the specified fields; any fields not included in the request will retain their current values.

Action Parameters

Action Response

Unassigns a specified phone number from a user’s dialpad account. this endpoint should be used when you need to remove a phone number association from a particular user, such as when an employee changes roles or leaves the organization. it allows for efficient management of phone number resources within your dialpad system. the operation is irreversible, so ensure that you want to remove the number from the user before making the api call. note that this endpoint only unassigns the number; it does not delete the number from your dialpad account or make it available for immediate reassignment to another user.

Action Parameters

Action Response

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.

Action Parameters

Action Response

The oauth 2.0 token endpoint for dialpad’s api is used to obtain access tokens for authenticating api requests. it supports two grant types: authorization code and refresh token. for the authorization code flow, it exchanges an authorization code for an access token, enabling secure user authentication without exposing credentials. the refresh token flow allows obtaining a new access token when the current one expires, maintaining long-term access without user intervention. this endpoint is crucial for implementing oauth 2.0 authentication in applications integrating with dialpad’s api, ensuring secure and authorized access to user data and dialpad services.

Action Parameters

Action Response

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.

Action Parameters

Action Response

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.

Action Parameters

Action Response

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.

Action Parameters

Action Response

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.

Action Parameters

Action Response

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.

Action Parameters

Action Response

Assigns or reassigns a phone number to a specific target within the dialpad system. this endpoint allows you to associate a phone number with various entities such as users, departments, call centers, or other supported target types. use this when you need to allocate or reallocate phone numbers across your dialpad organization. the endpoint is particularly useful for managing phone number assignments during user onboarding, department restructuring, or call center setup. note that this operation may affect existing call routing and should be used cautiously in production environments.

Action Parameters

Action Response

Retrieves the current plan details for a specific office in your dialpad organization. this endpoint allows you to fetch information about the subscribed features, limitations, and other plan-specific details for a given office. use this endpoint when you need to review or verify the current plan status of an office, such as during account management or when considering plan upgrades. the response will likely include details such as the plan name, included features, user limits, and any custom configurations. note that this endpoint only provides read-only access to plan information and cannot be used to modify or update the office plan.

Action Parameters

Action Response

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.

Action Parameters

Action Response

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.

Action Parameters

Action Response

Retrieves a list of departments for a specified office within the dialpad organization. this endpoint is essential for obtaining the organizational structure and can be used to populate department selectors, generate reports, or manage team assignments. it returns basic information about each department, such as its name, id, and possibly the number of members. the endpoint should be used when needing an up-to-date view of the departmental structure within an office. it does not provide detailed information about individual department members or historical data about department changes. pagination parameters may be necessary for offices with a large number of departments to manage response sizes and api performance.

Action Parameters

Action Response

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.

Action Parameters

Action Response

Retrieves detailed information about a specific call center in the dialpad system. this endpoint allows you to fetch comprehensive data about a call center, including its configuration, associated agents, and operational metrics. use this when you need to access or review the current state and settings of a particular call center. the endpoint is particularly useful for administrators managing multiple call centers or for integrations that need up-to-date call center information. note that this endpoint only provides read access and cannot be used to modify call center details.

Action Parameters

Action Response

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.

Action Parameters

Action Response

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.

Action Parameters

Action Response

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.

Action Parameters

Action Response

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.

Action Parameters

Action Response

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.

Action Parameters

Action Response

Updates an existing agent status subscription in the dialpad system. this endpoint allows you to modify the configuration of a subscription that tracks changes in agent statuses within a contact center environment. use this to adjust the subscription’s enabled state, change the associated logging endpoint, or update the agent type. it’s particularly useful for maintaining up-to-date event tracking setups as your contact center needs evolve. note that all fields are optional, allowing for partial updates to the subscription. be cautious when changing the endpoint id, as this will affect where status change events are sent.

Action Parameters

Action Response

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.

Action Parameters

Action Response

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.

Action Parameters

Action Response

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.

Action Parameters

Action Response

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.

Action Parameters

Action Response

Retrieves the changelog for dialpad api subscriptions. this endpoint provides a historical record of changes and updates made to subscription events and notifications within the dialpad system. it’s useful for tracking modifications to webhooks, event subscriptions, and other notification-related configurations over time. the changelog can help developers understand when and how subscription settings have been altered, aiding in troubleshooting and maintaining up-to-date integrations. note that while the endpoint doesn’t appear to require specific parameters, it may support optional query parameters for filtering or pagination, which are not visible in the provided schema.

Action Parameters

Action Response

Retrieves detailed information about a specific agent status subscription using its unique identifier. this endpoint is used to fetch the current configuration and settings of an agent status subscription, which may include details such as the associated agent, status types being tracked, and any custom off-duty statuses. it’s particularly useful for administrators or supervisors who need to review or troubleshoot individual agent status subscriptions. the endpoint does not modify any data and is safe for frequent calls to keep the client application updated with the latest subscription information. note that this endpoint only provides details for a single subscription and cannot be used to list multiple subscriptions or modify existing ones.

Action Parameters

Action Response

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.

Action Parameters

Action Response

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.

Action Parameters

Action Response

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.

Action Parameters

Action Response

Retrieves information about conference meetings in the dialpad platform. this endpoint allows users to fetch details about scheduled, ongoing, or past conference meetings, providing valuable data for managing and analyzing virtual collaboration sessions. it can be used to obtain an overview of meeting activities, track usage patterns, or gather information for reporting purposes. the endpoint is particularly useful for administrators or team leaders who need to monitor conference usage across their organization. note that while this endpoint retrieves meeting data, it does not provide real-time control over active meetings or allow for meeting creation or modification.

Action Parameters

Action Response

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.

Action Parameters

Action Response

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.

Action Parameters

Action Response

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.

Action Parameters

Action Response

Retrieves information about websocket connections or initiates a websocket connection for real-time event subscriptions with dialpad. this endpoint is essential for applications that require live updates and real-time communication capabilities within the dialpad platform. it enables developers to establish a persistent connection for receiving instant notifications about various events such as calls, sms, contacts, agent status, and system changes. use this endpoint when building applications that need to react immediately to dialpad events or maintain a live data stream. note that while this endpoint provides the websocket connection details, you may need to implement the websocket client separately to handle the actual connection and data exchange.

Action Parameters

Action Response

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.

Action Parameters

Action Response

Retrieves detailed information about a specific communication channel in the dialpad platform using its unique identifier. this endpoint allows developers to fetch comprehensive data about a particular channel, which can include its type (e.g., voice, video, or messaging), current status, associated users or groups, and other relevant metadata. it is particularly useful when you need to access or verify the properties of a specific channel within your application. the endpoint should be used when detailed information about a known channel is required, such as during channel management tasks, reporting, or when integrating channel-specific features into your application. note that this endpoint only provides information for a single channel at a time and does not support batch retrieval or listing of multiple channels.

Action Parameters

Action Response

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.

Action Parameters

Action Response

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.

Action Parameters

Action Response

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.

Action Parameters

Action Response

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.

Action Parameters

Action Response

Updates an existing call router in the dialpad system. this endpoint allows you to modify various settings of a call router, including its default target, enabled state, name, office association, error handling, routing url, and authentication secret. use this when you need to change the behavior or configuration of an existing call router. the endpoint is particularly useful for adjusting routing logic, updating fallback options, or managing error states. note that while all parameters are optional, providing at least one is necessary to make meaningful changes. be cautious when updating critical parameters like the routing url or secret, as incorrect values could disrupt call routing.

Action Parameters

Action Response

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.

Action Parameters

Action Response

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.

Action Parameters

Action Response

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.

Action Parameters

Action Response

Retrieves information about a specific blocked number in the dialpad system. this endpoint allows users or administrators to check if a particular phone number is currently blocked. it’s useful for verifying the status of a number before attempting communication or when reviewing security settings. the endpoint returns details about the blocked number, which may include when it was blocked and any associated metadata. it should be used when there’s a need to confirm the blocked status of a specific number, but it won’t provide a list of all blocked numbers or modify any existing blocks.

Action Parameters

Action Response

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.

Action Parameters