Flujo de inscripción integrado en WhatsApp para socios tecnológicos

WhatsApp Hosted Embedded Sign-up Flow es una interfaz de usuario de incorporación de marca blanca. Permite a los socios de Vonage incorporar a sus clientes a WhatsApp Business Accounts sin necesidad de crear, configurar o alojar su propio flujo de registro integrado.

A continuación se ofrece un resumen de los requisitos previos y el flujo del proceso. Si desea información más detallada, consulte la página Guía de inscripción de proveedores de tecnología.

Requisitos previos

Para aprovechar la solución de inscripción integrada, los socios de Vonage deben cumplir los siguientes requisitos previos:

  • Registrarse en Meta como proveedor de tecnología
  • Tener una metaaplicación activa en el panel de aplicaciones
  • Tener permisos de "Control total" o de administrador en la cartera de negocios en la que se va a incorporar un número WABA o WhatsApp.
  • Has enviado una solicitud de solución a Vonage, la solicitud ha sido aceptada y se te ha proporcionado un ID de solución.

Si tienes preguntas o necesitas ayuda con alguno de los requisitos previos mencionados anteriormente, comunícate con tu administrador de cuentas de Vonage.

Flujo de procesos

El proceso para registrarse en WhatsApp Hosted Embedded es el siguiente:

  1. El socio de Vonage genera una URL de inscripción incrustada
  2. El socio puede compartir la URL con sus clientes (por ejemplo, por correo electrónico o SMS, o incrustando la URL en su propia página web).
  3. La URL dirige al cliente a una experiencia de flujo de registro incrustado de marca blanca alojado por Vonage a través del cual se puede completar el registro de onboarding de WhatsApp Business Account (WABA) o WhatsApp number
  4. El cliente completa el proceso de incorporación utilizando el flujo de registro integrado.

Nota: Los intentos de alta o baja para cada número de WhatsApp son limitados (10 intentos por número y semana).

Generar una URL de registro incrustada

Se puede generar una URL de registro incrustada realizando una solicitud POST al archivo Generar punto final URL de flujo ES alojado de la API de Channel Manager.

Nota: la API de Channel Manager se encuentra actualmente en estado de versión Beta.

La autenticación puede realizarse mediante Basic Auth o Bearer Token (JWT) Auth.

El cuerpo de la solicitud debe contener un objeto JSON con, al menos, un elemento solution_id cuyo valor es el ID de solución proporcionado por Vonage (véase requisitos previos).

El cuerpo también puede contener un api_key para identificar la subcuenta de Vonage del cliente para el cual el socio desea crear la URL (si se omite esta propiedad, se utilizará la clave de API principal para la cuenta principal de Vonage).

A ttl también puede especificarse para establecer el límite de tiempo de validez de la URL generada (Máximo 3 días; si se omite, se utiliza la validez por defecto de 86400 segundos, o un día).

Ejemplo de cuerpo de solicitud

{
  "solution_id": "123456789111213",
  "api_key": "abc123", // Optional
  "ttl": 3600 // Optional
}

Ejemplo de cuerpo de respuesta

Una respuesta correcta devolverá un código de estado HTTP de 200 e incluir un cuerpo de respuesta con un objeto JSON que contenga la URL de registro incrustada generada, así como un ID de rastreo para la solicitud.

{
  "id": "3amb0119-0196-42d1-8fb5-55a98s133546",
  "url": "https://tools.vonage.com/wa/partners/onboard?token=fhdhhdJhbGciOiJSUzI1NiJ9.eyJleHAiOjE3MjU5Njc1OTYsImp0aSI6ImQ1MmJhNmFjLWYxZjktNDdmNC05MTR_cFT1bVfkDhP-wgpKZibSbUoh9z-9KGD-wsmHxi0h7tTidpVhPNShfC5jmgiHtOQKXXv5NWb9OqoUraOMMpqCdNdXoN3ao-PeZX7axyYW_FQ6CeV9gDEPhAZ4urTi0uW4mCYGl3ULmA9Ps92r_wi2DJyRE_Kx2KahWtQd51yVpU6FfXgMb4odREEccDctT1Peo09wKgwBa1wsOkD7rrvkoQPqZ00VXcqOY1_LOO5tq4WJaKqtxX-U7VtDo9qyVUl8pdegZW6QWChQzGN4PkqXXLWcBlyrCtAYdhtWG8q6NM_6bARRjcGJlj0tQvE0PZ9AtafAQSPpOll5lcnUK8Ds"
}

