Download sipgate - download do código-fonte sipgate

sipgate

Outras categorias

1.0.0

Baixar

? Biblioteca PHP para integração com sipgate

Requisitos

PHP 7.1 ou superior e extensão json .

Instalação

composer require innoscripta/ sipgate

Uso

Inicialize a classe sipgate :

sipgate sipgate ();">

 $ sipgate =  Orkhanahmadov  sipgate  sipgate ();

Autenticação básica

Você pode passar nome de usuário e senha de autenticação básica ao inicializar a classe:

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

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

Ou você pode definir a autenticação básica com o método setBasicAuthCredentials() :

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

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

Informações da conta:

 $ sipgate -> account ();

Retorna uma série de detalhes da conta.

Obtenha usuários:

 $ sipgate -> users ();

Retorna a matriz de usuários registrados na conta. Cada item na matriz é uma instância de Orkhanahmadov sipgate ResourcesUser e possui as seguintes propriedades:

 $ 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

Obtenha dispositivos de usuário:

Para obter os dispositivos do usuário, use o método devices() e passe uma instância de usuário ou ID de usuário.

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

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

Retorna uma matriz de dispositivos registrados para determinado usuário. Cada item na matriz é uma instância de Orkhanahmadov sipgate ResourcesDevice e possui as seguintes propriedades:

 $ 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

Chamadas ativas:

Use o método calls() para obter uma lista de chamadas atualmente estabelecidas.

 $ sipgate -> calls ();

Retorna uma matriz de chamadas atualmente estabelecidas. Cada item na matriz é uma instância de Orkhanahmadov sipgate ResourcesCall e possui as seguintes propriedades:

 $ 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

Iniciar nova chamada:

Use o método call() para iniciar uma nova chamada. O método aceita 3 parâmetros:

$device - Aceita instância do dispositivo ou ID do dispositivo. Isso define qual dispositivo você deseja usar para fazer uma chamada.
$callee - Número de telefone para o qual deseja ligar.
$callerId (opcional) - Defina este parâmetro se quiser mostrar um número diferente para outro destinatário. Quando ignorado, o número $device será usado.

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

Retorna o ID da sessão da chamada.

Desligar chamada em andamento:

Use o método hangup() para desligar a chamada em andamento. O método aceita o ID da chamada como parâmetro:

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

Gravar chamada em andamento:

Use o método record() para registrar a chamada em andamento. O método aceita 3 parâmetros:

$callId – ID de chamada exclusivo.
$value - true ou false , define o início ou término da gravação.
$announcement - true ou false , define se você deseja reproduzir o anúncio sobre a chamada sendo gravada.

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

Histórico de chamadas:

Use o método history() para obter o histórico de chamadas. O método aceita uma variedade de opções:

connectionIds - array , define lista de extensões
types - array , define a lista de tipos que você deseja receber no histórico, pode conter um dos seguintes valores: "CALL", "VOICEMAIL", "SMS", "FAX"
directions - array , define a lista de direções de chamada que você deseja receber no histórico, pode conter um dos muitos valores a seguir: "INCOMING", "OUTGOING", "MISSED_INCOMING", "MISSED_OUTGOING"
archived - bool , defina true se desejar receber apenas itens de histórico arquivados
starred - Define se você deseja receber nos itens do histórico com estrela ou sem estrela, um destes: "STARRED", "UNSTARRED"
from - Define a data de início do histórico. Deve estar no formato ISO8601
to - Define a data final do histórico. Deve estar no formato ISO8601
phonenumber - Define o número de telefone para pesquisar no histórico
limit - Define o valor "por página" para itens do histórico
offset - Define o valor de "offset" para itens do histórico

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

Retorna uma matriz de itens do histórico. Cada item na matriz é uma instância de Orkhanahmadov sipgate ResourcesHistory e possui as seguintes propriedades:

 $ 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