Mission Control API: Outbound profile

Using the API is an alternative way to configure and use your Mission Control account. This can be useful if you are interested in writing programs to explore and automate the use of our features.

In this guide we will give you an example of using our API docs GUI. Hopefully this will give you a base for writing programs to interact with our API.

Before we begin, we must tell the API our credentials so the API knows which portal account we will be using it with(and who we are).

For how to do this, please refer to our article on "Authentication and Tokens" after updating your credentials you can follow on from here.

 In this article you will learn how to:

  • Get your Outbound Profiles
  • Create a new Outbound Profile
  • Delete an Outbound Profile
  • Get an Outbound Profile
  • Update an Outbound Profile

Get your Outbound Profiles:

This endpoint returns all the outbound_profiles the user has on their account. There are 3 parameters, simply fill these in with whitelisted destination group,the amount of pages you would like returned & the amount of result per page. Once you've done that, hit "Try It Out".

You will receive a JSON response similar to the below with the details of all your generated outbound_profiles associated with your account.

Create a new Outbound Profile:

We can use the create a new outbound profile endpoint to add a new outbound profile to one of our connections. If we navigate to the endpoint there will be an example of the JSON body on the right hand side. Click this to copy it into your parameters box. The fields "connection_ids","traffic_type" & "service_plan" are mandatory. Edit your message body with your new outbound profile details. Below we can see an example of generating a new outbound profile.

Once your ready hit "TRY IT OUT", you should get a response similar to the one below with the details of your new outbound profile:

Delete an Outbound Profile:

We can use the delete an outbound profile endpoint to delete an outbound profile from our profile. In order to delete a outbound profile, we will need to pass outbound profile ID as the parameter. If you do not have your outbound profile ID, you can acquire it by using the "Get your outbound profiles" endpoint above. Once you have you ID, enter it into the "id" box and click "TRY IT NOW".

You will get a response similar to the one below letting you know if your request was successful or not.

Get an Outbound Profile:

Similarly to "Delete an Outbound Profile", we can use the get an address endpoint to get an outbound profile from our Telnyx account. In order to get the outbound profile, we will need to pass the outbound profile ID as as the parameter. If you do not have your outbound profile ID, you can acquire it by using the "Get your Outbound Profiles" endpoint above. Once you have you ID, enter it into the "id" box and click "TRY IT NOW".

You will get a response similar to the one below with the details of the outbound profile you have selected.

Update an Outbound Profile:

We can update the settings for any outbound profile by using the "Update an outbound profile" endpoint.

Firstly, we can enter the number or number ID into "id" parameter box. If you don't know your outbound profile ID you can find it out by using the get "Get your outbound profiles" endpoint. Next, we can enter our JSON body into the parameter box with our desired updated settings. It should look similar to the example below:

Once your ready hit "TRY IT OUT", you should get a response similar to the one below with the details of your new outbound profile:

Congratulations! You are now able to manage your Outbound Profiles via the Mission Control API !


Can't find what you're looking for? Click the chat bubble at your lower right-hand corner and start a chat!

Did this answer your question?