Basic information

phonebridge® provides an RESTful API to be able to use its backend without using the public frontend. You can download API description (*.yml) and upload it for example to Swagger Editor in order to see and test functionality. Furthermore there you can even generate working client code written in nearly any programming or script language (Java, Python, C#, PHP, JavaScript,...). 

Authorization

You need to register a free account first to use this API.

Afterwards you can authenticate with common JWT mechanism with Bearer token:

1. Send username and password to endpoint /api/authenticate and receive a token.
   
   Example:
   curl -X POST "https://app.phonebridge.io:443/api/authenticate" -H "accept: application/json" -H "Content-Type: application/json" -d "{\"email\":\"XXX@XXX.de\",\"password\":\"XXX\"}"
   
   Result:
   {"id_token":"XXX-XXX"}
   
   
2. Use any endpoint by providing your token. Replace "XXX-XXX" with the token received with step 1.
   
   Example:
   curl -X GET "https://app.phonebridge.io:443/api/users/me/connectors" -H "accept: application/json" -H "Content-Type: application/json" -H "Authorization: Bearer XXX-XXX"
   

phonebridge® Full API

Releases

Connector config parameters

phonebridge® CLIENT API

The phonebridge® CLIENT API is a subset of the complete phonebridge® API. It only contains endpoints and entities required by 3rd party vendors for creating and managing the phonebridge® CLIENT.

Its aim is to simplify development specifically for the phonebridge® CLIENT, which does not require a 3rd party developer to implement the whole phonebridge® API.

Releases

cURL Example

Use this commandline example to see how authentication, creating a phonebridge® CLIENT and deleting the same works:

First authenticate and receive a Bearer token for this session:

curl -d '{"email":"YOUR_EMAIL_ADDRESS","password":"YOUR_PASSWORD"}' -H "Content-Type: application/json" -X POST https://app.phonebridge.io:443/api/authenticate

Then use this Bearer token to create a phonebridge® CLIENT with the memo "Max Mustermann" and to receive the CLIENT ID:

curl -H "Accept: application/json" -H "Content-Type: application/json" -H "Authorization: Bearer YOUR_BEARER_TOKEN" -d '{"name": "Max Mustermann"}' -X POST https://app.phonebridge.io:443/api/users/me/clients

Then use Bearer token again to delete this phonebridge® CLIENT by ID:

curl -H "Accept: application/json" -H "Content-Type: application/json" -H "Authorization: Bearer YOUR_BEARER_TOKEN" -X DELETE https://app.phonebridge.io:443/api/clients/YOUR_CLIENT_ID

Technical support

Visit our website to see all available channels to get in touch with us.