Click2Call

Atención

Para hacer un click2call a una extensión interna y que al descolgar se marque a un destino exterior, se usará el método Generar llamada a extensión.

Si lo que se quiere hacer es sonar en un número exterior y enviar a un destino interno (tal como una cola, grupo de ring, extensión, menú vocal, etc), se tendrá que usar el método Generar llamada a un número exterior

Generar llamada a extensión

GET /originatecall/FROM/TO

Descripción

Genera una llamada desde FROM (extensión) hacía TO

Hay que tener en cuenta que el FROM sólo puede ser una extensión de la PBX. Se deberán de usar destinos externos para usar el FROM con números tradicionales.

Permisos

Generar llamadas (click2call) en la centralita asignada a la Api Key utilizada.

Petición

La petición se realizará pasando en la URL todos los parámetros necesarios

Parámetros URL

Nombre Tipo Valor por defecto Opcional Descripción
FROM numérico - No Extensión dónde sonará primero
TO numérico - No Destino donde se llamará una vez descolgada la llamada en FROM
timeout numérico 30 Tiempo en segundos que sonará en FROM antes de descartar la llamada
autoAnswer booleano false Desculegue automático en FROM (sólo para terminales soportados)
outboundId uuid null Una vez descolgado en FROM, la llamada al TO se cursará por las Reglas de salida con el indentificador indicado
  • URL de ejemplo completa
https://vpbx.me/api/originatecall/120/966261122?timeout=20&autoAnswer=true&outboundId=afb77f08177247fabe8fadf4a7307af0

Generar llamada a un número exterior

GET /c2cexternal/FROM/TO

Descripción

Genera una llamada desde FROM hacía TO (destino interno)

Hay que tener en cuenta que el TO sólo puede ser un destino interno de la PBX.

Permisos

Generar llamadas (click2call) en la centralita asignada a la Api Key utilizada.

Petición

La petición se realizará pasando en la URL todos los parámetros necesarios

Parámetros URL

Nombre Tipo Valor por defecto Opcional Descripción
FROM númerico - No Número externo dónde sonará primero
TO númerico - No Destino interno donde se llamará una vez descolgada la llamada en FROM, será un Número Dp o una extensión
timeout númerico 30 Tiempo en segundos que sonará en FROM antes de descartar la llamada
outboundId uuid null Una vez descolgado en FROM, la llamada al TO se cursará por las Reglas de salida con el indentificador indicado
  • URL de ejemplo completa
https://vpbx.me/api/c2cexternal/966261122/*601?timeout=20&outboundId=afb77f08177247fabe8fadf4a7307af0

Respuesta

El servicio web devolverá un mensaje JSON con los siguiente parámetros:

  • success: true|false en función de si se ha procesado correctamente el click2call
  • message: mensaje descriptivo
  • variables: variables usadas en el request

Ejemplo de respuesta al request de ejemplo

{
 "success":true,
 “message":"Call originated",
 "method":"originatecall",
 "variables":
        {
         "from":"120",
         "to":"966261122",
         "timeout":"20",
         "autoAnswer":"true",
         "outboundId":"afb77f08177247fabe8fadf4a7307af0",
         "callId":"8e09b9c9-42e6-46ef-9b83-4187b0c2312c"
        }
}

Obtener el ID de la llamada generada por un clic2call

GET /cdrc2c/<call id>

Descripción

Devuelve el callId del cdr de una llamada generada por el click2call, para ello se pasa el callId devuelto por servicio de click2call.

Permisos

Obtener IDs de click2call en la centralita asignada a la Api Key utilizada.

Petición

https://vpbx.me/api/cdrc2c/a992ba30-8233-11e5-8d44-6f9b49995edf

Respuesta

El servicio web devolverá un mensaje JSON con los siguientes parámetros:

  • uuid: identificador real de la llamada generada en el click2call

Ejemplo de respuesta al request de ejemplo

{
"uuid":"ebebaf72-8233-11e5-bc95-53cfef9baeb1"
}

Puede consultar la sección Código de ejemplo para más información