Configuring Your ApplicationΒΆ

Before you can make or direct calls and messages to your application, you will need to define settings for your app in your account. This includes setting URLs for your application and fallback (backup) webservers, as well as choosing the API key and password that you will use when making API requests.

If you don’t have a API Developer account yet, sign up to create one. Then set up the phone numbers and extensions you will need, and follow the configuration steps below.

  1. Log into your account.
  2. Under the API menu, click Add Applications.

Add Application page

  1. Complete the fields on the Add Application page:
    • API Application Name: Enter a name that will help you identify your application easily. Choose something that you will recognize when you go to route phone calls and SMS messages to your app. Example: Appointment Reminder or SMS Coupon Manager.
    • Main URL: (Optional) Set this field if you want to receive HTTP events from the API server during asynchronous API calls. Enter the URL of the primary webserver for your application.
    • Fallback URL: (Optional) You can also configure a fallback (backup) server to receive HTTP events if your primary webserver cannot be reached or is not responding. Enter the URL for your fallback server in this field.
    • API Key: Automatically generated key used to identify your application in API calls. Make a note of your API key and keep it in a safe place.
    • API Password: Your API password is used to secure your application’s API calls to the API server. Choose a secure password or let generate one for you. Make a note of your API password and keep it in a safe place.
    • Version: Select the API version you will use with your application.
    • Status: Choose the development stage that best describes the application you are configuring: Development, Beta or Live. This setting enables you to test applications at different stages of development at the same time.
  1. Click Save Changes.

The server can now process your API requests. For instructions on getting started and making basic API calls, see the topics listed below.

Learn More: