YakChat integrates with Bandwidth using Bandwidth's Version 2 Messaging API. Follow the steps below to configure your Bandwidth account and connect it to YakChat.

YakChat can connect to your Bandwidth telephony service in five easy steps:

1. Enable SMS on your Bandwidth service
2. Generate API credentials
3. Configure a Bandwidth application
4. Configure a location and assign phone numbers
5. Submit your connection details to YakChat

Once you submit your connection details, the YakChat team will test the connection and confirm when the integration has been successfully configured.

Step 1: Enable SMS on Bandwidth

To connect YakChat to your Bandwidth telephony service, contact Bandwidth and ensure SMS is enabled with HTTPS API (Version 2).

Note: New Bandwidth provider accounts should use Version 2 messaging.

Go to your Bandwidth Account page and make a note of your Account Number.
This is seven-digit number usually beginning with a 5

Important: Use your Account Number, not the Global Account Number prefixed with “BW”. You will need this Account Number when completing Step 5.

Locating the Bandwidth Account Number

Step 2: Generate API Credentials

Once SMS with HTTPS API (Version 2) has been enabled, generate API credentials through the Bandwidth Portal.

1. Navigate to Account > API Credentials.
2. Click Add + and create a new credential.
   
   
   
   Creating Bandwidth API Credentials

Bandwidth will generate:

• Client ID
• Client Secret

Important: The Client Secret is only displayed once when it is first generated. Be sure to save it securely before continuing. After it is saved, Bandwidth will no longer display it.

Make a note of both the Client ID and Client Secret, as they will be required when completing Step 5.

Accessing and Copying the Client ID and Client Secret on the Bandwidth Portal

Step 3: Configure a Bandwidth Application

To configure SMS settings, create a new Application in the Bandwidth Portal.

1. Select Applications from the top navigation menu.
2. Click Create New.
3. Complete the following information:

• Enter an Application Name.
• Select Messaging as the Application Type.
• Enable Use Multiple Callback URLs.
• Enter the following Inbound Callback URL:
  https://sp.yakchat.com/bandwidth/v2/message
• Enter the following Status Callback URL:
  https://sp.yakchat.com/bandwidth/v2/statuscallback

4. Click Create Application.
   
   
   
   Creating an Application on the Bandwidth Portal

After the Application has been created, make a note of the Application ID. You will need this value when completing Step 5.

Copy the Application ID on your Bandwidth Application

Configure Callback Authentication

Bandwidth requires authentication for inbound and status callbacks. Open the Application you created and configure the following:

1. Enable Use username/password for inbound callbacks.
2. Create an Inbound Callback Username.
3. Create an Inbound Callback Password.
4. Enable Use username/password for status callbacks.
5. Enter the same username and password used for inbound callbacks.
6. Save the Application.

Important: The Inbound Callback Username and Password must be identical for both inbound and status callbacks.

Make a note of the following information:

• Application ID
• Inbound Callback Username
• Inbound Callback Password

Configuring Callback Authentication in Bandwidth

Step 4: Configure a Location and Assign Phone Numbers

Bandwidth requires phone numbers to be assigned to a Location before SMS messaging can be configured.

Create a New Location

1. Navigate to Account > Locations.
2. Click Create Location.
3. Enter a Location name.
4. Open the Messaging tab.
5. Configure the following settings:
   

   SMS Enabled	On
   Toll Free	Optional
   Short Codes	Optional
   Geographic Reach	Select the appropriate region
   SMS Protocol	HTTP
   V2 Messaging	On
   Application	Select your Application
   MMS Enabled	On

   Click Save.

Location Configuration on the Bandwidth Portal

Assign a New Phone Number to the Location

1. Navigate to Numbers.
2. Purchase or provision a new phone number.
3. During setup, select the Location you configured for YakChat messaging.
4. Complete the number purchase and activation process.

Move an Existing Phone Number to the Location

1. Navigate to Numbers.
2. Locate and select the phone number you want to use.
3. Open Phone Number Details.
4. Locate the Location setting.
5. Change the selected Location to the one configured for YakChat messaging.
6. Click Move Number to save the change.

Note: Existing phone numbers must be assigned to the Location containing your Messaging configuration before they can be used with YakChat.

Step 5: Submit Your Connection Details

Information Required by YakChat

Before submitting your request, ensure you have the following information available:

• Account Number (Information from Step 1)
• Application ID (Information from Step 3)
• Client ID (Information from Step 2)
• Client Secret (Information from Step 2)
• Inbound Callback Username (Information from Step 3) 
• Inbound Callback Password (Information from Step 3)
• Test Phone Number associated with the Bandwidth service

Provide the following information to YakChat:

1. Select Bandwidth as the SMS service provider.
2. Enter your Account Number.
3. Enter your Application ID.
4. Enter your Client ID in the Integration Data 1 (Encrypted) field.
5. Enter your Client Secret Integration Data 2 (Encrypted) field.
6. Enter your Inbound Callback Username Integration Data 3 (Encrypted) field.
7. Enter your Inbound Callback Password Integration Data 4 (Encrypted) field.
8. Enter a phone number assigned to the configured Bandwidth service.

Test Phone Number: A phone number added to this service provider to confirm configuration.

Once your information has been submitted, the YakChat team will test the connection and confirm when the integration is complete.

This information is required for YakChat to complete and validate your Bandwidth integration successfully.

• How to Connect Twilio to YakChat for SMS and MMS
  
• How to Connect YakChat to Your Telnyx Service