Sandbox da Messages API

O Sandbox da Messages API é uma maneira rápida de testar o envio de mensagens por meio de determinados canais de mensagens usando a Messages API da Vonage. Não é necessário configurar nenhum account externo com provedores (como a conta do WhatsApp Business). Isso significa que você pode testar esses canais da Messages API imediatamente usando sua conta da Vonage.

• WhatsApp
• Viber
• Facebook Messenger
• Instagram

Para usar o ambiente de teste e experimentar o envio de mensagens para um canal específico, seu número ou ID associado a esse canal deve primeiro ser adicionado à lista de números/IDs permitidos para o canal. Você precisará enviar uma mensagem para o ambiente de teste, conforme as instruções na Painel de controle para que seu número ou ID seja incluído na lista de permissões.

Observe que:

• Os números e IDs incluídos na lista de permissões estão associados a chaves de API da Vonage específicas. Se você incluir o mesmo número/ID na lista de permissões com uma chave de API da Vonage diferente (por exemplo, por meio de uma conta separada no Painel da Vonage), esse número/ID será removido da lista de permissões do Sandbox para a chave de API à qual ele havia sido adicionado anteriormente.
• O Sandbox utiliza um endpoint de API diferente do da Messages API em produção. Certifique-se de estar usando o endpoint do Sandbox ao testar a Messages API por meio do Sandbox.
• O Sandbox é destinado a experimentando a Messages API, por exemplo, durante uma exploração inicial da API. Ela não se destina a ser usada como parte de um ambiente de controle de qualidade (QA) ou de teste para avaliar sua integração antes da entrada em operação. Se você já decidiu integrar a Messages API ao seu aplicativo, recomendamos que crie sua própria Account seguindo as instruções no painel de controle do canal específico.

Preços do Sandbox da Messages API

O uso do Sandbox da Messages API é gratuito. É aplicado um limite mensal de uso razoável de 100 mensagens por mês. Se esse limite for excedido, suas solicitações de mensagens retornarão um Erro HTTP 429.

Limite de taxas

A Sandbox da Messages API tem um limite de taxa de uma mensagem por segundo.

Configure sua área de testes

Siga as etapas abaixo para configurar um canal no Sandbox (lembre-se de que cada canal precisa ser configurado separadamente).

1. Acesse o Sandbox da Messages API no Painel.
2. Se você tiver várias chaves de API disponíveis no Chave da API Na lista suspensa, selecione a chave de API a ser associada ao ambiente de teste que você está configurando.
3. Clique no Adicionar à área de teste Clique no link associado ao canal que você deseja configurar e siga as instruções no Painel desse canal.

Configurar webhooks

1. Insira o nome do seu aplicativo Entrada URL do webhook. O webhook de entrada é a URL para a qual as mensagens recebidas são encaminhadas.
2. Insira o nome do seu aplicativo Status URL do webhook. O webhook de status é a URL na qual você receberá atualizações sobre o status das mensagens.
3. Clique no Salvar webhooks botão.

Novas tentativas de webhook

Os webhooks de entrada e de status são repetidos individualmente para cada notificação na Sandbox da Messages API. Qualquer resposta que não seja 200 a um webhook fará com que a Vonage tente novamente periodicamente, em intervalos cada vez maiores: 5, 10, 20, 40, 80, 160, 320, 640 e, em seguida, a cada 900 segundos durante 24 horas.

Envie uma mensagem de teste por meio do Sandbox da Messages API

Assim que seu número ou ID do destinatário for incluído na lista de permissões, você precisará usar o endpoint da Sandbox da Messages API para enviar suas mensagens de teste. O from O valor na solicitação deve ser o ID ou o número associado à conta externa específica do Vonage Sandbox. Para fins de teste, o valor na from o campo já está preenchido nos trechos de código fornecidos no Painel de controle. É importante observar que você precisará substituir o valor no to preencha o campo com o seu número ou com o ID do destinatário que está na lista de permissões da conta externa específica do Vonage Sandbox.

O exemplo a seguir mostra como usar o Sandbox para enviar uma mensagem de texto pelo WhatsApp, mas a mesma abordagem geral pode ser aplicada a outros canais. Observe o uso do endpoint do Sandbox em vez do endpoint padrão do Messages (ao utilizar um dos SDKs de servidor, é necessário substituir o endpoint padrão).

Veja a seguir a descrição de todas as variáveis utilizadas em cada trecho de código:

curl -X POST $MESSAGES_SANDBOX_URL \
  -H "Authorization: Bearer "$JWT\
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -d $'{
    "to": "'${MESSAGES_TO_NUMBER}'",
    "from": "'${WHATSAPP_SENDER_ID}'",
    "channel": "whatsapp",
    "message_type": "text",
    "text": "This is a WhatsApp text message sent using the Vonage Messages API."
  }'

npm install @vonage/server-sdk @vonage/messages

const vonage = new Vonage(
  {
    applicationId: VONAGE_APPLICATION_ID,
    privateKey: VONAGE_PRIVATE_KEY,
  },
  {
    apiHost: MESSAGES_SANDBOX_URL,
  },
);

