Primeros pasos para socios de soluciones

En esta guía se describen los pasos que deben seguir los socios de soluciones para poder ofrecer la API de nube a sus clientes. Hay cuatro fases principales:

1. Preparar y planificar
2. Configurar los recursos
3. Firmar los contratos
4. Crear la integración

Al terminar, mantente al día con las actualizaciones mensuales.

Preparar y planificar

Leer la documentación

Antes de empezar, te recomendamos que leas la documentación para desarrolladores y la colección de Postman. De esta forma, podrás comprender el funcionamiento de la API de nube, incluidos los primeros pasos y la migración de números.

Planificar la incorporación y la migración

Debes utilizar el registro insertado para incorporar nuevos clientes a la API de nube. Si todavía no lo has hecho, integra e inicia el registro insertado. El registro insertado es la forma más rápida y sencilla de registrar clientes, ya que les permite empezar a enviar mensajes en menos de cinco minutos.

A continuación, piensa en los clientes que quieres migrar a la API de nube en primer lugar. Nuestra recomendación general es que migres todos los clientes de la API local a la API de nube, pero las necesidades de cada uno de ellos pueden variar. Mientras piensas en los clientes que quieres migrar, considera lo siguiente:

Cuando sepas los clientes que se van a migrar, puedes crear un calendario y un plan de la migración.

Al crear el plan, recuerda diseñar el sistema para dos escenarios: la incorporación de nuevos clientes y la migración de los clientes actuales de la API local a la API de nube. En el caso del escenario de migración, incluye planes para hacer una copia de seguridad de la instancia local y migrar esos números a la API de nube.

Planificar las comunicaciones con los clientes

En primer lugar, tienes que decidir si notificar a los clientes existentes sobre la migración. A continuación, debes determinar si necesitas crear o actualizar la documentación para admitir la configuración de la API de nube.

Tomar decisiones sobre los precios

Como los costes de alojamiento de la API de nube los cubre Meta, debes decidir si quieres actualizar tus precios en consonancia.

Configurar los recursos

Para usar la API de nube, los socios de soluciones deben tener los siguientes activos:

Firmar los contratos

Aceptar las Condiciones del servicio

Para poder acceder a la API de nube de mensajes de WhatsApp Business, primero debes aceptar las Condiciones del servicio de la Plataforma de WhatsApp Business en nombre de tu empresa.

Para ello, accede al Administrador de WhatsApp y acepta las Condiciones del servicio en el banner de información.

Si eres un socio beta existente de la API de nube, dispones de un periodo de gracia de 90 días. Esto quiere decir que tienes que aceptar las condiciones antes del 5 de julio de 2022 o perderás el acceso.

En el caso de las nuevas empresas de la API de nube, incluidas las que realizan la migración desde la API local, tendrás que aceptar las Condiciones del servicio para poder empezar a usar la API de nube. Se producirá un error en las llamadas de registro hasta que aceptes las Condiciones del servicio.

Crear la integración

Paso 1: Obtener el identificador de acceso de usuario del sistema

Las llamadas a la API Graph usan los identificadores de acceso para la autenticación. Para obtener más información, consulta Identificadores de acceso. Te recomendamos usar tu usuario del sistema para generar el identificador.

Para generar un identificador de acceso de usuario del sistema, sigue estos pasos:

