Dialpad

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 statu…

Untrusted display-only summary

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 availabi…

Untrusted display-only summary

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…

Untrusted display-only summary

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 return…

Untrusted display-only summary

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…

Untrusted display-only summary

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…

Untrusted display-only summary

Retrieves a list of operators associated with a specific call center in Dialpad. This endpoint allows you to fetch detailed information about the operators working in a particular call center, which is essential for managing call center operations, monitoring staff, and optimizing workload distribution. Use this endpo…

Untrusted display-only summary

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…

Untrusted display-only summary

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 en…

Untrusted display-only summary

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 rou…

Untrusted display-only summary

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 rout…

Untrusted display-only summary

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 st…

Untrusted display-only summary

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, a…

Untrusted display-only summary

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…

Untrusted display-only summary

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 particu…

Untrusted display-only summary

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 asso…

Untrusted display-only summary

Retrieves detailed information about a specific company within the Dialpad platform. This endpoint allows developers to access various company-level data, such as company name, settings, and other relevant details. It should be used when an application needs to fetch or display company information, update local record…

Untrusted display-only summary

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, trac…

Untrusted display-only summary

Retrieves detailed information for a specific contact in your Dialpad account using the contact's unique identifier. This endpoint allows you to fetch comprehensive data about a single contact, including their name, phone numbers, email addresses, and any custom fields associated with the contact. Use this when you ne…

Untrusted display-only summary

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…

Untrusted display-only summary

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 par…

Untrusted display-only summary

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 manag…

Untrusted display-only summary

Retrieves the Enhanced 911 (E911) settings for a specific office within the Dialpad communication platform. This endpoint allows administrators to fetch crucial emergency service configuration details associated with a particular office location. It should be used when auditing or verifying E911 compliance, updating e…

Untrusted display-only summary

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 n…

Untrusted display-only summary

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 oth…

Untrusted display-only summary

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…

Untrusted display-only summary

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…

Untrusted display-only summary

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 displayin…

Untrusted display-only summary

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,…

Untrusted display-only summary

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…

Untrusted display-only summary