sipgate Download - sipgate Quellcode herunterladen

sipgate

Andere Kategorien

1.0.0

Herunterladen

? PHP-Bibliothek zur Integration mit sipgate

Anforderungen

PHP 7.1 oder höher und json Erweiterung.

Installation

composer require innoscripta/ sipgate

Verwendung

sipgate -Klasse initialisieren:

sipgate sipgate ();">

 $ sipgate =  Orkhanahmadov  sipgate  sipgate ();

Basisauthentifizierung

Sie können beim Initialisieren der Klasse den Benutzernamen und das Passwort für die Basisauthentifizierung übergeben:

sipgate sipgate ('[email protected]', 'secret');">

 $ sipgate =  Orkhanahmadov  sipgate  sipgate ( ' [email protected] ' , ' secret ' );

Oder Sie können die Basisauthentifizierung mit der Methode setBasicAuthCredentials() festlegen:

sipgate sipgate (); $ sipgate ->setBasicAuthCredentials('[email protected]', 'secret');">

 $ sipgate =  Orkhanahmadov  sipgate  sipgate ();
$ sipgate -> setBasicAuthCredentials ( ' [email protected] ' , ' secret ' );

Kontoinformationen:

 $ sipgate -> account ();

Gibt eine Reihe von Kontodetails zurück.

Benutzer abrufen:

 $ sipgate -> users ();

Gibt eine Reihe von Benutzern zurück, die unter dem Konto registriert sind. Jedes Element im Array ist eine Instanz von Orkhanahmadov sipgate ResourcesUser und hat folgende Eigenschaften:

 $ user -> id ; // string
$ user -> firstname ; // string
$ user -> lastname ; // string
$ user -> email ; // string
$ user -> defaultDevice ; // string
$ user -> busyOnBusy ; // bool
$ user -> addressId ; // string
$ user -> directDialIds ; // array
$ user -> admin ; // bool

Benutzergeräte abrufen:

Um die Geräte des Benutzers abzurufen, verwenden Sie die Methode devices() und übergeben Sie eine Benutzerinstanz oder Benutzer-ID.

sipgate->devices($user); // or $ sipgate ->devices('ABC-123');">

 $ sipgate -> devices ( $ user );
// or
$ sipgate -> devices ( ' ABC-123 ' );

Gibt eine Reihe von Geräten zurück, die für einen bestimmten Benutzer registriert sind. Jedes Element im Array ist eine Instanz von Orkhanahmadov sipgate ResourcesDevice und hat folgende Eigenschaften:

 $ device -> id ; // string
$ device -> alias ; // string
$ device -> type ; // string
$ device -> online ; // bool
$ device -> dnd ; // bool
$ device -> activePhonelines ; // array
$ device -> activeGroups ; // array
$ device -> credentials ; // array
$ device -> registered ; // array
$ device -> emergencyAddressId ; // string
$ device -> addressUrl ; // string

Aktive Anrufe:

Verwenden Sie die Methode calls() um eine Liste der aktuell eingerichteten Anrufe abzurufen.

 $ sipgate -> calls ();

Gibt ein Array aktuell bestehender Anrufe zurück. Jedes Element im Array ist eine Instanz von Orkhanahmadov sipgate ResourcesCall und hat folgende Eigenschaften:

 $ call -> id ; // string
$ call -> firstname ; // string
$ call -> lastname ; // string
$ call -> email ; // string
$ call -> defaultDevice ; // string
$ call -> busyOnBusy ; // bool
$ call -> addressId ; // string
$ call -> directDialIds ; // array
$ call -> admin ; // bool

Neuen Anruf einleiten:

Verwenden Sie die Methode call() um einen neuen Anruf zu initiieren. Die Methode akzeptiert 3 Parameter:

$device – Akzeptiert eine Geräteinstanz oder Geräte-ID. Hier legen Sie fest, mit welchem Gerät Sie telefonieren möchten.
$callee – Telefonnummer, die Sie anrufen möchten.
$callerId (optional) – Legen Sie diesen Parameter fest, wenn Sie dem Angerufenen eine andere Nummer anzeigen möchten. Beim Überspringen wird $device Gerätenummer verwendet.

 $ sipgate -> call ( $ device , $ callee , $ callerId );

Gibt die Sitzungs-ID des Anrufs zurück.

Laufendes Gespräch auflegen:

Verwenden Sie die Methode hangup() um den laufenden Anruf zu beenden. Methode akzeptiert Aufruf-ID als Parameter:

 $ sipgate -> hangup ( ' ABC-123 ' );

Laufenden Anruf aufzeichnen:

Verwenden Sie die Methode record() um den laufenden Anruf aufzuzeichnen. Die Methode akzeptiert 3 Parameter:

$callId – Eindeutige Anruf-ID.
$value – true oder false , definiert den Start oder Stopp der Aufzeichnung.
$announcement – true oder false , definiert, ob Sie eine Ansage über den aufgezeichneten Anruf abspielen möchten.

 $ sipgate -> record ( $ callId , $ value , $ announcement );

Anrufverlauf:

Verwenden Sie die Methode history() um den Anrufverlauf abzurufen. Die Methode akzeptiert eine Reihe von Optionen:

connectionIds – array , definiert die Liste der Erweiterungen
types – array , definiert die Liste der Typen, die Sie im Verlauf empfangen möchten, kann einen der folgenden Werte enthalten: „CALL“, „VOICEMAIL“, „SMS“, „FAX“
directions – array , definiert eine Liste der Anrufanweisungen, die Sie im Verlauf erhalten möchten, kann einen der folgenden Werte enthalten: „INCOMING“, „OUTGOING“, „MISSED_INCOMING“, „MISSED_OUTGOING“
archived - bool , setzen Sie true , wenn Sie nur archivierte Verlaufselemente empfangen möchten
starred – Definiert, ob Sie markierte oder nicht markierte Verlaufselemente erhalten möchten, eines davon: „STARRED“, „UNSTARRED“
from – Definiert das Startdatum des Verlaufs. Muss im ISO8601-Format vorliegen
to – Definiert das Enddatum des Verlaufs. Muss im ISO8601-Format vorliegen
phonenumber – Definiert die Telefonnummer, die im Verlauf durchsucht werden soll
limit – Definiert den Wert „pro Seite“ für Verlaufselemente
offset – Definiert den „Offset“-Wert für Verlaufselemente

 $ sipgate -> history ([ ' from ' => ' 2019-07-10T19:32:18Z ' , ' to ' => ' 2019-07-22T19:32:18Z ' ]);

Gibt ein Array von Verlaufselementen zurück. Jedes Element im Array ist eine Instanz von Orkhanahmadov sipgate ResourcesHistory und hat folgende Eigenschaften:

 $ history -> id ; // string
$ history -> source ; // string
$ history -> target ; // string
$ history -> sourceAlias ; // string
$ history -> targetAlias ; // string
$ history -> type ; // string
$ history -> created ; // string
$ history -> lastModified ; // string
$ history -> direction ; // string
$ history -> incoming ; // bool
$ history -> status ; // string
$ history -> connectionIds ; // array
$ history -> read ; // bool
$ history -> archived ; // bool
$ history -> note ; // string
$ history -> endpoints ; // array
$ history -> starred ; // bool
$ history -> labels ; // array
$ history -> callId ; // string
$ history -> recordingUrl ; // string
$ history -> recordings ; // array
$ history -> duration ; // int
$ history -> responder ; // string
$ history -> responderAlias ; // string