vonage.messages.send({
  to: MESSAGES_TO_NUMBER,
  from: WHATSAPP_SENDER_ID,
  channel: Channels.WHATSAPP,
  messageType: 'text',
  text: 'This is a WhatsApp text message sent using the Vonage Messages API.',
})
  .then((resp) => console.log(resp.messageUUID))
  .catch((error) => console.error(error));

implementation 'com.vonage:server-sdk-kotlin:2.1.1'

val client = Vonage {
    applicationId(VONAGE_APPLICATION_ID)
    privateKeyPath(VONAGE_PRIVATE_KEY_PATH)
}

println(client.messages.send(
    whatsappText {
        to(MESSAGES_SANDBOX_ALLOW_LISTED_TO_NUMBER)
        from(MESSAGES_SANDBOX_WHATSAPP_NUMBER)
        text("Hello from $WHATSAPP_SENDER_ID!")
    },
    sandbox = true
))

apply plugin: 'application'
mainClassName = project.hasProperty('main') ? project.getProperty('main') : ''

implementation 'com.vonage:server-sdk:9.3.1'

System.out.println(VonageClient.builder()
		.applicationId(VONAGE_APPLICATION_ID)
		.privateKeyPath(VONAGE_PRIVATE_KEY_PATH)
		.build()
		.getMessagesClient()
		.useSandboxEndpoint()
		.sendMessage(WhatsappTextRequest.builder()
			.from(MESSAGES_SANDBOX_WHATSAPP_NUMBER)
			.to(MESSAGES_SANDBOX_ALLOW_LISTED_TO_NUMBER)
			.text("Hello from Vonage, "+System.getenv("NAME"))
			.build()
		).getMessageUuid()
);

apply plugin: 'application'
mainClassName = project.hasProperty('main') ? project.getProperty('main') : ''

Install-Package Vonage

// Set "Url.Api" to "https://messages-sandbox.nexmo.com" in appsettings.json
var credentials = Credentials.FromAppIdAndPrivateKeyPath(VONAGE_APPLICATION_ID, VONAGE_PRIVATE_KEY_PATH);

var vonageClient = new VonageClient(credentials);

var request = new WhatsAppTextRequest
{
    To = messagesSandboxAllowListedToNumber,
    From = messagesSandboxWhatsAppNumber,
    Text = "A WhatsApp text message sent using the Vonage Messages API via the Messages Sandbox"
};

var response = await vonageClient.MessagesClient.SendAsync(request);

composer require vonage/client

$keypair = new \Vonage\Client\Credentials\Keypair(
    file_get_contents(VONAGE_APPLICATION_PRIVATE_KEY_PATH),
    VONAGE_APPLICATION_ID
);

$client = new \Vonage\Client(
    $keypair,
    [
        'base_api_url' => MESSAGES_SANDBOX_URL
    ]   
);

$whatsApp = new \Vonage\Messages\MessageType\WhatsApp\WhatsAppText(
    MESSAGES_SANDBOX_ALLOW_LISTED_TO_NUMBER,
    MESSAGES_SANDBOX_WHATSAPP_NUMBER,
    'This is a WhatsApp text message sent using the Vonage PHP SDK via the Messages Sandbox via the Messages Sandbox'
);

$response = $client->messages()->send($message);

pip install vonage python-dotenv

client = Vonage(
    auth=Auth(
        application_id=VONAGE_APPLICATION_ID,
        private_key=VONAGE_PRIVATE_KEY,
    ),
    http_client_options=HttpClientOptions(api_host=MESSAGES_SANDBOX_HOST),
)

message = WhatsappText(
    to=MESSAGES_TO_NUMBER,
    from_=WHATSAPP_SENDER_ID,
    text="This is a WhatsApp text message sent using the Vonage Messages API via the Messages Sandbox",
)

response = client.messages.send(message)

gem install vonage

client = Vonage::Client.new(
  application_id: VONAGE_APPLICATION_ID,
  private_key: VONAGE_PRIVATE_KEY,
  api_host: MESSAGES_SANDBOX_HOST
)

message = client.messaging.whatsapp(
  type: 'text',
  message: "This is a WhatsApp text message sent using the Vonage Messages API"
)

client.messaging.send(
  from: WHATSAPP_SENDER_ID,
  to: MESSAGES_TO_NUMBER,
  **message
)

Experimente

Ao executar o código, uma mensagem do WhatsApp é enviada para o número de destino.

Próximos passos

Agora que você já experimentou esses canais com o Sandbox da Messages API, veja a seguir algumas etapas que você pode seguir para começar a desenvolver com a própria Messages API:

Configure suas redes sociais

O procedimento exato para fazer isso dependerá do próprio canal. Você pode começar pelo Contas Externas página do Painel de Controle da Vonage ou consulte primeiro a documentação de Introdução específica para cada canal:

• Introdução ao WhatsApp
• Introdução ao Facebook Messenger
• Introdução às Mensagens Empresariais do Viber

Saiba mais sobre as redes sociais

Leia nossa documentação específica para cada canal para saber mais sobre cada rede social e como ela funciona:

• Entendendo as mensagens do WhatsApp
• Entendendo as mensagens do Facebook
• Entendendo as mensagens do Viber