1. Accede a Business Manager > Configuración de la empresa > Usuarios > Usuarios del sistema para ver el usuario del sistema que has creado.
2. Haz clic en ese usuario y selecciona Añadir activos. Esta acción inicia una nueva ventana.
3. En Seleccionar tipo de activo en el panel del lado izquierdo, selecciona Aplicaciones. En Seleccionar activos, elige la aplicación de Meta que quieres usar (la aplicación debe tener los permisos correctos). Activa Desarrollar la aplicación para dicha aplicación.
4. Selecciona Guardar cambios para guardar la configuración y volver a la pantalla principal de usuarios del sistema.
5. Ahora ya puedes generar el identificador. En la pantalla principal de usuarios del sistema, haz clic en Generar identificador y selecciona la aplicación de Meta. Tras seleccionar la aplicación, ves una lista de los permisos disponibles. Selecciona whatsapp_business_management y whatsapp_business_messaging. Haz clic en Generar identificador.
6. Se abre una nueva ventana con el usuario del sistema, la aplicación asignada y el identificador de acceso. Guarda el identificador.
7. De manera opcional, puedes hacer clic en el identificador y ver el depurador de identificadores. En el depurador, deberías ver los dos permisos seleccionados. También puedes pegar directamente el identificador en el depurador de identificadores de acceso.

Paso 2: Configurar los webhooks

Con los webhooks configurados, puedes recibir notificaciones HTTP en tiempo real de la Plataforma de WhatsApp Business. Esto significa que obtienes una notificación cuando, por ejemplo, recibes un mensaje de un cliente o se producen cambios en tu cuenta de WhatsApp Business (WABA).

Para configurar el webhook, tienes que crear un servidor web accesible desde internet con una URL que cumpla los requisitos de WhatsApp y Meta. Consulta Crear un extremo para obtener instrucciones sobre cómo hacerlo. Si necesitas un extremo para realizar pruebas, puedes generar un extremo de webhooks de prueba.

Configuración de la aplicación

Cuando el extremo esté listo, configúralo para que lo use la aplicación de Meta:

Solo tienes que configurar los webhooks una vez para cada aplicación que tengas. Puedes usar el mismo webhook para recibir distintos tipos de eventos de distintas cuentas de WhatsApp Business. Para obtener más información, consulta la sección Webhooks.

Paso 3: Suscribirse a la cuenta WABA

Para asegurarte de recibir las notificaciones de la cuenta correcta, suscribe la aplicación:

curl -X POST \
'https://graph.facebook.com/v19.0/WHATSAPP_BUSINESS_ACCOUNT_ID/subscribed_apps' \
-H 'Authorization: Bearer ACCESS_TOKEN'

Si obtienes la siguiente respuesta, todos los eventos de webhooks de los números de teléfono de esta cuenta se enviarán al extremo de webhooks configurado.

{
  "success": true
}

Paso 4: Obtener el identificador del número de teléfono

Para enviar mensajes, tienes que registrar el número de teléfono que quieres usar, que se corresponde con el número de teléfono de la empresa mencionado en la sección Antes de empezar.

Para poder continuar con el registro, tienes que encontrar el identificador de ese número de teléfono. Para obtener el identificador del número de teléfono, realiza la siguiente llamada a la API:

curl -X GET \
'https://graph.facebook.com/v19.0/WHATSAPP_BUSINESS_ACCOUNT_ID/phone_numbers' \
-H 'Authorization: Bearer ACCESS_TOKEN'

Si la solicitud se realiza correctamente, en la respuesta se incluyen todos los números de teléfono conectados a la cuenta WABA:

{
  "data": [
    {
      "verified_name": "Jasper's Market",
      "display_phone_number": "+1 631-555-5555",
      "id": "1906385232743451",
      "quality_rating": "GREEN"
    },
    {
      "verified_name": "Jasper's Ice Cream",
      "display_phone_number": "+1 631-555-5556",
      "id": "1913623884432103",
      "quality_rating": "NA"
    }
  ]
}

Guarda el identificador del número de teléfono que quieres registrar. Consulta Leer números de teléfono para obtener más información sobre este extremo.

Excepción de migración

Paso 5: Registrar el número de teléfono

Una vez que tienes el identificador del número de teléfono, puedes registrarlo. En la llamada a la API de registro, debes realizar dos acciones a la vez:

1. Registrar el teléfono.
2. Activar la verificación en dos pasos mediante la configuración de un código de registro de seis dígitos que debes establecer por tu parte. Guarda y recuerda este código, ya que te lo podemos pedir más tarde.

