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 procedente de la Fragmentos de código de Vonage Node y Fragmentos de código de Vonage Curl repositorios.

Lee atentamente esta información para que puedas sacar el máximo partido a los fragmentos de código.

Requisitos previos

  1. Crear un Account de la API de Vonage
  2. Instalar Node JS - Es necesario para utilizar la interfaz de línea de comandos (CLI) de Vonage.
  3. Instalar la CLI de Vonage
  4. Instalar el SDK del Servidor de Nodos - Solo es necesario si se utiliza Node.
  5. Configurar webhooks.
  6. Aprende a crear un servidor de webhooks
  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 concreta:

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

Variables y elementos sustituibles específicos

Algunos fragmentos de código contienen variables más específicas, como los ID de páginas de Facebook, que deberán sustituirse por valores reales. Cuando sea necesario, estas variables se especifican en cada fragmento de código.

Webhooks

Los principales que encontrarás aquí son:

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

Si estás realizando pruebas de forma local utilizando Ngrok Deberás configurar las URL de tus webhooks en el objeto «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

Cambiar demo en lo anterior, sustituyéndolo por lo que Ngrok te genere, a menos que hayas 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.

CONSEJO: Solo tienes que seguir este paso si estás realizando pruebas con Curl, ya que los SDK de cliente y servidor generan los JWT según sea necesario.

Una vez que hayas creado una aplicación de la API de Vonage, podrás utilizar 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 CLI de Vonageutilice este comando

# A command with parameters
vonage jwt create `
--app-id='00000000-0000-0000-0000-000000000000' `
--private-key=./private.key

# Will produce a token
eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJleHAiOjE3MzYyODE5NDYsImp0aSI6IjBmZjcwZDNmLTAzN2EtNGY4MC04ODZjLWI3MmM3MmQyMWNmMiIsImlhdCI6MTczNjI4MTA0NiwiYXBwbGljYXRpb25faWQiOiIwMDAwMDAwMC0wMDAwLTAwMDAtMDAwMC0wMDAwMDAwMDAwMDAifQ.gA7jClpqaZ2OoS0iri-zGCbda4jO7C0M8mka0EnSyjlds1EeY8fNoBEx3FTXHfkkzzrj0TskrWc_dcs1wuM8Kx55c5rLQ7taVpDAYopKSc_CeeOaad8S6aWnRkTUTNeduO4aIn-0CbyRTluBYsH1RBqYBQvobuQIDEwbFw8xBgx0UfREMMN6DAWknR57eiVXN9x_oD6CGQJ1yV3025nGboeMsP9YgX4Nwc-rE2r8c1ZGwCLO81x8i19Qil3Nwu5q1nzouyavQjIw00B_TZkushnI1ufdi_GNqk-h5q2HvGkg7Pj9bVkZHFdVTO8im03JYNyJmcV83vnpjOLuCFRzxQ

REM A command with parameters
vonage jwt create ^
--app-id='00000000-0000-0000-0000-000000000000' ^
--private-key=./private.key

REM Will produce a token
eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJleHAiOjE3MzYyODE5NDYsImp0aSI6IjBmZjcwZDNmLTAzN2EtNGY4MC04ODZjLWI3MmM3MmQyMWNmMiIsImlhdCI6MTczNjI4MTA0NiwiYXBwbGljYXRpb25faWQiOiIwMDAwMDAwMC0wMDAwLTAwMDAtMDAwMC0wMDAwMDAwMDAwMDAifQ.gA7jClpqaZ2OoS0iri-zGCbda4jO7C0M8mka0EnSyjlds1EeY8fNoBEx3FTXHfkkzzrj0TskrWc_dcs1wuM8Kx55c5rLQ7taVpDAYopKSc_CeeOaad8S6aWnRkTUTNeduO4aIn-0CbyRTluBYsH1RBqYBQvobuQIDEwbFw8xBgx0UfREMMN6DAWknR57eiVXN9x_oD6CGQJ1yV3025nGboeMsP9YgX4Nwc-rE2r8c1ZGwCLO81x8i19Qil3Nwu5q1nzouyavQjIw00B_TZkushnI1ufdi_GNqk-h5q2HvGkg7Pj9bVkZHFdVTO8im03JYNyJmcV83vnpjOLuCFRzxQ
# A command with parameters vonage jwt create \ --app-id='00000000-0000-0000-0000-000000000000' \ --private-key=./private.key # Will produce a token eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJleHAiOjE3MzYyODE5NDYsImp0aSI6IjBmZjcwZDNmLTAzN2EtNGY4MC04ODZjLWI3MmM3MmQyMWNmMiIsImlhdCI6MTczNjI4MTA0NiwiYXBwbGljYXRpb25faWQiOiIwMDAwMDAwMC0wMDAwLTAwMDAtMDAwMC0wMDAwMDAwMDAwMDAifQ.gA7jClpqaZ2OoS0iri-zGCbda4jO7C0M8mka0EnSyjlds1EeY8fNoBEx3FTXHfkkzzrj0TskrWc_dcs1wuM8Kx55c5rLQ7taVpDAYopKSc_CeeOaad8S6aWnRkTUTNeduO4aIn-0CbyRTluBYsH1RBqYBQvobuQIDEwbFw8xBgx0UfREMMN6DAWknR57eiVXN9x_oD6CGQJ1yV3025nGboeMsP9YgX4Nwc-rE2r8c1ZGwCLO81x8i19Qil3Nwu5q1nzouyavQjIw00B_TZkushnI1ufdi_GNqk-h5q2HvGkg7Pj9bVkZHFdVTO8im03JYNyJmcV83vnpjOLuCFRzxQ

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

CONSEJO: Puedes probar el JWT que has generado en jwt.io