Table of Contents

Overview

Sangoma's Business Voice and CPaaS APIs are designed for robust, secure, and scalable communication solutions. Access to these APIs requires specific credentials to ensure the security and proper management of your integrations.

How to Request API Keys

Access to these APIs requires specific credentials to ensure the security and proper management of your integrations. To start making API calls, you'll need an API Key. Follow the step below to request Business Voice and CPaaS API Keys.

Steps to Request Business Voice and CPaaS API Keys:

1. Navigate to the "Request APIs" Form: On developer.sangoma.com, locate and click on the "Request APIs" link, typically found in the main navigation or a prominent section of the homepage.

2. Fill Out the Request Form:

   • Provide your Contact Information: Full Name, Company Name, Email Address, and Phone Number.

   • Select the request apiKey from the “Purpose of form Submission” dropdown

   • Choose Platform: BV and CPaaS or CommUnity

   • Select Environment: Production, Sandbox or select not sure in case you do not have a testing environment. 

   • Describe Your Project: Briefly explain your intended use case or project. This helps our team understand your needs and provide the right level of access and support.

3. Submit Your Request: Review all entered information for accuracy and click the "Submit" button.

4. Review and Approval Process:

   • Your request will be reviewed by the Sangoma Team.

   • This review process allows us to ensure your project aligns with our API usage policies and to provide the appropriate credentials.

   • You will receive an email confirmation that your request has been received.

5. Receive Your API Credentials: Once approved, you will receive an email containing your API Key(s) and any additional necessary credentials (e.g., API Secret, Account SID) along with instructions on how to use them. This process may take 1-2 business days.