Detalhes técnicos da Dispatch API

Product deprecation notice

From August 31st 2025, the Vonage Dispatch API will be closed to new users, though the product will continue to be supported for existing users. If you are looking to build a messaging application with failover functionality, failover is now supported directly in the Messages API.

For general information about the Messages Failover feature please refer to this guide. For guidance on migrating from Dispatch API to Messages API Failover, please refer to this guide.

If you have any further questions regarding this product deprecation, please contact your account manager or support for help.

A Dispatch API de Vonage permite que o desenvolvedor envie mensagens aos usuários por meio de uma estratégia multicanal.

Um exemplo de fluxo de trabalho poderia especificar o envio de uma mensagem pelo Facebook Messenger e, caso essa mensagem não seja lida, o usuário poderia receber uma mensagem pelo Viber. Se essa mensagem também não for lida, o usuário poderia então receber uma mensagem por SMS.

A Dispatch API fornece o mecanismo para ordenar mensagens e especificar sua condições de sucesso. A Dispatch API utiliza a Messages API para enviar as mensagens propriamente ditas.

O diagrama a seguir ilustra a relação entre a Dispatch API e a Messages API:

Messages and Dispatch Overview

Beta

Atualmente, essa API está em fase beta.

Nesta versão, a Vonage disponibiliza um modelo de failover. O modelo de failover instrui o Messages API para enviar uma mensagem ao canal especificado. Se essa mensagem falhar imediatamente ou se o condition_status Se não for alcançado dentro do prazo especificado, a próxima mensagem é enviada.

A Vonage sempre agradece seus comentários. Suas sugestões nos ajudam a melhorar o produto. Caso precise de ajuda, envie um e-mail para apoio e inclua “Workflow API” na linha de assunto. Observe que, durante o período beta, o horário de atendimento é limitado de segunda a sexta-feira.

Recursos compatíveis

Nesta versão, você pode:

  • Enviar Mensagens por SMS, Facebook Messenger, WhatsApp e Viber Business com o Dispatch, desenvolvido com base no Messages API.
  • Failover para a próxima mensagem, caso a condição não seja atendida dentro do prazo ou se a mensagem falhar imediatamente.

O status da condição é o status que a mensagem retorna. Com o Facebook Messenger e o Viber Business Messages, você pode usar delivered e read status como o status da condição. Com o SMS, você só pode usar delivered.

API de Contas Externas

O API de Contas Externas é usado para gerenciar seus Accounts do Viber Business Messages, do Facebook Messenger e do WhatsApp ao utilizar esses canais com as APIs do Messages e da Dispatch API.

Introdução

Neste exemplo, você precisará substituir as seguintes variáveis por valores reais, utilizando qualquer método que lhe for mais conveniente:

Chave Descrição
VONAGE_API_KEY Chave da API da Vonage, que pode ser obtida em sua Painel da API da Vonage.
VONAGE_API_SECRET Chave secreta da API da Vonage, que pode ser obtida em sua Painel da API da Vonage.
FB_SENDER_ID Seu ID da página. O FB_SENDER_ID é igual ao to.id valor que você recebeu no evento do Messenger de entrada na URL do seu webhook de mensagens de entrada.
FB_RECIPIENT_ID O PSID do usuário ao qual você deseja responder. O FB_RECIPIENT_ID é o PSID do usuário do Facebook para quem você está enviando a mensagem. Esse valor é o from.id valor que você recebeu no evento do Messenger de entrada na URL do seu webhook de mensagens de entrada.
FROM_NUMBER Um número de telefone de sua propriedade ou algum texto para identificar o remetente.
TO_NUMBER O número de telefone para o qual a mensagem será enviada.

NOTA: Não use um espaço à esquerda + ou 00 Ao digitar um número de telefone, comece com o código do país, por exemplo, 447700900000.

O código a seguir mostra como criar um fluxo de trabalho que tenta enviar uma mensagem pelo Facebook Messenger e, caso ela não seja lida dentro do prazo, uma mensagem será enviada por SMS:

Escreva o código

Adicione o seguinte ao arquivo ` send-message-with-failover-basic-auth.sh`:

curl -X POST https://api.nexmo.com/v0.1/dispatch \
  -u "$VONAGE_API_KEY:$VONAGE_API_SECRET" \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -d $'{
    "template":"failover",
    "workflow": [
      {
        "from": { "type": "messenger", "id": '$FB_SENDER_ID' },
        "to": { "type": "messenger", "id": '$FB_RECIPIENT_ID' },
        "message": {
          "content": {
            "type": "text",
            "text": "This is a Facebook Messenger Message sent from the Dispatch API"
          }
        },
        "failover":{
          "expiry_time": 600,
          "condition_status": "read"
        }
      },
      {
        "from": {"type": "sms", "number": '$FROM_NUMBER'},
        "to": { "type": "sms", "number": '$TO_NUMBER'},
        "message": {
          "content": {
            "type": "text",
            "text": "This is an SMS sent from the Dispatch API"
          }
        }
      }
    ]
  }'

Ver código-fonte completo

Execute seu código

Salve este arquivo no seu computador e execute-o:

bash send-message-with-failover-basic-auth.sh

Concepts

Trechos de código

Tutoriais

Casos de uso

Referência