Creating a Voice API application on the Universal Platform

David Preo

Updated

Note: This article contains steps specific to our Universal Platform. If you're using our Legacy North American Platform, please see Creating a Voice API application on the Legacy North American Platform

To begin using your Bandwidth App numbers for Voice APIs, you first need to create a Voice application and then associate it with your phone number’s location:

  1. Log in to the Bandwidth App.
  2. Create a Sub-account (if you already have a Sub-account that you want to associate with this application, you can skip this step). 
  3. In the side navigation bar, select Applications.
  4. Provide the Application name (we recommend you use something that identifies what the application will do).
  5. Under Application type, select Voice (you won’t be able to change this once the application is created).
  6. Enable the Use a callback username and password checkbox if you’d like to use a callback username and password. Your password won’t be visible after leaving this screen, so please store it securely for your use or return here to create a new one.
  7. Under Call initiated callback method, select GET or POST.
  8. Under Call status callback method, select GET or POST (optional).
  9. Enter a Call initiated callback URL (invoked when a call is initiated).
  10. Enter a Call status callback URL (optional). Currently this is invoked when a call is terminated, but other status events may be added in the future.
  11. If you checked the Use a callback username and password, please enter the Callback user ID and Callback password. These credentials will be used by your server to authenticate callbacks.
  12. Click Create Application.

voice-application.png

Next, you need to associate your Voice Configuration Package (VCP) with your Voice application.

  1. In the side navigation bar, click Service Management and select Voice Configurations.
  2. Click Add Package or select an existing VCP.
  3. Click the Configure with HTTP voice protocol toggle.
  4. In the Voice Application drop-down menu, select the Voice application you created above.
  5. Click Create Package (if creating a new VCP) or Save Changes (if updating an existing one).

universal-platform-associating-vcp-with-application.png

Now any number assigned to this VCP will cause webhooks to be received by the application when receiving an inbound call.

Questions? Please open a ticket with your Bandwidth Support Team or hit us up at (855) 864-7776!

Article is closed for comments.