Datos técnicos de la 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.

La Dispatch API de Vonage permite al desarrollador enviar mensajes a los usuarios usando una estrategia de canales múltiples.

Un ejemplo de flujo de trabajo podría especificar que se envíe un mensaje a través de Facebook Messenger, y si ese mensaje no se lee, entonces se puede enviar al usuario un mensaje a través de Viber. Si ese mensaje tampoco se lee, entonces se podría enviar al usuario un mensaje a través de SMS.

La Dispatch API proporciona el mecanismo mediante el cual ordenar los mensajes y especificar su condiciones de éxito. La Dispatch API utiliza la Messages API para enviar los mensajes.

El siguiente diagrama ilustra la relación entre la Dispatch API y la Messages API:

Messages and Dispatch Overview

Beta

Esta API se encuentra actualmente en fase Beta.

En esta versión, Vonage proporciona una plantilla de conmutación por error. La plantilla de conmutación por error indica al Messages API para enviar un mensaje al canal especificado. Si ese mensaje falla inmediatamente o si el condition_status no se alcanza en el plazo especificado, se envía el siguiente mensaje.

Vonage siempre agradece tus comentarios. Tus sugerencias nos ayudan a mejorar el producto. Si necesitas ayuda, envía un email a soporte e incluya Workflow API en el asunto. Tenga en cuenta que durante el periodo Beta, el horario de asistencia se limita a lunes a viernes.

Funciones compatibles

En esta versión puedes:

  • Enviar SMS, Facebook Messenger, WhatsApp y Viber Mensajes de empresa con Despacho incorporado en el Messages API.
  • Conmutación por error al siguiente mensaje si el estado de la condición no se cumple dentro del periodo de tiempo o si el mensaje falla inmediatamente.

El estado de condición es el estado que devuelve el mensaje. Con Facebook Messenger y Viber Business Messages, puede utilizar delivered y read como estado de condición. Con SMS sólo puede utilizar delivered.

API de cuentas externas

En API de cuentas externas se utiliza para gestionar sus cuentas de Viber Business Messages, Facebook Messenger y WhatsApp cuando utiliza esos canales con las API de Messages y Dispatch.

Cómo empezar

En este ejemplo tendrá que sustituir las siguientes variables por valores reales utilizando cualquier método conveniente:

Clave Descripción
VONAGE_API_KEY Clave API de Vonage que puedes obtener de tu Panel de API de Vonage.
VONAGE_API_SECRET Secreto de API de Vonage que puede obtenerse de tu Panel de API de Vonage.
FB_SENDER_ID Su ID de página. En FB_SENDER_ID es el mismo que el to.id que recibió en el evento de mensajería entrante en su URL de Webhook de Mensaje Entrante.
FB_RECIPIENT_ID El PSID del usuario al que desea responder. La dirección FB_RECIPIENT_ID es el PSID del usuario de Facebook al que envías el mensaje. Este valor es el from.id que recibió en el evento de mensajería entrante en su URL de Webhook de Mensaje Entrante.
FROM_NUMBER Un número de teléfono de tu propiedad o algún texto para identificar al remitente.
TO_NUMBER El número del teléfono al que se enviará el mensaje.

NOTA: No utilice un + o 00 cuando introduzca un número de teléfono, empiece por el prefijo del país, por ejemplo 447700900000.

El siguiente código muestra cómo crear un flujo de trabajo que intenta enviar un mensaje a través de Facebook messenger y si no se lee dentro del límite de tiempo se enviará un mensaje a través de SMS:

Escriba el código

Añada lo siguiente a 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 fuente completa

Ejecute su código

Guarde este archivo en su máquina y ejecútelo:

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

Concepts

Fragmentos de código

Tutoriales

Casos prácticos

Referencia