Detalles técnicos

Una aplicación API de Vonage contiene la información de seguridad y configuración que necesitas para conectarte a los puntos finales de Vonage y usar las API de Vonage.

Cada aplicación de Vonage creada puede admitir múltiples capacidades; por ejemplo, puedes crear una aplicación que admita el uso de Voice, Messages y RTC API.

Para ilustrar el uso de las aplicaciones de Vonage, aquí se presenta un breve resumen para crear y utilizar una aplicación de voz de Vonage:

1. Crea una aplicación de Vonage usando la CLI, el panel o la API de aplicaciones.
2. Asegúrate de configurar tus URL de webhook. Vonage devolverá la llamada en estas URL con información importante.
3. Asocia un número de Vonage con tu aplicación de Vonage.
4. Escribe tu aplicación web. Implementa los puntos finales de webhook que configuraste en el paso 2, usando las API de Vonage según sea necesario.

Por ejemplo, si desea crear una aplicación que desvía las llamadas entrantes a un teléfono de destino, deberá realizar los siguientes pasos:

1. Crea una aplicación de Vonage que tenga funciones de voz.
2. Se configuran las URL de los webhooks de respuesta y evento.
3. Asocia un número de Vonage con tu aplicación de Vonage.
4. Implemente una aplicación web que responda a las devoluciones de llamada de las URL de los webhooks.
5. Cuando se realiza una llamada entrante al número de Vonage asociado con la aplicación de Vonage, un OCN se devuelve en el answer_url.

Otros tipos de aplicaciones, como las que disponen de funciones de Mensajes y Despacho, tienen un proceso ligeramente diferente que se describe en las secciones correspondientes de este documento. documentación.

Las siguientes secciones explican las aplicaciones de Vonage con más detalle.

Estructura

Cada aplicación tiene lo siguiente:

Capacidades

Una aplicación de Vonage puede usar varias API, como Voice, Messages and Dispatch, Conversation y Client SDK.

Al crear una aplicación puedes especificar las capacidades que quieres que soporte tu aplicación. Para cada capacidad puede establecer webhooks en función de las capacidades que desee, por ejemplo, para una aplicación con una función rtc puedes especificar una URL de evento para recibir eventos RTC. Si su aplicación también necesita utilizar voice también podría establecer una URL de respuesta para recibir un webhook de respuesta de llamada, una URL de reserva en caso de que su URL de respuesta falle, y otra URL de evento para recibir eventos relacionados con llamadas de voz.

En la tabla siguiente se ofrece un resumen de las capacidades:

Webhooks

Las URL de webhooks que se proporcionan al crear una aplicación dependen de las capacidades de la aplicación requeridas. La siguiente tabla resume los webhooks:

Tipos de webhook

La siguiente tabla describe los webhooks disponibles por capacidad:

Tiempos de espera de los webhooks

Para el voice se pueden establecer tiempos de espera en los webhooks. Se pueden especificar dos tiempos de espera: connection_timeout y socket_timeout. Estos parámetros se aplican al answer, eventy fallback y se especifican en milisegundos. La siguiente tabla proporciona más información:

Al crear o actualizar una aplicación, estos parámetros pueden definirse directamente o actualizarse en función de las necesidades, por ejemplo:

...
  "capabilities": {
    "voice": {
      "webhooks": {
        "answer_url": {
          "address": "https://example.com/webhooks/answer",
          "http_method": "POST",
          "connection_timeout": 500,
          "socket_timeout": 3000
        },
        "fallback_answer_url": {
          "address": "https://fallback.example.com/webhooks/answer",
          "http_method": "POST",
          "connection_timeout": 500,
          "socket_timeout": 3000
        },
        "event_url": {
          "address": "https://example.com/webhooks/event",
          "http_method": "POST",
          "connection_timeout": 500,
          "socket_timeout": 3000
        }
      }
    }
...

Si no se especifican estos valores al crear o actualizar la aplicación, se aplicarán los valores por defecto. Los valores por defecto para estos tiempos de espera dependen del webhook en cuestión, como se muestra en la siguiente tabla:

Hay más explicaciones sobre los tiempos de espera de los webhooks en la sección documentación sobre webhooks.

Creación de aplicaciones

Hay cuatro formas principales de crear una aplicación:

1. En el Vonage Cuadro de mandos. A continuación, las Applications aparecen en la lista sus aplicaciones del Cuadro de mandos.
2. Utilización de la CLI de Vonage.
3. Utilización de la API de aplicaciones.
4. Utilizando uno de los SDK de servidor.

Gestión de aplicaciones mediante la CLI

• Administración de aplicaciones mediante la CLI de Vonage

Fragmentos de código

• Application / Actualizar solicitud
• Application / Borrar una aplicación
• Application / Crear una aplicación
• Application / Lista de Applications
• Application / Obtener una solicitud
• User / Actualizar un usuario
• User / Crear un usuario
• User / Eliminar un usuario
• User / Lista de usuarios
• User / Obtener un usuario

Referencia

• API de aplicaciones