sipgate下載 - sipgate原始碼下載

sipgate

其他類別

1.0.0

下載

？用於與sipgate整合的 PHP 函式庫

要求

PHP 7.1或更高版本和json擴充。

安裝

composer require innoscripta/ sipgate

用法

初始化sipgate類別：

sipgate sipgate ();">

 $ sipgate =  Orkhanahmadov  sipgate  sipgate ();

基本驗證

您可以在初始化類別時傳遞基本驗證使用者名稱和密碼：

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

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

或者您可以使用setBasicAuthCredentials()方法設定基本驗證：

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

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

帳戶資訊：

 $ sipgate -> account ();

傳回帳戶詳細資料數組。

取得用戶：

 $ sipgate -> users ();

傳回在帳戶下註冊的使用者陣列。陣列中的每個項目都是Orkhanahmadov sipgate ResourcesUser的實例，並具有以下屬性：

 $ 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

取得用戶設備：

若要取得使用者的設備，請使用devices()方法並傳遞使用者實例或使用者 ID。

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

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

傳回為給定使用者註冊的裝置數組。陣列中的每個項目都是Orkhanahmadov sipgate ResourcesDevice的實例，並具有以下屬性：

 $ 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

活躍通話：

使用calls()方法取得目前建立的呼叫清單。

 $ sipgate -> calls ();

傳回目前建立的呼叫的數組。陣列中的每個項目都是Orkhanahmadov sipgate ResourcesCall的實例，並具有以下屬性：

 $ 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

發起新呼叫：

使用call()方法發起新的呼叫。方法接受 3 個參數：

$device - 接受裝置或裝置 ID 的實例。這定義了您要使用哪個裝置來撥打電話。
$callee - 您要呼叫的電話號碼。
$callerId （可選）- 如果您想向其他被叫方顯示不同的號碼，請設定此參數。跳過時，將使用$device編號。

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

傳回呼叫的會話 ID。

掛斷正在進行的通話：

使用hangup()方法掛斷正在進行的通話。方法接受呼叫 ID 作為參數：

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

記錄正在進行的通話：

使用record()方法記錄正在進行的通話。方法接受 3 個參數：

$callId - 唯一的呼叫 ID。
$value - true或false ，定義記錄的開始或停止。
$announcement - true或false ，定義是否要播放有關正在錄製的通話的通知。

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

通話記錄：

使用history()方法取得通話記錄。方法接受選項數組：

connectionIds - array ，定義擴充列表
types - array ，定義您想要在歷史記錄中接收的類型列表，可能包含以下多個值之一：“CALL”、“VOICEMAIL”、“SMS”、“FAX”
directions - array ，定義您想要在歷史記錄中接收的呼叫方向列表，可能包含以下多個值之一：“INCOMING”、“OUTGOING”、“MISSED_INCOMING”、“MISSED_OUTGOING”
archived - bool ，如果您只想接收已存檔的歷史項目，則設定true
starred - 定義您是否要接收已加星標或未加星標的歷史記錄項目，其中之一：“已加星標”、“未加星標”
from - 定義歷史記錄的開始日期。必須採用 ISO8601 格式
to - 定義歷史記錄的結束日期。必須採用 ISO8601 格式
phonenumber - 定義要在歷史記錄中搜尋的電話號碼
limit - 定義歷史項目的「每頁」值
offset - 定義歷史項目的「偏移」值

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

傳回歷史項目的陣列。陣列中的每個項目都是Orkhanahmadov sipgate ResourcesHistory的實例，並具有以下屬性：

 $ 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