Overview of the sipgate REST API and Push API – features, pricing, and possible uses for your telephony.
Note: This feature is available available only to customers on sipgate classic . On sipgate neo, the feature is integrated in a different form.
An API is an application programming interface that can be used to automate processes and integrate them into your own applications. sipgate offers a total of two such interfaces at sipgate.io here:
The REST API can be used to control almost all functions of the sipgate account. We also use it internally to develop new products.
Features:
Trigger calls, transfer, hang up, hold, record, mute, list active calls, play DTMF tones or announcements
change number routing, change caller ID numbers
configure forwarding, retrieve event list
query device settings
send SMS
send fax
For sipgate products:
Price: free of charge
Here you can find the documentation
Protocol: REST
Authentication: OAuth2, Personal Access Token
With this Push API, you can to real time influence incoming and outgoing calls by script. As a user, you store a URL in our system that is called during phone calls in order to inform you about the call and possibly receive control instructions. forward calls or interaction via DTMF keypad input are prominent examples of the functions offered.
Features:
send real-time information about calls and call acceptance to a web server
automatically forward calls, hang up, or send them to voicemail
DTMF
For sipgate products:
Here you can find pricing information
And here are the documentation
Here you will find examples of use.
There are also ready-made integrations with some software products, for example Zoho CRM.
The XML-RPC API was shut down on January 1, 2022.
At GitHub we explain how you can use the API in general. We also provide information here about specific ways of using the API in connection with your sipgate account.
Last updated
