What Is the sipgate API and what features does it offer?

Overview of the sipgate API features including call building, SMS, fax, voicemail access, and event list retrieval.

Note: This feature works differently in sipgate neo, so this article does not apply.

The sipgate API (Application Programming Interface) provides sipgate platform functionality for external applications. The sipgate API provides, amongst other things, functionality from the following areas:

• Building of telephone conversations

• SMS

• Sending and receiving faxes

• Retrieving account balance information

• Access to the event list (data about calls, faxes, voicemails, recordings and SMS)

• Access to voicemails

• Provisioning information for VoIP endpoints

In general, all elements of the event list information are available, such as sender, recipient, and timestamp. The contents of voicemails, fax, and SMS can also be downloaded as a file.

Note: The sipgate API can also build calls between "normal" telephones. Numbers must always be passed in the international format (E164). The exact functionality, including all Input and Output parameters, is described by the sipgate API Specification. A brief example using the sipgate API is available here.

In addition to the sipgate API, there is also the sipgate.io Push-API. The differences between the sipgate API and sipgate.io are explained here.