Register and Configure an Application

Applications are how FreeClimb knows what URLs to request when calls, messages, or status changes happen on the platform. To FreeClimb, an application is simply a set of configuration data.

Register Your Application

To register an application go to the Apps page in your Dashboard.

The Dashboard Apps page

Click the button, "Register New App."

Give your application an Alias. This is a nickname for your app to make it easy to find.

An Alias is a nickname for your app.

At this point, you can continue configuration or save your registered application without adding any URLs.

Once you've saved your application an app ID will be generated. You'll see this app ID and the alias in your table of applications.

Table of applications with the newest app added.

Configure Your Application

Your application's configuration depends on what your app will be doing. Select the application you want to configure from the Apps page in your Dashboard. This will open the app's App Config page where you can configure the following URLs:

Webhook

Description

voiceUrl

URL that FreeClimb should request when an inbound call arrives on a phone number assigned to this Application.

voiceFallbackUrl

URL that FreeClimb will request if it times out waiting for a response from the voiceUrl.

smsUrl

URL that FreeClimb will request when a phone number assigned to this Application receives an incoming SMS message.

smsFallbackUrl

URL that FreeClimb will request if it times out waiting for a response from the smsUrl.

callConnectUrl

URL that FreeClimb will request when an outbound call request is complete.

statusCallbackUrl

URL that FreeClimb will request to pass call status (such as call ended) to the application.

The format for each URL is:

http://www.example.com:PORT/exampleEndpoint

The base and port number of the URL are where your app can be reached. The endpoint is the route you've defined in your code.

Save your app once you've finished configuration.

Updated 10 months ago

Register and Configure an Application


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.