papierkorb / sipgate.io

sipgate.io Documentation

sipgate.io

This README documents the sipgate.io functionality. A demo page can be found here.

Requirements

• Order a simquadrat SIM
• Book the sipgate.io feature
• Enter your URL in the simquadrat dashboard

Documentation

The POST request

Our API sends a simple POST request with an application/x-www-form-urlencoded payload. The payload contains the following parameters:

Parameter	Description
from	The calling number (e.g. "492111234567" or "anonymous")
to	The called number (e.g. "4915791234567")

That's all!

You can simulate this POST request and test your server with a simple cURL command:

curl -X POST --data "from=492111234567&to=4915791234567" http://localhost:3000

Server Examples

We compiled a collection of server examples to get you started:

• Clojure
• Common Lisp
• Go
• Java
• Node.js
• PHP
• Perl
• Prolog
• Python
• Ruby
• Scala
• C++

Troubleshooting

sipgate.io Log

You can enable logging within your account for debugging purposes. You will find each request and the corresponding response in the logging table.

How do I inspect network traffic?

You can use ngrep to inspect the incoming requests on your side:

sudo ngrep -dany -Wbyline port 3000

A word about security

HTTP vs. HTTPS

We strongly encourage you to use a HTTPS server. Although we support plain HTTP connections we do not recommend pushing sensitive call details over unencrypted connections. By default, the API does not accept self-signed certificates, but you can enable them in the dashboard.

Authentication

The API supports HTTP Basic Authentication. You can include your username and password within the URL (e.g. https://username:[email protected]:8080).

Help us make it better

Please tell us how we can make the API better. If you have a specific feature request or if you found a bug or would like to add an example, please use GitHub Issues or fork these docs and send a pull request with your improvements.