Dialpad

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

This endpoint assigns a phone number to a specific call router in the dialpad system. it allows users to either provide a full phone number for assignment or specify an area code to automatically select an available number within that region. the assigned number can optionally be set as the primary number for the call router. this functionality is crucial for setting up and managing call routing within an organization, enabling efficient distribution of incoming calls to the appropriate departments or individuals.

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.

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.

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.

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.

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.

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.