This article is for API V1, please use the Developer Center for API V2 guides.
Mission Control API: Connection credentials authentication
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:
Create credentials for a connection
Update credentials for a connection
Get a credential suggestion
Create credentials for a connection:
You can use this endpoint to create credentials for an existing connection. Beware, this will override any other authentication types set for this connection.
Firstly, enter in the connection ID into "id" parameter box. If you don't know your connections ID you can find it out by using the get "Get your connections" endpoint. Next, we can enter our JSON body into the "credentials" parameter box with our desired credentials. It should look similar to the example below:
When you're confident you have prepared your query correctly click "TRY IT NOW". You should receive a JSON response similar to the one below:
Congratulations, you've just set your connection to use credential based authentication!
Update credentials for a connection:
We can update credentials for any credential-based connection by using the "Update credentials for a connection" endpoint.
Firstly, enter the connection ID into "id" parameter box. If you don't know your connections ID you can find it out by using the get "Get your connections" endpoint. Next, we can enter our JSON body into the "credentials" parameter box with our desired updated credentials. It should look similar to the example below:
When you're confident you have prepared your query correctly click "TRY IT NOW". You should recieve a JSON response similar to the one below:
Congratulations, you've just updated your connection credentials!
Get a credential suggestion:
We can get a suggestion for our credentials for any credential-based connection by using the "Get a credential suggestion" endpoint.
To get a credential suggestion, simply enter the connection ID into the 'connection_id' box of the connection you would like the suggestion for and click "TRY IT OUT".
You should receive a response similar to the below:
Note - If you would like media traffic to be routed through a specific "AnchorSite" please send the username of the connection created in the "contact" header in your FIRST invite to Telnyx.
Can't find what you're looking for? Click the chat bubble at your lower right-hand corner and start a chat!