La configuración de la autenticación en dos pasos es un requisito para usar la API de nube. Si no la configuras, recibirás un mensaje de error de incorporación:

Ejemplo de solicitud:

curl -X POST \
'https://graph.facebook.com/v19.0/FROM_PHONE_NUMBER_ID/register' \
-H 'Authorization: Bearer ACCESS_TOKEN' \
-H 'Content-Type: application/json' \
-d '{"messaging_product": "whatsapp","pin": "6_DIGIT_PIN"}'

Ejemplo de respuesta:

{
  "success": true
}

Usuarios del registro insertado

Paso 6: Recibir un mensaje de una aplicación de consumidor

Cuando los clientes participantes envían un mensaje a tu empresa, obtienes 24 horas de mensajes gratis con ellos. Dicho periodo de tiempo se denomina periodo de atención al cliente. Con el propósito de realizar pruebas, queremos activar este periodo para que puedas enviar los mensajes que quieras.

Desde una aplicación personal de WhatsApp para Android o iOS, envía un mensaje al número de teléfono que acabas de registrar. Tras enviar el mensaje, deberías recibir un mensaje entrante en el webhook con una notificación con el formato siguiente.

{
  "object": "whatsapp_business_account",
  "entry": [
    {
      "id": "WHATSAPP_BUSINESS_ACCOUNT_ID",
      "changes": [
        {
          "value": {
            "messaging_product": "whatsapp",
            "metadata": {
              "display_phone_number": "16315551234",
              "phone_number_id": "PHONE_NUMBER_ID"
            },
            "contacts": [
              {
                "profile": {
                  "name": "Kerry Fisher"
                },
                "wa_id": "16315555555"
              }
            ],
            "messages": [
              {
                "from": "16315555555",
                "id": "wamid.ABGGFlA5FpafAgo6tHcNmNjXmuSf",
                "timestamp": "1602139392",
                "text": {
                  "body": "Hello!"
                },
                "type": "text"
                }
            ]
          },
        "field": "messages"
        }
      ]
    }
  ]
}

Paso 7: Enviar un mensaje de prueba

Cuando hayas activado el periodo de atención al cliente, podrás enviar un mensaje de prueba al número del consumidor que has usado en el paso anterior. Para ello, haz la siguiente llamada a la API:

curl -X  POST \
'https://graph.facebook.com/v19.0/FROM_PHONE_NUMBER_ID/messages' \
-H 'Authorization: Bearer ACCESS_TOKEN' \
-H 'Content-Type: application/json' \
-d '{"messaging_product": "whatsapp", "to": "16315555555","text": {"body" : "hello world!"}}'

Si la llamada se realiza correctamente, en la respuesta se incluirá un identificador de mensaje. Usa ese identificador para realizar un seguimiento del progreso de los mensajes mediante webhooks. La longitud máxima del identificador son 128 caracteres.

Ejemplo de respuesta:

{
  "id":"wamid.gBGGFlaCGg0xcvAdgmZ9plHrf2Mh-o"
}

Mantenerse al día con las actualizaciones mensuales

Publicaremos actualizaciones de la API de nube el primer martes de cada mes. Dichas actualizaciones incluirán nuevas funciones y mejoras. No es necesario que hagas nada para usar las nuevas funciones, ya que la API de nube se actualiza automáticamente.

Preguntas frecuentes

Preguntas frecuentes generales

Preguntas frecuentes sobre la implementación técnica

What is the architecture of the Cloud API?

The Cloud API architecture significantly simplifies the Solution Partner's operational and infrastructure requirements to integrate with WhatsApp Business Platform. First, it removes the infrastructure requirements to run Business API docker containers (CAPEX savings). Second, it obviates the need of operational responsibilities to manage the deployment (OPEX savings). For details, refer to the architecture diagram comparing the On-Premises and Cloud API deployments.

Enlace permanente

Preguntas frecuentes sobre la seguridad y la privacidad de datos

Preguntas frecuentes sobre el cumplimiento normativo