# CommPeak Documentation and Developer Hub Documentation > Discover everything you need to engage with powerful contact center solutions offered by CommPeak. From comprehensive guides to detailed documentation and APIs, we've got you covered. Let’s dive in! ## Guides - [Getting Started](https://docs.commpeak.com/docs/commpeak-portal-getting-started.md): How to get started and make the most of the services provided by the CommPeak company. - [Onboarding Guide: Registering on CommPeak Portal](https://docs.commpeak.com/docs/your-first-step-creating-a-commpeak-account.md): Learn how to create a CommPeak account with your email or a Google or Microsoft login and complete the mandatory onboarding steps. - [Linking a Social Login to Your Account](https://docs.commpeak.com/docs/linking-a-social-login-to-your-account.md): Connect a Google or Microsoft account to your existing CommPeak account, or understand what happens when the two overlap. - [Logging In](https://docs.commpeak.com/docs/logging-in-to-commpeak-portal.md): Log in to CommPeak Portal with your email and password or a Google or Microsoft account, and recover access if you cannot log in. - [Resetting Your Password](https://docs.commpeak.com/docs/resetting-your-password.md): Reset a forgotten CommPeak password or recover access to your account if you can't log in. - [CommPeak Portal Overview](https://docs.commpeak.com/docs/commpeak-portal-overview.md): Introduction to the CommPeak Portal's web user interface, guiding you through its layout, navigation, dashboard, menu structure, and key functional areas for managing CommPeak services - [My CommPeak Home: Dashboard](https://docs.commpeak.com/docs/my-commpeak-dashboard-home.md): Overview of your operations from the Home page, your customizable CommPeak Portal Dashboard - [Getting Ready to Make Calls](https://docs.commpeak.com/docs/getting-ready-to-make-calls.md): Learn where in CommPeak Portal to find username, domain and password for your first SIP account. - [Configuring SIP Account in Softphone App](https://docs.commpeak.com/docs/configuring-a-sip-account-in-a-softphone-app.md): Register your SIP account using either the CommPeak softphone, a third-party application, or an IP phone of your choice. - [Profile & Account Settings](https://docs.commpeak.com/docs/account-settings.md): Update your CommPeak profile and account data, change your password, manage your notifications and authorized applications preferences. - [Your Profile](https://docs.commpeak.com/docs/your-profile.md): Update your CommPeak profile: change your name, timezone, email, and password, manage Google and Microsoft social logins, and set communication preferences. - [Account](https://docs.commpeak.com/docs/your-account.md): View and manage your CommPeak account's information. - [Notifications Settings](https://docs.commpeak.com/docs/notification-settings.md): Edit your CommPeak notifications settings: select notification types and recipients to receive updates about CommPeak account events like balance threshold warnings, daily usage reports, and rate updates. - [Authorized Applications](https://docs.commpeak.com/docs/authorized-applications.md): View and manage your CommPeak account's active 3rd party authorized applications. - [Your Contracts](https://docs.commpeak.com/docs/my-contracts.md): View your CommPeak contracts to stay informed about updates and changes and review and accept them. - [Billing & Payments](https://docs.commpeak.com/docs/payment-management-overview.md): Manage your CommPeak account spending and payments: monitor recent expenses, view subscription fees, track consumption rates, set low balance threshold notifications, and access payment history and settings from the CommPeak Portal Dashboard. - [Adding & Managing Credit](https://docs.commpeak.com/docs/adding-managing-credit.md): Learn how to add credit and manage your balance. - [Adding Credit to Your Account](https://docs.commpeak.com/docs/adding-credit-to-your-account.md): Top up CommPeak account balance via various payment methods, such as credit card, PayPal, or wire transfer. - [Payment Methods & History](https://docs.commpeak.com/docs/payment-methods-history.md): Track, review, and manage your CommPeak payments. - [Invoices](https://docs.commpeak.com/docs/invoices.md): View issued CommPeak invoices by category (VoIP termination, DID numbers, etc.): see each invoice's date, amount, period, and status, and download as a PDF file. - [Proforma Invoices](https://docs.commpeak.com/docs/proforma-invoices.md): Request an official proforma invoice for budget approvals, prepayments, or internal finance processes, and track each request from your Portal account. - [Recurring Payments](https://docs.commpeak.com/docs/recurring-payments.md): Manage CommPeak account's automatic credit refills: view the list of recurring payments, modify the threshold amount for balance refills, or stop recurring payments. - [Recurring Services](https://docs.commpeak.com/docs/recurring-services.md): Manage CommPeak account's automatic credit refills: view the list of recurring services or stop recurring payments. - [PayPal Payments](https://docs.commpeak.com/docs/paypal-payments.md): Pay for CommPeak services using PayPal: select PayPal as payment type, add credit, and verify PayPal account email address if necessary. - [Usage & Monitoring](https://docs.commpeak.com/docs/usage-monitoring.md): Monitor your CommPeak service usage and billing. - [Monitoring Spending from Dashboard](https://docs.commpeak.com/docs/monitoring-your-spending-from-dashboard.md): Monitor your daily spending, review account insights, and access payment actions from the My CommPeak Dashboard. - [Payment History](https://docs.commpeak.com/docs/payment-history.md): View and download your CommPeak account's payment history as a CSV file: filter by category, apply date range, select specific categories, and save to specified location. - [Balance Graph](https://docs.commpeak.com/docs/balance-graph.md): View daily changes in CommPeak account balance: see graph showing balance history, and hover over specific dates to view exact balance amount. - [Call and SMS Pricing](https://docs.commpeak.com/docs/call-and-sms-pricing.md): View and download outbound call and SMS rates for CommPeak services by filtering and searching in the Billing tab of the CommPeak Portal under Voice Rates or SMS Rates. - [Setting Spending Limit](https://docs.commpeak.com/docs/setting-the-spending-limit-with-the-rate-cap.md): Prevent unnecessary expenses by setting a rate cap for call center agents, limiting their spending on phone numbers with high charges. - [Managing Portal API Keys](https://docs.commpeak.com/docs/getting-portal-api-keys-and-documentation.md): Create and manage API keys for CommPeak Billing API. - [FAQs](https://docs.commpeak.com/docs/billing-and-payments-faqs.md): Billing & Payments FAQs - [What Are Billing Increments?](https://docs.commpeak.com/docs/what-are-billing-increments.md): Learn what billing increments are. - [What Payment Methods Do You Accept?](https://docs.commpeak.com/docs/what-payment-methods-do-you-accept.md): Learn what payment methods are accepted. - [What Currencies Do You Accept?](https://docs.commpeak.com/docs/which-currencies-do-you-accept.md): Learn what currencies are accepted. - [What Is the Smallest Amount I Can Top Up?](https://docs.commpeak.com/docs/what-is-the-smallest-amount-i-can-top-up.md): Learn what the smallest amount can you top up. - [What Are TCCL Bank Payment Supported Countries?](https://docs.commpeak.com/docs/tccl-bank-payment-supported-countries.md): Information for customers who use wire transfers and wish to pay via CommPeak TCCL bank account. - [How Do I Check Voice Rates for a Specific Country?](https://docs.commpeak.com/docs/how-do-i-check-voice-rates-for-a-specific-country.md): Look up per-minute voice rates for any country and network in the CommPeak Portal's Billing > Voice Rates page. - [How Do I Check SMS Rates for a Specific Country?](https://docs.commpeak.com/docs/how-do-i-check-sms-rates-for-a-specific-country.md): Look up per-message SMS rates by country, route type, and MCC/MNC in the CommPeak Portal's Billing > SMS Rates page. - [Can I Edit a Submitted Proforma Invoice Request?](https://docs.commpeak.com/docs/can-i-edit-a-submitted-proforma-invoice-request.md): Find out whether a submitted proforma invoice request can be changed, and what your options are depending on the request's approval status. - [Can I Download a Previously Approved Proforma Invoice Again?](https://docs.commpeak.com/docs/can-i-download-a-previously-approved-proforma-invoice-again.md): Learn how to re-download an approved proforma invoice from your request history in CommPeak Portal at any time. - [DIDs](https://docs.commpeak.com/docs/did-numbers.md): Configure and manage the DID numbers service from the CommPeak Portal account. - [Getting Started](https://docs.commpeak.com/docs/did-numbers-getting-started.md): How to get started and make the most of CommPeak DID numbers, a service that allows you to have unique virtual phone numbers for each person or workstation. - [Benefits of DIDs](https://docs.commpeak.com/docs/benefits-of-dids.md): Learn how DIDs can enhance communication with clients, increase efficiency, and ultimately drive business growth. - [DID Types](https://docs.commpeak.com/docs/did-types.md): Order DID numbers from CommPeak depending on your needs. - [Ordering DID Numbers](https://docs.commpeak.com/docs/ordering-did-numbers.md): Information on the steps to obtain your first CommPeak DID with no support ticket required. - [Managing Your DIDs](https://docs.commpeak.com/docs/did-management.md): Follow our guidelines to configure the DID numbers service to boost your calling success. - [DID Management Overview](https://docs.commpeak.com/docs/did-management-overview.md): This page provides information on how to set up and manage your DIDs. - [DID Inventory: My DIDs](https://docs.commpeak.com/docs/my-dids.md): Learn about what information is available on the My DIDs page that provides a detailed table view of your entire DID inventory. - [Receiving Incoming Calls to Your DID](https://docs.commpeak.com/docs/how-to-receive-incoming-calls-to-your-did.md): A step-by-step guide to set up call forwarding to your DID number. - [Configuring Voice URI Routing](https://docs.commpeak.com/docs/configuring-voice-routing.md): Route incoming calls on your DIDs by configuring SIP routing profiles. - [Setting Up PSTN on Your DID Number](https://docs.commpeak.com/docs/setting-up-pstn-on-your-did-number.md): A step-by-step guide to configuring forwarding DID calls to your landline or mobile phone. - [Setting Up Inbound Calls on Your SIP Account](https://docs.commpeak.com/docs/setting-up-inbound-calls-on-your-sip-account.md): A step-by-step guide to configuring forwarding DID calls to your SIP account. - [Managing SMS Delivery](https://docs.commpeak.com/docs/managing-sms-delivery.md): Create SMS delivery profiles and configure CommPeak DID numbers to forward inbound SMS messages by email or to TextPeak. - [Creating Tags and Assigning Them to DID Numbers](https://docs.commpeak.com/docs/creating-and-assigning-did-numbers-tags.md): Create DID tags and assign them to your DID numbers in the CommPeak Portal. - [Managing Multiple DIDs](https://docs.commpeak.com/docs/bulk-actions.md): Learn how to select multiple DID records and apply bulk actions in DID Management. - [Maintenance Mode](https://docs.commpeak.com/docs/maintenance-mode.md): Enable or disable Maintenance Mode for a DID number in the CommPeak Portal to run technical tests without changing permanent settings. - [Canceling a DID Number](https://docs.commpeak.com/docs/how-to-cancel-a-did-number.md): Learn how to cancel your DID number. - [Using DID Numbers](https://docs.commpeak.com/docs/using-did-numbers.md): Follow our guidelines to ensure smooth integration of DID numbers and compliance with country regulations. - [Setting Voicemail for DID Numbers](https://docs.commpeak.com/docs/voicemail-settings-for-did-numbers.md): Configure a voicemail message to play to customers when their call goes to voicemail due to incorrect DID forwarding or unreachable destination. - [Number Reputation Checks](https://docs.commpeak.com/docs/reputation-checks.md): Inspect DID numbers, set up scheduled checks, monitor their status, and view detailed logs of past checks. - [DID Verification: How to Verify Your External Caller IDs](https://docs.commpeak.com/docs/what-is-did-verification-how-do-i-verify-my-external-caller-ids.md): Learn how to verify your non-CommPeak DID number as a Caller ID in CommPeak Portal. - [DID Reports](https://docs.commpeak.com/docs/did-reports.md): Run Origination CDR, SMS, and Voicemails reports for your CommPeak Portal DID numbers. - [Identities & Verification](https://docs.commpeak.com/docs/identities.md): Follow the step-by-step guides to create and manage your business or personal identity if you wish to purchase DID numbers. - [Business Identity](https://docs.commpeak.com/docs/business-identity.md): Learn how to create a business identity to unlock a full range of tailored services to cater to companies' unique business requirements. - [Personal Identity](https://docs.commpeak.com/docs/personal-identity.md): Learn how to create a personal identity to access a range of tailored services for individuals. - [Managing Identities](https://docs.commpeak.com/docs/managing-identities.md): Learn how to manage identities in the CommPeak Portal. - [KYC Instructions](https://docs.commpeak.com/docs/kyc-instructions.md): This article offers a detailed guide for completing the Know Your Customer (KYC) process as part of CommPeak’s extended verification procedures. - [FAQs](https://docs.commpeak.com/docs/faq-did-numbers.md): CommPeak DID Numbers and identity verification FAQs - [What Is DID?](https://docs.commpeak.com/docs/what-is-did.md): DIDs explained - [Do You Offer Termination in Every Country?](https://docs.commpeak.com/docs/do-you-offer-termination-in-every-country-1.md) - [How to Create a Virtual Phone Number (DID)?](https://docs.commpeak.com/docs/how-to-create-a-virtual-phone-number-did.md) - [Do You Pass Caller ID? What Method Do You Use?](https://docs.commpeak.com/docs/do-you-pass-caller-id-what-method-do-you-use.md) - [How Can I Get my DIDs Incoming Messages Into TextPeak?](https://docs.commpeak.com/docs/how-can-i-add-dids-for-textpeak-option-for-my-agents-2.md) - [Can I Setup Own Prefix to Use for Calling From Different DIDs to One Number?](https://docs.commpeak.com/docs/can-i-setup-own-prefix-to-use-for-calling-from-dids-to-one-number.md) - [Should Agents Add Prefixes When Dialing out?](https://docs.commpeak.com/docs/when-dialing-out-should-the-agents-dial-the-prefixes.md) - [Can I Purchase a Virtual Number to Receive OTP Codes and Messages?](https://docs.commpeak.com/docs/can-i-purchase-a-virtual-number-to-receive-otp-codes-and-messages.md) - [How Can I Replace Old Numbers For a Specific Route?](https://docs.commpeak.com/docs/how-can-i-replace-old-numbers-for-a-specific-route.md) - [Are There Countries That Limit Incoming Caller IDs?](https://docs.commpeak.com/docs/are-there-countries-that-limit-incoming-caller-ids.md): Learn which contries require verified Caller IDs for incoming calls. - [Can I Configure Outbound/Inbound Rates for Specific DIDs?](https://docs.commpeak.com/docs/can-i-configure-outboundinbound-rates-for-specific-did-numbers.md) - [What Are CommPeak's Verification Requirements?](https://docs.commpeak.com/docs/what-are-identity-verification-requirements.md): Check CommPeak verification requirements, including who can apply, which documents you may need, and how to submit verification through the CommPeak Portal. - [How to Submit Documents for Verification?](https://docs.commpeak.com/docs/verification-documentation-management.md): Learn which documents you need for CommPeak, how to upload them in the Portal, and how to match your profile details to avoid approval delays. - [CommPeak’s Identity Verification: What to Expect?](https://docs.commpeak.com/docs/commpeak-identity-verification-timeline.md): Learn how CommPeak identity verification works, why review times vary, what Pending Review means, and how you’ll be notified when verification is complete. - [Troubleshooting](https://docs.commpeak.com/docs/troubleshooting-did-numbers.md): Troubleshoot CommPeak DID number and identity verification issues. - [Verification Documents Uploads Fail](https://docs.commpeak.com/docs/failed-documents-uploads.md): Learn why verification document uploads fail and how to fix common issues like file size limits, password protection, browser cache, and poor image quality. - [Choppy or Distorted Audio](https://docs.commpeak.com/docs/choppy-or-distorted-audio-did.md): Learn how to troubleshoot the issues with interruptions or poor audio quality during calls. - [Echo During Calls](https://docs.commpeak.com/docs/echo-during-calls-did.md): Learn how to troubleshoot the issues with voice echoed back during calls. - [One-Way Audio](https://docs.commpeak.com/docs/one-way-audio-did.md): Learn how to troubleshoot the issues with one party not hearing the other. - [Dropped Calls](https://docs.commpeak.com/docs/dropped-calls-did.md): Learn how to troubleshoot the issues with calls unexpectedly disconnecting during conversations. - [VoIP Services](https://docs.commpeak.com/docs/voip-services.md): View and manage VoIP services from your CommPeak Portal account. - [Getting Started](https://docs.commpeak.com/docs/voip-service-getting-started.md): How to get started and make the most of the CommPeak VoIP (Voice over Internet Protocol) Service, a technology that allows users to make voice calls using a broadband internet connection instead of a traditional phone line - [Adding SIP Accounts](https://docs.commpeak.com/docs/adding-sip-accounts.md): Create SIP accounts in CommPeak Portal, up to the default limit of 10, and request more through support. - [Configuring SIP Accounts](https://docs.commpeak.com/docs/configuring-sip-accounts.md): Change your SIP account settings: reset password, modify username, increase channel limit, set Caller IDs, and change authentication type. - [VoIP Services Management](https://docs.commpeak.com/docs/voip-services-management.md): Check the detailed descriptions and step-by-step instructions on how to configure and manage your VoIP Services from the CommPeak Portal. - [SIP Account Authentication](https://docs.commpeak.com/docs/sip-account-authentication.md): Set password-based or IP-based authentication for your SIP account in CommPeak Portal. - [Transferring In-Progress Call to a CommPeak DID](https://docs.commpeak.com/docs/transferring-in-progress-call-to-a-commpeak-did.md): Learn how to transfer an in-progress call to your CommPeak DID using SIP REFER: request format, validation rules, response codes, and AI agent platform setup. - [Passing Custom Metadata with X-B-ext SIP Headers](https://docs.commpeak.com/docs/passing-custom-metadata-with-x-b-ext-sip-headers.md): Learn how to use the X-B-ext1, X-B-ext2, and X-B-ext3 custom SIP headers to carry your own correlation IDs and metadata through CommPeak calls and transfers. - [Enabling JWT Authentication for SIP Account](https://docs.commpeak.com/docs/enabling-jwt-authentication-for-sip-account.md): Set up JWT authentication for SIP accounts so that they can use short-lived tokens to safely authenticate from public internet resources. - [Allowed Caller IDs](https://docs.commpeak.com/docs/allowed-caller-ids.md): Manage your verified caller IDs, add new ones, and track their status with ease. Learn how to use the Allowed Caller IDs page in CommPeak Portal. - [Dynamic Caller ID Rules](https://docs.commpeak.com/docs/dynamic-caller-id-rules.md): Сreate dynamic caller ID rules to change or hide your caller ID during outbound calls based on specific conditions, such as country or prefix, and activate them in your SIP accounts. - [CommPeak's SIP Trunking Addresses](https://docs.commpeak.com/docs/commpeaks-sip-trunking-addresses.md): This article outlines the IP addresses required for SIP Signalling & Media addresses required for firewall whitelisting. - [How to Allow ICMP (Ping) Traffic for Your Office Router](https://docs.commpeak.com/docs/how-to-allow-icmp-ping-traffic-for-your-office-router.md): Allow 'ping messages' between CommPeak servers and your IP address to monitor your network's performance. Refer to manufacturer guides (FortiGate, Palo Alto, F5, MikroTik, Cisco) for specific settings. - [Integrating WebRTC Phone into Web Pages Using CommPeak](https://docs.commpeak.com/docs/implementing-webrtc-phone-on-your-web-page-with-commpeak.md): Learn how to configure calling functionality in your web-based software using WebRTC via CommPeak. - [Integrating WebRTC Applications with CommPeak](https://docs.commpeak.com/docs/integrating-webrtc-applications-with-commpeak.md): Learn how to register your WebRTC solution with CommPeak using SIP account credentials. - [WebCall Widget: In-page VoIP Calls](https://docs.commpeak.com/docs/webcall-widget-in-page-voip-calls-directly-from-your-website.md): Check out what a WebCall Widget is and how it works to place in-page VoIP Calls directly from your website. - [Proactive Account Monitoring](https://docs.commpeak.com/docs/proactive-account-monitoring.md): Enhance account security and control spending with Proactive Account Monitoring: block suspicious traffic, restrict hours/days of calling, set spending limits, and receive notifications to stay on top of your CommPeak account. - [FAQs](https://docs.commpeak.com/docs/faqs-voip-services.md): CommPeak VoIP Services FAQs - [How Are Calls Handled and Optimized with CallBoost?](https://docs.commpeak.com/docs/how-are-calls-handled-and-optimized-with-callboost-faq.md): Learn how CallBoost, a dynamic call routing engine, operates to enhance call success rates on the CommPeak platform. - [How Can I Set Up a VoIP Network With Dual ISPs?](https://docs.commpeak.com/docs/how-should-i-set-up-a-voip-network-with-dual-isps-faq.md): Learn how to set up a VoIP network with dual ISPs. - [How Can I Manage Load Balancing or Failover Across Multiple IP Addresses?](https://docs.commpeak.com/docs/do-i-have-to-manage-load-balancing-or-failover-across-multiple-ip-addresses-faq.md): Learn how you can manage load balancing or failover across multiple IP addresses. - [Do You Support DNS SRV Record?](https://docs.commpeak.com/docs/do-you-support-dns-srv-record-faq.md): Learn if CommPeak supports DNS SRV record. - [Do You Support SIP Over TLS and SRTP?](https://docs.commpeak.com/docs/do-you-support-sip-over-tls-and-srtp-for-secure-voip-communication-faq.md): Learn if CommPeak supports SIP over TLS and SRTP. - [Can VPN Affect VoIP Calls?](https://docs.commpeak.com/docs/how-can-vpn-affect-voip-calls-faq.md): Learn how VPN can affect VoIP calls. - [Do You Support IPSec Integration With Customers?](https://docs.commpeak.com/docs/do-you-support-ipsec-integration-with-customers-faq.md): Learn if CommPeak supports IPSec integration with Customers. - [What Codecs Provide the Best Sound Quality?](https://docs.commpeak.com/docs/what-codec-should-i-use-faq.md): Learn what codecs can provide the best sound quality. - [What Are CommPeak's Current IP Ranges?](https://docs.commpeak.com/docs/what-are-commpeak-ip-addresses-faq.md): Learn what CommPeak's current IP ranges are. - [Where Is My Traffic Sent To?](https://docs.commpeak.com/docs/where-is-my-traffic-sent-to-faq.md): Learn where your traffic is sent to. - [How to Learn Which Exactly Caller ID Rule Was Triggered?](https://docs.commpeak.com/docs/how-can-i-know-which-exactly-caller-id-rule-was-triggered-faq.md): Learn how to find out which exactly Caller ID rule was triggered. - [What Is E.164 Standard?](https://docs.commpeak.com/docs/what-is-e164-faq.md): Check out the E.164 standard explained. - [What Ports to Allow for CommPeak VoIP Services?](https://docs.commpeak.com/docs/what-are-allowed-ports-for-commpeak-voip-services.md): Learn what ports should be allowed for CommPeak VoIP services. - [What to Do If Port 5061 Is Blocked?](https://docs.commpeak.com/docs/what-to-do-if-port-5061-is-blocked.md): Learn what to do if port 5061 is blocked. - [Important Note: Third-Party Applications Usage](https://docs.commpeak.com/docs/important-note-third-party-applications-usage.md): Check out the important note on using 3rd-party applications. - [Dialer](https://docs.commpeak.com/docs/dialers.md): View CommPeak Dialer details, including its domain, from your Portal account and access additional information on recording access accounts - [Recording Access Accounts](https://docs.commpeak.com/docs/recordings-access-accounts.md): Configure S3 Browser to access call recordings from your CommPeak Dialer instance or connect using the AWS CLI V2, configure access rules, and view access log in CommPeak Portal - [Cloud PBX](https://docs.commpeak.com/docs/your-pbx-instances.md): View and manage your CommPeak Cloud PBX instances from the Portal account. - [Requesting a New PBX Instance](https://docs.commpeak.com/docs/pbx-questionnaire.md): Follow the steps to order a new PBX from your CommPeak Portal account. - [PBX Details](https://docs.commpeak.com/docs/pbx-details.md): View CommPeak Cloud PBX details, including its domain, from your Portal account. - [Configuring Access Control Lists](https://docs.commpeak.com/docs/configuring-access-control.md): Learn how to configure access control lists for your PBX instance. - [Recording Access Accounts](https://docs.commpeak.com/docs/recording-access-accounts.md): Configure S3 Browser to access call recordings from your CommPeak Cloud PBX instance or connect using the AWS CLI V2, configure access rules, and view access log in CommPeak Portal. - [Network Statistics](https://docs.commpeak.com/docs/network-statistics.md): Monitor network latency for PBX extensions from the CommPeak Portal: select a date range, view graphs for all extensions, or display statistics for specific extension(s) to identify potential network issues affecting call quality. - [SMS Services](https://docs.commpeak.com/docs/sms-services.md): View and manage SMS services from the CommPeak Portal account. - [Getting Started](https://docs.commpeak.com/docs/sms-service-getting-started.md): Get started and make the most of the CommPeak's SMS services, including TextPeak, Streams API, and SMPP Channels. - [Overview of CommPeak SMS Services](https://docs.commpeak.com/docs/overview-of-the-commpeak-sms-services.md): Get an overview of the CommPeak SMS services and learn how to start using them. - [TextPeak Messaging Services](https://docs.commpeak.com/docs/activating-textpeak-messaging-services.md): Check our step-by-step guide on activating TextPeak messaging services within your CommPeak Portal account. - [SMS Route Types: a Comprehensive Guide](https://docs.commpeak.com/docs/sms-route-types-a-comprehensive-guide.md): Learn how to choose the right route for your messaging strategy, ensuring compliance, deliverability, and cost-effectiveness. - [SMS Management](https://docs.commpeak.com/docs/sms-management.md): A comprehensive overview of SMS management within the CommPeak Portal, detailing various articles on API integration, channel creation, testing, reporting, and technical specifications for effective text messaging operations - [Creating SMS SMPP Channels](https://docs.commpeak.com/docs/creating-sms-smpp-channels.md): Create password-protected SMPP channels for SMS messaging on the CommPeak platform, setting channel name, product, IP address, username, and password, then enable the channel for use in your campaigns. - [Sending Test SMS Messages](https://docs.commpeak.com/docs/sending-test-sms-messages.md): Testing SMS routes before sending live messages ensures that your SMS setup is working correctly and provides valuable insights into pricing and delivery data. - [Generating SMS Delivery Reports](https://docs.commpeak.com/docs/generating-sms-delivery-reports.md): View and generate reports on your outbound SMS messages with EDRs, including search filters, dashboard metrics, and export options to CSV files. - [Viewing SMS Messages Sent to DID Numbers](https://docs.commpeak.com/docs/how-to-view-sms-messages-sent-to-did-numbers.md): View incoming SMS messages sent to DID numbers, share them, and grant access permissions to others based on IP address. - [Using the Streams SMS API in the CommPeak Portal](https://docs.commpeak.com/docs/using-the-streams-sms-api-in-the-commpeak-portal.md): Launch CommPeak's Streams SMS API: activate the SMS service, create or use default API tokens, and configure stream settings to authenticate and send SMS messages via API. - [HTTP(S) API Description](https://docs.commpeak.com/docs/http-s-api-description.md): Integrate with CommPeak's SMS service using HTTPS API, enabling SMS submitting and delivery status checking. - [SMPP Technical Information](https://docs.commpeak.com/docs/smpp-technical-information.md): Integrate with CommPeak's SMS platform using SMPP protocol. - [SMS Integrations](https://docs.commpeak.com/docs/sms-integrations.md): Learn how to automate your SMS message workflows using CommPeak integrations - [FAQs](https://docs.commpeak.com/docs/faq-sms-service.md): CommPeak SMS Services FAQs - [Can I Purchase a Virtual Number to Receive OTP Codes and Messages?](https://docs.commpeak.com/docs/can-i-purchase-a-virtual-number-from-your-service-to-be-able-to-receive-otp-codes-and-messages.md): Learn how to purchase a virtual number to receive OTP codes and messages. - [How Can I Get My DIDs Incoming Messages Into TextPeak?](https://docs.commpeak.com/docs/how-can-i-add-dids-for-textpeak-option-for-my-agents-sms.md): Learn how you can get your DIDs incoming messages into TextPeak. - [Can I Send SMS Directly From Monday.com/Pipedrive/HubSpot/Shopify/Zapier/Make/Intercom?](https://docs.commpeak.com/docs/can-i-integrate-sending-sms-with-my-crm.md): Check out how to send SMS directly from Monday.com/Pipedrive/HubSpot/Shopify/Zapier/Make/Intercom. - [Can I Integrate WhatsApp/Telegram Instant Messaging Service?](https://docs.commpeak.com/docs/can-i-integrate-whatsuptelegram-instant-messaging-service-sms.md): Check how to integrate WhatsApp/Telegram instant messaging services. - [How Can I Activate the SMS Option Through the Dialer?](https://docs.commpeak.com/docs/how-can-i-activate-the-sms-option-through-the-dialer-sms.md): Learn how to activate the SMS option through the Dialer. - [Troubleshooting](https://docs.commpeak.com/docs/troubleshooting-sms-service.md): Troubleshooting CommPeak SMS Services Issues - [SMS Delivery Failures](https://docs.commpeak.com/docs/sms-delivery-failures.md): Learn how to troubleshoot the issues with scheduled messages sent at incorrect times or failing to send altogether. - [Delayed SMS Delivery](https://docs.commpeak.com/docs/delayed-sms-delivery.md): Learn how to troubleshoot the issues with messages received by recipients after a significant delay. - [API Integration Issues](https://docs.commpeak.com/docs/api-integration-issues.md): Learn how to troubleshoot the issues with integrating the SMS service via API. - [Issues with 2-Way Messaging](https://docs.commpeak.com/docs/2-way-sms-not-functioning.md): Learn how to troubleshoot the issues with Two-Way messaging. - [Compliance and Regulatory Issues](https://docs.commpeak.com/docs/compliance-and-regulatory-issues.md): Resolve issues with messages blocked or flagged due to compliance or regulatory issues. - [Speech to Text](https://docs.commpeak.com/docs/speech-to-text-portal.md): Explore how our Speech to Text solution transforms audio into searchable text, streamlining call analysis, data extraction, and improving overall operational insights - [Getting Started](https://docs.commpeak.com/docs/speech-to-text-getting-started.md): How to get started and make the most of the CommPeak Speech to Text feature that enables users to transform audio from calls into written transcripts - [Creating New Speech Transcripts](https://docs.commpeak.com/docs/creating-new-speech-transcripts.md): Convert voice recordings to text through, specifying language and channels to transcribe, and then view and search the resulting transcripts. - [Viewing and Downloading Speech Transcripts](https://docs.commpeak.com/docs/viewing-and-downloading-speech-transcripts.md): Transcribe, store, and review voice recordings, search transcripts for keywords, and easily manage your recordings with just a few clicks. - [Troubleshooting](https://docs.commpeak.com/docs/troubleshooting-speech-to-text.md): Troubleshooting CommPeak Speech to Text Issues - [Inaccurate Transcriptions or Speech Recognition Errors](https://docs.commpeak.com/docs/inaccurate-transcriptions.md): Learn how to troubleshoot the issues with erroneous transcriptions or misinterpretations of speech output. - [Speech Recognition not Activating](https://docs.commpeak.com/docs/speech-recognition-not-activating.md): Resolve the issues with the Speech to Text service not starting or responding. - [Error Messages During Transcription](https://docs.commpeak.com/docs/error-messages-during-transcription.md): Learn how to troubleshoot the issues with receiving error messages when attempting to transcribe audio. - [Delayed Transcription Output](https://docs.commpeak.com/docs/delayed-transcription-output.md): Learn how to troubleshoot the issues with transcriptions appearing with a significant delay after speech input. - [LookUp](https://docs.commpeak.com/docs/commpeak-lookup-overview.md): Verify phone numbers worldwide with LookUp. Filter, validate, and view precise real-time data in international and local formats - [Creating a New Lookup](https://docs.commpeak.com/docs/creating-a-new-lookup.md): Run bulk or individual phone number lookups with the dedicated CommPeak tool, estimate costs, and get notified when your lookup results are ready. - [Viewing Recent Lookups and Results](https://docs.commpeak.com/docs/using-my-lookups-and-results.md): View recent lookups and lookup statistics and find detailed information about each phone number checked. - [LookUp Requests Data Explained](https://docs.commpeak.com/docs/number-validation-request-explained.md): Review precise, real-time data for your phone number lookups, including validation status, network details (MCC, MNC), and number formatting (E.164, national, international). - [LookUp API Service](https://docs.commpeak.com/docs/lookup-api-service.md): View and manage keys for CommPeak LookUp API service. - [FAQs](https://docs.commpeak.com/docs/lookup-faqs.md): LookUp FAQs - [Can I Test Your HLR LookUp Service Before Buying?](https://docs.commpeak.com/docs/can-i-test-your-hlr-lookup-service-before-buying.md): Learn how to test the CommPeak HLR Lookup service before buying. - [Can I Know From LookUp.csv List If the Number Was Reachable?](https://docs.commpeak.com/docs/can-i-know-from-the-lookup-csv-list-if-the-number-was-reachable.md): Learn if you know if the number was reachable from the LookUp.csv list. - [Can I Send HLR LookUp Requests From CommPeak API?](https://docs.commpeak.com/docs/can-i-send-hlr-lookup-requests-from-commpeak-api.md): Learn if you can send HLR Lookup requests from CommPeak API. - [Troubleshooting](https://docs.commpeak.com/docs/troubleshooting-lookup.md): Use this article to troubleshoot CommPeak LookUp issues. - [HLR LookUp Returns an "Unknown" Status](https://docs.commpeak.com/docs/what-should-i-do-if-hlr-lookup-returns-an-unknown-status.md): Learn how to troubleshoot the leads validity when the HLR LookUp returns an "Unknown" status. - [Reports](https://docs.commpeak.com/docs/reports-overview.md): View and manage your call and expense history in the CommPeak Portal with our range of available reports - [Call Records (CDR)](https://docs.commpeak.com/docs/call-records-cdr.md): Generate Call Records (CDR) reports for outbound calls: filter results in CommPeak Portal by SIP account, pricing group, and date range, and download as CSV or view on-screen. - [Origination CDR](https://docs.commpeak.com/docs/origination-cdr.md): Run the Origination CDR report in CommPeak Portal to view inbound call details, filter by DID number and date range, and export results as CSV. - [Daily Calls](https://docs.commpeak.com/docs/daily-calls.md): View daily call data, including summaries for each day within your selected timeframe: number of calls, total and billable duration, and total cost. - [Calls by Destination](https://docs.commpeak.com/docs/calls-by-destination.md): View outbound call statistics by destination, including totals and breakdowns by SIP account or network name. - [Call Graphs](https://docs.commpeak.com/docs/call-graphs.md): View call statistics: status, average duration, answer-seizure rate, and length of calls by date range. - [Balance Graph](https://docs.commpeak.com/docs/balance-graph-1.md): View daily changes in CommPeak account balance: see graph showing balance history, and hover over specific dates to view exact balance amount. - [Failed SIP Calls Analysis](https://docs.commpeak.com/docs/failed-sip-calls-analysis.md): Learn how to review, monitor and understand why calls failed due to SIP errors - [Troubleshooting Failed SIP Calls](https://docs.commpeak.com/docs/troubleshooting-failed-sip-calls.md): Information to help you identify, isolate, and resolve issues with SIP calls. - [Settings: Users & Access](https://docs.commpeak.com/docs/your-settings.md): Learn about the various settings that control CommPeak's Portal overall functionality - [Users](https://docs.commpeak.com/docs/your-users.md): How CommPeak account owners can create and manage multiple users with various roles and control access to different sections. - [Departments](https://docs.commpeak.com/docs/departments.md): Learn how CommPeak account owners can create departments, assign users to them, and manage existing departments. - [Account Security](https://docs.commpeak.com/docs/account-security.md): Learn about the measures and practices designed to enhance your account's security. - [How to Keep Your Account Secure](https://docs.commpeak.com/docs/how-to-keep-your-account-secure.md): Protect your account with CommPeak's security tips to keep safe. - [How to Create a Secure Password](https://docs.commpeak.com/docs/how-to-create-a-secure-password.md): Create strong and unique passwords by mixing characters, keeping them secure, and avoiding personal info, common words, sequences, and reused passwords. - [How to Restore Your Forgotten Password](https://docs.commpeak.com/docs/how-to-restore-your-forgotten-password.md): Forgot password for your CommPeak account? Reset it in four easy steps. - [Using CommPeak Support PIN](https://docs.commpeak.com/docs/using-commpeak-support-pin.md): Find and re-generate your CommPeak support PIN ensuring that sensitive account information and requests are only handled by authorized users. - [How to Handle Phishing and Spam Issues](https://docs.commpeak.com/docs/how-can-i-handle-phishing-and-spam-issues.md): Beware of fake CommPeak emails from imposters trying to initiate spam or phishing attempts and check them for authenticity. - [PBX IP ACL Settings](https://docs.commpeak.com/docs/pbx-ip-acl-settings.md): Allow specific IP addresses to access your PBX system by setting whitelisted IP addresses in Web ACL, SIP ACL, or Click2Call ACL and use Dynamic DNS (DDNS) for dynamic IP addresses and Geo ACL for country-based whitelisting. - [Proactive Account Monitoring](https://docs.commpeak.com/docs/proactive-account-monitoring-1.md): Enhance account security and control spending with Proactive Account Monitoring: block suspicious traffic, restrict hours/days of calling, set spending limits, and receive notifications to stay on top of your CommPeak account. - [FAQs](https://docs.commpeak.com/docs/account-security-faqs.md): Account Security FAQs - [How Do You Authenticate SIP Calls?](https://docs.commpeak.com/docs/how-do-you-authenticate-sip-calls.md): Check out how CommPeak authenticates SIP calls. - [How Can I Know If I Received a Genuine CommPeak Email?](https://docs.commpeak.com/docs/how-can-i-know-if-i-received-a-genuine-commpeak-email.md): Learn how to make sure you received a genuine CommPeak email. - [Data Privacy Concerns](https://docs.commpeak.com/docs/data-privacy-concerns.md): Learn how you can make sure that your data is securely protected - [Help & Support](https://docs.commpeak.com/docs/how-to-contact-commpeak-support.md): Get help from CommPeak's support team and access various support options such as opening tickets, chatting with Speaky, calling support, and requesting remote assistance. - [Using Speaky, Your AI Assistant](https://docs.commpeak.com/docs/speaky-ai-assistant.md): Learn how to use Speaky, the CommPeak AI assistant, to check your balance, invoices, SIP accounts, rates, and DID setup, and to reach a support agent when needed. - [My Tickets](https://docs.commpeak.com/docs/my-tickets.md): Manage and track your support tickets with filtering, sorting, and status management capabilities. Create new tickets and view ticket details through the integrated chat interface. - [Network Monitor Pinger](https://docs.commpeak.com/docs/network-monitor-pinger.md): Сheck your connection quality with Network Monitor - Pinger: measure latency and packet loss between CommPeak servers and your IP address, helping you identify issues on either side. - [Requesting Refund](https://docs.commpeak.com/docs/requesting-a-refund.md): Request a refund in CommPeak account: select a reason and specify payment(s) to be refunded, choose refund destination (bank account, PayPal, etc.), and track status through email updates and Account Refund page. - [Closing CommPeak Account](https://docs.commpeak.com/docs/closing-commpeak-account.md): Learn how to submit a CommPeak account closure request, review active services and balance details, and understand what happens after approval. - [FAQs](https://docs.commpeak.com/docs/faq-portal.md): CommPeak Portal FAQs - [How Can VPN Affect VoIP Calls?](https://docs.commpeak.com/docs/how-can-vpn-affect-voip-calls-2.md): How the use of a VPN can impact VoIP calls. - [What Are the Supported Codecs?](https://docs.commpeak.com/docs/what-are-the-supported-codecs.md): Learn what codes are supported by CommPeak. - [Can I Make a Test Call Before Crediting My Account?](https://docs.commpeak.com/docs/can-i-make-some-test-calls-before-crediting-my-account.md): Learn how to make a test call before crediting your account. - [Do You Offer Termination in Every Country?](https://docs.commpeak.com/docs/do-you-offer-termination-in-every-country.md): Check out the countries we offer termination in. - [What Is SIP Origination and SIP Termination?](https://docs.commpeak.com/docs/what-is-sip-origination-sip-termination.md): Learn what SIP origination and SIP termination is. - [How Up-To-Date Are the CDRs?](https://docs.commpeak.com/docs/how-up-to-date-are-the-cdrs.md): Learn about how up-to-date the CDRs are. - [Can I Use My Wireless Satellite Connection?](https://docs.commpeak.com/docs/can-i-use-my-wireless-satellite-connection.md): Check out if you can use your wireless satellite connection. - [Can I Disable the Ability of the Specific User to See Balance and Total Usage?](https://docs.commpeak.com/docs/can-i-disable-the-ability-of-the-specific-user-to-see-balance-and-total-usage.md): Learn if you can disable the ability of the specific Uuer to see balance and total usage. - [Can I Use One Number on My SIP as a Static Number for Outbound and Inbound Calls?](https://docs.commpeak.com/docs/can-i-use-one-number-on-my-sip-as-a-static-number-for-outbound-and-inbound-calls.md): Learn if you can use one number on your SIP as a static number for outbound and inbound calls. - [Do You Have a VoIP Reseller Program?](https://docs.commpeak.com/docs/do-you-have-a-voip-reseller-program.md): Learn about the CommPeak Affiliate Program (VoIP Reseller Program). - [Do You Have an SMS Reseller Program?](https://docs.commpeak.com/docs/do-you-have-an-sms-reseller-program.md): Learn about the CommPeak Affiliate Program (SMS Reseller Program). - [Troubleshooting](https://docs.commpeak.com/docs/troubleshooting-portal.md): Troubleshoot My CommPeak Portal Issues. - [Login Difficulties in CommPeak Portal](https://docs.commpeak.com/docs/login-difficulties-in-commpeak-portal.md): Learn how to troubleshoot the issues with logging in to your CommPeak account. - [Billing and Payment Issues in CommPeak Portal](https://docs.commpeak.com/docs/billing-and-payment-discrepancies-in-commpeak-portal.md): Learn how to troubleshoot billing and payment issues. - [API Integration Failures with CommPeak Services](https://docs.commpeak.com/docs/api-integration-failures-with-commpeak-services.md): Learn how to troubleshoot issues using CommPeak's API to connect 3rd party software. - [Two-Factor Authentication (2FA) Problems in CommPeak Portal](https://docs.commpeak.com/docs/two-factor-authentication-twofa-problems-in-commpeak-portal.md): Learn how to troubleshoot the issues with setting or using 2FA for securing your CommPeak account. - [Call Quality Issues](https://docs.commpeak.com/docs/portal-call-quality-issues.md): Learn how to troubleshoot call quality issues. - [Reporting and Analytics Errors in CommPeak Portal](https://docs.commpeak.com/docs/reporting-and-analytics-errors-in-commpeak-portal.md): Learn how to troubleshoot the errors with reporting and analytics in CommPeak Portal. - [Getting Started](https://docs.commpeak.com/docs/getting-started.md): How to get started with SIP trunking - [SIP Account Configuration](https://docs.commpeak.com/docs/sip-account-configuration.md): Learn about the options you can use to register a SIP account. - [Registering in CommPeak Softphone](https://docs.commpeak.com/docs/registering-in-commpeak-softphone.md): Register a SIP account in CommPeak Softphone and log in to start making calls. - [Registering in Zoiper](https://docs.commpeak.com/docs/registering-in-zoiper.md): Register a SIP account in Zoiper by entering SIP credentials from the CommPeak Portal and then log in to start making calls. - [Registering in IP Phones](https://docs.commpeak.com/docs/registering-in-ip-phones.md): Configure physical IP phones for CommPeak VoIP services by entering SIP account credentials and domain into the phone's settings, with specific setup examples provided for Yealink, Grandstream, and Fanvil IP phones. - [Setting Up a SIP Trunk in FreePBX](https://docs.commpeak.com/docs/setting-up-a-sip-trunk-in-freepbx.md): This guide provides step-by-step instructions on how to add a new SIP trunk in FreePBX. - [Setting Up a SIP Trunk in FreeSWITCH](https://docs.commpeak.com/docs/setting-up-a-sip-trunk-in-freeswitch.md): This guide provides step-by-step instructions on how to add a SIP trunk in FreeSWITCH. - [Setting Up a SIP Trunk in an Asterisk PBX](https://docs.commpeak.com/docs/setting-a-sip-trunk-in-an-asterisk-pbx.md): This guide provides step-by-step instructions on how to configure a SIP trunk to use it with your Asterisk PBX - [SIP Trunking Management](https://docs.commpeak.com/docs/sip-trunking-management.md): Learn about the options you can use to manage SIP trunking. - [Prioritizing Voice Traffic From CommPeak on Windows Environments](https://docs.commpeak.com/docs/prioritizing-voice-traffic-from-commpeak-on-windows-environments.md): Prioritize CommPeak Softphone traffic using Windows' QoS settings to ensure high-quality voice transmission. - [Dial Pattern for 3rd-Party PBXs](https://docs.commpeak.com/docs/dial-pattern-for-trd-party-pbxs.md): Learn how to configure your Private Branch Exchange (PBX) with CommPeak SIP account credentials using proper dial patterns and trunk setup. - [PBX VoIP Network and Firewall Best Practices](https://docs.commpeak.com/docs/port-ranges-for-using-the-classic-pbx.md): This article outlines best practices to ensure high-quality, secure VoIP calls while minimizing network disruptions. - [No-Surcharge Country List for UK Dialing](https://docs.commpeak.com/docs/no-surcharge-country-list-for-uk-dialing.md): Find Ofcom's regulations on outbound calls to UK mobile carriers that may incur surcharges and a list of countries exempt from this regulation under the No-Surcharge category. - [Service Testing](https://docs.commpeak.com/docs/service-testing.md): Learn how to test the VoIP services offered by CommPeak. - [CommPeak Speed Test](https://docs.commpeak.com/docs/commpeak-speed-test.md): The CommPeak Speed Test helps you assess the speed and quality of your connection, ensuring your VoIP communication is stable. - [CommPeak Looking Glass](https://docs.commpeak.com/docs/commpeak-looking-glass.md): The CommPeak Looking Glass service is a web-based network diagnostic tool to help you troubleshoot connectivity and routing issues without direct server access. - [Realtime System Status](https://docs.commpeak.com/docs/realtime-system-status.md): The page provides updates on the operational status of services and allows users to subscribe to notifications about maintenance and incidents through various channels. - [Running an Echo and DTMF Test](https://docs.commpeak.com/docs/running-an-echo-test.md): An echo test allows you to check the quality of your sound; a DTMF test is used to check that your hardware is sending through the correct DTMF signals. - [FAQs](https://docs.commpeak.com/docs/faq-voip-service.md): CommPeak SIP Trunking FAQs - [How Are Calls Handled and Optimized With CallBoost?](https://docs.commpeak.com/docs/how-are-calls-handled-and-optimized-with-callboost.md): Learn how CallBoost, a dynamic call routing engine, operates to enhance call success rates on the CommPeak platform. - [How Should I Set Up a VoIP Network With Dual ISPs?](https://docs.commpeak.com/docs/how-should-i-set-up-a-voip-network-with-dual-isps.md) - [Do I Have to Manage Load Balancing or Failover Across Multiple IP Addresses?](https://docs.commpeak.com/docs/do-i-have-to-manage-load-balancing-or-failover-across-multiple-ip-addresses.md) - [Do You Support DNS SRV Record?](https://docs.commpeak.com/docs/do-you-support-dns-srv-record.md) - [Do You Support SIP Over TLS and SRTP for Secure VoIP Communication?](https://docs.commpeak.com/docs/do-you-support-any-sip-tls-srtp-encryption-methods.md) - [How Can VPN Affect VoIP Calls?](https://docs.commpeak.com/docs/how-can-vpn-affect-voip-calls.md): Learn how VPNs impact VoIP call quality through increased latency, jitter, and packet loss. Discover mitigation strategies and best practices for optimal call performance. - [Do You Support IPSec Integration With Customers?](https://docs.commpeak.com/docs/do-you-support-ipsec-integration-with-customers.md) - [What Codec Should I Use?](https://docs.commpeak.com/docs/what-codec-should-i-use.md) - [What Are CommPeak IP Addresses?](https://docs.commpeak.com/docs/what-are-commpeak-s-ip-addresses.md) - [Where Is My Traffic Sent To?](https://docs.commpeak.com/docs/where-is-my-traffic-sent-to.md) - [How Can I Know Which Exactly Caller ID Rule Was Triggered?](https://docs.commpeak.com/docs/how-can-i-know-which-exactly-caller-id-rule-was-triggered.md) - [What Are CommPeak SIP Signaling Addresses?](https://docs.commpeak.com/docs/pbx-what-are-commpeak-s-sip-proxy-addresses.md) - [What Is E.164?](https://docs.commpeak.com/docs/global-standard.md): E.164 standard explained - [What Are Allowed Ports for CommPeak VoIP Services?](https://docs.commpeak.com/docs/what-ports-to-allow-for-commpeak-voip-services-faq.md) - [What Should I Do if Port 5061 is Blocked?](https://docs.commpeak.com/docs/what-to-do-if-port-5061-is-blocked-faq.md) - [What Are STUN and TURN in SIP?](https://docs.commpeak.com/docs/what-are-stun-and-turn-in-sip.md) - [Important Note: Using 3rd-Party Applications](https://docs.commpeak.com/docs/important-note-third-party-applications-usage-faq.md) - [Troubleshooting](https://docs.commpeak.com/docs/troubleshooting-voip-service.md): Troubleshooting SIP Trunking Issues - [Choppy or Distorted Audio](https://docs.commpeak.com/docs/choppy-or-distorted-audio-sip.md): Learn how to troubleshoot the issues with interruptions or poor audio quality during calls. - [Echo During Calls](https://docs.commpeak.com/docs/echo-during-calls-sip.md): Learn how to troubleshoot the issues with voice echoed back during calls. - [Incorrect Caller ID Display](https://docs.commpeak.com/docs/incorrect-caller-id-display-sip.md): Learn how to troubleshoot the issues with caller ID information displayed incorrectly or not at all. - [Call Connection Failures](https://docs.commpeak.com/docs/call-connection-failures-sip.md): Learn how to troubleshoot the issues with connecting your calls. - [One-Way Audio](https://docs.commpeak.com/docs/one-way-audio-sip.md): Learn how to troubleshoot the issues with one party not hearing the other. - [Dropped Calls](https://docs.commpeak.com/docs/dropped-calls-sip.md): Learn how to troubleshoot the issues with calls unexpectedly disconnecting during conversations. - [Extension Registration Issues](https://docs.commpeak.com/docs/extension-registration-issues.md): Learn how to troubleshoot the issues with registering extensions. - [Getting Started](https://docs.commpeak.com/docs/dialer-getting-started.md): How to get started and make the most of CommPeak Dialer, an advanced cloud-based telephony solution - [Manager's Guide: Getting Your Agents Started](https://docs.commpeak.com/docs/getting-your-agents-started-manager-s-guide.md): Learn how to set up agent users, manage their login process, reset passwords, and introduce them to their workflow and workspace. - [Agent's Guide: Getting Started](https://docs.commpeak.com/docs/getting-started-agent-s-guide.md): Learn the essentials of using the CommPeak Dialer, covering login setup, workspace navigation, and instructions for managing calls and contacts, along with helpful resources for further training. - [Dialer Navigation & Search](https://docs.commpeak.com/docs/dialer-navigation-and-search.md): Learn how to navigate your Dialer instance and search for leads, pages, or look for needed information using the AI bot. - [Dialer Dashboard](https://docs.commpeak.com/docs/dialer-dashboard.md): This article overviews the manager and agent dashboards in CommPeak Dialer and includes instructions on customizing and managing dashboard content. - [User Profile](https://docs.commpeak.com/docs/user-profile.md): This page is a centralized hub for user-specific settings that enhance system personalization and streamline workflow efficiency. - [Search Bar](https://docs.commpeak.com/docs/search-bar.md): This article outlines how to use the Search Bar to quickly access specific sections, simplify system navigation, and improve workflow efficiency. - [Admin Tools](https://docs.commpeak.com/docs/basic-pages-a-manager-should-know.md): Know the Dialer pages and features that managers should be familiar with, including dashboard customization, real-time statistics, lead management tools, and campaign settings. - [Users Management](https://docs.commpeak.com/docs/users-management.md): Manage your Dialer users easily to control who has access to your system and what they can do. - [Creating a Single User](https://docs.commpeak.com/docs/creating-a-single-user.md): Create a user account, set up user information, assign groups and roles, and configure extension and security settings. - [Mass User Creation](https://docs.commpeak.com/docs/mass-user-creation.md): Create multiple users in CommPeak Dialer from a file: learn about the necessary file format, field mapping, and upload process. - [Managing Existing Users](https://docs.commpeak.com/docs/managing-existing-users.md): Manage user accounts: apply filters, reset passwords, update settings or delete individual users, and apply mass actions. - [Active User Sessions](https://docs.commpeak.com/docs/active-user-sessions.md): View and manage active user sessions, enable auto-refresh, and kick off users individually or in bulk. - [Desks](https://docs.commpeak.com/docs/dialer-desks.md): Learn how to create and edit desks, and add or remove users. - [User Roles](https://docs.commpeak.com/docs/user-roles.md): Learn about role-based permissions in CommPeak Dialer, including default roles and how to request new roles through support. - [Skill Groups](https://docs.commpeak.com/docs/skill-groups.md): Understand how skill groups work and modify a skill group by editing its name or description, adding or deleting users. - [Users Breaks](https://docs.commpeak.com/docs/users-breaks.md): Understand how user states function, how to create new user breaks, and how agents can modify their state. - [Clock Out Reasons](https://docs.commpeak.com/docs/dialer-clock-out-reasons.md): Create clock-out reasons for agents to select when they go on a break. - [Desk's Breaks](https://docs.commpeak.com/docs/desks-breaks.md): Understand how to set breaks per desk in CommPeak Dialer, how to apply a global default configuration, and how to define specific custom settings. - [Groups Management](https://docs.commpeak.com/docs/groups-management.md): The Dialer Groups Management functionality helps to direct campaign leads to suitable agent desks by setting logical rules and filters. - [User Group Parameters](https://docs.commpeak.com/docs/user-group-parameters.md): Edit user groups by adjusting basic parameters, filter groups, and predictive settings to tailor how leads are managed and dialed. - [Filter Groups](https://docs.commpeak.com/docs/filter-groups.md): Learn how to filter groups within user groups work and how to configure them. - [Tips for Managing User Groups](https://docs.commpeak.com/docs/tips-for-managing-user-groups.md): Apply these tips to effectively manage user groups and get the most of your Dialer. - [Testing Lead Assignment](https://docs.commpeak.com/docs/testing-lead-assignment.md): Use the Test lead assignment feature to verify that your lead belongs to only one user group and see which group it is. - [Group Leads Simulator](https://docs.commpeak.com/docs/group-leads-simulator.md): Test group filters and see how many available leads the group can call. - [Priority Groups](https://docs.commpeak.com/docs/priority-groups.md): Understand the concept of priority groups and how they are connected to skill groups and user groups. - [Agents Management](https://docs.commpeak.com/docs/dialet-agents.md): Check the resources essential for agents and their managers working with the CommPeak Dialer. - [Getting Your Agents Started - Manager's Guide](https://docs.commpeak.com/docs/getting-your-agents-started.md): Learn how to set up agent users, manage their login process, reset passwords, and introduce them to their workflow and workspace. - [Getting Started - Agent's Guide](https://docs.commpeak.com/docs/getting-started-agents-guide.md): Learn the essentials of using the CommPeak Dialer, covering login setup, workspace navigation, and instructions for managing calls and contacts, along with helpful resources for further training. - [Dialer Calling Options](https://docs.commpeak.com/docs/dialer-calling-options.md): Discover the calling options agents have in CommPeak Dialer to communicate with leads. - [Predictive Dialing](https://docs.commpeak.com/docs/predictive-dialing.md): Understand how to work in the Predictive Dialing mode that automates the calling process using predefined rules. The article will guide you through clocking in, making calls, submitting feedback, and clocking out. - [Scheduled Calls](https://docs.commpeak.com/docs/scheduled-calls.md): Manage your personal scheduled meetings with leads, view and edit upcoming calls, and perform actions such as making manual calls, adding comments, and reviewing lead history from the scheduled calls list. - [Personal Predictive Queue](https://docs.commpeak.com/docs/personal-predictive-queue.md): Activate and configure the Personal Predictive Queue (PPQ) feature, manage agents' calling ratios, and monitor PPQ agents from the Realtime page. - [Call Rating](https://docs.commpeak.com/docs/call-rating.md): Learn about the call rating feature that enables you to easily give feedback about the call quality and report call issues. - [Registering in Third-Party Softphones](https://docs.commpeak.com/docs/registering-in-third-party-softphones.md): Set up your Dialer account in MicroSIP or other third-party softphones. - [Leads Management](https://docs.commpeak.com/docs/leads-campaigns.md): Learn how to enhance your CommPeak Dialer campaign strategies. - [Lead Search](https://docs.commpeak.com/docs/lead-search.md): Learn how to search for leads, view their history, work with agent comments, and perform bulk actions on multiple leads. - [Lead Files Management](https://docs.commpeak.com/docs/lead-files.md): Learn how to upload lead files in CommPeak Dialer, ensure file requirements are met, map columns correctly, and assign leads to campaigns. - [Duplicates Management](https://docs.commpeak.com/docs/duplicates-management.md): Manage duplicate leads: view, download, and delete duplicates from lead files. - [Blacklists Management](https://docs.commpeak.com/docs/blacklists-management.md): Manage blacklisted leads: upload leads to a blacklist to prevent them from being dialed, approve, and remove leads from the blacklist. - [Custom Lead Fields](https://docs.commpeak.com/docs/custom-lead-fields.md): Learn how to create custom fields in CommPeak Dialer for filtering and matching purposes, and how to add them to lead searches, user roles, and call page fields. - [Object Lists](https://docs.commpeak.com/docs/object-lists.md): Learn how to create, manage, and duplicate various types of object lists to use them in group filters for lead filtering. - [Lead Indicators](https://docs.commpeak.com/docs/lead-indicators.md): Create multicolored lead indicators to mark specific lead attributes to be used as tags for agents during calls. - [Campaigns Management](https://docs.commpeak.com/docs/campaigns.md): Manage Dialer campaigns and campaign groups: view active campaigns, create groups, edit campaign parameters, and assign agents to campaigns. Learn how to apply campaign rules and access campaign statistics. - [Customizing Campaigns](https://docs.commpeak.com/docs/guide-to-campaign-parameters.md): Customize campagins in CommPeak Dialer according to your needs. - [Manager Hashtags](https://docs.commpeak.com/docs/tagging-managers-in-calls.md): Activate the Manager Hashtags feature, create, assign, and manage hashtags for specific campaigns, apply them during calls, and view related statistics in call records. - [Campaign Rules](https://docs.commpeak.com/docs/understanding-campaign-rules.md): Understand campaign rules and learn how rule conditions and actions work. - [Lead Status Workflow](https://docs.commpeak.com/docs/lead-status-workflow.md): Control which lead statuses agents can select on the Feedback page. Set call duration conditions to restrict when certain statuses become available. - [Realtime Management](https://docs.commpeak.com/docs/realtime.md): Learn how to work with the Dialer Realtime page, most frequently used page for managers. - [Realtime Stats](https://docs.commpeak.com/docs/new-realtime-stats.md): This is an overview of the Realtime Stats page, detailing how managers can monitor live call center operations, customize the live view, and access notifications about ongoing issues. - [Realtime Modules](https://docs.commpeak.com/docs/realtime-modules.md): Learn about the modules available on the Realtime page that allow you to monitor agents' real-time activities, view call center statistics, and access key actions and metrics through customizable grid or table layouts. - [Realtime Customization](https://docs.commpeak.com/docs/realtime-customization.md): Customize the Realtime page for monitoring your call center activities. Learn to apply and clear filters, define settings like layout, alerts, and agent states, and switch to TV mode for a full-screen view. - [Realtime Dashboard Templates](https://docs.commpeak.com/docs/realtime-dashboard-templates.md): Create and customize real-time dashboard templates, configuring color and priority settings to highlight specific agent details during calls. - [Realtime Alerts](https://docs.commpeak.com/docs/realtime-alerts.md): Learn about the Alerts indicator on the Realtime page, which informs users about issues like low ASR rates, insufficient lead availability, and low voice or SMS balance, and offers steps to resolve these alerts. - [Listen, Whisper, and Barge](https://docs.commpeak.com/docs/dialer-listen-whisper-and-barge.md): This article explains how to use the Listen, Whisper, and Barge functions in CommPeak Dialer, allowing managers to monitor and interact with agent conversations. - [Agent's Guides](https://docs.commpeak.com/docs/agents-guides.md): Training guides for CommPeak Dialer agents covering the Agent Workspace, making calls, lead management, feedback, call transfers, calendar, call rating, and more. - [Agent's Guide: Getting Started](https://docs.commpeak.com/docs/agent-guide-getting-started.md): Learn the essentials of using the CommPeak Dialer, covering agent login setup, workspace navigation, and instructions for managing calls and contacts, along with helpful resources for further training. - [How to Switch to the Agent Workspace and What’s New](https://docs.commpeak.com/docs/quick-start-guide-to-the-new-agent-workspace-experience.md): This article explains how to switch to the new Agent Workspace and highlights the key improvements over the Legacy Agent Interface. - [Dialer Calling Options](https://docs.commpeak.com/docs/agent-guide-dialer-calling-options.md): Discover the calling options agents have in CommPeak Dialer to communicate with leads. - [Predictive Dialing](https://docs.commpeak.com/docs/agent-guide-predictive-dialing.md): This guide introduces predictive dialing in the Agent Workspace. - [Making Calls](https://docs.commpeak.com/docs/agent-guide-making-calls.md): This article walks you through the steps required to start receiving lead calls in CommPeak Dialer Agent Workspace. It also introduces the agent workspace, including the options and actions available during an active call in the Predictive Mode. - [Lead Details](https://docs.commpeak.com/docs/lead-details.md): This guide provides a comprehensive overview of how to manage lead data and view CRM integrations directly from your Agent Workspace during a live call. - [Call Transfers & Conferences](https://docs.commpeak.com/docs/agent-guide-transfers-and-conferences.md): This guide explains how to and use call transfer, conferencing, and call forwarding options in the CommPeak Dialer Agent Workspace including transferring to extensions, queues, or manually dialed numbers. - [Calendar](https://docs.commpeak.com/docs/working-with-calendar.md): Learn how to use the Calendar feature in the CommPeak Dialer Agent Workspace to view your scheduled appointments. - [Leaving Comments](https://docs.commpeak.com/docs/leaving-comments-messages.md): Log internal notes about lead interactions in the Comments section of the Agent Workspace, giving your team immediate context on past conversations and instructions. - [Submitting Feedback](https://docs.commpeak.com/docs/submitting-feedback.md): This guide explains how to manage post-call actions in the predictive mode, including submitting feedback, scheduling callbacks, redialing leads, and reviewing or editing lead details and interaction history within the agent workspace. - [Audio Messages, Beeps, and Pause Notifications ](https://docs.commpeak.com/docs/audio-messages-beeps-and-pause-notifications.md): This article explains how audio notifications work in predictive dialing, including agent whisper messages and beep signals. It outlines how each sound and message helps agents understand call progress, status changes, and pause conditions. - [How to Rate Calls](https://docs.commpeak.com/docs/agent-guide-call-rating.md): Learn about the call rating feature that enables you to easily give feedback about the call quality and report call issues. - [Secure Login Options](https://docs.commpeak.com/docs/secure-login-options.md): Learn about secure login options in our system, including external identity providers like Google and Microsoft OAuth or SSO, which eliminate the need for passwords. - [External Identity Providers Login Options](https://docs.commpeak.com/docs/login-through-external-identity-providers.md): Follow the detailed instructions for providing Microsoft or Google OAuth login options to your CommPeak Dialer or Cloud PBX users and for signing in with SSO SAML. - [Configuring Two-Factor Authentication (2FA)](https://docs.commpeak.com/docs/configuring-two-factor-authentication.md): Learn at which levels you can configure 2FA: for a user, for a role or the whole account. - [2FA Login Steps](https://docs.commpeak.com/docs/twofa-login-steps.md): Learn how to complete two-factor authentication steps via email or the Google Authenticator app. - [Special Login Conditions](https://docs.commpeak.com/docs/special-login-conditions.md): Learn when two-factor authentication (2FA) is required and when it can be bypassed. - [Alerts on Password Reset Requests](https://docs.commpeak.com/docs/alerts-on-password-reset-requests.md): Discover how password reset actions are performed by users or administrators and the email notifications generated for these events. - [Troubleshooting 2FA Login Issues](https://docs.commpeak.com/docs/troubleshooting-2fa-login-issues.md): Learn how to troubleshoot issues with two-factor authentication in user logins. - [Settings & Infrastructure](https://docs.commpeak.com/docs/dialer-settings.md): Learn about the various settings that control the CommPeak's Dialer's overall functionality. - [General Settings](https://docs.commpeak.com/docs/general-settings.md): Manage general settings, such as phone number masking, user session security, call page layout customization, and additional features like lead lookup and dropped call settings. - [Access Control Lists](https://docs.commpeak.com/docs/access-control-lists.md): Configure IP address, FQDN, and country-based access controls for your domain. Learn how to enable the feature, add entries, filter, and manage access for various types of connections. - [Default Timezones Management](https://docs.commpeak.com/docs/default-timezones-management.md): Set a default timezone for a country to standardize calling times across multiple timezones. - [CDR Dialing Pattern](https://docs.commpeak.com/docs/fix-cdr-dialing-pattern.md): Set dialing prefixes to be hidden in CDR reports, on the CommPeak Dialer Realtime page, and in webhooks. - [Fields Translations](https://docs.commpeak.com/docs/field-translations.md): Learn how to customize lead field names to better align with your preferences. - [Call Center Regions](https://docs.commpeak.com/docs/dialer-call-center-regions.md): Learn how to set up and manage multiple call center regions within your account to optimize connectivity and communication. This article covers key steps, including viewing available regions, checking network metrics, adding new regions, and assigning users to the best server locations. - [Recordings](https://docs.commpeak.com/docs/recordings.md): This guide covers step-by-step instructions for uploading files, generating recordings in multiple languages, and managing them in your settings. - [IP Addresses and Port Ranges for CommPeak Dialer](https://docs.commpeak.com/docs/ip-addresses-and-port-ranges-for-commpeak-dialer.md): Here, you will find IP addresses and port ranges for configuring CommPeak Dialer. - [Outbound Configurations](https://docs.commpeak.com/docs/outbound-configurations.md): This section overviews outbound configurations, including trunks management, auto dialing Caller IDs and manual dialing routes. - [Trunks](https://docs.commpeak.com/docs/trunks.md): Manage and configure SIP trunks for connecting the Dialer with external media servers. Learn how to create, test, and assign trunks to routing rules. - [Auto Dialing Caller IDs](https://docs.commpeak.com/docs/auto-dialing-caller-ids.md): Manage auto dialing Caller IDs for campaigns: add new Caller IDs, edit settings, block numbers, or download lists of Caller IDs. - [Manual Dialing Routes](https://docs.commpeak.com/docs/manual-dialing-routes.md): Learn how to manage manual dialing routes for PBX calls. - [Dialer Routes](https://docs.commpeak.com/docs/dialer-routes.md): Learn how to manage routing rules for trunks: create, modify, and delete routes, assign or unassign trunks, divide usage, simulate rules, and assign trunks to specific leads in campaigns. - [Inbound Configurations](https://docs.commpeak.com/docs/inbound-configurations.md): This section overviews inbound configurations, including IVR and queue management, text-to-speech recording generation and upload for your IVRs. - [IVR Flows](https://docs.commpeak.com/docs/ivr-flows.md): Learn how to configure and manage inbound call flows in your CommPeak Dialer using IVR queues and custom templates. - [IVR Elements](https://docs.commpeak.com/docs/guide-to-ivr-elements.md): Learn the essential rules for building error-free IVR flows. This guide ensures your IVR designs are logical, efficient, and aligned with system behavior. - [IVR Settings](https://docs.commpeak.com/docs/ivr-settings.md): Enter data for your new IVR configuration or modify settings in existing setups. - [IVR Canvas Builder](https://docs.commpeak.com/docs/ivr-canvas-builder.md): These controls allow users to design and configure the IVR system efficiently. - [Queues Management](https://docs.commpeak.com/docs/queues-management.md): Discover how to configure inbound calls to reach agents through a queue. - [Dialer Integrations](https://docs.commpeak.com/docs/integrations.md): Learn how to improve communication efficiency by simplifying the calling process within your existing CRM and business tools. - [CRM Integration vs Uploading Lead Files](https://docs.commpeak.com/docs/crm-integration-vs-uploading-lead-files.md): Learn about the two approaches to adding leads in CommPeak Dialer and consider the advantages of CRM interaction. - [Dispatch Leads Automation (Incoming Request Global Adapter)](https://docs.commpeak.com/docs/remote-adapter-incoming-request-global.md): The incoming request global adapter provides a smart API endpoint for programmatic lead injection into the Dialer system. - [Click2Call Integrations Overview](https://docs.commpeak.com/docs/clicktocall-integrations.md): Find out how to create and manage Click2Call integrations and implement them in your CRM for seamless one-click phone call functionality. - [Click2Call: Secure Leg-B Encryption Guide](https://docs.commpeak.com/docs/clicktocall-encrypt.md): Learn how to integrate secure Click2Call into your CRM. You will find out how to use AES-256 encryption to make safe calls without exposing destination data. - [FreshSales / FreshWorks Click2Call](https://docs.commpeak.com/docs/freshsales-clicktocall-dialer-pbx-integration.md): Learn about FreshSales / FreshWorks integration with CommPeak Click2Call: how to install the CommPeak app and make calls from your CRM. - [Salesforce Click2Call](https://docs.commpeak.com/docs/salesforce-clicktocall-dialerpbx-integration.md): Instructions for integrating your Salesforce CRM with CommPeak Click2Call, enabling seamless call functionality from within your CRM. - [Leverate Click2Call](https://docs.commpeak.com/docs/leverate-and-commpeak-dialer-clicktocall-integration.md): Step-by-step instructions for integrating your Leverate CRM with CommPeak Click2Call, enabling seamless call functionality from within your CRM. - [HubSpot Click2Call](https://docs.commpeak.com/docs/integrating-hubspot-and-commpeak-dialer-clicktocall.md): Integrate with HubSpot CRM and make calls directly from HubSpot and view call history within the CRM. - [Panda Click2Call](https://docs.commpeak.com/docs/panda-clicktocall.md): Step-by-step instructions for integrating your Panda CRM with CommPeak Click2Call, enabling seamless call functionality from within your CRM. - [EasyTech Click2Call](https://docs.commpeak.com/docs/easytech-clicktocall.md): Step-by-step instructions for integrating your EasyTech CRM with CommPeak Click2Call, enabling seamless call functionality from within your CRM. - [Proftit Click2Call](https://docs.commpeak.com/docs/proftit-clicktocall.md): Step-by-step instructions for integrating your Proftit CRM with CommPeak Click2Call, enabling seamless call functionality from within your CRM. - [Chameleon Click2Call](https://docs.commpeak.com/docs/chameleon-clicktocall.md): Step-by-step instructions for integrating your Chameleon CRM with CommPeak Click2Call, enabling seamless call functionality from within your CRM. - [Zoho CRM](https://docs.commpeak.com/docs/zoho-leads-integration.md): Learn how to integrate CommPeak Dialer with Zoho CRM: register your application with Zoho and complete the required steps in CommPeak Dialer. - [HubSpot CRM](https://docs.commpeak.com/docs/hubspot-crm.md): Learn how to integrate CommPeak Dialer with Hubspot CRM: register your application with Hubspot and complete the required steps in CommPeak Dialer. - [Bitrix CRM](https://docs.commpeak.com/docs/bitrix-crm.md): Learn how to integrate CommPeak Dialer with Bitrix CRM. - [Webhooks Management](https://docs.commpeak.com/docs/webhooks-management.md): Learn how to create, configure, and manage webhooks in CommPeak Dialer to send general or Click2Call CDR data to external parties with customizable triggers and authentication options. - [API Management](https://docs.commpeak.com/docs/api-management.md): This article outlines how to manage API users, access documentation, monitor API logs, and map lead statuses between a CRM and CommPeak Dialer. - [Messaging Channels](https://docs.commpeak.com/docs/messaging-channels.md): Learn about the Messaging Channels feature that allows you to manage all text-based communications. - [Creating Transactional Channels](https://docs.commpeak.com/docs/creating-transactional-channel.md): Learn how to create transactional channels from the CommPeak Dialer. - [Creating Two-Way SMS Channels](https://docs.commpeak.com/docs/creating-two-way-sms-channel.md): Learn how to create two-way SMS channels from the CommPeak Dialer. - [Creating WhatsApp Business Channels](https://docs.commpeak.com/docs/creating-whatsapp-business-channel.md): Learn how to create WhatsApp business channels from the CommPeak Dialer. - [Messaging Inbox](https://docs.commpeak.com/docs/dialer-messaging-inbox.md): Learn how to create, manage, and optimize SMS and WhatsApp conversations using Dialer's Messaging Inbox. - [Making Inbox Calls](https://docs.commpeak.com/docs/making-inbox-calls.md): Learn about the Inbox Calls feature that lets you handle inbound and outbound VoIP and WhatsApp calls directly from the CommPeak Dialer. - [Incoming Messages Alerts](https://docs.commpeak.com/docs/incoming-messages-alerts.md): Learn about the messages alerts flow in CommPeak Dialer. - [Troubleshooting Messaging Channels](https://docs.commpeak.com/docs/manage-channels-and-events.md): Information to help you identify, isolate, and resolve issues with Messaging channels. - [My Channel Was Disabled Automatically](https://docs.commpeak.com/docs/my-channel-was-disabled-automatically.md) - [My Event Was Disabled Automatically](https://docs.commpeak.com/docs/my-event-was-disabled-automatically.md) - [What Happens to Messages When My Channel or Event is Disabled?](https://docs.commpeak.com/docs/what-happens-to-messages-when-my-channel-or-event-is-disabled.md) - [Agents Can’t Modify the Event Message While Calling a Lead](https://docs.commpeak.com/docs/why-cant-an-agent-modify-the-event-message-while-calling-a-lead.md) - [My Agents Can't See the Option to Open the Messaging Inbox](https://docs.commpeak.com/docs/my-agents-cant-see-the-option-to-open-the-messaging-inbox.md) - [I Cannot Choose the Right Messaging Route](https://docs.commpeak.com/docs/i-cannot-choose-the-right-messaging-route.md) - [Speech Recognition Management](https://docs.commpeak.com/docs/speech-recognition-management.md): Check the step-by-step instructions for creating speech recognition channels in CommPeak Dialer and a list of callback parameters with explanations. - [Answering Machine Detection (AMD)](https://docs.commpeak.com/docs/voice-mail-detection.md): Learn about CommPeak's free Answering Machine Detection (AMD) feature that automatically identifies voicemails, reduces agent idle time, and minimizes the impact on drop rates. - [Reports & Analytics](https://docs.commpeak.com/docs/dialer-reports.md): Learn how to navigate through the reporting interface, understand the available data points, and customize reports to meet your specific informational needs. - [Predictive Realtime Stats](https://docs.commpeak.com/docs/predictive-realtime-stats.md): Track your call center or group operations in real time, access key statistics on agents and calls, and manage notifications directly from the Realtime Stats page for efficient oversight and decision-making. - [Agents Performance Report](https://docs.commpeak.com/docs/agents-performance-report.md): Analyze agent performance over a selected timeframe by gathering detailed data on calls, feedback, and system activity, use customizable filters, and save report templates for future use. - [Personal Dialer Performance](https://docs.commpeak.com/docs/personal-dialer-performance.md): Monitor the performance of agents operating in the PPQ mode with detailed insights into call activity, success rates, and agent efficiency over a selected timeframe, using customizable filters and export options for further analysis. - [Scheduled Calls by Agents](https://docs.commpeak.com/docs/scheduled-calls-by-agents.md): Learn how team managers and agents can view and manage assigned leads using campaign, lead, and time filtering options, edit callback times, make manual calls, add comments, and track lead history for more efficient lead management. - [Shift Performance Stats](https://docs.commpeak.com/docs/shift-performance-stats.md): Overview agent performance during a selected timeframe, including call totals and statuses. The report breaks down calls per agent, summarizes call activity, and categorizes call statuses, offering insights into key metrics such as call duration, average call duration, and success rates. - [Call Analytics](https://docs.commpeak.com/docs/call-analytics.md): Find out how to generate, customize, and schedule call analytics reports, apply filters, group data, save templates for recurring reports, which can be automatically emailed at specified intervals, and build a failed-calls report grouped by error code. - [Call Records List Report](https://docs.commpeak.com/docs/call-records-list-report.md): The Call Records List report provides detailed call data with options for filtering, sorting, downloading as CSV, and listening to call recordings directly from the platform. - [Search Text in Calls](https://docs.commpeak.com/docs/search-text-in-calls.md): The Search Text in Calls page allows users to locate relevant call insights efficiently using advanced speech-to-text search capabilities. - [Agents Clocked-In Stats](https://docs.commpeak.com/docs/agents-clocked-in-stats.md): Learn how to run the Agents Clocked-In Stats report, understand the output, and download it. - [External Reports](https://docs.commpeak.com/docs/external-reports.md): Find out how to access and use third-party analytics through interactive charts that provide key insights into call center operations, categorized by countries, affiliates, caller IDs, and agents. - [Messaging Logs](https://docs.commpeak.com/docs/messaging-logs.md): Monitor SMS and email messages sent to leads with the Messaging Logs report. Filter and view sent messages, manage undelivered ones, and export the report in CSV or Excel format. - [Network Stats](https://docs.commpeak.com/docs/network-stats.md): Monitor network performance across call center regions with detailed ping and jitter metrics. Learn how to use charts to track connectivity issues, ensure stable communication for agents, and save key reports for analysis. - [Additional Services](https://docs.commpeak.com/docs/overview-of-additional-services.md): Learn which additional features CommPeak offers apart from the default set - [SMS](https://docs.commpeak.com/docs/sms-and-email.md): Enable and manage SMS messaging feature in the Dialer, including setting up templates, viewing reports, and handling balance alerts. - [Call Transfers and Conferences](https://docs.commpeak.com/docs/call-transfers-and-conferences.md): Find out which call transfer options CommPeak Dialer offers and how to request these features from the support team. - [Speech to Text](https://docs.commpeak.com/docs/speech-to-text.md): This article explains how to add and configure CommPeak's Speech to Text service to transcribe agent's voice calls, access and search transcriptions, and manage settings through a support ticket. - [Interactive Features](https://docs.commpeak.com/docs/interactive-features.md): Enhance Dialer performance by enabling interactive features such as customized messages for dropped calls and voicemails, IVR setups, and agent queues for inbound calls. - [WhatsApp Calls](https://docs.commpeak.com/docs/whatsapp-calls.md): Learn about the WhatsApp Business Calling feature that lets you handle inbound and outbound WhatsApp calls directly from the CommPeak Dialer, using Meta’s official WhatsApp Business Cloud API. - [Troubleshooting](https://docs.commpeak.com/docs/troubleshooting-dialer.md): Troubleshooting CommPeak Dialer Issues - [No Agents on the Realtime Page](https://docs.commpeak.com/docs/no-agents-on-the-realtime-page.md): Learn how to troubleshoot when group managers can't see their agents on the Predictive Realtime Stats page. - [Agents' Actions Are Not Syncing to CRM](https://docs.commpeak.com/docs/agents-actions-are-not-syncing-with-a-crm.md): Discover how to resolve issues when agents' actions are not syncing to the CRM. - [Agents Are Waiting Too Long for a Call](https://docs.commpeak.com/docs/agents-are-waiting-too-long-for-a-call.md): Learn how to troubleshoot when agents experience long wait times for calls. - [Agent Calling Only Old or Personal Leads](https://docs.commpeak.com/docs/agent-calling-only-old-or-personal-leads-how-to-check-and-resolve-the-issue.md): Learn how to address issues with agents calling only old or personal leads. - [Dialer Call Quality Issues](https://docs.commpeak.com/docs/dialer-call-quality-issues.md): Learn how to troubleshoot CommPeak's Dialer call quality issues. - [Low Answer Seizure Ratio](https://docs.commpeak.com/docs/low-answer-seizure-ratio-reasons-and-solutions.md): Understand why the Answer-Seizure Ratio (ASR) may decrease with automated dialing and explore solutions. - [No Initial Ring for Agents](https://docs.commpeak.com/docs/no-initial-ring-for-agents.md): Resolve issues where agents fail to receive initial clock-in calls. - [Wrong Lead Called](https://docs.commpeak.com/docs/wrong-lead-was-called.md): Learn how to troubleshoot instances where the Dialer calls the wrong customer. - [Not Receiving Initial Softphone Calls for Dialer Predictive Mode](https://docs.commpeak.com/docs/not-receiving-an-initial-webrtc-call.md): Troubleshoot the issue when no initial calls can be received with the built-in Softphone for the Dialer Predictive mode. - [Microphone Volume Automatically Decreases: WebRTC Issue](https://docs.commpeak.com/docs/pc-microphone-volume-automatically-decreases-webrtc-issue.md): Resolve microphone volume issues in WebRTC-based Dialer applications and PBX clients using WebRTC. - [2FA Login Issues](https://docs.commpeak.com/docs/twofa-login-issues.md): Learn how to troubleshoot issues with two-factor authentication in user logins. - [Manual Call Is Not Showing in Realtime](https://docs.commpeak.com/docs/manual-call-is-not-showing-in-real-time.md): Resolve the issue with manual calls not showing in Realtime. - [I Cannot Listen to Phone Calls in Realtime](https://docs.commpeak.com/docs/i-cannot-i-listen-the-phone-calls-in-real-time-to-monitor-them.md): Learn how to troubleshoot the issue with not being able to listen to phone calls in the Realtime mode. - [Getting Started](https://docs.commpeak.com/docs/getting-started-with-textpeak.md): How to get started and make the most of the CommPeak TextPeak Platform - [Starting with TextPeak](https://docs.commpeak.com/docs/starting-with-textpeak.md): Steps to start sending bulk messages with the CommPeak TextPeak Platform. - [TextPeak Login & 2FA](https://docs.commpeak.com/docs/secure-login-options-and-two-factor-authentication-twofa-textpeak.md): Learn about the secure login options available to TextPeak users. This article describes the two-factor authentication (2FA) method and the scenario for bypassing 2FA. - [TextPeak Dashboard](https://docs.commpeak.com/docs/textpeak-dashboard.md): Get insights into your account performance with TextPeak Dashboard. Learn about key statistics, recent campaign activity, and domain management features to optimize your SMS campaigns. - [Realtime Performance](https://docs.commpeak.com/docs/real-time-performance.md): Get instant visibility into your SMS stream API and campaign performance with our real-time tracking features. Filter data by names, statuses, or tags, and access detailed statistics on delivery success, cost, and more. - [Support](https://docs.commpeak.com/docs/support.md): Troubleshoot issues or get assistance with your SMS platform using our comprehensive Help Center and live chat support options. Find popular articles, video guides, and ticketing system to resolve your concerns quickly. - [SMS Campaigns Management](https://docs.commpeak.com/docs/sms-campaigns-overview.md): Learn how to create, manage, and optimize your SMS campaigns using TextPeak's powerful features. Understand campaign statuses, stats, and settings, and discover how to pause, resume, or delete campaigns. - [Campaign Management Overview](https://docs.commpeak.com/docs/campaign-management.md): Get an overview of the TextPeak campaign management options. - [Creating Campaigns](https://docs.commpeak.com/docs/campaign-creation-step-by-step.md): This article will walk you through creating an SMS campaign step by step. - [Managing WhatsApp Campaigns](https://docs.commpeak.com/docs/managing-whatsapp-campaigns.md): Learn how to create, edit, and manage campaigns using WhatsApp Business streams. - [Message Templates](https://docs.commpeak.com/docs/message-templates.md): Learn how to create, edit, and manage message templates in TextPeak. Get tips on creating manual and automatic word groups, adding tags and URLs, and previewing your messages before saving them as a template. - [Managing WhatsApp Templates](https://docs.commpeak.com/docs/whatsapp-template-management.md): Learn how to create and manage WhatsApp Business message templates in TextPeak: compose marketing and utility templates with custom content and buttons, and set up authentication templates for one-time passwords. - [Word Groups](https://docs.commpeak.com/docs/word-groups.md): In this article, you will learn how to add word groups to your message template. - [Analytics & Insights](https://docs.commpeak.com/docs/analytics-and-insights.md): Get detailed insights into your SMS campaigns with TextPeak's analytics features. - [Streams API Management](https://docs.commpeak.com/docs/streams-api-overview.md): Explore how to use the power of Streams API in CommPeak to create customized messaging routes for marketing, transactional, OTP, two-way, Telegram bot, and WhatsApp interactions. - [Getting Started with Streams API](https://docs.commpeak.com/docs/getting-started-with-streams-api.md): Start creating your routes using CommPeak Streams. - [Creating Marketing Streams](https://docs.commpeak.com/docs/creating-marketing-streams.md): This article will walk you through creating a marketing SMS stream step by step. - [Creating Transactional Streams](https://docs.commpeak.com/docs/creating-transactional-streams.md): This article will walk you through creating a transactional SMS stream step by step. - [Transactional Stream Guidelines](https://docs.commpeak.com/docs/guidelines-for-using-the-transactional-stream-for-sms-messaging.md): Learn what content the transactional SMS stream allows, how it differs from marketing traffic, and which message patterns to avoid to prevent filtering. - [Creating OTP Streams](https://docs.commpeak.com/docs/creating-otp-streams.md): This article will walk you through creating an OTP SMS stream step by step. - [Creating Two-Way Streams](https://docs.commpeak.com/docs/creating-two-way-streams.md): This article will walk you through creating two-way SMS streams step by step. - [Creating WhatsApp Streams](https://docs.commpeak.com/docs/creating-whatsapp-streams.md): This article will walk you through creating a WhatsApp SMS stream step by step. - [Viewing WhatsApp Stream Details](https://docs.commpeak.com/docs/viewing-whatsapp-stream-details.md): Learn how you can review the details of the WhatsApp stream API you create. - [Creating a Token for WhatsApp Business](https://docs.commpeak.com/docs/creating-a-token-for-whatsapp-business.md): Learn how to get the WhatsApp account ID, and how to configure webhooks to be alerted about WhatsApp-related actions. - [Creating Telegram Bot Streams](https://docs.commpeak.com/docs/creating-telegram-bot-streams.md): This article will walk you through creating a Telegram Bot stream step by step. - [Creating Voice Streams](https://docs.commpeak.com/docs/creating-voice-streams.md): Set up a voice stream to deliver OTPs and other voice-based notifications over a dedicated SIP account. - [OTP Service](https://docs.commpeak.com/docs/otp-service.md): Define a single OTP endpoint that delivers one-time passwords across SMS, WhatsApp, and Voice with shared rate limits and a configurable failover chain. - [Creating OTP Configurations](https://docs.commpeak.com/docs/creating-otp-configurations.md): Learn how to create and manage OTP configurations in TextPeak, including channel setup, rate limits, failover order, and recording themes. - [Contacts](https://docs.commpeak.com/docs/contact-management.md): Learn how to manage your contacts before creating your first SMS campaign - [Getting Started with Contacts](https://docs.commpeak.com/docs/getting-started-with-contact-lists.md): Learn how to prepare your contacts by managing contact lists, segments, and fields before creating your first messaging campaign. - [Creating Contact Lists from CSV Files](https://docs.commpeak.com/docs/creating-contact-lists-from-csv-files.md): Learn how to create new contact lists by uploading multiple contacts from CSV files or integrations, and manage existing ones with detailed information and actions. - [Connecting Contacts from App Integrations](https://docs.commpeak.com/docs/connecting-contacts-from-app-integrations.md): This article demonstrates how to add contacts to the TextPeak platform from your integrated application using an example of HubSpot CRM. - [Segments](https://docs.commpeak.com/docs/segments.md): Learn how to create targeted contact segments based on filters such as location, behavior, or previous interactions, and use them in messaging campaigns. - [Individual Contacts](https://docs.commpeak.com/docs/individual-contacts.md): Manage individual contacts, add new ones, edit details, and apply filters to search for specific contacts. - [Contact Fields](https://docs.commpeak.com/docs/contact-fields.md): Set up custom contact fields, enable or disable standard details, and add additional fields to personalize your messaging campaigns. - [Sender IDs](https://docs.commpeak.com/docs/sender-ids.md): Add and manage <>s to appear as the sending identity when subscribers receive your SMS messages. - [SMS Sender IDs: Best Practices & Requirements](https://docs.commpeak.com/docs/best-practices-and-requirements-for-sms-sender-ids.md) - [Inbox](https://docs.commpeak.com/docs/inbox.md): Learn how to create, manage, and optimize SMS, WhatsApp, and Telegram conversations using TextPeak Inbox. - [Agent's Guide: Managing Conversations](https://docs.commpeak.com/docs/managing-conversations.md): A comprehensive agent's guide on how to view and manage Inbox conversations integrated with SMS, WhatsApp, and Telegram platforms. - [Making WhatsApp Business & VoIP Calls](https://docs.commpeak.com/docs/making-whatsapp-business-voip-calls.md): Learn about the Inbox Calls feature that lets you handle inbound and outbound VoIP and WhatsApp calls directly from the CommPeak Dialer. - [Manager's Guide: Inbox Settings](https://docs.commpeak.com/docs/inbox-settings.md): A comprehensive guide for managers on how to work with the settings that control TextPeak's Inbox functionality. - [Sender Profiles](https://docs.commpeak.com/docs/sender-profiles.md): A comprehensive guide for managers on how to create sender profiles and restrict their availability to specific Inbox teams or agents. - [Incoming Routing](https://docs.commpeak.com/docs/incoming-routing.md): A comprehensive guide for managers on how to create and manage Inbox incoming routing rules. - [Tag Management](https://docs.commpeak.com/docs/tag-management.md): A comprehensive guide for managers on how to create and manage Inbox conversation tags. - [Canned Templates](https://docs.commpeak.com/docs/canned-templates.md): A comprehensive guide for managers on how to create and manage the customized Inbox responses for most common customers' queries. - [Conversation Goals](https://docs.commpeak.com/docs/conversation-goals.md): A comprehensive guide for managers on how to create and manage the customized conversation goals in Inbox. - [Team Management](https://docs.commpeak.com/docs/team-management.md): A comprehensive guide for managers on how to manage Inbox teams, assign agents, and control which WhatsApp templates each team can use. - [User Management](https://docs.commpeak.com/docs/inbox-user-management.md): A comprehensive guide for managers on how to manage Inbox agents. - [Working Hours](https://docs.commpeak.com/docs/working-hours.md): Define the days, hours, and time zone your Inbox team is available so auto replies fire only outside those windows. - [Auto Replies](https://docs.commpeak.com/docs/auto-replies.md): Send automatic responses to inbound SMS and WhatsApp messages based on working hours, keywords, or quick-reply buttons. - [Inbox Statistics](https://docs.commpeak.com/docs/inbox-statistics.md): Learn how to access the TextPeak Inbox statistics. - [My Statistics](https://docs.commpeak.com/docs/my-statistics.md): Learn how to check the agent inbox statistics. - [Space Statistics](https://docs.commpeak.com/docs/space-statistics.md): Learn how to view and filter manager inbox statistics. - [Inbox Role Permissions](https://docs.commpeak.com/docs/inbox-role-permissions-1.md): Learn how to manage roles and permissions in the TextPeak Inbox tab. This guide covers default Inbox roles like Admin, Manager, and Agent and explains how to create and customize new roles for your team. - [Messages](https://docs.commpeak.com/docs/managing-your-messages.md): Learn how to view, filter, send new messages, and download them - [Managing Messages](https://docs.commpeak.com/docs/managing-messages.md): Learn how to manage SMS Campaign or Streams API messages. - [Outgoing Messages](https://docs.commpeak.com/docs/outgoing-messages.md): View, filter, and manage your outgoing campaign and stream API messages in one place, including tracking content, source, destination, message length and cost, date, and status. - [Incoming Messages](https://docs.commpeak.com/docs/incoming-messages.md): View, filter, and respond to incoming messages from subscribers in your inbound and outbound campaigns. - [Domains and URLs](https://docs.commpeak.com/docs/domains-overview.md): Set up custom domains, create domain pools, and use them in future campaigns to reduce spam identification, track click-through rates, and measure customer engagement. - [Domain Management](https://docs.commpeak.com/docs/domain-management.md): Add, configure, and manage custom domains for use in SMS campaigns, set global domain limits, and apply various actions to one or more domains. - [Domain Pools](https://docs.commpeak.com/docs/domain-pools.md): Manage domain pools, making it easy to use custom domains in SMS campaigns. - [URL Offers & Opt Out](https://docs.commpeak.com/docs/url-offers-opt-out.md): Add and configure URL offers, specifying original URLs and custom domains, adding parameters to track engagement, and setting expiry dates for deals. - [TextPeak Integrations](https://docs.commpeak.com/docs/textpeak-integrations.md): Learn how to automate your messaging workflows using TextPeak integrations. - [monday.com Integration](https://docs.commpeak.com/docs/monday-com-integration.md): This guide will walk you through automating your workflows in monday.com boards. - [Pipedrive Integration](https://docs.commpeak.com/docs/pipedrive-integration.md): This article explains how you can generate SMS messages in Pipedrive using CommPeak integrations. - [Intercom Integration](https://docs.commpeak.com/docs/intercom-integration.md): This article demonstrates how to send SMS messages right in the Intercom interface. - [Make Integration](https://docs.commpeak.com/docs/make-integration.md): This guide will walk you through creating your CommPeak integrations in Make. - [Setting Triggers in Make](https://docs.commpeak.com/docs/setting-triggers-in-make.md): Create triggers to send data to Make and set up further actions after customers respond to your SMS messages or click links. - [Zapier Integration](https://docs.commpeak.com/docs/zapier-integration.md): This guide will walk you through creating Messaging integrations with TextPeak in Zapier. - [Setting Triggers in Zapier](https://docs.commpeak.com/docs/setting-triggers-in-zapier.md): How to set automatic email sending in SendGrid after you receive an incoming message via TextPeak. - [Hubspot Integration](https://docs.commpeak.com/docs/hubspot-integration.md): This section provides information about how to define your CommPeak integrations in Hubspot. - [Integrating Hubspot and CommPeak SMS](https://docs.commpeak.com/docs/how-to-integrate-hubspot-and-commpeak-sms.md): This guide will walk you through integrating your HubSpot account with CommPeak SMS Service using CommPeak app. - [Installing a Connection Between Hubspot and CommPeak](https://docs.commpeak.com/docs/installing-a-connection-between-hubspot-and-commpeak.md): Create a connection with Hubspot from the marketplace or CommPeak SMS platform. - [Importing Contacts from Hubspot CRM to TextPeak](https://docs.commpeak.com/docs/importing-contacts-from-hubspot-crm-to-textpeak.md): Import your contacts from HubSpot as a list to CommPeak SMS platform (TextPeak) and create campaigns with them. - [Shopify Integration](https://docs.commpeak.com/docs/shopify-integration.md): This guide will walk you through automating your workflows in Shopify. - [Importing Contacts from Shopify to CommPeak SMS Platform](https://docs.commpeak.com/docs/importing-contacts-from-shopify-to-commpeak-sms-platform.md): Add your Shopify customer data to CommPeak SMS platform as a contact list and send campaigns to them. - [Zoho Integration](https://docs.commpeak.com/docs/zoho-integration.md): Learn how to integrate TextPeak Inbox with Zoho CRM: register your application with Zoho and complete the required steps in TextPeak. - [OpenAI Integration](https://docs.commpeak.com/docs/openai-integration.md): Learn how to integrate TextPeak Inbox with OpenAI and set it as a default AI service. - [Gemini Integration](https://docs.commpeak.com/docs/gemini-integration.md): Learn how to integrate TextPeak Inbox with Gemini and set it as a default AI service. - [Webhook Management](https://docs.commpeak.com/docs/webhook-management.md): Manage webhooks for short URL clicks, incoming, delivery, or EDR information messages - [Working with Webhooks](https://docs.commpeak.com/docs/working-with-webhooks.md): Steps to start working with webhooks in the CommPeak SMS platform. - [Request Logs](https://docs.commpeak.com/docs/request-log.md): View history and details of webhook requests. - [Users & Roles Management](https://docs.commpeak.com/docs/textpeak-users.md): Learn how to invite users and manage spaces and teams created under your TextPeak's account. - [Managing Spaces & Teams](https://docs.commpeak.com/docs/spaces-teams.md): Easily manage your TextPeak account spaces and teams to keep your business organized. - [Managing Users](https://docs.commpeak.com/docs/users-management-textpeak.md): Manage your users within your TextPeak account spaces and teams: assign, unassign, edit, or delete them; add filters, reset passwords, update settings or delete individual users, and apply mass actions. - [Role Permissions](https://docs.commpeak.com/docs/role-permissions.md): Manage your team users' roles and permissions. - [Inbox Role Permissions](https://docs.commpeak.com/docs/inbox-role-permissions.md): Learn how to manage roles and permissions in the TextPeak Inbox tab. This guide covers default Inbox roles like Admin, Manager, and Agent and explains how to create and customize new roles for your team. - [Settings & Infrastructure](https://docs.commpeak.com/docs/textpeak-settings.md): Learn about the various settings that control CommPeak's TextPeak overall functionality. - [My Profile](https://docs.commpeak.com/docs/my-profile.md): View or change your basic TextPeak profile settings and reset your password. - [Blocked Destinations](https://docs.commpeak.com/docs/blocked-destinations.md): Create a list of blocked numbers to prevent these numbers from receiving messages from TextPeak. - [Pricing](https://docs.commpeak.com/docs/pricing.md): Search and view your TextPeak account's outbound SMS rates for all destination countries. - [Sending Hours](https://docs.commpeak.com/docs/sending-hours.md): Search and check the allowed TextPeak sending hours for all destination countries. - [API Keys](https://docs.commpeak.com/docs/api-keys.md): Add API keys to use the TextPeak API. - [Tasks](https://docs.commpeak.com/docs/textpeak-tasks.md): View the status of the TextPeak task's processing. - [FAQs](https://docs.commpeak.com/docs/faq-textpeak.md): CommPeak TextPeak FAQs - [Can I Add SMS DID for Specific Country to Use With TextPeak Only?](https://docs.commpeak.com/docs/can-i-add-sms-did-for-country-to-use-with-textpeak-only.md) - [How Can I Get My DIDs Incoming Messages Into TextPeak?](https://docs.commpeak.com/docs/how-can-i-add-dids-for-textpeak-option-for-my-agents.md) - [Can I Manage Permissions for my Agents?](https://docs.commpeak.com/docs/how-can-i-manage-permissions-for-my-agents.md) - [Can I Integrate TextPeak With My CRM?](https://docs.commpeak.com/docs/can-i-connect-textpeak-api-services-to-my-crm.md) - [Can I Integrate WhatsApp/Telegram Instant Messaging Service?](https://docs.commpeak.com/docs/can-i-integrate-whatsapptelegram-instant-messaging-service.md) - [Can I Set Up Auto-Messaging With TextPeak on Classic PBX?](https://docs.commpeak.com/docs/classic-pbx-integration.md): Set up auto-messaging on the CommPeak Classic PBX using TextPeak. - [Troubleshooting](https://docs.commpeak.com/docs/troubleshooting-textpeak.md): Troubleshooting TextPeak Issues - [TextPeak 2FA Login Issues](https://docs.commpeak.com/docs/two-fa-login-issues-textpeak.md): Learn how to troubleshoot TextPeak two-factor authentication (2FA) login issues. - [Message Delivery Failures in TextPeak](https://docs.commpeak.com/docs/message-delivery-failures-in-textpeak.md): Learn how to troubleshoot the issues with specific SMS messages not reaching their intended recipients. - [Issues With 2-Way Messaging](https://docs.commpeak.com/docs/issues-with-two-way-messaging-in-textpeak.md): Learn how to troubleshoot the issues with 2-Way messaging. - [Integration Challenges Between TextPeak and CRM Systems](https://docs.commpeak.com/docs/integration-challenges-between-textpeak-and-crm-systems.md): Resolve issues with syncing contacts, sending messages, or tracking campaign performance through integrated CRM platforms. - [Delayed or Failed Message Scheduling in TextPeak](https://docs.commpeak.com/docs/delayed-or-failed-message-scheduling-in-textpeak.md): Learn how to troubleshoot the issues with scheduled messages sent at incorrect times or failing to send altogether. - [Difficulty Adding or Managing Contacts in TextPeak](https://docs.commpeak.com/docs/difficulty-adding-or-managing-contacts-in-textpeak.md): Learn how to troubleshoot the issues with adding or managing contacts in TextPeak. - [Not Receiving Inbound Messages in TextPeak](https://docs.commpeak.com/docs/not-receiving-inbound-messages-in-textpeak.md): Learn how to troubleshoot the issues with not receiving incoming messages when using TextPeak. - [Getting Started](https://docs.commpeak.com/docs/cloud-pbx-getting-started.md): How to get started and make the most of CommPeak Cloud PBX, a cloud-based private branch exchange (PBX) service. - [Navigation & Search](https://docs.commpeak.com/docs/navigation-and-search-pbx.md): Learn how to navigate your Cloud PBX instance and search for phone numbers or pages. - [Dashboard](https://docs.commpeak.com/docs/dashboard-pbx.md): This article overviews the manager and agent dashboards in CommPeak Cloud PBX and includes instructions on customizing and managing dashboard content. - [Getting Your Agents Started - Manager's Guide](https://docs.commpeak.com/docs/getting-your-agents-started-managers-guide-pbx.md): Learn how to set up agent users, manage their login process, reset passwords, and introduce them to their workflow and workspace. - [Getting Started - Agent's Guide](https://docs.commpeak.com/docs/getting-started-agents-guide-pbx.md): Learn the essentials of using the CommPeak Cloud PBX, covering login setup, workspace navigation, along with helpful resources for further training. - [User Profile](https://docs.commpeak.com/docs/user-profile-pbx.md): This page is a centralized hub for user-specific settings that enhance your Cloud PBX system personalization and streamline workflow efficiency. - [Admin Tools](https://docs.commpeak.com/docs/admin-tools-cloud-pbx.md): Know the Cloud PBX tools admins should be familiar with, including agents management, real-time statistics, and users management tools. - [Users Management](https://docs.commpeak.com/docs/user-management.md): Manage your users easily to control who has access to your Cloud PBX system and what they can do. - [Creating a Single User](https://docs.commpeak.com/docs/creating-a-single-user-pbx.md): Create a user account in your PBX system, set up user information, assign groups and roles, and configure extension and security settings. - [Mass User Creation](https://docs.commpeak.com/docs/mass-user-creation-pbx.md): Create multiple users in CommPeak Cloud PBX from a file: learn about the necessary file format, field mapping, and upload process. - [Managing Existing Users](https://docs.commpeak.com/docs/managing-existing-users-pbx.md): Manage user accounts in CommPeak Cloud PBX: apply filters, reset passwords, update settings or delete individual users, and apply mass actions. - [Active User Sessions](https://docs.commpeak.com/docs/active-user-sessions-pbx.md): View and manage active user sessions in CommPeak Cloud PBX, enable auto-refresh, and kick off users individually or in bulk. - [Desks](https://docs.commpeak.com/docs/desks-pbx.md): Learn how to create and edit desks, and add or remove users in CommPeak Cloud PBX. - [User Roles](https://docs.commpeak.com/docs/user-roles-pbx.md): Learn about role-based permissions in CommPeak Cloud PBX, including default roles and how to request new roles through support. - [Users Breaks](https://docs.commpeak.com/docs/users-breaks-pbx.md): Understand how user states function in CommPeak Cloud PBX, how to create new user breaks, and how agents can modify their state. - [Desk's Breaks](https://docs.commpeak.com/docs/desks-breaks-pbx.md): Understand how to set breaks per desk in CommPeak Cloud PBX, including how to apply a global default configuration or define specific custom settings. - [Realtime Management](https://docs.commpeak.com/docs/realtime-pbx.md): Learn how to work with the Realtime page in your Cloud PBX system. - [Realtime Stats](https://docs.commpeak.com/docs/new-realtime-stats-pbx.md): An overview of the Realtime Stats page, detailing how managers can monitor live call center operations, customize the live view, and access notifications about ongoing issues. - [Realtime Modules](https://docs.commpeak.com/docs/realtime-modules-pbx.md): Learn about the modules available on the Realtime page that allow you to monitor agents' real-time activities, view call center statistics, and access key actions and metrics through customizable grid or table layouts. - [Realtime Customization](https://docs.commpeak.com/docs/realtime-customization-pbx.md): Learn how to customize the Realtime page for monitoring your call center activities. Learn to apply and clear filters, define settings like layout, alerts, and agent states, and switch to TV mode for a full-screen view. - [Realtime Alerts](https://docs.commpeak.com/docs/realtime-alerts-pbx.md): Learn about the Alerts indicator on the Realtime page which informs users about issues like low balance, and other alerts and offers steps to resolve them. - [Agents Management](https://docs.commpeak.com/docs/agents-pbx.md): Check the resources essential for agents and their managers working with the CommPeak Cloud PBX. - [Call Rating](https://docs.commpeak.com/docs/call-rating-pbx.md): Learn about the call rating feature that enables you to easily give feedback about the call quality and report call issues. - [Registering in Third-Party Softphones](https://docs.commpeak.com/docs/registering-in-third-party-softphones-pbx.md): Set up your Cloud PBX account in MicroSIP or other third-party softphones. - [Secure Login Options](https://docs.commpeak.com/docs/secure-login-options-pbx.md): Learn about secure login options in our system, including external identity providers like Google and Microsoft OAuth or SSO, which eliminate the need for passwords. Alternatively, explore two-factor authentication (2FA) methods to enhance security, along with detailed instructions, special conditions, and troubleshooting tips. - [Login Through External Identity Providers](https://docs.commpeak.com/docs/login-through-external-identity-providers-pbx.md): Follow the detailed instructions for providing Microsoft or Google OAuth login options to your CommPeak Cloud PBX users and for signing in with SSO SAML. - [Configuring Two-Factor Authentication (2FA)](https://docs.commpeak.com/docs/configuring-two-factor-authentication-pbx.md): Learn at which levels you can configure 2FA: for a user, for a role or the whole account. - [2FA Login Steps](https://docs.commpeak.com/docs/twofa-login-steps-pbx.md): Learn how to complete two-factor authentication steps via email or the Google Authenticator app. - [Special Login Conditions](https://docs.commpeak.com/docs/special-login-conditions-pbx.md): Learn when two-factor authentication (2FA) is required and when it can be bypassed. - [Alerts on Password Reset Requests](https://docs.commpeak.com/docs/alerts-on-password-reset-requests-pbx.md): Discover how password reset actions are performed by users or administrators and the email notifications generated for these events. - [Troubleshooting 2FA Login Issues](https://docs.commpeak.com/docs/troubleshooting-2fa-login-issues-pbx.md): Learn how to troubleshoot issues with two-factor authentication in user logins. - [Settings & Infrastructure](https://docs.commpeak.com/docs/settings-pbx.md): Learn about the various settings that control CommPeak's Cloud PBX's overall functionality. - [General Settings](https://docs.commpeak.com/docs/general-settings-pbx.md): Manage general settings in your Cloud PBX, such as phone number masking, user session security, login configuration, and additional features like call rating. - [Access Control Lists](https://docs.commpeak.com/docs/access-control-lists-pbx.md): Configure IP address, FQDN, and country-based access controls for your Cloud PBX domain. Learn how to enable the feature, add entries, filter, and manage access for various types of connections. - [CDR Dialing Pattern](https://docs.commpeak.com/docs/fix-cdr-dialing-pattern-pbx.md): Set dialing prefixes to be hidden in CDR reports, on the Realtime page of your Cloud PBX, and in webhooks settings. - [Call Center Regions](https://docs.commpeak.com/docs/call-center-regions-pbx.md): Learn how to set up and manage multiple call center regions within your Cloud PBX account to optimize connectivity and communication. This article covers key steps, including viewing available regions, checking network metrics, adding new regions, and assigning users to the best server locations. - [Recordings](https://docs.commpeak.com/docs/recordings-pbx.md): This guide covers step-by-step instructions for uploading files, generating recordings in multiple languages, and managing them in your settings. - [Trunks](https://docs.commpeak.com/docs/trunks-pbx.md): Manage and configure SIP trunks for connecting the Cloud PBX with external media servers. Learn how to create, test, and assign trunks to routing rules. - [Manual Dialing Routes](https://docs.commpeak.com/docs/manual-dialing-routes-pbx.md): Learn how to manage manual dialing routes for PBX calls. - [Inbound Configurations](https://docs.commpeak.com/docs/inbound-configurations-pbx.md): This article overviews inbound configurations, including IVR and queue management, text-to-speech recording generation and upload for your IVRs. - [Designing IVR Flows](https://docs.commpeak.com/docs/designing-ivr-flows-pbx.md): Learn how to configure and manage inbound call flows in your Cloud PBX using IVR queues and custom templates. - [IVR Settings](https://docs.commpeak.com/docs/ivr-settings-pbx.md): Configure your IVR settings by entering new data for a fresh setup or updating parameters in existing configurations to control how incoming calls are routed. - [IVR Canvas Builder](https://docs.commpeak.com/docs/ivr-canvas-builder-pbx.md): Learn how to use IVR Flow controls to design and configure the IVR system efficiently. - [Guide to IVR Elements](https://docs.commpeak.com/docs/guide-to-ivr-elements-pbx.md): Learn the essential rules for building error-free IVR flows. This guide ensures your IVR designs are logical, efficient, and aligned with system behavior. - [Cloud PBX Integrations](https://docs.commpeak.com/docs/integrations-pbx.md): Learn how to automate your workflows using CommPeak Cloud PBX integrations. - [Click2Call Integrations Overview](https://docs.commpeak.com/docs/clicktocall-integrations-pbx.md): Find out how to create and manage Click2Call integrations in your Cloud PBX and implement them in your CRM for seamless one-click phone call functionality. - [FreshSales / FreshWorks Click2Call](https://docs.commpeak.com/docs/freshsales-clicktocall-integration-pbx.md): Learn about FreshSales / FreshWorks integration with CommPeak Click2Call: how to install the CommPeak app and make calls from your CRM. - [Salesforce Click2Call](https://docs.commpeak.com/docs/salesforce-clicktocall-pbx.md): Instructions for integrating your Salesforce CRM with CommPeak Click2Call, enabling seamless call functionality from within your CRM. - [Leverate Click2Call](https://docs.commpeak.com/docs/leverate-clicktocall-pbx.md): Step-by-step instructions for integrating your Leverate CRM with CommPeak Click2Call, enabling seamless call functionality from within your CRM. - [HubSpot Click2Call](https://docs.commpeak.com/docs/hubspot-pbx-clicktocall.md): Integrate with HubSpot CRM and make calls directly from HubSpot and view call history within the CRM. - [Panda Click2Call](https://docs.commpeak.com/docs/panda-clicktocall-pbx.md): Step-by-step instructions for integrating your Panda CRM with CommPeak Click2Call, enabling seamless call functionality from within your CRM. - [EasyTech Click2Call](https://docs.commpeak.com/docs/easytech-clicktocall-pbx.md): Step-by-step instructions for integrating your EasyTech CRM with CommPeak Click2Call, enabling seamless call functionality from within your CRM. - [Proftit Click2Call](https://docs.commpeak.com/docs/proftit-clicktocall-pbx.md): Step-by-step instructions for integrating your Proftit CRM with CommPeak Click2Call, enabling seamless call functionality from within your CRM. - [Chameleon Click2Call](https://docs.commpeak.com/docs/chameleon-clicktocall-pbx.md): Step-by-step instructions for integrating your Chameleon CRM with CommPeak Click2Call, enabling seamless call functionality from within your CRM. - [API Management](https://docs.commpeak.com/docs/api-management-pbx.md): This article outlines how to manage API users, access documentation and monitor API logs in your Cloud PBX. - [Speech Recognition Management](https://docs.commpeak.com/docs/speech-recognition-management-pbx.md): Check the step-by-step instructions for creating speech recognition channels in CommPeak Cloud PBX and a list of callback parameters with explanations. - [Messaging Channels (PBX)](https://docs.commpeak.com/docs/messaging-channels-pbx.md): Learn about the Messaging channels feature that allows you to manage all text-based communication. - [Creating Transactional Channels (PBX)](https://docs.commpeak.com/docs/creating-transactional-channel-pbx.md): This guide walks you through the steps to create transactional messaging channels within your Cloud PBX system. Learn how to configure routes for automated, one-way messages -ideal for sending alerts, confirmations, and other transactional notifications through supported messaging platforms. - [Creating Two-Way SMS Channels (PBX)](https://docs.commpeak.com/docs/creating-two-way-sms-channel-pbx.md): Learn how to set up two-way SMS channels in PBX Cloud to send and receive messages seamlessly from a single platform. - [Creating WhatsApp Business Channels (PBX)](https://docs.commpeak.com/docs/creating-whatsapp-business-channel-pbx.md): Follow this guide to set up WhatsApp Business channels in PBX Cloud. Learn how to generate a WhatsApp Business access token and connect your account to enable secure, real-time messaging through the platform. - [Messaging Inbox (PBX)](https://docs.commpeak.com/docs/messaging-inbox-pbx.md): Learn how to create, manage, and optimize SMS, WhatsApp, and Telegram conversations using PBX's Messaging Inbox. - [Reports & Analytics](https://docs.commpeak.com/docs/reports-pbx.md): Learn how to navigate through the CommPeak Cloud PBX reporting interface, understand the available data points, and customize reports to meet your specific informational needs - [Agents Performance Report](https://docs.commpeak.com/docs/agents-performance-report-pbx.md): Analyze agent performance over a selected timeframe by gathering detailed data on calls, feedback, and system activity, use customizable filters, and save report templates for future use. - [Call Records List Report](https://docs.commpeak.com/docs/call-records-list-report-pbx.md): The Call Records List report provides detailed call data with options for filtering, sorting, downloading as CSV, and listening to call recordings directly from the platform. - [Search Text in Calls](https://docs.commpeak.com/docs/search-text-in-calls-pbx.md): The Search Text in Calls page allows users to locate relevant call insights efficiently using advanced speech-to-text search capabilities. - [External Reports](https://docs.commpeak.com/docs/external-reports-pbx.md): Find out how to access and use third-party analytics through interactive charts that provide key insights into call center operations, categorized by countries, affiliates, caller IDs, and agents. - [Messaging Logs](https://docs.commpeak.com/docs/messaging-logs-pbx.md): Monitor SMS and email messages sent to customers with the Messaging Logs report. Filter and view sent messages, manage undelivered ones, and export the report in CSV or Excel format. - [Network Stats](https://docs.commpeak.com/docs/network-stats-pbx.md): Monitor network performance across call center regions with detailed ping and jitter metrics. Learn how to use charts to track connectivity issues, ensure stable communication for agents, and save key reports for analysis. - [Additional Services](https://docs.commpeak.com/docs/additional-services.md): Learn which additional features CommPeak offers apart from the default set - [WhatsApp Calls](https://docs.commpeak.com/docs/whatsapp-calls-pbx.md): Learn about the WhatsApp Business Calling feature that lets you handle inbound and outbound WhatsApp calls directly from the CommPeak Cloud PBX, using Meta’s official WhatsApp Business Cloud API. - [Answering Machine Detection (AMD)](https://docs.commpeak.com/docs/voice-mail-detection-pbx.md): Learn about CommPeak's free Answering Machine Detection (AMD) feature that automatically identifies voicemails, reduces agent idle time, and minimizes the impact on drop rates. - [FAQs](https://docs.commpeak.com/docs/faq-cloud-pbx.md): CommPeak Cloud PBX FAQs - [How Can I Edit My Agents' Names?](https://docs.commpeak.com/docs/how-can-i-edit-my-agents-names.md) - [How Can I Setup C2C After I Switch to a New CRM? Where Can I Find the Endpoints and Extensions?](https://docs.commpeak.com/docs/how-can-i-activate-ctoc-after-i-switch-to-a-new-crm-where-can-i-find-the-endpoints-and-extensions.md) - [How Can I Whitelist Specific IPs Under Click2Call ACL?](https://docs.commpeak.com/docs/how-can-i-whitelist-specific-ips-under-clicktocall-acl-faq.md) - [How Can I Configure a New PBX-Dialer Version and Delete the Old One?](https://docs.commpeak.com/docs/how-can-i-configure-a-new-pbx-dialer-version-and-delete-the-old-one.md) - [How Can VPN Affect VoIP Calls?](https://docs.commpeak.com/docs/how-can-vpn-affect-voip-calls-4.md) - [Troubleshooting](https://docs.commpeak.com/docs/troubleshooting-cloud-pbx.md): Troubleshooting CommPeak Cloud PBX Issues - [Microphone Volume Automatically Decreases: WebRTC Issue](https://docs.commpeak.com/docs/microphone-volume-automatically-decreases-webrtc-issue-pbx.md): Resolve microphone volume issues in WebRTC-based Dialer applications and PBX clients using WebRTC. - [Integration Challenges with CRM Systems](https://docs.commpeak.com/docs/integration-challenges-with-crm-systems.md): Learn how to troubleshoot the issues with integrating CommPeak Cloud PBX with Customer Relationship Management (CRM) systems. - [2FA Login Issues](https://docs.commpeak.com/docs/twofa-login-issues-pbx.md): Learn how to troubleshoot issues with two-factor authentication in user logins. - [I Cannot See Click2Call in my CRM](https://docs.commpeak.com/docs/why-cannot-i-see-the-clicktocall-in-my-crm.md): Learn how to troubleshoot the Click2Call Visibility Issues in CRMs. - [Getting Started](https://docs.commpeak.com/docs/classic-pbx-getting-started.md): How to get started and make the most of CommPeak Classic PBX, an intelligent, highly customizable, and feature-rich solution hosted on the user's premises - [Settings](https://docs.commpeak.com/docs/settings-classic-pbx.md): Learn about the various settings that control CommPeak's Classic PBX's overall functionality - [Viewing Network Statistics](https://docs.commpeak.com/docs/viewing-network-statistics.md): Monitor network latency for all your PBX extensions, including CommPeak Softphone, any other 3rd party softphones or IP phones. - [Configuring Outbound Caller IDs](https://docs.commpeak.com/docs/configuring-outbound-caller-ids.md): Learn how to add, modify, and manage verified caller IDs for outbound calls, with tips on firewall settings and dial pattern configuration. - [Adding Devices and Users](https://docs.commpeak.com/docs/adding-devices-and-users.md): Learn how to register devices and add users, or agents, with unique extensions and passwords, to manage calls in your CommPeak system. - [Transferring Calls in PBX](https://docs.commpeak.com/docs/how-to-transfer-calls-in-pbx.md): Learn how to perform blind and attended call transfers, including differences between the two types and step-by-step examples. - [Blacklisting an Incoming Number](https://docs.commpeak.com/docs/how-to-blacklist-an-incoming-number.md): Learn how to block unwanted calls by blacklisting numbers, specifying custom destinations, and setting actions for blocked calls using the Blacklist Module in your CommPeak PBX. - [PBX IP ACL Settings](https://docs.commpeak.com/docs/pbx-ip-acl-settings-classic.md): Allow specific IP addresses to access your PBX system by setting whitelisted IP addresses in Web ACL, SIP ACL, or Click2Call ACL. You can also use Dynamic DNS (DDNS) for dynamic IP addresses and Geo ACL for country-based whitelisting. - [Configuring Incoming Call Flow](https://docs.commpeak.com/docs/configuring-incoming-call-flow.md): Learn how to configure the incoming call flows for the CommPeak Classic PBX. - [Configuring Inbound Call Routes in PBX](https://docs.commpeak.com/docs/configuring-inbound-call-routes-in-pbx.md): Configure inbound call routes in CommPeak Classic PBX, including setting up routing rules, destinations, and call recordings. - [Creating a Queue in PBX](https://docs.commpeak.com/docs/creating-a-queue-in-pbx.md): Create and configure call queues in CommPeak Classic PBX, including setting up queue settings, ring strategies, and failover destinations. - [Configuring IVRs](https://docs.commpeak.com/docs/configuring-ivrs.md): Create an Interactive Voice Response (IVR) and assign it to an incoming call flow in Classic PBX. - [Configuring Announcements](https://docs.commpeak.com/docs/configuring-announcements.md): Check step-by-step instructions on how to upload audio files, configure announcement settings, and assign the announcement to various call flow elements. - [Adding Time Groups and Time Conditions](https://docs.commpeak.com/docs/adding-time-groups-and-time-conditions.md): This guide describes steps to add time groups and time conditions in your Classic PBX. - [Why You Need Call Forwarding to Voicemail](https://docs.commpeak.com/docs/why-you-need-call-forwarding-to-voicemail.md): Find out what steps are required to complete the PBX setup and enable recorded voice messages to be sent to voicemail. - [Click2Call](https://docs.commpeak.com/docs/clicktocall.md): Know the parameters required for Click2Call requests, including CRM vendor ID, client ID, agent ID, lead's phone number, and PBX outbound calls prefix. Find out how to set up Click2Call by obtaining a unique Click2Call URL from CommPeak, whitelisting IP addresses, and installing the Chrome extension (for non-CRM users). - [Getting Started with Click2Call](https://docs.commpeak.com/docs/clicktocall-getting-started.md): Getting started with CommPeak Click2Call - [Click2Call Information for CRM Developers](https://docs.commpeak.com/docs/clicktocall-information-for-crm-developers.md): Integrate Click2Call with your CRM software, including the required fields and parameters for a successful API GET request. Discover how to add custom data to the request and configure it to display in CDRs. - [PBX Stats](https://docs.commpeak.com/docs/pbx-stats.md): Learn what PBX Stats is and how to use it. - [Getting Started](https://docs.commpeak.com/docs/pbx-stats-getting-started.md): How to get started and make the most of PBX Stats system - [PBX Stats Overview: Video Guide](https://docs.commpeak.com/docs/pbx-stats-overview-video-guide.md): Are you new to PBX Stats? This video guide will give you an overview of the system, explaining its essential features. - [Manager Login](https://docs.commpeak.com/docs/manager-login.md): Log in securely to PBX Stats as a manager user, including setting up two-factor authentication using email codes, the Google Authenticator app, or backup codes. - [Dashboard](https://docs.commpeak.com/docs/pbx-stats-dashboard.md): Get familiar with the PBX Stats dashboard, your account's homepage, which provides a summary of key statistics such as call volumes, durations, and agent performance, along with interactive graphs and charts. - [Logging In to CommPeak Softphone](https://docs.commpeak.com/docs/logging-in-to-commpeak-softphone.md): Check the guidelines about initial steps with standalone and built-in CommPeak Softphones. - [Configuring a Device and Logging in to Zoiper Softphone](https://docs.commpeak.com/docs/configuring-a-device-and-logging-in-to-zoiper-softphone.md): Step-by-step guide to registering in Zoiper softphone - [Configuring a Device and Logging in to MicroSIP Softphone](https://docs.commpeak.com/docs/configuring-a-device-and-logging-in-to-microsip-softphone.md): Step-by-step guide to registering in MicroSIP softphone - [Configuring IP Phones](https://docs.commpeak.com/docs/configuring-ip-phones.md): This article demonstrates how physical IP phones can be configured for CommPeak VoIP services using PBX Stats credentials. It provides setting examples for Yealink, Grandstream, and Fanvil IP phones. - [IP-Based Access Control](https://docs.commpeak.com/docs/ip-based-access-control.md): Learn how to protect your PBX Stats account by whitelisting authorized IP addresses, setting up web access control lists (ACL) in the CommPeak Portal. - [Configuring PBX Stats](https://docs.commpeak.com/docs/configuring-pbx-stats.md): Learn how to configure PBX Stats. - [Desks](https://docs.commpeak.com/docs/desks.md): Organize agents into virtual groups called "desks", which are essential for displaying agent information on the Realtime page in PBX Stats, and configure desk settings by renaming, assigning queues, and managing agent lists. - [Agents](https://docs.commpeak.com/docs/agents.md): Manage agents in PBX Stats by adding single or bulk agents, editing login and name details, resetting passwords, and deleting agents, all while maintaining permissions and security controls. - [Devices](https://docs.commpeak.com/docs/devices.md): Manage devices in PBX Stats by adding single or bulk devices, editing login and Caller ID details, resetting passwords, and deleting devices. - [Pause Types](https://docs.commpeak.com/docs/pause-types.md): Configure pause types in PBX Stats by creating custom statuses for agents and managers to indicate unavailability, with options for work-related or personal reasons. - [Scheduled Reports](https://docs.commpeak.com/docs/scheduled-reports.md): This page shows the reports scheduled to run recurrently and allows you to create a new scheduled report based on an existing template. - [Users](https://docs.commpeak.com/docs/users.md): Manage users in PBX Stats by creating new accounts, editing existing ones, and deleting unnecessary ones. Assign users roles and desks, enable or disable their accounts, and configure two-factor authentication (2FA) for added security. - [Roles & Permissions](https://docs.commpeak.com/docs/roles-and-permissions.md): Learn how to manage roles in PBX Stats: create, modify, or enable permissions. - [Webhooks](https://docs.commpeak.com/docs/webhooks.md): Create custom or predefined webhooks and define custom parameters. - [Admin Page](https://docs.commpeak.com/docs/admin-page.md): The users with admin permissions can create various parameters on the Admin page from available templates and edit or delete existing parameters.. - [Live Sessions](https://docs.commpeak.com/docs/live-sessions.md): View the list of active users in your CommPeak Cloud PBX Stats, control users’ activity and disconnect unwanted users as a security measure. - [Activity Logs](https://docs.commpeak.com/docs/activity-logs.md): Generate reports of all actions taken by users within a selected timeframe and of the Listen, Whisper, and Barge actions in particular. - [Phone Number Masking](https://docs.commpeak.com/docs/phone-masking.md): Learn how to mask phone numbers in PBX Stats using admin parameters or user roles, controlling which digits are hidden on CDRs and Realtime pages. - [Getting PBX Stats API Keys and Documentation](https://docs.commpeak.com/docs/getting-pbx-stats-api-keys-and-documentation.md): Generate and manage API keys in PBX Stats for secure data access. Easily create, view, and delete API keys through your profile. - [Working with PBX Stats](https://docs.commpeak.com/docs/working-with-pbx-stats.md): Learn how to work with PBX Stats. - [Stats by Queue](https://docs.commpeak.com/docs/stats-by-queue.md): Generate and customize queue reports in PBX Stats. View detailed statistics on call types, agent performance, and SLAs, with options to filter, save, and schedule reports. - [Queue Manager](https://docs.commpeak.com/docs/queue-manager.md): Manage incoming calls in PBX Stats with the Queue Manager. Assign agents to queues, pause calls, or listen in using whisper mode. - [Stats by Agent](https://docs.commpeak.com/docs/stats-by-agent.md): Generate detailed agent performance reports in PBX Stats. Track call statistics, pause times, and more with customizable filters and multi-agent reports. - [Tasks](https://docs.commpeak.com/docs/tasks.md): Save and download reports from the Stats by Agent and CDRs pages in PBX Stats. View report progress and download completed tasks in various formats. - [Realtime Monitoring](https://docs.commpeak.com/docs/realtime-monitoring.md): Monitor your agents in real-time on the Realtime page of PBX Stats. Access detailed agent data, customize views with filters and sorting options, and manage calls directly. - [Listen, Whisper, Barge, Split Recording](https://docs.commpeak.com/docs/realtime-actions-listen-whisper-barge-split-recording.md): This article outlines the available actions for managing live calls in PBX Stats, including Listen, Whisper, and Barge modes, and explains how to utilize split call recording. - [Listen, Whisper and Barge from Softphone](https://docs.commpeak.com/docs/listen-whisper-and-barge-from-softphone.md): How to use the Listen, Whisper, and Barge options directly from any softphone application, including CommPeak Softphone - [Creating Report Templates](https://docs.commpeak.com/docs/creating-report-templates.md): Create and save report templates with predefined filters to streamline future report generation and scheduling. - [CDRs](https://docs.commpeak.com/docs/cdrs.md): The CDRs (Call Data Records) page of the CommPeak PBX Stats platform provides a detailed overview of each call's information, including metrics like caller, destination, duration, and cost, along with summary statistics based on applied filters. - [Managing Agents](https://docs.commpeak.com/docs/agent-s-workspace-overview.md): Learn how to use the Agent's Workspace where you can make and receive clients' calls, check out your call statistics, and report your breaks. - [Configuring a Device and Logging In to MicroSIP Softphone](https://docs.commpeak.com/docs/configuring-a-device-and-logging-in-to-microsip-softphone-1.md): Step-by-step guide to registering in MicroSIP softphone - [Configuring a Device and Logging In to Zoiper Softphone](https://docs.commpeak.com/docs/configuring-a-device-and-logging-in-to-zoiper-softphone-1.md): Step-by-step guide to registering in Zoiper softphone - [Post-Answer Playback](https://docs.commpeak.com/docs/post-answer-playback.md): Learn how to upload an announcement recording to Classic PBX and assign it to an outbound route so called parties hear a disclosure before the call connects. - [Troubleshooting](https://docs.commpeak.com/docs/troubleshooting-post-answer-playback.md): Troubleshooting Post-Answer Playback Issues - [No Audio on Test Call](https://docs.commpeak.com/docs/i-made-a-test-call-and-heard-nothing.md): Find out why your Post-Answer Playback test call completed but played no announcement, and how to fix it. - [Call Ends Immediately After the Other Side Picks Up](https://docs.commpeak.com/docs/the-call-was-ended-immediately-after-the-other-side-picked-up.md): Find out why Post-Answer Playback ends a call the moment the other side picks up, and how to restore the recording so calls connect normally. - [Only One Side Hears the Announcement](https://docs.commpeak.com/docs/only-one-side-hears-the-announcement.md): Find out why only one call party hears the Post-Answer Playback announcement and how to fix it. - [Recording Drop-Down Not Visible After Selecting Yes](https://docs.commpeak.com/docs/i-cant-see-the-recording-drop-down-after-selecting-yes.md): Find out why the recording drop-down does not appear after setting Enable post-answer playback to Yes, and how to fix it. - [FAQs](https://docs.commpeak.com/docs/faq-classic-pbx.md): CommPeak Classic PBX FAQs - [How Should I Set Up a VoIP Network With Dual ISPs?](https://docs.commpeak.com/docs/how-should-i-set-up-a-voip-network-with-dual-isps-pbx.md) - [Do I Need to Configure My Home Firewall for VoIP?](https://docs.commpeak.com/docs/do-i-need-to-configure-my-home-firewall-for-voip-pbx.md) - [What PBX VoIP Network Firewall Settings Are Needed for Business Networks?](https://docs.commpeak.com/docs/what-firewall-settings-are-needed-for-business-networks-pbx.md) - [Do You Support Any SIP TLS SRTP Encryption Methods?](https://docs.commpeak.com/docs/do-you-support-any-sip-tls-srtp-encryption-methods-pbx.md) - [How Can I Whitelist Specific IPs Under Click2Call ACL?](https://docs.commpeak.com/docs/how-can-i-whitelist-specific-ips-under-clicktocall-acl.md) - [Can I Add a Second Queue to an Inbound Number?](https://docs.commpeak.com/docs/can-i-add-the-second-queue-to-an-inbound-number.md) - [How to Create Outbound/Inbound Configuration in My PBX?](https://docs.commpeak.com/docs/how-to-create-outboundinbound-configuration-in-my-pbx.md) - [How Can I Setup C2C After I Switch to a New CRM?](https://docs.commpeak.com/docs/how-can-i-setup-c2c-after-i-switch-to-a-new-crm.md) - [How Can I Monitor the PBX Extension Latency?](https://docs.commpeak.com/docs/how-can-i-monitor-the-pbx-extension-latency.md) - [How Can VPN Affect VoIP Calls?](https://docs.commpeak.com/docs/how-can-vpn-affect-voip-calls-3.md) - [Can I Set Up Auto-Messaging on the Classic PBX Using TextPeak?](https://docs.commpeak.com/docs/can-i-set-up-auto-messaging-on-the-classic-pbx-using-textpeak.md) - [Troubleshooting](https://docs.commpeak.com/docs/troubleshooting-pbx-stats.md): Troubleshooting CommPeak Classic PBX Issues - [PBX Call Quality Issues](https://docs.commpeak.com/docs/pbx-call-quality-issues.md): Learn how to troubleshoot CommPeak's PBX call quality issues. - [Access to PBX Stats Denied](https://docs.commpeak.com/docs/why-can-t-i-access-pbx-stats.md): Learn how to troubleshoot PBX Stats access issues. - [2FA Login Issues](https://docs.commpeak.com/docs/twofa-issues.md): Learn how to troubleshoot issues with two-factor authentication in user logins. - [When I Click the Click2Call Link, it Says the Webpage is Unavailable and Does Not Initiate a Call](https://docs.commpeak.com/docs/when-i-click-the-click2call-link-it-says-the-webpage-is-unavailable-and-does-not-initiate-a-call.md): Learn how to troubleshoot the situation when your click on the Click2Call hyperlink does not initiate a phone call. - [Not Receiving an Incoming Call When Using Listen or Whisper](https://docs.commpeak.com/docs/why-don-t-i-receive-an-incoming-call-when-using-listen-or-whisper.md): Learn how to troubleshoot the issues with not receiving an incoming call when using Listen or Whisper modes. - [Getting Started](https://docs.commpeak.com/docs/softphone-getting-started.md): How to get started and make the most of CommPeak Softphone, a WebRTC-based application designed to work with any CommPeak product - [CommPeak Softphone Options](https://docs.commpeak.com/docs/getting-started-with-commpeak-softphone.md): Check out the guidelines about initial steps with different Softphone options offered by CommPeak. - [Standalone CommPeak Softphone](https://docs.commpeak.com/docs/standalone-commpeak-softphone.md): Learn about installation and the options to log in to standalone CommPeak Softphone. - [Built-in CommPeak Softphone](https://docs.commpeak.com/docs/built-in-commpeak-softphone.md): Learn how to get started with the built-in CommPeak Softphone and its features across different platforms. - [Web-Based Softphone Widget](https://docs.commpeak.com/docs/web-based-softphone-widget.md): Step-by-step guide on how to access and start using CommPeak Softphone on the web or on your mobile device. - [Built-in Softphone for JWT-Enabled SIP Accounts](https://docs.commpeak.com/docs/built-in-for-jwt-enabled-sip-accounts.md): Use the built-in CommPeak Softphone with your JWT-enabled SIP account to place calls right from your browser. - [How SSO Login Works in Softphone](https://docs.commpeak.com/docs/softphone-sso-login-flow.md): Discover how the Softphone app streamlines secure authentication with Single Sign-On (SSO) support for Google, Microsoft, and SAML. - [Login with 2FA Support](https://docs.commpeak.com/docs/login-with-2fa-support.md): Learn how Softphone app streamlines secure authentication with 2FA support. - [Operating Standalone CommPeak Softphone](https://docs.commpeak.com/docs/using-commpeak-softphone.md): Learn how to use the standalone CommPeak Softphone. - [System Requirements](https://docs.commpeak.com/docs/system-requirements.md): Standalone CommPeak Softphone System Requirements - [Interface Description](https://docs.commpeak.com/docs/commpeak-softphone-interface-description.md): Introduction to the CommPeak Softphone interface in full and mini modes - [Making Calls](https://docs.commpeak.com/docs/making-calls.md): Detailed instructions for making and receiving calls in both full and mini modes of the standalone CommPeak Softphone - [Active Call Functions](https://docs.commpeak.com/docs/call-functions.md): Detailed instructions for managing active calls in both full and mini modes of the standalone CommPeak Softphone, including features like call transfer, muting, holding, conferencing, volume control, and network and audio status indicators. - [Call History](https://docs.commpeak.com/docs/call-history.md): Find out how to view, filter, and manage recent call history in the standalone CommPeak Softphone, including call details and re-dial options, in both full and mini modes. - [Listen, Whisper, & Barge](https://docs.commpeak.com/docs/listen-whisper-and-barge.md): This article explains how to use the Listen, Whisper, and Barge functions in CommPeak standalone Softphone, allowing managers to monitor and interact with agent conversations. - [Available & DND Statuses](https://docs.commpeak.com/docs/available-and-dnd-statuses.md): Here, you will find an explanation how to switch between Available and Do Not Disturb (DND) statuses in the full and mini modes of the standalone CommPeak Softphone and how each status affects call functionality. - [Rating Calls](https://docs.commpeak.com/docs/rating-calls-on-your-softphone.md): Report call issues and rate connection quality both during and after a conversation in full and mini modes of the standalone CommPeak Softphone. - [Softphone Errors Explained](https://docs.commpeak.com/docs/softphone-errors-explained.md): A list of errors you can see in CommPeak standalone Softphone with explanations - [Changing Settings](https://docs.commpeak.com/docs/changing-settings.md): Access CommPeak standalone Softphone's settings to test sound quality, set a ringtone, add SIP accounts, and perform other configurations. - [General Settings](https://docs.commpeak.com/docs/settings.md): Configure SIP account usage, the auto-answering feature, DTMF types and network options for operating the standalone version of CommPeak Softphone. - [Audio Settings](https://docs.commpeak.com/docs/audio-settings.md): In this section, you can change the settings of your input and output sound, adjust your ringtones, and set the application language in the standalone CommPeak Softphone. - [Help & Support](https://docs.commpeak.com/docs/help-and-support.md): This section of the standalone CommPeak Softphone provides details about the application and its recent updates, your technical data, and directs you to the CommPeak Help Center and product legal information. - [Operating Built-In CommPeak Softphone](https://docs.commpeak.com/docs/using-built-in-softphone.md): Learn how to use the built-in CommPeak Softphone. - [Making Calls](https://docs.commpeak.com/docs/builtin-making-calls.md): Detailed instructions for making and receiving calls in the built-in Softphone version - [Active Call Functions](https://docs.commpeak.com/docs/builtin-active-call-functions.md): Detailed instructions for managing active calls in both full and mini modes of the CommPeak's built-in Softphone version, including features like call transfer, muting, holding, conferencing, and volume control - [Call History](https://docs.commpeak.com/docs/builtin-call-history.md): Find out how to view, filter, and manage recent call history, including call details and re-dial options using the CommPeak's built-in Softphone version. - [Phonebook](https://docs.commpeak.com/docs/phonebook.md): Create an alphabetical list of your contacts when using the standalone Softphone in CommPeak Dialer or Cloud PBX and quickly locate the one you need. - [Listen, Whisper, & Barge](https://docs.commpeak.com/docs/builtin-listen-whisper-and-barge-from-commpeak-softphone.md): This article explains how to use the Listen, Whisper, and Barge functions in the built-in CommPeak Softphone, allowing managers to monitor and interact with agent conversations. - [Available & DND Statuses](https://docs.commpeak.com/docs/builtin-available-and-dnd-statuses.md): Here, you will find an explanation how to switch between Available and Do Not Disturb (DND) statuses of the CommPeak's built-in Softphone version and how each status affects call functionality. - [Rating Calls](https://docs.commpeak.com/docs/builtin-rating-calls.md): Report call issues and rate connection quality both during and after a conversation in the CommPeak's built-in Softphone version. - [Softphone Errors Explained](https://docs.commpeak.com/docs/softphone-errors-explained-1.md): A list of errors you can see in CommPeak built-in Softphone with explanations - [Changing Settings](https://docs.commpeak.com/docs/builtin-changing-settings.md): Access the built-in Softphone's settings to test sound quality, set ringtone, and perform other configurations - [General Settings](https://docs.commpeak.com/docs/builtin-general-settings.md): Configure the auto-answering feature and DTMF types in the CommPeak's built-in Softphone. - [Audio Settings](https://docs.commpeak.com/docs/builtin-audio.md): In this section of the CommPeak's built-in Softphone version, you can change the settings of your input and output sound, adjust your ringtones, and set the application language. - [Help & Support](https://docs.commpeak.com/docs/builtin-help-and-support.md): This section of the CommPeak's built-in Softphone version allows to test sound quality, provides details about your technical data, and directs you to the CommPeak Help Center. - [Operating Web-Based Softphone Widget](https://docs.commpeak.com/docs/operating-web-based-softphone-widget.md): Learn how to use the web-based CommPeak Softphone widget. - [Making Calls](https://docs.commpeak.com/docs/web-based-making-calls.md): Detailed instructions for making and receiving calls in the web-based Softphone widget - [Softphone Chrome Application](https://docs.commpeak.com/docs/softphone-browser-installation-bookmarks.md): Learn how to launch the CommPeak Web-based Softphone directly from Chrome for quick access. - [Active Call Functions](https://docs.commpeak.com/docs/web-based-active-call-functions.md): Detailed instructions for managing active calls in the web-based Softphone widget, including features like call transfer, muting, holding, conferencing, and volume control - [Call History](https://docs.commpeak.com/docs/web-based-call-history.md): Find out how to view, filter, and manage recent call history in the web-based Softphone version, including call details and re-dial options. - [Listen, Whisper, & Barge](https://docs.commpeak.com/docs/web-based-listen-whisper-barge.md): This article explains how to use the Listen, Whisper, and Barge functions in the web-based CommPeak Softphone, allowing managers to monitor and interact with agent conversations. - [Available & DND Statuses](https://docs.commpeak.com/docs/web-based-available-and-dnd-statuses.md): Here, you will find an explanation how to switch between Available and Do Not Disturb (DND) statuses in the web-based Softphone and how each status affects call functionality. - [Softphone Errors Explained](https://docs.commpeak.com/docs/web-based-softphone-errors-explained.md): A list of errors you can see in CommPeak web-based Softphone with explanations - [Changing Settings](https://docs.commpeak.com/docs/web-based-changing-settings.md): Access CommPeak web-based Softphone's settings to test sound quality, set a ringtone, add SIP accounts, and perform other configurations. - [General Settings](https://docs.commpeak.com/docs/web-based-general-settings.md): Configure the auto-answering feature, DTMF types and network options for operating web-based Softphone. - [Audio Settings](https://docs.commpeak.com/docs/web-based-audio.md): In this section, you can change the settings of your Softphone widget's input and output sound, adjust your ringtones, and set the application language. - [Help & Support](https://docs.commpeak.com/docs/web-based-help-and-support.md): This section provides details about the application and its recent updates, your technical data, and directs you to the CommPeak Help Center and product legal information. - [Operating Built-In Softphone for SIP Accounts](https://docs.commpeak.com/docs/operating-built-in-softphone-for-jwt.md): Learn how to use the built-in CommPeak Softphone application with your JWT-enabled SIP account. - [Making Calls](https://docs.commpeak.com/docs/softphone-for-jwt-making-calls.md): Detailed instructions for making and receiving calls in the CommPeak built-in Softphone when started from your JWT-enabled SIP account - [Active Call Functions](https://docs.commpeak.com/docs/softphone-for-jwt-active-call-functions.md): Detailed instructions for managing active calls in the Softphone widget when started from your JWT-enabled SIP account, including features like call transfer, muting, holding, conferencing, and volume control. - [Call History](https://docs.commpeak.com/docs/softphone-for-jwt-call-history.md): Find out how to view, filter, and manage recent call history in the CommPeak Softphone started from your JWT-enabled SIP account, including call details and re-dial options. - [Listen, Whisper, & Barge](https://docs.commpeak.com/docs/softphone-for-jwt-listen-whisper-barge.md): This article explains how to use the Listen, Whisper, and Barge functions in the built-in CommPeak Softphone when started from your JWT-enabled SIP account, allowing managers to monitor and interact with agent conversations. - [Available & DND Statuses](https://docs.commpeak.com/docs/softphone-for-jwt-available-dnd-statuses.md): Here, you will find an explanation how to switch between Available and Do Not Disturb (DND) statuses in the CommPeak built-in Softphone started from your JWT-enabled SIP account and how each status affects call functionality. - [Softphone Errors Explained](https://docs.commpeak.com/docs/softphone-for-jwt-errors-explained.md): A list of errors you can see in CommPeak built-in Softphone started from your JWT-enabled SIP account with explanations - [Changing Settings](https://docs.commpeak.com/docs/softphone-for-jwt-changing-settings.md): Access the settings of the CommPeak Softphone app built into your JWT-enabled SIP account to test sound quality, set a ringtone, add SIP accounts, and perform other configurations. - [General Settings](https://docs.commpeak.com/docs/softphone-for-jwt-general-settings.md): Configure the auto-answering feature, DTMF types and network options for operating CommPeak built-in Softphone started from your JWT-enabled SIP account. - [Audio Settings](https://docs.commpeak.com/docs/softphone-for-jwt-audio.md): In this section, you can change the settings of your input and output sound, adjust your ringtones, and set the application language for built-in Softphone started from your JWT-enabled SIP account. - [Help & Support](https://docs.commpeak.com/docs/softphone-for-jwt-help-support.md): This section provides details about the CommPeak built-in Softphone started from your JWT-enabled SIP account, your technical data, and directs you to the CommPeak Help Center. - [FAQs](https://docs.commpeak.com/docs/faq-softphone.md): CommPeak Softphone FAQs - [What Do I Need to Make Calls With CommPeak Softphone?](https://docs.commpeak.com/docs/what-do-i-need-to-make-calls-with-commpeak-softphone.md) - [Can I Transfer Calls in CommPeak Softphone?](https://docs.commpeak.com/docs/can-i-transfer-calls-in-commpeak-softphone.md) - [What DTMF Modes Does CommPeak Softphone Have?](https://docs.commpeak.com/docs/what-dtmf-modes-does-commpeak-softphone-have.md) - [How Can I Check My Sound?](https://docs.commpeak.com/docs/how-can-i-check-my-sound.md) - [How Can I Improve the Audio Quality of Calls?](https://docs.commpeak.com/docs/how-can-i-improve-the-audio-quality-of-calls.md) - [How Can I Check My Ping/Jitter in Softphone?](https://docs.commpeak.com/docs/how-can-i-check-my-internet-speed-ping-jitter.md) - [How Can I Add One More Call to the Active Call?](https://docs.commpeak.com/docs/how-can-i-add-one-more-call-to-the-active-call.md) - [Why Enable STUN/TURN in CommPeak Softphone?](https://docs.commpeak.com/docs/why-enable-stunturn-in-commpeak-softphone-faq.md) - [Troubleshooting](https://docs.commpeak.com/docs/troubleshooting-built-in-softphone.md): Troubleshooting CommPeak Softphone Issues - [Not Receiving Initial Softphone Calls for Dialer Predictive Mode](https://docs.commpeak.com/docs/call-registration-fails.md): Troubleshoot the issue when no initial calls can be received with the built-in Softphone for the Dialer Predictive mode. - [Microphone Volume Automatically Decreases](https://docs.commpeak.com/docs/microphone-volume-automatically-decreases.md): Resolve microphone volume issues in WebRTC-based Dialer applications and PBX clients using WebRTC - [Unable to Make or Receive Calls](https://docs.commpeak.com/docs/unable-to-make-or-receive-calls.md): Learn how to troubleshoot the issues with Softphone not allowing making or receiving calls. - [Choppy or Distorted Audio](https://docs.commpeak.com/docs/choppy-or-distorted-audio.md): Learn how to troubleshoot the issues with interruptions or poor audio quality during calls. - [Echo During Calls](https://docs.commpeak.com/docs/echo-during-calls.md): Learn how to troubleshoot the issues with voice echoed back during calls. - [One-Way Audio](https://docs.commpeak.com/docs/one-way-audio.md): Learn how to troubleshoot the issues with one party not hearing the other. - [Dropped Calls](https://docs.commpeak.com/docs/dropped-calls.md): Learn how to troubleshoot the issues with calls unexpectedly disconnecting during conversations. - [Extension Registration Issues](https://docs.commpeak.com/docs/extension-registration-issues-1.md): Learn how to troubleshoot the issues with registering extensions. - [Built-In Softphone Login Error: 403 - IP mismatch](https://docs.commpeak.com/docs/403-invalid-credentials-ip-mismatch-error.md): Learn how to troubleshoot the login issues with the built-in Softphone for JWT-enabled SIP accounts. - [Getting Started with CommPeak Affiliate Program](https://docs.commpeak.com/docs/affiliate-getting-started.md): How to get started and make the most of the CommPeak SMS and VoIP Affiliate Program that allows you to earn a commission from CommPeak by referring your customers - [Joining CommPeak Affiliate Program](https://docs.commpeak.com/docs/starting-with-commpeak-affiliate-program.md): Learn the first steps you must take to start earning with the CommPeak Affiliate Program. - [Affiliate Profile Approval](https://docs.commpeak.com/docs/affiliate-profile-approval.md): Learn how to get approval for your CommPeak Affiliate Profile. - [Completing KYC Verification](https://docs.commpeak.com/docs/completing-kyc-verification.md): This article offers a detailed guide for completing the Know Your Customer (KYC) process as part of CommPeak SMS and VoIP Affiliate extended verification procedure - [Managing Your Payouts](https://docs.commpeak.com/docs/managing-your-payouts-payout-plans.md): Learn about the payout plans options for managing your payouts. - [Working with CommPeak Affiliate Program](https://docs.commpeak.com/docs/working-with-commpeak-affiliate-program.md): Learn how you benefit from joining the CommPeak Affiliate program - [Affiliates Portal: Overview](https://docs.commpeak.com/docs/affiliates-portal.md): Get an overview of the CommPeak Affiliate Portal and learn what the Portal dashboard offers. - [Commission Payout](https://docs.commpeak.com/docs/commission-payout.md): Request new payouts for earned commissions, view previous requests, change your payout plans, and send invoices. - [Managing Your Customers](https://docs.commpeak.com/docs/managing-your-customers.md): Manage and refer new customers, view detailed reports on their usage, and handle customer invitations and tokens on the Customers tab. - [Viewing Your Balance](https://docs.commpeak.com/docs/viewing-your-balance.md): Learn where to see your affiliate balance and the history of the commission earned. - [Troubleshooting](https://docs.commpeak.com/docs/troubleshooting.md): Information to help you identify, isolate, and resolve issues with the CommPeak Affiliate Program - [Account Activation Delays](https://docs.commpeak.com/docs/account-activation-delays.md): Learn how to troubleshoot the issues with extended delays in your Affiliate account activation after registration. - [Accessing the Affiliate Portal](https://docs.commpeak.com/docs/accessing-the-affiliate-portal.md): Learn how to troubleshoot the Affiliate Portal access issues. - [Understanding CommPeak Services](https://docs.commpeak.com/docs/understanding-service-features.md): Understand the features and capabilities of CommPeak services. ## API Reference - [Overview](https://docs.commpeak.com/reference/dialer-api-overview.md): The CommPeak Dialer API is a comprehensive suite of APIs that provides partners and customers with seamless, secure, and scalable programmatic access to the Dialer data. The API allows developers to retrieve various information related to calls, campaigns, leads and users. - [Core API Concepts](https://docs.commpeak.com/reference/core-api-concepts.md) - [Common and Useful API Examples](https://docs.commpeak.com/reference/common-api-useful-examples.md): Here, you can find common API request logic to help you understand the logic workflow. - [Dispatch Leads](https://docs.commpeak.com/reference/dispatchleads.md): ### Dispatch leads to Dialer This endpoint enables you to push leads into the Dialer system programmatically. It leverages the Dialer's remote adapter architecture, allowing seamless integration with your sources, such as CRM systems. Key Features: - Specify adapter and import group for each batch of leads. - Automatically applies lead lifecycle updates and weight prioritization. - Supports priority automation for outbound calls. Learn more about integrating remote adapter via API [here](https://td.commpeak.link/docs-remote-adapter). ##### Request params - `adapter_id` - your Dialer adapter id - `import_group_id` - your import group is related to the Dialer adapter. ##### Request body: JSON with the following allowed possible lead fields: `id` (your original identifier), `first_name`, `last_name`, `phone`, `campaign`, `source`, `affiliate`, `country`, `language`, `status` (your dedicated statuses list from `/statuses`), `agent`, `email`, `desk`, `business_unit`, `registration_date`, `last_updated_at`, `last_login_date`, `first_deposit_date` \=== - [Dispatch Statuses](https://docs.commpeak.com/reference/dispatchstatuses.md): ### Dispatch lead statuses to Dialer This endpoint added statuses for use with the dispatch `/leads` endpoint. ##### Request params - `adapter_id` - your dialer adapter - `import_group_id` - your import group is related to the Dialer adapter. ##### Request body: JSON with status ID and name. - [Get all calls](https://docs.commpeak.com/reference/getallcalls.md): The GET all calls API allows you to retrieve the calls made from the Dialer. You can apply various request parameters as filters to segment and limit the number of records. ### Parameters - `campaign_id`: Integer - `id` : Integer - `object_type_id` : Integer - `object_id` : Integer - `caller_user_id` : Integer - `start_at` : DateTime URL encoded format 2020-09-01T00:00:00 - `end_at` : DateTime URL encoded format 2020-09-01T00:00:00 - `src` : String - `dst` : String - `call_uuid` : String - `agent_callerid_name` : String - `agent_callerid_number` : String - `agent_hangup_disposition` : String - `client_callerid_name` : String - `client_callerid_number` : String - `client_hangup_disposition` : String - `call_duration` : Integer - `call_bill_duration` : Integer - `status` : String - `status_id_before` : Integer - `status_id_after` : Integer - `record_file` : String - `created_at` : DateTime URL encoded format 2020-09-01T00:00:00 - `q850` : String - `beep_detected` : Boolean - `user_group_id` : Integer - `sip_term_status` : String - `amd_status` : String - `amd_result` : String - `cost` : String - [Get aggregated call stats](https://docs.commpeak.com/reference/getaggregatedcallstats.md): The Get aggregated call stats endpoint retrieves call statistics for a specific time period and campaign ID. ### Parameters - `from`: datetime urlencode format 2020-09-01T00:00:00 - `till`: datetime urlencode forma 2024-09-03T00:00:00 - `campaign_id`: Integer - [Get specific call](https://docs.commpeak.com/reference/getspecificcall.md): The Get specific call API enables you to retrieve the details of a specific call identified by the call `id`. ### Parameters - `id` : Integer - [Get specific call's record file](https://docs.commpeak.com/reference/getspecificcallsrecordfile.md): Use the Get specific call's record file method to get the recording file of a specific call identified by the call id. ### Parameters - `id` : Integer - [Get specific campaign](https://docs.commpeak.com/reference/getspecificcampaign.md): The Get specific campaign API allows you to retrieve all the details of a specific campaign filtering by id. - [Update specific campaign](https://docs.commpeak.com/reference/updatespecificcampaign.md): The Update specific campaign method enables you to update the details of a specific campaign specified by the campaign id. - [Delete specific campaign](https://docs.commpeak.com/reference/deletespecificcampaign.md): The Delete specific campaign API allows you to delete a specific campaign and all details based on the campaign id. - [Get all campaigns](https://docs.commpeak.com/reference/getallcampaigns.md): The Get all campaigns API allows you to retrieve details of all campaigns. - [Clone campaign (Create)](https://docs.commpeak.com/reference/clonecampaigncreate.md): The Clone campaign API method enables to clone/duplicate a campaign and all details, based on the campaign id. - [Delete Leads](https://docs.commpeak.com/reference/deleteleads.md): The Delete Leads endpoint method allows you to delete all leads from a campaign, specified by the campaign ID. - [Get campaign leads](https://docs.commpeak.com/reference/getcampaignleads.md): The Get campaign leads API allows you to retrieve a list of leads and all details. Apply various request parameters as filters to segment and limit the number of records. Will also be provided the `total_leads` field which indicates the total number of leads that matches the given filter of the request. - [Mass assign leads](https://docs.commpeak.com/reference/massassignleads.md): The Mass assign leads endpoint enables you to mass assign leads to a specific campaign. In the request body you should provide: - `remove_from_others` - Remove from other campaigns (true - remove, false - skip). - `campaign_id` - campaign to add leads to - `where` - array of conditions, can have any of the following fields: id, first_name, last_name, phone, phone2, address1, address2, country, state, city, zip, timezone, original_identifier, support_site, purchase_site, purchase_date, purchase_amount, purchase_product_name, purchase_card_name, purchase_card_type, purchase_card_digits, email, birthdate, loan_amount - [Mass delete](https://docs.commpeak.com/reference/massdelete.md): Use the Mass delete API method if you want to delete multiple campaign leads at once. You should provide the list of campaign lead ids that you want to delete in the body. - [Move to campaign](https://docs.commpeak.com/reference/movetocampaign.md): The Move to campaign API endpoint allows you to move leads from one campaign to another. You should specify the following fields in the request body: #### Request Body - `id` (array of integers) - The Lead IDs of the leads to be moved. - `source_campaign_id` (integer) - The ID of the source campaign. - `with_preserve_data` (boolean) - Indicates whether to preserve the data while moving the leads. - `destination_campaign_id` (integer) - The ID of the destination campaign. - [Update Campaign leads](https://docs.commpeak.com/reference/updatecampaignleads.md): Use this endpoint to update campaign leads fields. You should specify the following parameters in the request body: #### Request Body - `where` - allow to update by campaign lead ids - `update` - key/value pairs to update the filtered campaign leads from the were. update separated to cmapaign lead entities and lead entities. - `lead` entities: first_name, last_name, phone, phone_normalized, phone2, phone_normalized2, address1, address2, state, city, zip, lat, lng, timezone, timezone_id, original_identifier, support_site, purchase_site, purchase_date, purchase_amount, purchase_product_name, purchase_card_name, purchase_card_type, purchase_card_digits, email, birthdate, loan_amount, call_after, call_after_outside_allowed_time - `campaign_lead` entities: status_id, created_at, updated_at, assigned_user_id, assigned_at, assigned_user_permanent, call_after, weight, is_deleted, clone_of, updating_status_started_at, permanent_assignment_expire_at, call_after_outside_allowed_time, no_ratio, calls_count, amd_disabled, outbound_ivr_disabled, override_trunk_id - [Mass unassign leads](https://docs.commpeak.com/reference/massunassignleads.md): Thw Mass unassign leads API method is used to unassign multiple leads from a specific campaign. You should add the following fields in the request body: #### Request Body - `campaign_id` (integer) - The ID of the campaign from which leads are to be unassigned. - `where` (object) - Criteria to select the leads to be unassigned. In this example, the criteria is based on the lead `id` field. #### Response The response for this request is a 204 status code with a Content-Type of text/xml. - [Call](https://docs.commpeak.com/reference/call.md): # Click2Call The [Click2Call](https://td.commpeak.link/C2C) API allows agents to initiate a call from a third party application such as a CRM to the agent's extension. After the agent answers, we will initiate a call to your destination according to your outbound routing setups. ### Path Parameters - `c2c_id` (string): The unique identifier for your c2c setup. - `leg_a` (string): Agent extension (caller) - `leg_b` (string): Destination’s phone number (callee) - `route_number` (string): Outbound calls prefix (default prefix is ‘00’). For example: \*01 \*This prefix must match the existing prefix configured at the dial pattern on the [Manual Dialing Routes](https://td.commpeak.link/outbound-routs) - [Get comments](https://docs.commpeak.com/reference/getcomments.md): Use the Get comments endpoint if you want to retreive comments left for the leads and calls. Apply various request parameters as filters to segment and limit the number of records. ### Response The response will include an array of comments, where each comment object contains the following properties: - id (string): The unique identifier for the comment. - campaign_lead_id (string): The identifier for the campaign lead associated with the comment. - creator_user_id (string): The identifier for the user who created the comment. - body (string): The content of the comment. - created_at (string): The timestamp indicating when the comment was created. - username (string): The username of the user who created the comment. - lead_id (string): The identifier for the lead associated with the comment. - original_identifier (null): An optional property that may be null. - [Create comment](https://docs.commpeak.com/reference/createcomment.md): The Create comment API endpoint allows you to create a new comment for a campaign lead id. You should add the following fields in the request body: #### Request Body - `creator_user_id` (string, required): The ID of the user creating the comment. - `campaign_lead_id` (string, required): The ID of the campaign lead related to the comment. - `body` (string, required): The content of the comment. #### Response The response will be a JSON object with a `comments` array containing the newly created comment object. Each comment object includes the following fields: - `id` (string): The unique identifier of the comment. - `campaign_lead_id` (string): The ID of the campaign lead related to the comment. - `creator_user_id` (string): The ID of the user who created the comment. - `body` (string): The content of the comment. - `created_at` (string): The timestamp of when the comment was created. - `success` (boolean): Indicates whether the request was successful. - [Create mass comments](https://docs.commpeak.com/reference/createmasscomments.md): ### Add Mass Comments The Add Mass Comments method enables you to add multiple comments at once. You should the following data in the request body: #### Request Body - The request should be sent as an array of objects in the raw format. - `creator_user_id` (Number): The ID of the user creating the comment. - `campaign_lead_id` (String): The ID of the campaign lead. - `body` (String): The content of the comment. #### Response The response will contain an array of comments, each with the following properties: - `id` (String): The ID of the comment. - `campaign_lead_id` (String): The ID of the campaign lead. - `creator_user_id` (String): The ID of the user who created the comment. - `body` (String): The content of the comment. - `created_at` (String): The timestamp of when the comment was created. - `success` (Boolean): Indicates if the comment was added successfully. - [Get DNC](https://docs.commpeak.com/reference/getdnc.md): Use the Get DNC method if you want to retrieve details of the specific DNC. You should add the DNC id to the request. - [Delete DNC](https://docs.commpeak.com/reference/deletednc.md): The Delete DNC API endpoint allows you to delete specific DNC and all details. You should add the DNC id to the request. - [Approve DNC phone](https://docs.commpeak.com/reference/approvedncphone.md): Use the Approve DNC phone method if you want to move the DNC phone to the approved DNC list. You should add the DNC id to the request. - [UnApprove DNC phone](https://docs.commpeak.com/reference/unapprovedncphone.md): The UnApprove DNC phone API method allows you to remove the DNC phone from the approved list. You should add the DNC id to the request. - [Get DNC list](https://docs.commpeak.com/reference/getdnclist.md): Use the Get DNC list API request if you want to retrieve all the DNC entries. - [Create DNC](https://docs.commpeak.com/reference/creatednc.md): The Create DNC endpoint enables you to create a Do Not Call (DNC) entry. You should add the following fields to the body: #### Request Body - `phone` (string, required): The phone number to be added to the DNC list. - `country_iso` (string, required): The country ISO code for the phone number. - `approved` (integer, required): Indicates if the entry is approved. - `permanent` (integer, required): Indicates if the entry is permanent. - [Get DNC by phone](https://docs.commpeak.com/reference/getdncbyphone.md): The Get DNC by phone API method allows you to retrieve details of the DNC specifying by phone number. You should add the phone number to the body request. - [Mass Approve/Unapprove DNC numbers](https://docs.commpeak.com/reference/massapproveunapprovedncnumbers.md): Use the Mass Approve/Unapprove DNC numbers API endpoint if you want to approve/unapprove multiple Do Not Call (DNC) entries at once. You should add the following fields to the request body: #### Request Body - `create_missing` (boolean): Set to true to create missing DNC entries. - `dnc` (array): An array of objects containing the following parameters for each DNC entry: - `phone` (string): The phone number for the DNC entry. - `country_iso` (string): The country ISO code for the phone number. - `approved` (integer): The approval status for the DNC entry. - `permanent` (integer): The permanence status for the DNC entry. - [Get all leads](https://docs.commpeak.com/reference/getallleads.md): Use the Get all leas API request if you want to retreive all the leads details. Apply various request parameters as filters to segment and limit the number of records. - [Delete Leads](https://docs.commpeak.com/reference/deleteleads1.md): The Delete leads endpoint allows you to mass delete leads by their IDs. You should add the lead id in the request body: #### Request Body - `id` (array of integers) - The IDs of the leads to be updated or deleted. #### Response The response will contain an array of objects under the key `removedLeads`, each object representing a lead that has been removed. - [Update Leads](https://docs.commpeak.com/reference/updateleads.md): The Update leads API endpoint allows you to update multiple leads in bulk by specifying the criteria for the leads to be updated and the fields to be updated. You should the following to the request body: ### Request Body - `where` (object) - Criteria to select the leads to be updated. For example, you can specify the lead IDs to be updated. - `id` (array) - An array of lead IDs to be updated. - `update` (object) - The fields and their new values to be updated for the selected leads. - `first_name` (string) - The new first name for the leads. - `call_after` (string) - The new call after date for the leads. - `customFields` (object) - Custom fields and their new values for the leads. - `custom_string` (string) - The new value for the custom string field. - `my_test` (string) - The new value for the my test field. ### Response The response will contain an array of updated leads with their respective fields and values. If no leads are updated, an empty array will be returned. - [Create Lead](https://docs.commpeak.com/reference/createlead.md): The Create lead API request enables you to create leads in mass. You should add all the details in the request body. #### Request Body - The request body should be in the raw format. - The payload should include an array of objects, where each object represents a lead with various properties such as first_name, last_name, phone, address, purchase details, email, birthdate, loan_amount, and customFields. #### Response The response will be an array of objects, each containing information about the lead added. The objects will include properties like id, lead_file_id, api_user_id, first_name, last_name, phone, address, purchase details, email, birthdate, loan_amount, remote_adapter_id, hlr, and customFields. - [Update Lead](https://docs.commpeak.com/reference/updatelead.md): The Create lead API request enables you to update a lead details. You should add all the details in the request body. ### Request Body The request body should be in form-data format. The keys and values to be included in the form-data request body were not provided. ### Response The response to this request will vary based on the specific lead being updated. Examples of responses for this request were not provided. - [Delete Lead](https://docs.commpeak.com/reference/deletelead.md): Use the Delete lead API method if you want to delete a lead from the dialer based on the lead id. - [Get Extended information about lead(s)](https://docs.commpeak.com/reference/getextendedinformationaboutleads.md): The Get extended information about leads API endpoint allows you to get all the extended details from a lead based on one or more extended data from the leads. You should add all the filters in the body request. Apply various request parameters as filters to segment and limit the number of records. - [Get all lead files](https://docs.commpeak.com/reference/getallleadfiles.md): The Get all lead files API method allows you to retrieve the lead files avaialble in the dialer. - [Get all lead files by params](https://docs.commpeak.com/reference/getallleadfilesbyparams.md): The Get all lead files by params enables you to get a list of the lead files specifed by name and id. - [Get all statuses](https://docs.commpeak.com/reference/getallstatuses.md): Use the Get all statuses endpoint if you want to retrieve a list of statuses. You can specify per status id or campaign id. #### Response The response will be a JSON object with a `statuses` array containing status objects. Each status object will have the following properties: - `id` (string): The ID of the status. - `campaign_id` (string): The ID of the campaign associated with the status. - `name` (string): The name of the status. - `code` (null): The code associated with the status, if available. - [Get specific status](https://docs.commpeak.com/reference/getspecificstatus.md): Use the Get specific status API endpoint if you want to retrieve the details of a specific status. You should add the status id to the variables. - [Get all users](https://docs.commpeak.com/reference/getallusers.md): The Get all users, enables you to retrieve all the users created in the dialer. - [Create User](https://docs.commpeak.com/reference/createuser.md): Use the Create user API method if you want to create one or more users. You should add the following fields in the request body: #### Request Body - `username` (string): The username of the user. - `password` (string): The password for the user account. - `email` (string): The email address of the user. - `sip_option` (string): The SIP option for the user. - `is_active` (string): Indicates whether the user account is active. - `reset_password` (string): Indicates whether the user should reset their password. - `sip_uri` (string): The SIP URI for the user. - `use_extended_ip_acl` (string): Indicates the usage of extended IP ACL. - `user_route_caller_id` (string): The caller ID for user routing. - `member_all_desks` (string): Indicates membership to all desks. - `kerb_username` (string): The Kerberos username for the user. - `desks` (array): An array of desks associated with the user. - `roles` (array): An array of roles assigned to the user. - `skill_groups` (array): An array of skill groups assigned to the user. - [Get user](https://docs.commpeak.com/reference/getuser.md): Use the Get user API method if you want to get all the details from a specific user. You should add the user id in the query parameters. - [Update User](https://docs.commpeak.com/reference/updateuser.md): This Update user endpoint allows you to update the details of a specific user. You should add the id as a variable and the fields to update in the request body. #### Request Body Parameters - `id` (number): The unique identifier of the user. - `username` (string): The username of the user. - `email` (string): The email address of the user. - `is_active` (number): Indicates if the user is active. - `sip_uri` (string): The SIP URI of the user. - `is_deleted` (number): Indicates if the user is deleted. - `use_extended_ip_acl` (number): Indicates if the user uses extended IP ACL. - `user_route_caller_id` (number): The caller ID for user routing. - `predictive_dynamic_extension` (string): The dynamic extension for predictive dialing. - `timezone_id` (number): The timezone identifier for the user. - `first_name` (string): The first name of the user. - `last_name` (string): The last name of the user. - `virtual_extension` (string): The virtual extension of the user. - `default_language` (string): The default language for the user. - `en_US` - English (United States) - `es_ES` - Spanish (Spain) - `pt_BR` - Portuguese (Brazil) - `max_session_time` (string): The maximum session time for the user. - `max_concurrent_sessions` (string): The maximum concurrent sessions for the user. - `twofa_type` (string): The two-factor authentication type for the user. - `default` - Default from Role / Tenant - `disabled` - Disabled - login without 2FA - `email` - Email - with one-time code - `google` - Google 2FA App - with one-time code - `member_all_skill_groups` (string): Indicates if the user is a member of all skill groups. - `member_all_desks` (string): Indicates if the user is a member of all desks. - `registration_password` (string): The registration password for the user. - `is_clockedin` (string): Indicates if the user is clocked in. - `is_predictive_clockedin` (string): Indicates if the user is predictive clocked in. - `use_webrtc` (number): Indicates if the user uses WebRTC. - [Delete User](https://docs.commpeak.com/reference/deleteuser.md): Use the Delete User if API request if you want to delete a specific user. You should add the user id to the request. - [Get Breaks](https://docs.commpeak.com/reference/getbreaks.md): Get Breaks - [Get Users Breaks](https://docs.commpeak.com/reference/getusersbreaks.md): Get Users Breaks - [Get desks](https://docs.commpeak.com/reference/getdesks.md): Use Get desks if you want to retrieve the list of desks avaialble. - [Create desk](https://docs.commpeak.com/reference/createdesk.md): The Create desk API method allows you to create a new desk. You should send the following fields in the request body: #### Request Body - `name` (string, required): The name of the desk. - `userIds` (array, required): An array of user IDs associated with the desk. #### Response Body The response will contain a JSON object with the following properties: - `userDesk` - `id` (string): The ID of the created desk. - `name` (string): The name of the desk. - `userIds` (array): An array of user IDs associated with the desk. - [Update desk](https://docs.commpeak.com/reference/updatedesk.md): The Update desk API endpoint enables you to update a desk. You should send the following fields in the request body: #### Request Body - `name` (string, optional): The updated name of the desk. - `userIds` (array): An array of user IDs associated with the desk. - [Desk Breaks](https://docs.commpeak.com/reference/deskbreaks.md): Desk Breaks - [Get all groups](https://docs.commpeak.com/reference/getallgroups.md): The Get all groups API endpoint retrieves the list of the existing user groups in the dialer. - [Get assigned users](https://docs.commpeak.com/reference/getassignedusers.md): Use the Get assigned users API endpoint if you want to get the list of users that are assigned to a specific user group. You should the user group id as a variable in the request. - [Get assigned campaigns](https://docs.commpeak.com/reference/getassignedcampaigns.md): Use the Get assigned campaigns API method if you want to get the list of campaigns assigned to a specific user group. You should add the user group id as a variable. - [Get group](https://docs.commpeak.com/reference/getgroup.md): The Get group API request retreives all the details of a specific user group. You should add the user group id as a variable in the request. - [Update group](https://docs.commpeak.com/reference/updategroup.md): Use the Update group API request if you want to update one of the settings from a user group. You should send the user group id as a variable and fields you want to update in the request body: #### Request Body - `name` (string): The name of the group. - `description` (string): Description of the group. - `callerid_name` (string): Caller ID name for the group. - `callerid_number` (string): Caller ID number for the group. - `ratio` (string): Ratio for the group. - `freeswitch` (string): FreeSwitch details for the group. - `hard_drop_rate` (string): Hard drop rate for the group. - `soft_drop_rate` (string): Soft drop rate for the group. - `optimal_drop_rate` (string): Optimal drop rate for the group. - `hard_ratio_increment` (string): Hard ratio increment for the group. - `soft_ratio_increment` (string): Soft ratio increment for the group. - `optimal_ratio_increment` (string): Optimal ratio increment for the group. - `group_type` (string): Type of the group. - `minimum_ratio` (string): Minimum ratio for the group. - `maximum_ratio` (string): Maximum ratio for the group. #### Response The API returns a JSON object with a `groups` key, which contains an array of group objects. In the example response. - [Delete group](https://docs.commpeak.com/reference/deletegroup.md): The Delete group API method gives the option to delete a user group. You should send the user group id as a variable in the request. - [Get priority groups](https://docs.commpeak.com/reference/getprioritygroups.md): Use the Get priority groups method if you want retrieve the list of priority groups created in the dialer. - [Get skill group by priority group id](https://docs.commpeak.com/reference/getskillgroupbyprioritygroupid.md): The Get skill group by priority group id enables you to retrieve the skill groups associated to a spescific priority group. You should send the priority group id as a variable in the request. - [Update priority group](https://docs.commpeak.com/reference/updateprioritygroup.md): Use the Update priority group API endpoint if you want to update one or more fields from a priority group. You should add the priority group id as a variable and the fields to be updated in the request body. - [Get skill groups](https://docs.commpeak.com/reference/getskillgroups.md): Use the Get skill groups API request to retrieve all the skill groups created in the dialer. - [Create skill group](https://docs.commpeak.com/reference/createskillgroup.md): The Create skill group allows you to create a new skill group from scratch. You should send all the relevant fields in the request body. - [Get List Of Roles](https://docs.commpeak.com/reference/getlistofroles.md): Use Get list of roles if you want to retrieve the list of roles avaialble. - [Get User role](https://docs.commpeak.com/reference/getuserrole.md): Use the Get user role endpoint if you want to retrieve a specific user role. You should send the user role id as a variable in the request. - [Update User role](https://docs.commpeak.com/reference/updateuserrole.md): The Update User Role API method allows you to update a user role. You should send the user role id as a variable and the following fields in the request body: #### Request Body - `name` (string, required): The name of the role. - `level` (string, required): The level of the role. - `twofa_type` (string, required): The type of two-factor authentication associated with the role. - `userIds` (array of integers, required): An array of user IDs associated with the role. - [Get all logs](https://docs.commpeak.com/reference/getalllogs.md): The Get all logs API method allows you to get all the logs from a specific user in a specific period of time. You should send in the request body the following fields: #### Request - Parameters - from (string, required): The start date and time for the logs retrieval. - till (string, required): The end date and time for the logs retrieval. The response will contain an array of log objects, each with an ID, creation timestamp, user ID, message, object type, and object ID. - [Get logs object types](https://docs.commpeak.com/reference/getlogsobjecttypes.md): Use the Get logs object types if you want to get a list of all the object types available on the logs. - [Get api logs](https://docs.commpeak.com/reference/getapilogs.md): The Get API logs allows you to get all the API logs specified by one or more parameters. You should send the parameters as variables in the request. ### Parameters - `filter_from` (string): Start date for filtering logs. - `filter_till` (string): End date for filtering logs. - `filter_api_user_id` (string): User ID for filtering logs. - `filter_action` (string): Action for filtering logs. - `filter_method` (string): HTTP method for filtering logs. - `filter_response_code` (string): HTTP response code for filtering logs. - [Send Speech with callback URL](https://docs.commpeak.com/reference/sendspeechwithcallbackurl.md): This endpoint allows you to search and send calls for speech recognition based on various input filters (like duration, language, phrase, and more), and if transcription is complete, the results are sent automatically to your callback URL. It supports dynamic placeholders in the callback data to include call, speech, user, campaign, and lead details. The response initially provides a speech request ID and call IDs, while the full speech results are sent later to the callback URL. ### Expected Input - `callback_url`: (string) The URL where the callback will be sent. (mandatory) - `callback_method`: (string) The HTTP method for the callback request. options: POST, PUT. (mandatory) - `callback_data`: (string) The data of the callback response action, JSON with placeholders. (mandatory) - `token` (string) - `min_duration` (integer) - `max_duration` (integer) - `call_status` (string) - `from` (DateTime) - `till` (DateTime) - `language` (string) - `phrase` (string) - `summary` (string) - `rank_description` (string) - `rank_min` (Integer 0-100) - `rank_max` (Integer 0-100) - `limit` (integer) Allowed placeholders for `callback_data`: Speech-related: \- {speech_result} - Speech result \- {speech_phrases} - Array of Speech phrases \- {speech_task_state} - Speech task's current state \- {speech_summary} - Text Summary of the call \- {speech_rank} - Rank of the call between 0 to 100 \- {speech_rank_description} - Text of the speech recognition rank description Call-related: \- {call_id} - Call Id \- {caller_user_id} - Caller User Id \- {caller_username} - Caller username \- {start_at} - Call Start At \- {end_at} - Call End At \- {agent_callerid_name} - Agent Caller Id name \- {agent_callerid_number} - Agent Caller Id number \- {call_duration} - Call duration \- {call_bill_duration} - Call bill duration User and Campaign-related: \- {user_group_id} - User group Id \- {object_id} - Campaign Lead Id \- {weight} - Campaign Lead weight \- {call_after} - Campaign Lead Call After \- {status_id_before} - Campaign Lead Status Id before \- {status_id_after} - Campaign Lead Status Id after \- {status_before} - Campaign Lead Status before \- {status_after} - Campaign Lead Status after \- {campaign_id} - Campaign Id \- {campaign_name} - Campaign name \- {assigned_user_id} - Assigned User Id \- {assigned_username} - Assigned Username Lead-related: \- {lead_id} - Lead Id \- {country_name} - Lead Country name \- {first_name} - Lead first_name \- {last_name} - Lead last_name \- {phone_normalized} - Lead phone \- {original_identifier} - Lead original identifier (Remote\\CRM Id) \- {support_site} - Lead support site \- {purchase_site} - Lead purchase site \- {purchase_date} - Lead purchase date \- {purchase_product_name} - Lead purchase product name \- {purchase_card_name} - Lead purchase card name \- {email} - Lead email \- {birthdate} - Lead birthdate ### Expected Output The response will be in JSON format and may include a `speechRequestId` and `callIds` object containing the details of calls that initiate to speech recognition service. while speech transcript will be ready, the request will initiate to your `callback_url` ****Important:** The token used to create the speech transcription for a call will be the only token authorized to retrieve the speech recognition results. - [Send to speech recognition](https://docs.commpeak.com/reference/sendtospeechrecognition.md): This endpoint retroactively sends existing calls that have not yet been transcribed to the speech recognition service. You provide arrays of call IDs, campaign lead IDs, or lead IDs along with optional parameters like languages, minimum duration, and recording side (lead, agent, or both). The service then processes these calls for transcription and returns a JSON response detailing the completed calls that were sent for transcription. #### Request Body - `call_ids` (array) - An array of call IDs. - `campaign_lead_ids` (array) - An array of campaign lead IDs. - `lead_ids` (array) - An array of lead IDs. - `token` (string) - The token for authentication. - `languages` (array) - An array of languages. - `min_duration` (interger) - The minimum duration for the recording. - `recording_side` (string) - The side of the recording. lead, agent, both. The response is a JSON object with nested properties. It includes details of completed calls for the specified leads and campaign leads. ****Important:** The token used to create the speech transcription for a call will be the only token authorized to retrieve the speech recognition results. - [Get Speech for call id](https://docs.commpeak.com/reference/getspeechforcallid.md): Use the Get speech for call id if you want to get the transcription of call, specified by the call id. You should send the call id as a variable in the request. #### Response Body - `data` (object) - `remote_identifier` (string): Remote identifier. - `created_at` (string): Date and time of creation. - `language` (string): Language used in the call. - `plain_body` (string): Plain body of the call. - `sentiment` (float): call rank (score) between 0 - 1. assess the quality and value of the call. - `summary` (String): AI Summary analyzes call transcripts to generate concise summaries. - `phrases` (array): Array of phrases detected in the call. - `phrase` (string): Detected phrase. - `start_at` (integer): Start time of the phrase. - `end_at` (integer): End time of the phrase. - `channel` (integer): Channel of the phrase. - `metadata` (object) - `channel_id` (string): fetch calls that created for specific speech channel. - `status` (string): Status of the call. - `message` (string): Additional message related to the call. ****Important:** The token used to create the speech transcription for a call will be the only token authorized to retrieve the speech recognition results. - [Get all language](https://docs.commpeak.com/reference/getalllanguage.md): The Get all language API method enables you to get the list of languages supported by the speech to text service. - [Get dynamic caller ids by params](https://docs.commpeak.com/reference/getdynamiccalleridsbyparams.md): The Get dynamic caller ids by params gives you the option to retrieve the caller ids specified by different params. You can see the filters that can be used as a variable below: #### Request No request body is required for this endpoint. - `filterby` (path parameter) - The filter to be applied for retrieving dynamic caller IDs for the campaign. allowed filter by: `campaign_id`, `prefix`, `caller_id_number`, `caller_id_name`, `is_active`, `created_at_from`, `created_at_till`, `is_blocked` - [Get all dynamic caller ids](https://docs.commpeak.com/reference/getalldynamiccallerids.md): The Get all dynamic caller ids API request enables you to get the whole list of caller ids in the dialer. - [Update dynamic caller ids](https://docs.commpeak.com/reference/updatedynamiccallerids.md): The Update dynamic caller ids endpoint allows to update the status of specific caller IDs. The request should include a raw JSON body with the keys "is_active" and "ids". The "is_active" key should have a value of 0 to deactivate the IDs, and the "ids" key should be an array of the IDs to be updated. ### Request Body - `is_active` (number): Indicates the status to be updated. Set to 0 to deactivate the IDs. - `ids` (array): An array of IDs to be updated. - [Get Route Caller IDs](https://docs.commpeak.com/reference/getroutecallerids.md): The Get route caller ids allows you to get the list of all route caller ids avaialble in the dialer. - [Enable/Disable Route CallerID](https://docs.commpeak.com/reference/enabledisableroutecallerid.md): Use the Enable/Disable Route CallerID API endpoint if you want to update the state of a route caller id. You should send the following fields in the request body: #### Request Body - `id` (string) - The ID of the caller to be updated. - `action` (string) - The action to be performed on the caller ID. Enable `1`, Disable `0` - [Create Route CallerID](https://docs.commpeak.com/reference/createroutecallerid.md): The Create route CallerID API method enables you to create a new route CallerID from scratch. You should send the following fields in the request body: #### Request Body - `caller_id_name` (string, optional): The name of the caller ID. - `caller_id_number` (string, optional): The number of the caller ID. - `is_active` (string, optional): Indicates if the caller ID is active. - [Get Route CallerID](https://docs.commpeak.com/reference/getroutecallerid.md): The Get route caller id enables you to get a route caller id avaialble in the dialer, specified as callerID id. You should send it as a variable in the request. - [Delete Route CallerID](https://docs.commpeak.com/reference/deleteroutecallerid.md): Use the Delete Route CallerID API method if you want to delete a callerID from the dialer. You should send the CallerID id as a variable in the request. - [Get all timezones](https://docs.commpeak.com/reference/getalltimezones.md): The Get all timezones enables you to get a list of all existing timezones. - [Get all CDRs](https://docs.commpeak.com/reference/getallcdrs.md): Use the Get all CDRs if you want to get a list of all CDRs available in your dialer. Apply various request parameters as filters to segment and limit the number of records. #### Request Body This is a GET request and does not require a request body. You can filter by any parameter that you get in the response. In addition, use `fields` with wanted fields to ensure you get specific fields in the response. #### Response Body The response will contain an array of CDR objects. Each CDR object includes the following parameters: - `start_at` (string) - The start time of the call - `end_at` (string) - The end time of the call - `src` (string) - The source of the call - `dst` (string) - The destination of the call - `call_uuid` (string) - The unique identifier of the call - `client_callerid_name` (string) - The name of the caller - `client_callerid_number` (number) - The caller's phone number - `call_duration` (number) - The duration of the call - `call_bill_duration` (number) - The billed duration of the call - `status_id_before` (string) - The status ID before the call - `status_id_after` (string) - The status ID after the call - `status` (string) - The status of the call - `q850` (string) - Q850 status - `caller_user_id` (string) - The ID of the caller user - `client_hangup_disposition` (string) - The disposition of the client hangup - `campaign_lead_id` (number) - The ID of the campaign lead - `lead_id` (number) - The ID of the lead - `campaign_id` (string) - The ID of the campaign - `assigned_user_id` (number) - The ID of the assigned user - `assigned_user_permanent` (number) - The permanent ID of the assigned user - `call_after` (string) - The call after time - `campaign_lead_weight` (number) - The weight of the campaign lead - `call_after_outside_allowed_time` (number) - The call after outside allowed time - `no_ratio` (number) - The ratio of the call - `lead_file_id` (number) - The ID of the lead file - `first_name` (string) - The first name of the caller - `last_name` (string) - The last name of the caller - `phone_normalized` (string) - The normalized phone number - `phone_normalized2` (string) - The second normalized phone number - `address1` (string) - Address line 1 - `address2` (string) - Address line 2 - `state` (string) - The state - `city` (string) - The city - `zip` (string) - The ZIP code - `country_id` (string) - The ID of the country - `timezone_id` (string) - The ID of the timezone - `original_identifier` (string) - The original identifier - `support_site` (string) - The support site - `purchase_site` (string) - The purchase site - `purchase_date` (string) - The purchase date - `purchase_amount` (number) - The purchase amount - `purchase_product_name` (string) - The name of the purchased product - `purchase_card_name` (string) - The name on the purchase card - `purchase_card_type` (string) - The type of the purchase card - `purchase_card_digits` (string) - The digits of the purchase card - `email` (string) - The email address - `birthdate` (string) - The birthdate - `loan_amount` (string) - The loan amount - `object_type_id` (number) - The object type ID - `custom_date` (string) - Custom date - `custom_string` (string) - Custom string - `d_solitics_data` (string) - Solitics data - `d_solitics_event_id` (string) - Solitics event ID - `date_field` (string) - Date field - `cost` (float) - CDR rate cost. In case there are no CDRs available, an empty array will be returned. - [Aggregate CDRs](https://docs.commpeak.com/reference/aggregatecdrs.md): ### Aggregate CDRs This endpoint allows you to aggregate Call Detail Records (CDRs) based on specified parameters. #### Request Body - `group` (string): Specifies the fields to group the CDRs by. \*_Required__\*_Example: ``` "campaign;user;call status;status before;status after;weight;duration;country;timezone;lead file;hangup;destination;caller_id;user group;q850;sip termination status;campaign lead created at;campaign lead updated at;extension number;lead created at;lead updated at;transfer to;conference to;trunk;campaign_lead_id;original_identifier;first_name;last_name;phone_normalized;phone_normalized2;support_site;purchase_site;purchase_date;purchase_amount;purchase_product_name;purchase_card_name;purchase_card_type;purchase_card_digits;email;birthdate;loan_amount;address1;address2;hlr;state;city;zip;assigned_user_permanent;no_ratio;lead_id" ``` - `fields` (string): Specifies the fields to include in the aggregated CDRs. **Example:** ``` "campaign;user;call status;status before;status after;weight;duration;country;timezone;lead file;hangup;destination;caller_id;user group;q850;sip termination status;campaign lead created at;campaign lead updated at;extension number;lead created at;lead updated at;transfer to;conference to;trunk;custom fields;period;total calls;successful calls;total duration;total bill duration;ACD;ASR;cost;transfer duration;conference duration;transfer cost;conference cost;total transfer;campaign lead id;lead id;permanent;call agent duration" ``` - `period` (string): Specifies the time period for aggregation. Example: `"year;month;day;hour"` - `weightSteps` (string) weight stepts to group by. Example: (`"All"` \\ `"100"` \\ `"50"`) - `filter` (object): Contains the filter criteria for aggregating the CDRs. **Required (strat_at & end_at)** Example: ``` json { "start_at": "2020-01-01 00:00:00", // required, operator is not supported "end_at": "2025-01-01 00:00:00", // required, operator is not supported "destination": [ "12", "464646466465" ], // single value or array, operator is not supported "caller_id": [ "4565654654" ], // single value or array, operator is not supported "permanent": 0, // only 1 / 0, operator is not supported "statusBefore": [ "answered" ], // array, operator is not supported "statusAfter": [ "Busy", "New" ], // array, operator is not supported "callAttributes": [ "Conference", "Transfer" ], // array, operator is not supported "campaign": [ 22, 0 ], // array of campaigns ids, operator is not supported "userGroup": [ 30 ], // array of groups ids, operator is not supported "user": [ 2, 3 ], // array of users ids, operator is not supported "country": [ 1, 2 ], // array of coutries ids, operator is not supported "timezone": [ 189, 90 ], // array of timezones ids, operator is not supported "leadFile": [ 29, 31 ], // array of lead files ids, operator is not supported "original_trunk_id": [ 2 ], // array of trunks ids, operator is not supported "callsType": [ 6, 4 ], // array of call types ids, operator is not supported // Allowed call types: // PHONEBOOK: 2 // MANUAL_CALL: 3 // INCOMING: 4 // PROGRESSIVE: 5 // PREDICTIVE: 6 // MISSED_CALL: 7 // INTERNAL_CALL: 8 "weight": "0;>|999;<=", "bill_duration": "3;>=", "duration": "5;>|9999;<", "original_identifier": "1;>=|9;<", "first_name": "test", "last_name": "test", "phone_normalized": "4454544778787", "phone_normalized2": "4454544778787", "support_site": "test", "purchase_site": "test", "purchase_date": "2025-01-01 00:00:00;<", "purchase_amount": "test", "purchase_product_name": "test", "purchase_card_name": "test", "purchase_card_type": "test", "purchase_card_digits": "123", "email": "test@test.com", "birthdate": "1020-01-01 00:00:00;>=;|2050-01-01 00:00:00;<;", "loan_amount": "50;>|999;<", "address1": "test", "address2": "test", "hlr": "1", "state": "test", "city": "test", "zip": "test", "assigned_user_permanent": "test", "no_ratio": "1", "lead_id": "123;>|9999;<=" } ``` - `order` (string): Specifies the order in which the aggregated CDRs should be presented. The field must be selected on group or fields values Example: `"campaignd;desc"` - `limit` (integer): Specifies the maximum number of aggregated CDRs to return. Example: `100` - `offset` (integer): Specifies the offset for paginating through the aggregated CDRs. Example: `0` #### Response The response will include the aggregated CDRs based on the provided parameters.Example: ``` json [ { "campaign_id": 22, "caller_user_id": 3, "status": "NORMAL_CLEARING", "status_id_before": "answered", "status_id_after": "answered", "campaign_lead_weight": 3948, "object_id": 125673, "lead_id": 98059, "period": "2024 06 27 14", "total": "1", "successful": "1", "call_duration": "0:00:05", "call_bill_duration": "0:00:04", "acd": "00:00:04(in 1 calls)", "asr": "100% (in 1 of 1 calls)", "cost": 0, "transfer_duration": "0", "conference_duration": "0", "transfer_cost": 0, "conference_cost": 0, "total_transfer": "0", "assigned_user_permanent": "0", "call_agent_duration": "0" }, { "campaign_id": 22, "caller_user_id": 3, "status": "NORMAL_CLEARING", "status_id_before": "answered", "status_id_after": "answered", "campaign_lead_weight": 3948, "object_id": 139075, "lead_id": 84657, "period": "2024 06 27 14", "total": "1", "successful": "1", "call_duration": "0:00:38", "call_bill_duration": "0:00:36", "acd": "00:00:36(in 1 calls)", "asr": "100% (in 1 of 1 calls)", "cost": 0, "transfer_duration": "0", "conference_duration": "0", "transfer_cost": 0, "conference_cost": 0, "total_transfer": "0", "assigned_user_permanent": "0", "call_agent_duration": "38" } ] ``` - [Get devices list](https://docs.commpeak.com/reference/getdeviceslist.md): Use the Get devices list to get the list of available devices in the dialer. - [Update device](https://docs.commpeak.com/reference/updatedevice.md): Use the Update device API request if you want to update an existing device from the dialer. You should send the following fields in the body request: #### Request Body - `extension` (string, optional): The extension of the device. - `name` (string, optional): The name of the device. #### Response The response will be an array of devices with the following properties: - `id` (string): The unique identifier of the device. - `name` (string): The name of the device. - `extension` (string): The extension of the device. - `password` (string): The password of the device. - `created_at` (string): The timestamp of when the device was created. - `updated_at` (string): The timestamp of when the device was last updated. - `login_user_id` (string): The user ID associated with the device's login. - `last_login` (string, null): The timestamp of the device's last login, or null if not available. - [Create Device](https://docs.commpeak.com/reference/createdevice.md): Use the Create device API method if you want to create a new device from scratch. You should send the following fields in the request body: #### Request Body - `extension` (string, optional): The extension of the device. - `name` (string, optional): The name of the device. #### Response Upon successful creation, the response will include an array of devices, each containing the following details: - `id` (string): The unique identifier of the device. - `name` (string): The name of the device. - `extension` (string): The extension of the device. - `password` (string): The password of the device. - `created_at` (string): The date and time when the device was created. - `updated_at` (string, nullable): The date and time when the device was last updated. - `login_user_id` (string): The unique identifier of the user who last logged in to the device. - `last_login` (string, nullable): The date and time of the last login to the device. - [Get device](https://docs.commpeak.com/reference/getdevice.md): The Get device API method allows you to retrieve a device specified by the device id. You should send the device id as a variable in the request. - [Delete device](https://docs.commpeak.com/reference/deletedevice.md): Use the Delete device API endpoint if you want to remove a device specified by the device id. You should send the device id as a variable. - [Get Call Center Regions](https://docs.commpeak.com/reference/getcallcenterregions.md): Use the Get Call Center Regions PBX domains available. - [Overview](https://docs.commpeak.com/reference/cloud_pbx_overview.md): The CommPeak Cloud PBX API allows businesses to control various aspects of call center operations, including call routing, user accounts, extensions, and device settings. - [Core API Concepts](https://docs.commpeak.com/reference/core-api-concepts-pbx.md) - [Get all calls](https://docs.commpeak.com/reference/getallcalls-1.md): The GET all calls API allows you to retrieve the calls made from the PBX. You can apply various request parameters as filters to segment and limit the number of records. ### Parameters - `id` : Integer - `object_type_id` : Integer - `caller_user_id` : Integer - `start_at` : DateTime URL encoded format 2020-09-01T00:00:00 - `end_at` : DateTime URL encoded format 2020-09-01T00:00:00 - `src` : String - `dst` : String - `call_uuid` : String - `agent_callerid_name` : String - `agent_callerid_number` : String - `agent_hangup_disposition` : String - `client_callerid_name` : String - `client_callerid_number` : String - `client_hangup_disposition` : String - `call_duration` : Integer - `call_bill_duration` : Integer - `status` : String - `record_file` : String - `created_at` : DateTime URL encoded format 2020-09-01T00:00:00 - `q850` : String - `beep_detected` : Boolean - `sip_term_status` : String - `cost` : String - [Get specific call](https://docs.commpeak.com/reference/getspecificcall-1.md): ### Retrieve Call Details This endpoint retrieves details of a specific call identified by the provided `id`. ### Parameters - `id` : Integer - [Get specific call's record file](https://docs.commpeak.com/reference/getspecificcallsrecordfile-1.md): This method allows you to retrieve the recording file of a specific call to listen to it. ### Parameters - `id` : Integer - [Call](https://docs.commpeak.com/reference/call-1.md): # Click2Call [Click2Call](https://td.commpeak.link/C2C) will initiate a call to the agent's extension. After the agent answers, we will initiate a call to your destination according to your outbound routing setups. ### Path Parameters - `c2c_id` (string): The unique identifier for your c2c setup. - `leg_a` (string): Agent extension (caller) - `leg_b` (string): Destination’s phone number (callee) - `route_number` (string): Outbound calls prefix (default prefix is ‘00’). For example: \*01 \*This prefix must match the existing prefix configured at the dial pattern on the [Manual Dialing Routes](https://td.commpeak.link/outbound-routs) - [Get all users](https://docs.commpeak.com/reference/getallusers-1.md): This endpoint makes an HTTP GET request to retrieve a list of users. The response is in JSON format and includes an array of user objects, each containing various attributes such as id, username, email, registration password, and other user-related information. - [Create User](https://docs.commpeak.com/reference/createuser-1.md): ### Add User This endpoint allows the client to add a new user by sending a POST request to the specified URL. #### Request Body - `username` (string): The username of the user. - `password` (string): The password for the user account. - `email` (string): The email address of the user. - `sip_option` (string): The SIP option for the user. - `is_active` (string): Indicates whether the user account is active. - `reset_password` (string): Indicates whether the user should reset their password. - `sip_uri` (string): The SIP URI for the user. - `use_extended_ip_acl` (string): Indicates the usage of extended IP ACL. - `user_route_caller_id` (string): The caller ID for user routing. - `member_all_desks` (string): Indicates membership to all desks. - `desks` (array): An array of desks associated with the user. - `roles` (array): An array of roles assigned to the user. - [Get user](https://docs.commpeak.com/reference/getuser-1.md): ### Get User Details This endpoint retrieves the details of a specific user based on the provided user ID. #### Response The response will contain an array of user objects, with each object including the following properties: - `id` (string): The unique identifier of the user. - `username` (string): The username of the user. - `email` (string): The email address of the user. - `registration_password` (string): The registration password of the user. - `is_active` (string): Indicates whether the user is active. - `is_clockedin` (string): Indicates whether the user is clocked in. - `sip_uri` (string): The SIP URI of the user. - `auto_dial` (string): Indicates the auto-dial status of the user. - `is_deleted` (string): Indicates whether the user is deleted. - `use_extended_ip_acl` (string): Indicates the usage of extended IP ACL. - `timezone_id` (string): The timezone ID of the user. - `use_webrtc` (string): Indicates the usage of WebRTC. - `first_name` (string): The first name of the user. - `last_name` (string): The last name of the user. - `virtual_extension` (string): The virtual extension of the user. - `default_language` (string): The default language of the user. - `max_session_time` (string): The maximum session time allowed for the user. - `max_concurrent_sessions` (string): The maximum concurrent sessions allowed for the user. - `twofa_type` (string): The two-factor authentication type of the user. - `member_all_desks` (string): Indicates whether the user is a member of all desks. - `desks` (array): An array of desks associated with the user. - `roles` (object): An object containing the roles assigned to the user. - `groups` (array): An array of groups associated with the user. - [Update User](https://docs.commpeak.com/reference/updateuser-1.md): ### Update User Details This endpoint allows the client to update the details of a specific user. #### Request Body Parameters - `id` (number): The unique identifier of the user. - `username` (string): The username of the user. - `email` (string): The email address of the user. - `is_active` (number): Indicates if the user is active. - `sip_uri` (string): The SIP URI of the user. - `is_deleted` (number): Indicates if the user is deleted. - `use_extended_ip_acl` (number): Indicates if the user uses extended IP ACL. - `timezone_id` (number): The timezone identifier for the user. - `first_name` (string): The first name of the user. - `last_name` (string): The last name of the user. - `virtual_extension` (string): The virtual extension of the user. - `default_language` (string): The default language for the user. - `en_US` - English (United States) - `es_ES` - Spanish (Spain) - `pt_BR` - Portuguese (Brazil) - `max_session_time` (string): The maximum session time for the user. - `max_concurrent_sessions` (string): The maximum concurrent sessions for the user. - `twofa_type` (string): The two-factor authentication type for the user. - `default` - Default from Role / Tenant - `disabled` - Disabled - login without 2FA - `email` - Email - with one-time code - `google` - Google 2FA App - with one-time code - `member_all_desks` (string): Indicates if the user is a member of all desks. - `use_webrtc` (number): Indicates if the user uses WebRTC. - [Delete User](https://docs.commpeak.com/reference/deleteuser-1.md): This endpoint is used to delete a specific user by their ID. - [Get Breaks](https://docs.commpeak.com/reference/getbreaks-1.md): Get Breaks - [Get Users Breaks](https://docs.commpeak.com/reference/getusersbreaks-1.md): Get Users Breaks - [Get desks](https://docs.commpeak.com/reference/getdesks-1.md): ### Get User Desks Use Get desks if you want to retrieve the list of desks avaialble. - [Create desk](https://docs.commpeak.com/reference/createdesk-1.md): ### Create a New Desk This endpoint allows you to create a new desk. #### Request Body - `name` (string, required): The name of the desk. - `userIds` (array, required): An array of user IDs associated with the desk. #### Response Body The response will contain a JSON object with the following properties: - `userDesk` - `id` (string): The ID of the created desk. - `name` (string): The name of the desk. - `userIds` (array): An array of user IDs associated with the desk. - [Update desk](https://docs.commpeak.com/reference/updatedesk-1.md): ### Update Desk Details This endpoint allows the client to update the details of a specific desk. #### Request Body - `name` (string, optional): The updated name of the desk. - `userIds` (array): An array of user IDs associated with the desk. - [Desk Breaks](https://docs.commpeak.com/reference/deskbreaks-1.md): Desk Breaks - [Get User roles](https://docs.commpeak.com/reference/getuserroles.md): ### Get Roles This endpoint retrieves a list of roles. #### Response The response is a JSON object with a `roles` array containing objects with the following properties: - `id` (string): The ID of the role. - `name` (string): The name of the role. - `level` (string): The level of the role. - `twofa_type` (string): The type of two-factor authentication associated with the role. - `userIds` (array of strings): An array of user IDs associated with the role. - [Get User role](https://docs.commpeak.com/reference/getuserrole-1.md): # Get Role Details This endpoint retrieves details of a specific role identified by its ID. - [Update User role](https://docs.commpeak.com/reference/updateuserrole-1.md): ### Update Role Details This endpoint allows the client to update the details of a specific role. #### Request Body - `name` (string, required): The name of the role. - `level` (string, required): The level of the role. - `twofa_type` (string, required): The type of two-factor authentication associated with the role. - `userIds` (array of integers, required): An array of user IDs associated with the role. - [Get all logs](https://docs.commpeak.com/reference/getalllogs-1.md): ### GET Audit logs This endpoint retrieves audit logs, starting from the 0th index, within a specified time range. #### Request - Parameters - from (string, required): The start date and time for the logs retrieval. - till (string, required): The end date and time for the logs retrieval. The response will contain an array of log objects, each with an ID, creation timestamp, user ID, message, object type, and object ID. - [Get logs object types](https://docs.commpeak.com/reference/getlogsobjecttypes-1.md): Get logs object types - [Get api logs](https://docs.commpeak.com/reference/getapilogs-1.md): # API Logs Filter This endpoint retrieves API logs based on specified filters. ### Parameters - `filter_from` (string): Start date for filtering logs. - `filter_till` (string): End date for filtering logs. - `filter_api_user_id` (string): User ID for filtering logs. - `filter_action` (string): Action for filtering logs. - `filter_method` (string): HTTP method for filtering logs. - `filter_response_code` (string): HTTP response code for filtering logs. - [Send Speech with callback URL](https://docs.commpeak.com/reference/sendspeechwithcallbackurl-1.md): This endpoint allows you to search and send calls for speech recognition based on various input filters (like duration, language, phrase, and more), and if transcription is complete, the results are sent automatically to your callback URL. It supports dynamic placeholders in the callback data to include call, speech, and user. The response initially provides a speech request ID and call IDs, while the full speech results are sent later to the callback URL. ### Expected Input - `callback_url`: (string) The URL where the callback will be sent. (mandatory) - `callback_method`: (string) The HTTP method for the callback request. options: POST, PUT. (mandatory) - `callback_data`: (string) The data of the callback response action, JSON with placeholders. (mandatory) - `token` (string) - `min_duration` (integer) - `max_duration` (integer) - `call_status` (string) - `from` (DateTime) - `till` (DateTime) - `language` (string) - `phrase` (string) - `summary` (string) - `rank_description` (string) - `rank_min` (Integer 0-100) - `rank_max` (Integer 0-100) - `limit` (integer) Allowed placeholders for `callback_data`: Speech-related: \- {speech_result} - Speech result \- {speech_phrases} - Array of Speech phrases \- {speech_task_state} - Speech task's current state \- {speech_summary} - Text Summary of the call \- {speech_rank} - Rank of the call between 0 to 100 \- {speech_rank_description} - Text of the speech recognition rank description Call-related: \- {call_id} - Call Id \- {caller_user_id} - Caller User Id \- {caller_username} - Caller username \- {start_at} - Call Start At \- {end_at} - Call End At \- {agent_callerid_name} - Agent Caller Id name \- {agent_callerid_number} - Agent Caller Id number \- {call_duration} - Call duration \- {call_bill_duration} - Call bill duration ### Expected Output The response will be in JSON format and may include a `speechRequestId` and `callIds` object containing the details of calls that initiate to speech recognition service. while speech transcript will be ready, the request will initiate to your `callback_url` ****Important:** The token used to create the speech transcription for a call will be the only token authorized to retrieve the speech recognition results. - [Send to speech recognition](https://docs.commpeak.com/reference/sendtospeechrecognition-1.md): This endpoint retroactively sends existing calls that have not yet been transcribed to the speech recognition service. You provide arrays of call IDs, campaign lead IDs, or lead IDs along with optional parameters like languages, minimum duration, and recording side (lead, agent, or both). The service then processes these calls for transcription and returns a JSON response detailing the completed calls that were sent for transcription. #### Request Body - `call_ids` (array) - An array of call IDs. - `token` (string) - The token for authentication. - `languages` (array) - An array of languages. - `min_duration` (interger) - The minimum duration for the recording. - `recording_side` (string) - The side of the recording. caller, callee, both. The response is a JSON object with nested properties. It includes details of completed calls for the specified leads and campaign leads. ****Important:** The token used to create the speech transcription for a call will be the only token authorized to retrieve the speech recognition results. - [Get Speech for call id](https://docs.commpeak.com/reference/getspeechforcallid-1.md): Use the Get speech for call id if you want to get the transcription of call, specified by the call id. You should send the call id as a variable in the request. #### Response Body - `data` (object) - `remote_identifier` (string): Remote identifier. - `created_at` (string): Date and time of creation. - `language` (string): Language used in the call. - `plain_body` (string): Plain body of the call. - `sentiment` (float): call rank (score) between 0 - 1. assess the quality and value of the call. - `summary` (String): AI Summary analyzes call transcripts to generate concise summaries. - `phrases` (array): Array of phrases detected in the call. - `phrase` (string): Detected phrase. - `start_at` (integer): Start time of the phrase. - `end_at` (integer): End time of the phrase. - `channel` (integer): Channel of the phrase. - `metadata` (object) - `channel_id` (string): fetch calls that created for specific speech channel. - `status` (string): Status of the call. - `message` (string): Additional message related to the call. ****Important:** The token used to create the speech transcription for a call will be the only token authorized to retrieve the speech recognition results. - [Get all language](https://docs.commpeak.com/reference/getalllanguage-1.md): The Get all language API method enables you to get the list of languages supported by the speech to text service. - [Get Route Caller IDs](https://docs.commpeak.com/reference/getroutecallerids-1.md): This endpoint makes an HTTP GET request to retrieve the caller IDs associated with a specific route. The request does not require a request body as it is a GET request. The response will include an array of caller IDs along with their associated details. ### Response Body The response will be in JSON format with a status code of 200. It will contain an array of caller IDs, where each caller ID object includes the following properties: - `id` (string): The unique identifier for the caller ID. - `caller_id_name` (string): The name associated with the caller ID. - `caller_id_number` (string): The phone number associated with the caller ID. - `created_at` (string): The timestamp indicating when the caller ID was created. - `is_active` (string): Indicates whether the caller ID is currently active. - [Enable/Disable Route CallerID](https://docs.commpeak.com/reference/enabledisableroutecallerid-1.md): ### Update Route Caller IDs This endpoint allows the user to update route caller IDs by sending an HTTP PUT request to the specified URL. #### Request Body - `id` (string) - The ID of the caller to be updated. - `action` (string) - The action to be performed on the caller ID. Enable `1`, Disable `0` - [Create Route CallerID](https://docs.commpeak.com/reference/createroutecallerid-1.md): ### Add Route Caller ID This endpoint allows you to add a new caller ID for routing purposes. #### Request Body - `caller_id_name` (string, optional): The name of the caller ID. - `caller_id_number` (string, optional): The number of the caller ID. - `is_active` (string, optional): Indicates if the caller ID is active. #### Response The response will contain the status of the request to add the caller ID. - [Get Route CallerID](https://docs.commpeak.com/reference/getroutecallerid-1.md): ### Get Route Caller IDs This endpoint retrieves the details of a specific route caller ID. #### Request Parameters - `id` (path parameter) : The ID of the route caller ID. for all, just set `null`. - [Delete Route CallerID](https://docs.commpeak.com/reference/deleteroutecallerid-1.md): ### Delete Route Caller ID This endpoint is used to delete a specific route caller ID. #### Request Parameters - `id` (path parameter) : The ID of the route caller ID to be deleted. #### Response The response will not contain a message body. A 204 No Content status code will be returned upon successful deletion. - [Get all CDRs](https://docs.commpeak.com/reference/getallcdrs-1.md): Use the Get all CDRs if you want to get a list of all CDRs available in your dialer. Apply various request parameters as filters to segment and limit the number of records. #### Request Body This is a GET request and does not require a request body. You can filter by any parameter that you get in the response. In addition, use `fields` with wanted fields to ensure you get specific fields in the response. #### Response Body The response will contain an array of CDR objects. Each CDR object includes the following parameters: - `start_at` (string) - The start time of the call - `end_at` (string) - The end time of the call - `src` (string) - The source of the call - `dst` (string) - The destination of the call - `call_uuid` (string) - The unique identifier of the call - `client_callerid_name` (string) - The name of the caller - `client_callerid_number` (number) - The caller's phone number - `call_duration` (number) - The duration of the call - `call_bill_duration` (number) - The billed duration of the call - `status` (string) - The status of the call - `q850` (string) - Q850 status - `caller_user_id` (string) - The ID of the caller user - `client_hangup_disposition` (string) - The disposition of the client hangup - `campaign_lead_id` (number) - The ID of the campaign lead - `assigned_user_id` (number) - The ID of the assigned user - `cost` (float) - CDR rate cost. In case there are no CDRs available, an empty array will be returned. - [Aggregate CDRs](https://docs.commpeak.com/reference/aggregatecdrs-1.md): ### Aggregate CDRs This endpoint allows you to aggregate Call Detail Records (CDRs) based on specified parameters. #### Request Body - `group` (string): Specifies the fields to group the CDRs by. **Required** Example: ``` "user;call status;duration;hangup;destination;caller_id;q850;sip termination status;extension number;transfer to;conference to;trunk" ``` - `fields` (string): Specifies the fields to include in the aggregated CDRs. **Example:** ``` "user;call status;duration;hangup;destination;caller_id;q850;sip termination status;extension number;transfer to;conference to;trunk;total calls;successful calls;total duration;total bill duration;ACD;ASR;cost;transfer duration;conference duration;transfer cost;conference cost;total transfer;call agent duration" ``` - `period` (string): Specifies the time period for aggregation. Example: `"year;month;day;hour"` - `filter` (object): Contains the filter criteria for aggregating the CDRs. **Required (strat_at & end_at)** Example: ``` json { "start_at": "2020-01-01 00:00:00", // required, operator is not supported "end_at": "2025-01-01 00:00:00", // required, operator is not supported "destination": ["12","464646466465"], // single value or array, operator is not supported "caller_id": ["4565654654"], // single value or array, operator is not supported "callAttributes": ["Conference","Transfer"], // array, operator is not supported "user": [2,3], // array of users ids, operator is not supported "original_trunk_id": [2], // array of trunks ids, operator is not supported "callsType": [6,4], // array of call types ids, operator is not supported // Allowed call types: // PHONEBOOK: 2 // MANUAL_CALL: 3 // INCOMING: 4 // MISSED_CALL: 7 // INTERNAL_CALL: 8 "bill_duration": "3;>=" ,"duration": "5;>|9999;<" } ``` - `order` (string): Specifies the order in which the aggregated CDRs should be presented. The field must be selected on group or fields values Example: `"user;desc"` - `limit` (integer): Specifies the maximum number of aggregated CDRs to return. Example: `100` - `offset` (integer): Specifies the offset for paginating through the aggregated CDRs. Example: `0` #### Response The response will include the aggregated CDRs based on the provided parameters.Example: ``` json [ { "caller_user_id": 0, "status": "CALL_REJECTED", "client_hangup_disposition": "system", "dst": "*********024", "client_callerid_number": "2222102778", "q850": "Call rejected", "sip_term_status": 603, "src": "", "transfer_to": "", "conference_to": "", "trunk": "", "period": "2023 11 12", "total": "1", "successful": "0", "call_duration": "00:00:00", "call_bill_duration": "00:00:00", "acd": "0 (in 0 calls)", "asr": "0% (in 0 of 1 calls)", "cost": 0, "transfer_duration": "0", "conference_duration": "0", "transfer_cost": null, "conference_cost": null, "total_transfer": "0", "call_agent_duration": "0" }, { "caller_user_id": 0, "status": "USER_BUSY", "client_hangup_disposition": "system", "dst": "*********968", "client_callerid_number": "447893930499", "q850": "User busy", "sip_term_status": 486, "src": "", "transfer_to": "", "conference_to": "", "trunk": "", "period": "2024 06 27", "total": "1", "successful": "0", "call_duration": "0:00:05", "call_bill_duration": "00:00:00", "acd": "0 (in 0 calls)", "asr": "0% (in 0 of 1 calls)", "cost": 0, "transfer_duration": "0", "conference_duration": "0", "transfer_cost": 0, "conference_cost": 0, "total_transfer": "0", "call_agent_duration": "0" } ] ``` - [Get devices list](https://docs.commpeak.com/reference/getdeviceslist-1.md): This endpoint makes an HTTP GET request to retrieve a list of devices from the server. ### Response The response will have a status code of 200 and a content type of application/json. The response body will contain an array of "devices" where each device object includes the following properties: - id (string): The unique identifier of the device. - name (string): The name of the device. - extension (string): The extension of the device. - password (string): The password of the device. - created_at (string): The timestamp indicating when the device was created. - updated_at (string): The timestamp indicating when the device was last updated. - login_user_id (string or null): The ID of the user who last logged into the device, or null if no user has logged in. - last_login (string or null): The timestamp indicating the last login time, or null if the device has not been logged into. - [Update device](https://docs.commpeak.com/reference/updatedevice-1.md): Update device - [Create Device](https://docs.commpeak.com/reference/createdevice-1.md): ### Create Device This endpoint allows you to create a new device. #### Request Body - `extension` (string, optional): The extension of the device. - `name` (string, optional): The name of the device. #### Response Upon successful creation, the response will include an array of devices, each containing the following details: - `id` (string): The unique identifier of the device. - `name` (string): The name of the device. - `extension` (string): The extension of the device. - `password` (string): The password of the device. - `created_at` (string): The date and time when the device was created. - `updated_at` (string, nullable): The date and time when the device was last updated. - `login_user_id` (string): The unique identifier of the user who last logged in to the device. - `last_login` (string, nullable): The date and time of the last login to the device. - [Get device](https://docs.commpeak.com/reference/getdevice-1.md): Get device - [Delete device](https://docs.commpeak.com/reference/deletedevice-1.md): Delete device - [Get Call Center Regions](https://docs.commpeak.com/reference/getcallcenterregions-1.md): Use the Get Call Center Regions PBX domains available. - [Overview](https://docs.commpeak.com/reference/pbx-stats-api.md) - [Ongoing CDRs](https://docs.commpeak.com/reference/ongoingcdrs.md): List Ongoing Calls API - [Search CDRs](https://docs.commpeak.com/reference/searchcdrs.md): Search CDRs API - [Whisper Call](https://docs.commpeak.com/reference/whispercall.md): Whisper Call API - [Hangup Call](https://docs.commpeak.com/reference/hangupcall.md): Hangup Call API - [List Prefixes](https://docs.commpeak.com/reference/listprefixes.md): List prefixes API - [List Pause Types](https://docs.commpeak.com/reference/listpausetypes.md): List all Pause Types API - [List Desks](https://docs.commpeak.com/reference/listdesks.md): List Desks API - [List Desks With IDs](https://docs.commpeak.com/reference/listdeskswithids.md): List Desks With IDs API - [List Agents](https://docs.commpeak.com/reference/listagents.md): List all agents from your PBX Stats instance - [Agent Statistics](https://docs.commpeak.com/reference/agentstatistics.md): Agent Statistics API - [Add Agent](https://docs.commpeak.com/reference/addagent.md): Add Agent API - [Edit Agent](https://docs.commpeak.com/reference/editagent.md): Edit Agent Details API - [Pause Agent](https://docs.commpeak.com/reference/pauseagent.md): Pause Agent API - [UnPause Agent](https://docs.commpeak.com/reference/unpauseagent.md): UnPause Agent API - [Delete Agent](https://docs.commpeak.com/reference/deleteagent.md): Delete Agent API - [Add Device](https://docs.commpeak.com/reference/adddevice.md): Add Device API - [Overview](https://docs.commpeak.com/reference/portal-api-overview.md) - [Get customer info](https://docs.commpeak.com/reference/customer_details.md): get information about customer like email, voice balance, sms balance - [Search current voice rates](https://docs.commpeak.com/reference/search_current_voice_rates.md): search voice rates for customer for certain phone prefix - [Download voice rates](https://docs.commpeak.com/reference/download_voice_rates.md): download voice rates as CSV or XLS for the given tech prefix - [Show voice rates](https://docs.commpeak.com/reference/call_plan_voice_rates.md): show all voice rates for customer for certain call plan's tech prefix - [Search voice rates](https://docs.commpeak.com/reference/search_voice_rates_for_call_plan.md): search voice rates for customer for certain phone prefix for call plan's tech prefix - [Show current voice rates](https://docs.commpeak.com/reference/current_voice_rates.md): show all current voice rates for customer - [Get SMS rates](https://docs.commpeak.com/reference/sms_rates.md): get customer sms rates for certain sms channel - [Get speech result](https://docs.commpeak.com/reference/speech_recognition_result.md): get the state and result of a previously submitted speech recognition task - [Create speech task](https://docs.commpeak.com/reference/create_speech_recognition_task.md): submit an audio recording for speech recognition - [List SIP accounts](https://docs.commpeak.com/reference/list_sip_accounts.md): list the customer's active SIP accounts - [List DID numbers](https://docs.commpeak.com/reference/list_did_numbers.md): list the customer's operational DID numbers - [List origination CDRs](https://docs.commpeak.com/reference/origination_call_records.md): list inbound (origination) call records, paginated - [List termination CDRs](https://docs.commpeak.com/reference/termination_call_records.md): list outbound (termination) call records, paginated - [Overview](https://docs.commpeak.com/reference/lookup-api-overview.md) - [Get Token Info](https://docs.commpeak.com/reference/gettokeninfo.md): Get Token Info API - [Sync Request](https://docs.commpeak.com/reference/syncrequest.md): Sync Request API - [Async Request](https://docs.commpeak.com/reference/asyncrequest.md): Async Request API - [Async Upload](https://docs.commpeak.com/reference/asyncupload.md): Async Upload API - [Get Result](https://docs.commpeak.com/reference/getresult.md): Get Result API - [Get Metadata](https://docs.commpeak.com/reference/getmetadata.md): Get Metadata API - [Download Result](https://docs.commpeak.com/reference/downloadresult.md): Download Result API - [Search Results](https://docs.commpeak.com/reference/searchresults.md): Search Results API - [Overview](https://docs.commpeak.com/reference/textpeak-api-overview.md) - [Get messages](https://docs.commpeak.com/reference/getmessages.md): List sent (outgoing) messages for your account, newest first. Supports pagination and filtering by stream, status, recipient, and date range. **Authentication:** TextPeak API key in the `Authorization` header (see **Authentication** in the API Overview). - [Get incoming messages](https://docs.commpeak.com/reference/getincomingmessages.md): List incoming (inbound) messages for your account, newest first. Supports pagination and filtering by stream, sender, destination, and date range. **Authentication:** TextPeak API key in the `Authorization` header (see **Authentication** in the API Overview). - [Get all streams](https://docs.commpeak.com/reference/getallstreams.md): List all streams in your account. **Authentication:** TextPeak API key in the `Authorization` header (see **Authentication** in the API Overview). - [Add stream](https://docs.commpeak.com/reference/addstream.md): Create a new stream. `name` is required; other fields are optional and depend on the stream `type`. **Authentication:** TextPeak API key in the `Authorization` header (see **Authentication** in the API Overview). - [Get stream](https://docs.commpeak.com/reference/getstream.md): Retrieve a single stream by its ID. **Authentication:** TextPeak API key in the `Authorization` header (see **Authentication** in the API Overview). - [Update stream](https://docs.commpeak.com/reference/updatestream.md): Update an existing stream. Only the fields you send are changed. **Authentication:** TextPeak API key in the `Authorization` header (see **Authentication** in the API Overview). - [Delete stream](https://docs.commpeak.com/reference/deletestream.md): Permanently delete a stream. This cannot be undone. **Authentication:** TextPeak API key in the `Authorization` header (see **Authentication** in the API Overview). - [Get stream token](https://docs.commpeak.com/reference/getstreamtoken.md): Retrieve the stream token for a stream. This token authenticates the messaging endpoints (`simple_send`, `template_send`, …) for that stream — see the token types in the API Overview. **Authentication:** TextPeak API key in the `Authorization` header (see **Authentication** in the API Overview). - [Reset token](https://docs.commpeak.com/reference/resettoken.md): Rotate the stream token: invalidate the current token and generate a new one. Any client using the old token must be updated. **Authentication:** TextPeak API key in the `Authorization` header (see **Authentication** in the API Overview). - [Get All Domains](https://docs.commpeak.com/reference/getalldomains.md): List all domains in your account. **Authentication:** TextPeak API key in the `Authorization` header (see **Authentication** in the API Overview). - [Add domain](https://docs.commpeak.com/reference/adddomain.md): Register a new domain. Only `name` is required; the assigned `ip` is returned for you to configure DNS. **Authentication:** TextPeak API key in the `Authorization` header (see **Authentication** in the API Overview). - [Archive/Unarchive domain](https://docs.commpeak.com/reference/archiveunarchivedomain.md): Archive or unarchive a domain. Send `archive: true` to archive, or `archive: false` to restore it. **Authentication:** TextPeak API key in the `Authorization` header (see **Authentication** in the API Overview). - [Get domain](https://docs.commpeak.com/reference/getdomain.md): Retrieve a single domain by its ID. **Authentication:** TextPeak API key in the `Authorization` header (see **Authentication** in the API Overview). - [Delete domain](https://docs.commpeak.com/reference/deletedomain.md): Permanently delete a domain. This cannot be undone; to disable a domain without losing configuration, archive it instead. **Authentication:** TextPeak API key in the `Authorization` header (see **Authentication** in the API Overview). - [Get all senders](https://docs.commpeak.com/reference/getallsenders.md): List all sender identities in your account. **Authentication:** TextPeak API key in the `Authorization` header (see **Authentication** in the API Overview). - [Add sender](https://docs.commpeak.com/reference/addsender.md): Create a new sender identity. Both `name` and `value` are required. New senders may require approval before use. **Authentication:** TextPeak API key in the `Authorization` header (see **Authentication** in the API Overview). - [Get sender](https://docs.commpeak.com/reference/getsender.md): Retrieve a single sender by its ID. **Authentication:** TextPeak API key in the `Authorization` header (see **Authentication** in the API Overview). - [Update sender name](https://docs.commpeak.com/reference/updatesendername.md): Update a sender. Only `name` can be changed; `value` is set at creation and is immutable. **Authentication:** TextPeak API key in the `Authorization` header (see **Authentication** in the API Overview). - [Delete sender](https://docs.commpeak.com/reference/deletesender.md): Permanently delete a sender identity. **Authentication:** TextPeak API key in the `Authorization` header (see **Authentication** in the API Overview). - [Get all stream event templates](https://docs.commpeak.com/reference/getallstreameventtemplates.md): List all event templates in your account. **Authentication:** TextPeak API key in the `Authorization` header (see **Authentication** in the API Overview). - [Create stream event template](https://docs.commpeak.com/reference/createstreameventtemplate.md): Create a reusable event template. `name` and `eventKey` are required; trigger it later by passing `eventKey` as `event` on the send endpoints. **Authentication:** TextPeak API key in the `Authorization` header (see **Authentication** in the API Overview). - [Get stream event template](https://docs.commpeak.com/reference/getstreameventtemplate.md): Retrieve a single event template by its ID. **Authentication:** TextPeak API key in the `Authorization` header (see **Authentication** in the API Overview). - [Update stream event template](https://docs.commpeak.com/reference/updatestreameventtemplate.md): Update an event template. Only the fields you send are changed. **Authentication:** TextPeak API key in the `Authorization` header (see **Authentication** in the API Overview). - [Delete stream event template](https://docs.commpeak.com/reference/deletestreameventtemplate.md): Permanently delete an event template. **Authentication:** TextPeak API key in the `Authorization` header (see **Authentication** in the API Overview). - [Get all webhooks](https://docs.commpeak.com/reference/getallwebhooks.md): List all webhooks in your account. **Authentication:** TextPeak API key in the `Authorization` header (see **Authentication** in the API Overview). - [Create Webhook](https://docs.commpeak.com/reference/createwebhook.md): Register a webhook to receive event callbacks. `name`, `url`, `headers`, and `retries` are required. **Authentication:** TextPeak API key in the `Authorization` header (see **Authentication** in the API Overview). - [Get webhook](https://docs.commpeak.com/reference/getwebhook.md): Retrieve a single webhook by its ID. **Authentication:** TextPeak API key in the `Authorization` header (see **Authentication** in the API Overview). - [Update webhook](https://docs.commpeak.com/reference/updatewebhook.md): Update a webhook. Only the fields you send are changed. **Authentication:** TextPeak API key in the `Authorization` header (see **Authentication** in the API Overview). - [Delete webhook](https://docs.commpeak.com/reference/deletewebhook.md): Permanently delete a webhook. **Authentication:** TextPeak API key in the `Authorization` header (see **Authentication** in the API Overview). - [simple_send](https://docs.commpeak.com/reference/simplesend.md): Send one or more SMS messages in a single request. Each message is queued and delivered independently, so a batch can partially succeed — always inspect every item in the response. **Sender modes** — pick one: - **Batch:** set one top-level `sender` for the whole request and omit `sender` on each message. - **Mixed:** omit the top-level `sender` and set a `sender` on **every** message. - **Batch size:** up to 250 messages per request. - **Correlation:** set a unique `internal_id` per message; it is echoed back in the response and in delivery webhooks, and it keys any per-message error. - **Response:** a batch `task_id` plus, per message, a `message_uuid` and `conversation_uuid`. Final delivery status is sent asynchronously to your configured webhook. - **Partial failures** are reported inline on the offending message (`error` code + `details`). **Authentication:** stream token in the `Authorization` header (see **Authentication** in the API Overview). - [single_simple_send](https://docs.commpeak.com/reference/singlesimplesend.md): Send a single SMS message in one request. The body is a flat object — ideal for transactional, one-off messages. For high volume, use `simple_send` to batch up to 250 messages per call. Set a unique `internal_id` to correlate the message with delivery webhooks. The response returns a `task_id` and the assigned `message_uuid`/`conversation_uuid`. **Authentication:** stream token in the `Authorization` header (see **Authentication** in the API Overview). - [template_send - SMS](https://docs.commpeak.com/reference/templatesendsms.md): Send a templated SMS to one or more recipients. Provide the message text once in `message_template` using `[placeholder]` tokens, then supply each recipient's values in `template_variables`. - Set a default `sender` at the top level; override it per recipient if needed. - Up to 250 recipients per request. - Returns a batch `task_id` plus per-message identifiers; partial failures are reported inline. **Authentication:** stream token in the `Authorization` header (see **Authentication** in the API Overview). - [template_send - Whatsapp](https://docs.commpeak.com/reference/templatesendwhatsapp.md): Trigger a preconfigured event template for one or more recipients. Identify the template with `event` and pass each recipient's values in `template_variables`. **Modes** — pick one: - **Batch:** set top-level `sender` and `event`; omit them on each recipient. - **Mixed:** omit the top-level values and set `sender` and `event` on **every** recipient. Returns a batch `task_id` plus per-message identifiers; partial failures are reported inline. **Authentication:** stream token in the `Authorization` header (see **Authentication** in the API Overview). - [OTP Auth Request](https://docs.commpeak.com/reference/otpauthrequest.md): Send a one-time password (OTP) to a recipient. TextPeak generates the code, delivers it using the stream's configured OTP template and channel, and returns a `request_uuid` you reference when verifying. - Fails with `402` if the account balance is depleted, or `429` if the recipient's OTP request cap is reached. - Use `retry: true` to resend to the same recipient. **Authentication:** stream token in the `Authorization` header (see **Authentication** in the API Overview). - [OTP Verify Request](https://docs.commpeak.com/reference/otpverifyrequest.md): Verify the code a recipient submitted against the active OTP for their phone number. Returns `verification: true` on a match, otherwise `false`. A wrong code is a normal `false` result with HTTP `200` — not an error. Errors (e.g. too many failed attempts) are returned via the standard error envelope. **Authentication:** stream token in the `Authorization` header (see **Authentication** in the API Overview). - [Upload file](https://docs.commpeak.com/reference/uploadfile.md): Upload a media file to use in WhatsApp sends. The response returns a `media_id` that you then pass to the **Send Media** endpoint. Send the file as `multipart/form-data`. **Authentication:** stream token in the `Authorization` header (see **Authentication** in the API Overview). - [Send Media](https://docs.commpeak.com/reference/sendmedia.md): Send a WhatsApp media message (image, document, audio, video, …) that references a file you have already uploaded with the **Upload file** endpoint. Pass the `media_id` returned by that upload. Each entry sends one media message; include `message_content` for an optional caption, or `conversation_uuid` to reply into an existing conversation. **Authentication:** stream token in the `Authorization` header (see **Authentication** in the API Overview). - [Whatsapp template](https://docs.commpeak.com/reference/whatsapptemplate.md): Send an approved WhatsApp Business template message to one or more recipients. Identify the template with `event`, and supply its component variables (`HEADER`, `BODY`, `FOOTER`) per recipient. `sender` is the WhatsApp Business number the template is sent from. **Authentication:** stream token in the `Authorization` header (see **Authentication** in the API Overview). ## Pages - [API Reference](https://docs.commpeak.com/api-reference.md) - [Product / Cloud PBX](https://docs.commpeak.com/lp-cloud-pbx.md) - [Product / CommPeak Dialer](https://docs.commpeak.com/lp-dialer.md) - [Product / DID Numbers](https://docs.commpeak.com/lp-did.md) - [Product / User Portal](https://docs.commpeak.com/lp-portal.md) - [Product / Softphone](https://docs.commpeak.com/lp-softphone.md) - [Product / TextPeak](https://docs.commpeak.com/lp-textpeak.md) - [Product / VoIP Service](https://docs.commpeak.com/voip-services.md) ## Changelog - [Documentation and Developer Hub v1.9.3 Released - 10/07/2026](https://docs.commpeak.com/changelog/documentation-and-developer-hub-v193-released-10072026.md) - [Documentation and Developer Hub v1.9.2 Released - 03/07/2026](https://docs.commpeak.com/changelog/documentation-and-developer-hub-v192-released-03072026.md) - [Documentation and Developer Hub v1.9.1 Released - 26/06/2026](https://docs.commpeak.com/changelog/documentation-and-developer-hub-v191-released-26062026.md) - [Documentation and Developer Hub v1.9.0 Released - 19/06/2026](https://docs.commpeak.com/changelog/documentation-and-developer-hub-v190-released-19062026.md) - [Documentation and Developer Hub v1.8.9 Released - 12/06/2026](https://docs.commpeak.com/changelog/documentation-and-developer-hub-v188-released-05062026.md)