Antes de empezar

Este tema proporciona información básica sobre el uso de los fragmentos de código.

¿Qué son los fragmentos de código?

Los fragmentos de código son pequeñas porciones de código que puede reutilizar en sus propias aplicaciones.

Los fragmentos de código utilizan código de la aplicación Fragmentos de código de Vonage Node y Fragmentos de código de Vonage Curl repositorios.

Lea atentamente esta información para utilizar mejor los fragmentos de código.

Requisitos previos

  1. Crear una cuenta API de Vonage
  2. Instalar Node JS - necesario para usar la interfaz de línea de comandos (CLI) de Vonage.
  3. Instalar la CLI de Vonage
  4. Instalar el SDK del Servidor de Nodos - sólo es necesario si se utiliza Node.
  5. Configurar webhooks.
  6. Saber escribir un servidor webhook
  7. Sepa cómo probar su servidor webhook localmente

Variables sustituibles

Genérico reemplazable

La siguiente información sustituible depende de la biblioteca y de la llamada específica:

ClaveDescripción
VONAGE_API_KEY

Your Vonage API key (see it on your dashboard).

VONAGE_API_SECRET

Your Vonage API secret (also available on your dashboard).

VONAGE_APPLICATION_PRIVATE_KEY_PATH

Private key path.

VONAGE_APPLICATION_PRIVATE_KEY

Private key.

VONAGE_APPLICATION_ID

The Vonage Application ID.

Numbers

Todos los números de teléfono están en formato E.164.

ClaveDescripción
VONAGE_NUMBER

Your Vonage Number. E.g. 447700900000

FROM_NUMBER

Replace with number you are sending from. E.g. 447700900002

TO_NUMBER

Replace with the number you are sending to. E.g. 447700900001

Sustituibles/variables específicas

Algunos fragmentos de código tienen variables más especializadas, como los ID de página de Facebook, que deberán sustituirse por valores reales. En caso necesario, estos valores se especifican para cada fragmento de código.

Webhooks

Los principales que encontrarás aquí son:

  • /webhooks/messages/inbound - Aquí recibirás una devolución de llamada cuando Vonage reciba un mensaje.
  • /webhooks/messages/status - Aquí recibirás una devolución de llamada cuando Vonage reciba una actualización del estado del mensaje.

Si realiza las pruebas localmente con Ngrok establecerás tus URL de webhook en el objeto de aplicación de Vonage utilizando un formato similar al de los siguientes ejemplos:

  • https://demo.ngrok.io/webhooks/messages/inbound
  • https://demo.ngrok.io/webhooks/messages/status

Cambia demo en lo anterior con lo que Ngrok genere para usted, a menos que haya pagado por una URL reutilizable.

NOTA: Asegúrese de que sus URL de webhooks están configuradas y de que su servidor de webhooks está en funcionamiento antes de probar su aplicación.

TIP: Sólo tiene que realizar este paso si está realizando pruebas con Curl, ya que los SDK de cliente y servidor generan los JWT según sus necesidades.

Una vez que hayas creado una aplicación API de Vonage, podrás usar el ID de la aplicación y el archivo de clave privada, private.key, para generar un JWT.

Para crear un token JWT utilizando el método CLI de Vonageutilice este comando

También puede utilizar nuestro Aplicación web JWT para generar un JWT.

TIP: Puede probar el JWT generado en jwt.io