Antes de começar
Este tópico fornece algumas informações básicas sobre como usar os trechos de código.
O que são trechos de código?
Trechos de código são pequenos fragmentos de código que você pode reutilizar em suas próprias applications.
Os trechos de código utilizam código do Trechos de código do Vonage Node e Trechos de código do Vonage Curl repositórios.
Leia estas informações com atenção para que você possa aproveitar ao máximo os trechos de código.
Pré-requisitos
- Criar um Account na API da Vonage
- Instalar o Node.js - necessário para utilizar a Interface de Linha de Comando (CLI) da Vonage.
- Instale o CLI da Vonage
- Instale o SDK do Node Server - necessário apenas se estiver usando o Node.
- Configurar webhooks.
- Saiba como criar um servidor de webhooks
- Saiba como testar seu servidor de webhooks localmente
Variáveis substituíveis
Genérico, substituível
As seguintes informações substituíveis dependem da biblioteca e da chamada específica:
| Chave | Descrição |
|---|---|
VONAGE_API_KEY | Your Vonage API key (see it on |
VONAGE_API_SECRET | Your Vonage API secret (also available on |
VONAGE_APPLICATION_PRIVATE_KEY_PATH | Private key path. |
VONAGE_APPLICATION_PRIVATE_KEY | Private key. |
VONAGE_APPLICATION_ID | The Vonage Application ID. |
Numbers
Todos os números de telefone estão no formato E.164.
| Chave | Descrição |
|---|---|
VONAGE_NUMBER | Your Vonage Number. E.g. |
FROM_NUMBER | Replace with number you are sending from. E.g. |
TO_NUMBER | Replace with the number you are sending to. E.g. |
Variáveis específicas/substituíveis
Alguns trechos de código contêm variáveis mais específicas, como os IDs de páginas do Facebook, que precisarão ser substituídos por valores reais. Quando necessário, essas variáveis são especificadas individualmente para cada trecho de código.
Webhooks
Os principais que você encontrará aqui são:
/webhooks/messages/inbound- Você receberá uma ligação de retorno aqui assim que a Vonage receber uma mensagem./webhooks/messages/status- Você receberá uma notificação aqui assim que a Vonage receber uma atualização do status da mensagem.
Se você estiver realizando testes localmente usando Ngrok Você definirá as URLs dos seus webhooks no objeto “Vonage Application” usando um formato semelhante aos exemplos a seguir:
https://demo.ngrok.io/webhooks/messages/inboundhttps://demo.ngrok.io/webhooks/messages/status
Alterar demo no texto acima, substitua pelo que o Ngrok gerar para você, a menos que você tenha adquirido uma URL reutilizável.
NOTA: Certifique-se de que as URLs dos seus webhooks estejam configuradas e que o servidor de webhooks esteja em funcionamento antes de testar seu aplicativo.
DICA: Você só precisa seguir esta etapa se estiver realizando testes com o Curl, já que os SDKs do cliente e do servidor geram os JWTs conforme necessário para você.
Depois de criar uma aplicação da API da Vonage, você poderá usar o ID da aplicação e o arquivo da chave privada, private.key,
para gerar um JWT.
Para criar um token JWT usando o CLI da Vonage, use 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
Como alternativa, você pode usar nosso Aplicativo web JWT para gerar um JWT.
DICA: Você pode testar o JWT gerado em jwt.io