sipgate team Hilfe

Die sipgate APIs im Überblick

Eine API ist eine Programmierschnittstelle, mit der man Abläufe automatisieren kann. sipgate bietet insgesamt 3 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. 

  • 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
    • und vieles mehr....
  • Für diese Produkte: sipgate team, sipgate basic und simquadrat
  • Preis: kostenlos
  • Dokumentation: https://developer.sipgate.io/v2.0/docs
  • Protokoll: REST
  • Authentifizierung: OAuth2, BasicAuth

Achtung, dies ist die "neue" REST-API. Wir hatten zwischen 2009 und Juli 2016 eine andere, "alte" REST-API. Bitte nicht verwechseln.

 

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 hinterlegt man dazu in unserem System eine URL, die wir bei Telefongesprächen aufrufen, 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; und vieles mehr
  • Welche Produkte: sipgate team, sipgate basic und simquadrat
  • Preis: sipgate.io/de/prices
  • Dokumentation: sipgate.io (github)
  • Anwendungsbeispiele: book.sipgate.io

Neben "selber programmieren", gibt es auch fertige Integrationen mit einigen Software-Produkten, z.B. 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.

  • Funktionsumfang: Faxe versenden, SMS versenden, Anruf auslösen, Kontostand abfragen, Anrufhistorie abrufen, und vieles mehr
  • Für diese Produkte: sipgate team, sipgate basic, simquadrat und eingeschränkt für sipgate trunking
  • Preis: kostenlos
  • Dokumentation: XML-RPC API

Die Nummer 1 Funktionalität, die andere Kunden realisieren möchten, ist Click2Dial (Wahlhilfe, Click2Call, …): Man klickt auf eine Telefonnummer und ruft diese automatisch an. So geht's: book.sipgate.io/content/click2call.html

 

 

Haben Sie Fragen? Anfrage einreichen