Dialpad

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…

Untrusted display-only summary

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…

Untrusted display-only summary

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

Untrusted display-only summary

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

Untrusted display-only summary

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…

Untrusted display-only summary

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

Untrusted display-only summary

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

Untrusted display-only summary

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

Untrusted display-only summary

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

Untrusted display-only summary

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

Untrusted display-only summary

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

Untrusted display-only summary

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

Untrusted display-only summary

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

Untrusted display-only summary

Retrieves a list of members for a specific channel in Dialpad. This endpoint allows you to fetch user information for all members associated with the given channel ID. It's useful for obtaining an overview of channel participants, which can be helpful for managing team collaboration, assigning tasks, or analyzing chan…

Untrusted display-only summary

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

Untrusted display-only summary

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

Untrusted display-only summary

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

Untrusted display-only summary

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

Untrusted display-only summary

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

Untrusted display-only summary

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

Untrusted display-only summary

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

Untrusted display-only summary

Retrieves detailed information about a specific recording share link in the Dialpad system. This endpoint allows you to fetch the current status, settings, and metadata associated with a previously created share link for a call recording. It's particularly useful when you need to verify the current state of a share li…

Untrusted display-only summary

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…

Untrusted display-only summary

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

Untrusted display-only summary

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

Untrusted display-only summary

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

Untrusted display-only summary

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…

Untrusted display-only summary

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

Untrusted display-only summary

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…

Untrusted display-only summary

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

Untrusted display-only summary