Cómo comprobar el estado del número de verificación del teléfono de WhatsApp

Como parte del proceso de registro del número de WhatsApp, se enviará una contraseña de un solo uso (OTP) al número que se está registrando para verificar el número. La verificación debe completarse correctamente antes de utilizar el número.

El estado de verificación de los números puede comprobarse de las siguientes maneras:

Nota: Los administradores de clientes también recibirán una notificación por correo electrónico y una notificación de Meta Business Suite sobre el estado de la incorporación.

Comprobar manualmente el estado de un número

Para comprobar manualmente el estado de un número, puedes visitar la interfaz WhatsApp Manager de tu WABA. Un número activo mostrará un estado de Conectado.

Screenshot of WhatsApp Manager showing number status

Suscribirse a las actualizaciones sobre un número

Puede suscribirse a las actualizaciones sobre el cambio en el estado de verificación de un número utilizando Suscripciones a las notificaciones de WhatsApp.

Se pueden crear suscripciones para muchos eventos diferentes; puede obtener más información al respecto en la sección Documento guía de suscripciones a notificaciones de WhatsApp. Para las actualizaciones del estado de los números, debe crear una suscripción con la función account_update tipo de suscripción en el whatsapp_subscribe_typesy también el vonage_number_onboarded tipo de suscripción en el vonage_subscribe_types.

La notificación se activa mediante un PARTNER_ADDED y se envía al webhook o gancho de Slack que especificó al crear la suscripción. La carga útil de la notificación incluirá el archivo waba_id, solution_idy owner_business_id detalles.

La carga útil de un POST solicitud a la https://api.nexmo.com/v2/whatsapp-manager/subscriptions sería algo parecido a lo siguiente:

{
  "type": "webhook",
  "label": "#dk-test",
  "whatsapp_subscribe_types": "account_update", // or can be left blank ""
  "vonage_subscribe_types": "vonage_number_onboarded",
  "webhook": {
      "url" : "https://eo34s4y0tl.m.pipedream.net"
  }
}

Nota: el valor del id devuelto en la respuesta cuando Generar una URL de registro incrustada se correlaciona con el valor del onboarding_id en la propiedad notification_value dentro del objeto whatsapp en la carga útil de la notificación.

Cómo vincular un número de WhatsApp con una aplicación de Vonage

Para que el número de WhatsApp pueda usarse para enviar mensajes a través de Messages API de Vonage, debe estar vinculado a una aplicación de Vonage.

Esto puede hacerse a través de la función Panel de Vonage o a través del Vincular una aplicación a un punto final de Account de la API de cuentas externas.

Notas para los socios

  • No se requiere una habilitación por separado para que un socio/proveedor de tecnología de Vonage use el flujo de inscripción integrado alojado. Se puede acceder a él a través del api-key y las credenciales asociadas.
  • Solo las cuentas de WhatsApp Business Account (WABA) "compartidas" de los clientes pueden incorporar nuevos números de WhatsApp a través del flujo de registro incrustado alojado o de cualquier flujo de registro incrustado. En el caso de las WABA de OBO, la incorporación debe ser manual. Consulte la página Metadocumentación para más información sobre OBO y WABA compartidos.
  • Los socios/proveedores de tecnología de Vonage deben asegurarse de que su(s) cliente(s) que usa(n) el flujo integrado alojado haya(n) completado los detalles comerciales en la sección de información de su cartera de negocios. Si alguno de los detalles requeridos, por ejemplo, el email comercial del usuario, no es válido, es probable que el proceso de incorporación falle.
  • Durante el registro de números de WhatsApp, el tiempo de respuesta previsto de la Meta API puede ser de hasta 120 s.
  • Los intentos de registro o baja de cada número de WhatsApp están limitados por Meta (10 intentos por número y semana). Una vez alcanzado este límite, se bloqueará el registro del número.