Alle sipgate APIs im Überblick

Eine API ist eine Programmierschnittstelle, mit der man Abläufe automatisieren und in eigene Anwendungen integrieren kann. sipgate bietet insgesamt drei solcher Schnittstellen an:

REST-API

Über die REST-API lassen sich nahezu alle Funktionen des sipgate Accounts steuern. Wir benutzen sie auch intern zur Entwicklung neuer Produkte.

Zum 1. Januar 2022 wird die REST-API abgeschaltet.

Funktionsumfang: 

  • Anrufe auslösen, transferieren, auflegen, halten, aufzeichnen, stumm schalten, aktive Gespräche auflisten, DTMF-Signale oder Ansagen einspielen
  • Rufnummernrouting ändern, Absenderrufnufnummern ändern
  • Weiterleitungen konfigurieren, Ereignisliste abrufen
  • Endgeräteeinstellungen abfragen
  • SMS versenden
  • Fax versenden

Für sipgate Produkte: 

  • Preis: kostenlos
  • Hier gibt es die Dokumentation 
  • Protokoll: REST
  • Authentifizierung: OAuth2, BasicAuth

Achtung, Verwechslungsgefahr: Bei dieser REST-API handelt es sich um unsere 'neue' REST-API. Wir hatten zwischen 2009 und Juli 2016 eine andere, 'alte' REST-API.

sipgate.io – Push-API

Mit dieser Webhook-ähnlichen Push-API kann man in Echtzeit per Skript Einfluss auf ein- und ausgehende Gespräche zu nehmen. Als Nutzer:in hinterlegt man dazu in unserem System eine URL, die bei Telefongesprächen aufrufen wird, um über den Anruf zu informieren und eventuell Steuerungsanweisungen zu bekommen. Anrufe umleiten oder Interaktion per DTMF-Tastenabfrage sind prominente Beispiele der angebotenen Funktionen.

Funktionsumfang:

  • Echtzeit-Informationen über Anrufe und Anrufannahme an einen Webserver schicken
  • Anrufe automatisiert weiterleiten, auflegen oder auf Voicemail schicken;
  • DTMF

Für sipgate Produkte: 

Es gibt auch fertige Integrationen mit einigen Software-Produkten, beispielsweise Zoho-CRM.

XML-RPC API

Die XML-RPC API wird von uns nicht mehr weiter entwickelt. Für neue Projekte sollten Sie unbedingt die REST-API verwenden. Bestehende Projekte sollten bei Gelegenheit auf die REST-API umgestellt werden.

Vom sipgate-System angebotene Funktionen lassen sich durch ein Kommando in XML-Form aufrufen. Eine Antwort mit Status-Code und eventuellen Ergebnisdaten gibt es als XML zurück.

Zum 1. Januar 2022 wird die XML-RPC API abgeschaltet.

Funktionsumfang:

  • Faxe versenden
  • SMS versenden
  • Anruf auslösen
  • Kontostand abfragen
  • Anrufhistorie abrufen

Für sipgate Produkte und eingeschränkt für sipgate trunking

  • Die XML-RPC-API ist kostenlos.
  • Die Dokumentation gibt es hier XML-RPC API.