Integrating Using the External Channel API

Although we provide integrations with dozens of aggregators such as Twilio, Vonage and others, you may need to integrate with other systems. Our External Channel API makes this quick and easy.

Here are the steps:

1. Go to your workspace settings by clicking the Settings button at the bottom of the left sidebar, then click New Channel under Channels.

2. On the next page, scroll to find External API and click it.

3. Here you can configure how outgoing messages are sent. The platform can send messages using a standard GET, POST or JSON body, and you can configure the parameters as you wish. Select the type of URN you will be using (likely Phone Number) and fill out the other information about how you want us to receive incoming messages.

4. Once you submit this form, we will provide a URL for you to send incoming messages to. The platform expects messages to be delivered using a POST request to that URL. We will respond with a 200 status code if the message is accepted, or a 400 if there is an error in your submission, with details explaining why.

5. The platform will then handle incoming and outgoing messages for this channel as it does for any other. If you have problems sending outgoing messages through your external channel, you can check the sending log on your channel's page for a detailed log of those requests.