Conmutador virtual

API de llamadas de VoIPer

VoIPer dispone de una amplia gama de herramientas para integrar el conmutador virtual con sistemas  externos. En primer lugar hay una serie de APIs basadas en servicios web; esto significa que su sistema puede hacer peticiones al nuestro a través del Internet.

Las APIs le permiten integrar nuestros servicios telefónicos, número virtual, conmutador, etc. en sus aplicaciones en PC, en apps móviles o en su web.

La interfaz API gratuita de VoIPer  viene incluida en el servicio de conmutador virtual de VoIPer.

Incluye todas las funciones básicas para el funcionamiento.

Descripción de la API de llamadas de Voiper

Hay dos tipos de API de llamadas de VoIPer, una para realizar llamadas que denominamos “outbound” y otra para notificar la entrada de llamadas que denominamos “inbound”.

El API “outbound” consistente en una petición HTTP POST sobre TLS al servidor de VoIPer, es necesaria la autenticación para poder hacer uso.

El API “inbound” dispone de unos métodos para establecer en el sistema la URL de notificación “PUSH” y que el servidor notifique la entrada de llamadas. Solo es necesario la autenticación para establecer la URL.

Para usar cualquier API, el usuario y la contraseña será facilitada por atención al cliente de VoIPer como medida de seguridad.

API

Url del WebService

NombreObligatorioValor por defectoDescripción
SourceNúmero de extensión o teléfono que origina la llamada.
DestinationNúmero de extensión o teléfono que recibe la llamada.
DbiEl número de teléfono configurado como cabezera en el servicio de VOBX  o Trunk SIP.Número de señalización de la llamada. Si el número indicado no pertenece al cliente, será reemplazado por el valor por defecto.
TimeoutNo60 segundosSegundos de timbrado de la llamada.

Retorno del EndPoint

Siempre que la petición sea correctamente procesada, independientemente del resultado de la llamada, retornara un 200 Ok, de lo contrario lo hará con un 422 Unprocessable Entity. También puede retornar un 500 Server Error en caso de una petición HTTP muy mal formada. La notificación push se puede hacer al servidor del cliente en HTTP y HTTPS, no importando la validez del certificado de éste.

El contenido de la respuesta siempre será en JSON.
Ejemplo de respuesta de 200 Ok de una llamada contestada
{«response»:»Success»,»message»:»Originate successfully queued»}
Ejemplo de respuesta de 200 Ok de una llamada no contestada
{«response»:»Error»,»message»:»Originate failed»}
Ejemplo de respuesta de 422 Unprocessable Entity
{«error»:»…[descripción del error]…»}

Ejemplo de invocación del Endpoint con curl

/usr/bin/curl -v -X POST –user «usuario:contraseña» –data «source=100&destination=600600600&ddi=900900900&timeout=30»
https://test.panel.voiper.es/api/calls

PATCH /api/calls/push

Parámetros de invocación

NombreObligatorioValor por defectoDescripción
ExtensiónNúmero de extensión de la cual se notificarán las llamadas entrantes.
UrlNoUrl donde se hará la petición http de la notificación PUSH. Si es un valor vacío, se anulará la notificación.
DataNoInformación del POST que será enviada junto con la petición HTTP.

Retorno del Endpoint

Siempre que la petición sea correctamente procesada retornara un 200 Ok, de lo contrario lo hará con un 422 Unprocessable Entity. También puede retornar un 500 Server Error en caso de una petición HTTP muy mal formada.

El contenido de la respuesta siempre será en JSON.

Ejemplo de respuesta de 200 Ok
{«status»:»Ok»}

Ejemplo de respuesta de 422 Unprocessable Entity
{«status”:»error»,»error»:»…[descripción del error]…»}

Ejemplo de invocación del Endpoint con curl

/usr/bin/curl -v -X PATCH –user «usuario:contraseña» –data «extension=100&url=http://midominio.es/directoriosecreto/push.php&data=extension=[extension]&caller=[caller]»

https://test.panel.voiper.es/api/calls

Esta invocación del Endpoint creará un petición HTTP a http://midominio.es/directoriosecreto/push.php con el contenido POST “extension=100&caller=900900900” cada vez que una estructura similar a “name=Nombre del cliente, S.L.” que será pasado a la pantalla del teléfono.

Si quiere probar un conmutador telefónico de VoIPer durante 30 días gratis, rellene el formulario y uno de nuestros asesores se pondrá en contacto con usted a la mayor brevedad posible.

Menú
Contacta con nosotros

VoIPer es líder en telefonía IP para empresas. Con nosotros, aumentará las funcionalidades en las comunicaciones de su empresa, reduciendo los costes hasta un 90%.

×