Descargar sipgate - Descarga del código fuente sipgate

sipgate

Otras categorias

1.0.0

Descargar

? Biblioteca PHP para integración con sipgate

Requisitos

PHP 7.1 o superior y extensión json .

Instalación

composer require innoscripta/ sipgate

Uso

Inicializar la clase sipgate :

sipgate sipgate ();">

 $ sipgate =  Orkhanahmadov  sipgate  sipgate ();

Autenticación básica

Puede pasar el nombre de usuario y la contraseña de autenticación básica al inicializar la clase:

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

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

O puede configurar la autenticación básica con el método setBasicAuthCredentials() :

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

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

Información de la cuenta:

 $ sipgate -> account ();

Devuelve una serie de detalles de la cuenta.

Obtener usuarios:

 $ sipgate -> users ();

Devuelve una matriz de usuarios registrados en la cuenta. Cada elemento de la matriz es una instancia de Orkhanahmadov sipgate ResourcesUser y tiene las siguientes propiedades:

 $ 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

Obtener dispositivos de usuario:

Para obtener los dispositivos del usuario, utilice el método devices() y pase una instancia de usuario o ID de usuario.

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

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

Devuelve una serie de dispositivos registrados para un usuario determinado. Cada elemento de la matriz es una instancia de Orkhanahmadov sipgate ResourcesDevice y tiene las siguientes propiedades:

 $ 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

Llamadas activas:

Utilice el método calls() para obtener la lista de llamadas establecidas actualmente.

 $ sipgate -> calls ();

Devuelve una matriz de llamadas actualmente establecidas. Cada elemento de la matriz es una instancia de Orkhanahmadov sipgate ResourcesCall y tiene las siguientes propiedades:

 $ 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 nueva convocatoria:

Utilice el método call() para iniciar una nueva llamada. El método acepta 3 parámetros:

$device : acepta instancia de dispositivo o ID de dispositivo. Esto define qué dispositivo desea utilizar para realizar una llamada.
$callee : número de teléfono al que desea llamar.
$callerId (opcional): establezca este parámetro si desea mostrar un número diferente a la otra persona que llama. Cuando se omite, se utilizará el número $device .

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

Devuelve el ID de sesión de la llamada.

Colgar llamada en curso:

Utilice el método hangup() para colgar la llamada en curso. El método acepta el ID de llamada como parámetro:

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

Grabar llamada en curso:

Utilice el método record() para registrar la llamada en curso. El método acepta 3 parámetros:

$callId : ID de llamada único.
$value : true o false , define el inicio o la parada de la grabación.
$announcement : true o false , define si desea reproducir un anuncio sobre la llamada que se está grabando.

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

Historial de llamadas:

Utilice el método history() para obtener el historial de llamadas. El método acepta una variedad de opciones:

connectionIds - array , define la lista de extensiones
types : array , define la lista de tipos que desea recibir en el historial, puede contener uno de los muchos valores siguientes: "LLAMADA", "CORREO DE VOZ", "SMS", "FAX"
directions : array , define la lista de direcciones de llamadas que desea recibir en el historial, puede contener uno de los muchos valores siguientes: "ENTRANTE", "SALIENTE", "MISSED_INCOMING", "MISSED_OUTGOING"
archived - bool , configúrelo true si desea recibir solo elementos del historial archivados
starred : define si desea recibir elementos del historial destacados o no destacados, uno de estos: "DESTALLADO", "NO DESTACADO"
from : define la fecha de inicio del historial. Debe estar en formato ISO8601
to : define la fecha de finalización del historial. Debe estar en formato ISO8601
phonenumber : define el número de teléfono que se buscará en el historial
limit : define el valor "por página" para los elementos del historial
offset : define el valor de "compensación" para los elementos del historial

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

Devuelve una serie de elementos del historial. Cada elemento de la matriz es una instancia de Orkhanahmadov sipgate ResourcesHistory y tiene las siguientes propiedades:

 $ 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

Pruebas

composer test

Registro de cambios

Consulte CHANGELOG para obtener más información sobre los cambios recientes.

Contribuyendo

Consulte CONTRIBUCIÓN para obtener más detalles.

Seguridad

Si descubre algún problema relacionado con la seguridad, envíe un correo electrónico a [email protected] en lugar de utilizar el rastreador de problemas.