Documentación de la API WhatsApp Now

Introducción

Message Now es una API de mensajería versátil diseñada para facilitar el envío de mensajes por SMS y RCS.

Ayuda y soporte

Para obtener asistencia sobre la implementación y cualquier comentario, póngase en contacto con nosotros en: support@messagecentral.com

1. Gestor comercial de Facebook verificado
2. Cuenta en Message Central
3. Vinculación de tu cuenta empresarial de Facebook con Message Central
4. Un número de teléfono que debe verificarse y usarse con Message Central

Ayuda y soporteModos de envío de mensajes

Message Central ofrece dos modos principales para enviar mensajes a través de la API Message Now:operations@messagecentral.com

Entender la mensajería de WhatsApp

Los mensajes de WhatsApp Business Solution solo pueden enviarlos empresas que hayan sido aprobadas por Meta. Este perfil empresarial también tendrá una etiqueta verde de verificación para indicar que se trata de una empresa legítima.

La ventaja de WhatsApp es que el identificador de los usuarios en la plataforma es su número de teléfono móvil.

Reglas para enviar mensajes a los clientes

WhatsApp tiene el concepto de una ventana de atención al cliente de 24 horas, durante la cual una empresa puede enviar mensajes libremente a un usuario final. El período de 24 horas se puede iniciar de dos maneras:

1. Un usuario final envía un mensaje a la empresa
2. Una empresa envía un mensaje con plantilla al usuario final. El período de 24 horas comienza tan pronto como el usuario final responde.

Las plantillas deben ser aprobadas por Meta antes de que puedan usarse para enviar mensajes a un usuario final. Cuando venza el período de 24 horas, se debe volver a iniciar un nuevo período de atención al cliente de 24 horas. Es importante tener en cuenta que el período de atención al cliente de 24 horas no es el mismo que el período de conversación de 24 horas facturable.

Precios basados en conversaciones de WhatsApp

Message Central ofrece un modelo de precios basado en conversaciones para la mensajería de WhatsApp. Esto está en línea con el modelo de precios introducido por WhatsApp a principios de febrero de 2022.

¿Qué es una conversación?

Una conversación es cualquier número de mensajes enviados dentro de una «sesión», que se define como un período de 24 horas a partir del momento en que la empresa envía el primer mensaje.

¿Quién inicia una conversación?

Una conversación puede ser iniciado ya sea por un cliente (iniciado por el usuario) o negocio (iniciada por la empresa), pero en cualquier caso la «sesión» comienza con el primer mensaje enviado por la empresa.

¿Cómo funcionan los precios por conversación?

El precio de los mensajes de WhatsApp es por conversación. A partir del 1 de junio, el precio será por conversación y tipo de conversación. Ahora hay cuatro categorías de conversación, cada una de las cuales es cobrado a diferentes tarifas:

1. Conversación de utilidad - Permita completar una solicitud o transacción determinada y acordada o proporcione al cliente información actualizada sobre una transacción en curso, incluidas las notificaciones posteriores a la compra y los estados de facturación regulares.
2. Conversación de autenticación - Permite a las empresas utilizar códigos de acceso de un solo uso para verificar a los usuarios en varias etapas de inicio de sesión, si es necesario (por ejemplo, verificación de cuentas, recuperación de cuentas, desafíos de integridad)
3. Conversación de marketing - Conversaciones iniciadas por la empresa para promocionar un bien o servicio a los clientes, como el envío de ofertas pertinentes a los clientes que se hayan suscrito. Esto también incluiría cualquier interacción relacionada con la empresa que no sea una conversación de autenticación o de utilidad.
4. Conversación de servicio - Debates iniciados por los usuarios que ayudan a los consumidores a obtener respuestas a sus preguntas.

WhatsAppNow APIsEnviar SMS

Message Central facilita el envío de mensajes a través de varios canales de comunicación, incluidos SMS, WhatsApp y RCS (Rich Communication Services). Esta API ofrece funciones sólidas y opciones flexibles para satisfacer las diversas necesidades de mensajería. WhatsApp Now es un producto de Message Central que se basa en las API oficiales de WhatsApp Business.

Escenarios de casos de uso

• Campañas promocionales: Usa WhatsApp Now para enviar mensajes promocionales y de utilidad a los clientes a través de WhatsApp. Envía archivos multimedia y documentos directamente a través de WhatsApp. Entregue mensajes, notificaciones y actualizaciones personalizados para mejorar la satisfacción y la lealtad de los clientes y mejorar su experiencia de cliente.
  
• Mensajes de chat en vivo: Envía y recibe mensajes, contenido multimedia y documentos directamente a través de WhatsApp, garantizando una comunicación oportuna y eficaz con tu audiencia.
  
• Verificación OTP: Implemente un sistema de entrega OTP seguro para la autenticación de los usuarios, eligiendo entre SMS, WhatsApp o correo electrónico según las preferencias del usuario y los requisitos de seguridad.

Además, se deben enviar los siguientes parámetros al usar las API de WhatsApp Now;

URL base de API Rest:Para enviar un SMS a un número de teléfono móvil, se requieren los siguientes parámetros de solicitud. Es necesario un token de autenticación, generado por la API de generación de tokens, para enviar el SMS.

Todos los puntos finales de la API de la plataforma que aparecen a continuación deben tener como prefijo la siguiente URL:

https://cpaas.messagecentral.com

Generar tokenAl usar la API de verificación por SMS de Verify Now para enviar códigos de verificación por SMS, la llamada inicial debe ser a la API de generación de tokens.

Cuando utilices las API de WhatsApp Now para crear plantillas, enviar mensajes de texto y emitir mensajes, la llamada inicial debe ser a la API de generación de tokens. Esta API devuelve un token que debe incluirse en todas las llamadas posteriores. Se necesita un token de autenticación para validar al usuario y debe incluirse en la sección de encabezado de cada solicitud.

Parámetros de solicitud:Esta API devuelve un token que debe incluirse en todas las llamadas posteriores. Se necesita un token de autenticación para validar al usuario y debe incluirse en la sección de encabezado de cada solicitud.

Ruta URL de solicitud:

/auth/v1/authentication/token 

cURL

1curl --location 'https://cpaas.messagecentral.com/auth/v1/authentication/token?customerId=<CustomerId>&key=<Base64 Encrypted password>&scope=NEW&country=91&email=test@messagecentral.com' \
2--header 'accept: */*'
3

‍

NOTA: Para convertir un comando cURL en código con Postman, abre Postman, importa el comando cURL mediante el botón «Importar» y, a continuación, genera el código en tu idioma preferido haciendo clic en el botón «Código» situado a la derecha de la solicitud.

Respuesta JSON

Una respuesta correcta devolverá un código de estado 200.

1{
2      "status": Integer,
3      "token": "String"
4} 

Crear plantilla

Puede crear plantillas de varios tipos y categorías, así como crear variaciones de una plantilla en varios idiomas. Al crear plantillas con versiones en varios idiomas, asegúrate de que las traducciones de todas las versiones sean coherentes.

Asegúrate de que tus plantillas sigan Pautas para plantillas de mensajes de WhatsApp. No seguir correctamente las directrices puede afectar a la aprobación de las plantillas.

‍

Proceso de aprobación

Las plantillas deben ser aprobadas por Meta antes de que puedan usarse en un mensaje de WhatsApp. Cuando se crean, las plantillas tienen inicialmente un estado de PENDIENTE. Una vez aprobados, tendrán un estado de APROBADO, y luego se puede usar.

Categorías de plantillas

• UTILIDAD: Permitir la finalización de una solicitud o transacción concreta y acordada o proporcionar al cliente información actualizada sobre una transacción en curso, incluidas las notificaciones posteriores a la compra y los estados de facturación periódicos.
• AUTENTICACIÓN: Permite a las empresas utilizar códigos de acceso de un solo uso para verificar a los usuarios en varias etapas de inicio de sesión, si es necesario (por ejemplo, verificación de cuentas, recuperación de cuentas, desafíos de integridad).
• COMERCIALIZACIÓN: Conversaciones iniciadas por la empresa para promocionar un bien o servicio a los clientes, como el envío de ofertas pertinentes a los clientes que han optado por participar. Esto también incluiría cualquier interacción relacionada con la empresa que no sea una conversación de autenticación o de utilidad.

Para Crear plantilla a continuación se muestran los parámetros de la solicitud. El token de autenticación es necesario para crear una plantilla generada por la API de tokens generada (que puedes encontrar más arriba en la sección Introducción)

Ruta URL de solicitud:

/verification/v3/template

Parámetros de solicitud:

cURL

1curl --location 'https://cpaas.messagecentral.com/verification/v3/template' \
2--header 'authToken: eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJDLTM4MERBQzg1RDlGRjREMSIsImlhdCI6MTcyMDc2OTI2OCwiZXhwIjoxODc4NDQ5MjY4fQ.O8xl7vMUoOU4dCn61dqFTjBMxTVvnEpRCkzjMo4JW9YQrEdL0PK3sQW4PgZBWRUCvKDkoSRoDAdXhXy9rx' \
3--form 'phoneNumber="919457888189"' \
4--form 'name="template_without_media"' \
5--form 'language="en_US"' \
6--form 'category="MARKETING"' \
7--form 'headerFormat="TEXT"' \
8--form 'header="Congratulations"' \
9--form 'body="Hello Your account recharge of ₹100 is successful. Please use our services and enjoy!"' \
10--form 'footer="Type \"STOP\" to unsubscribe"'

‍

cURL

1curl --location 'https://cpaas.messagecentral.com/verification/v3/template' \
2--header 'authToken: eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJDLTM4MERBQzg1RDlGRjREMSIsImlhdCI6MTcyMDc2OTI2OCwiZXhwIjoxODc4NDQ5MjY4fQ.O8xl7vMUoOU4dCn61dqFTjBMxTVvnEpRCkzjMo4JW9YQrEdL0PK3sQW4PgZBWRUCvKDkoSRoDAdXYh9rxa' \
3--form 'phoneNumber="919457888189"' \
4--form 'name="template_without_media"' \
5--form 'language="en_US"' \
6--form 'category="MARKETING"' \
7--form 'headerFormat="TEXT"' \
8--form 'body="Hello Your account recharge of ₹100 is successful. Please use our services and enjoy!"' \
9--form 'footer="Type \"STOP\" to unsubscribe"' \
10--form 'file=@"/C:/Users/Kunal Suryawanshi/Downloads/Media (9).png"'

‍

Respuesta JSON (sin y con plantillas multimedia):

Una respuesta correcta devolverá un código de estado 200.

1{
2    "responseCode": 200,
3    "data": {
4        "data": {
5            “name”: “example_template”,
6            "id": "790937216444187",
7            "status": "PENDING",
8            "category": "MARKETING"
9        }
10    }
11}

Una respuesta correcta devolverá un código de estado 200.

Asesoramiento para la creación de plantillas

1. Nombre - El nombre de la plantilla debe estar siempre en minúsculas. Además, en caso de que haya varias palabras, añada un «_» entre 2 palabras (por ejemplo: tes_template_01)
2. Plantilla variable - Para crear una plantilla de variables, es necesario añadir obligatoriamente marcadores de posición y sus valores corporales al crear una solicitud para dicha plantilla.

Variables - Siempre se añaden en dos llaves rizadas y en números crecientes
pedido; de lo contrario, su plantilla será rechazada.
Valor corporal - Estos son ejemplos de lo que se incluirá en los valores de las variables. ¿Desde
estos son datos de formulario, por lo tanto, en el caso de más de 2 variables, sepárelas por
espacios.

‍Ejemplo de mensaje - Hola {{1}}, obtén un 50% de descuento aplicando el código de cupón {{2}} más reciente de {{3}} BodyValue (para ver el mensaje anterior) - «Kunal MSGCTL50 20thJune», aquí Kunal es un ejemplo de 1st BodyValue y así sucesivamente.

3. Límite de caracteres - Un mensaje de texto puede contener un máximo de 4096 caracteres largos.

Códigos de error para crear plantilla

Verificar el estado de la plantilla

Esto te permite supervisar el estado de las plantillas de mensajes que has enviado para su aprobación en WhatsApp. Esta API proporciona actualizaciones en tiempo real sobre si tus plantillas están aprobadas, pendientes o rechazadas, lo que garantiza que te mantengas informado sobre su disponibilidad para su uso.

Parámetros de solicitud:

cURL

1curl --location --request GET 'https://cpaas.messagecentral.com/verification/v3/template' \
2--header 'authToken: eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJDLTM4MERBQzg1RDlGRjREMSIsImlhdCI6MTcyMDc2OTI2OCwiZXhwIjoxODc4NDQ5MjY4fQ.O8xl7vMUoOU4dCn61dqFTjBMxTVvnEpRCkzjMo4JW9YQrEdL0PK3sQW4PgZBWRUCvKDkoSRoDAdYXh9rxa' \
3--form 'phoneNumber="919547888189"' \
4--form 'templateId="205681076471259"' \
5--form 'templateName="test_template"'

‍

Respuesta JSON

Una respuesta correcta devolverá un código de estado 200.

1{
2    "name": "prod_test_temp_wmedia_1",
3    "components": [
4        {
5            "type": "HEADER",
6            "format": "TEXT",
7            "text": "Congratulations!"
8        },
9        {
10            "type": "BODY",
11            "text": "Your account recharge of $100 is successful. Please use our services and enjoy!"
12        },
13        {
14            "type": "FOOTER",
15            "text": "Type \"STOP\" to unsubscribe"
16        }
17    ],
18    "language": "en_US",
19    "status": "APPROVED",
20    "category": "UTILITY",
21    "id": "205681076471259"
22}

Códigos de error para obtener el estado de la plantilla

Enviar transmisión

Para enviar una transmisión de WhatsApp a números móviles, se requieren los siguientes parámetros de solicitud. Es necesario un token de autenticación, generado por la API de generación de tokens, para enviar los mensajes de la plantilla por transmisión.

Ruta URL de solicitud:

/verification/v3/send

Parámetros de solicitud:

NOTA: Todas las plantillas utilizadas deben ser plantillas APROBADAS de Meta.

A continuación encontrará el formato de archivo de muestra en formato XLXS:

Donde 'var1', 'var2' y 'var3' son marcadores de posición para las variables. Si una empresa desea enviar un mensaje personalizado mediante la carga de archivos, el campo del mensaje debe tener el siguiente formato:

Ejemplo de mensaje: Hola {{1}}, obtén un 50% de descuento aplicando el cupón {{2}} como muy tarde antes del {{3}}

cURL

1curl --location 'https://cpaas.messagecentral.com/verification/v3/send?flowType=WHATSAPP&senderId=919457848169&type=BROADCAST&templateName=template_without_media_1' \
2--header 'authToken: eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJDLTM4MERBQzg1RDlGRjREMSIsImlhdCI6MTcyMDc2OTI2OCwiZXhwIjoxODc4NDQ5MjY4fQ.O8xl7vMUoOU4dCn61dqFTjBMxTVvnEpRCkzjMo4JW9YQrEdL0PK3sQW4PgZBWRUCvKDkoSRoDAdYXh9rxa' \
3--form 'file=@"/C:/Users/Kunal Suryawanshi/Documents/Test_WA_API.xlsx"'

‍

Respuesta JSON

Una respuesta correcta devolverá un código de estado 200.

1{
2    "responseCode": 200,
3    "message": "SUCCESS",
4    "data": null
5}
6

Códigos de error para enviar transmisión

Enviar mensajes de chat

Para enviar un mensaje de WhatsApp (mensaje de chat) a un número de teléfono móvil, se requieren los siguientes parámetros de solicitud. Se necesita un token de autenticación, generado por la API de generación de tokens, para enviar cualquier mensaje a través del chat en vivo.

Ruta URL de solicitud:

/verification/v3/send

Parámetros de solicitud:

cURL

1curl --location --request POST 'https://cpaas.messagecentral.com/verification/v3/send?countryCode=91&flowType=WHATSAPP&mobileNumber=7715836906&senderId=919457888189&type=CHAT&message=Welcome%20to%20Message%20Central' \
2--header 'authToken: eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJDLTM4MERBQzg1RDlGRjREMSIsImlhdCI6MTcyMDc2OTI2OCwiZXhwIjoxODc4NDQ5MjY4fQ.O8xl7vMUoOU4dCn61dqFTjBMxTVvnEpRCkzjMo4JW9YQrEdL0PK3sQW4PgZBWRUCvKDkoSRoDAdYXh9rxa'

‍

Respuesta JSON

Una respuesta correcta devolverá un código de estado 200.

1{
2    "responseCode": 200,
3    "message": "SUCCESS",
4    "data": {
5        "verificationId": null,
6        "mobileNumber": "917715836906",
7        "responseCode": "200",
8        "errorMessage": null,
9        "timeout": null,
10        "smsCLI": null,
11        "transactionId": "wamid.HBgMOTE3NzE1ODM2OTA2FQIAERgSOEFFNUM5MTFDRUVBMDUzMDFGAA=="
12    }
13}

Códigos de error para mensajes de chat

Configurar Webhook para mensajes entrantes

Antes de empezar a recibir notificaciones, tendrá que crear un punto final en su servidor para recibir las notificaciones.

Siempre que se produce un evento desencadenante, la plataforma WhatsApp Business de Message Central ve el evento y envía una notificación a la URL de webhook que especifiques. Puedes recibir dos tipos de notificaciones:

1. Mensajes recibidos: Esta alerta le avisa cuando ha recibido un mensaje. En toda la documentación, también se las puede denominar «notificaciones entrantes».
2. Estado del mensaje: Esta alerta le permite saber si el estado de un mensaje ha cambiado; por ejemplo, si el mensaje se ha leído o entregado. También pueden denominarse «notificaciones salientes».

Para suscribirte a Webhooks, tendrás que seguir estos pasos:

1. Información requerida:algún texto
   1. ID de cliente
   2. Nombre de la marca
   3. ID de correo electrónico registrado
   4. URL de devolución de llamada
      
      
2. Instrucciones de envío: Envíe la información anterior a operations@messagecentral.com con el asunto «Configuración de webhooks de WhatsApp con Message Central».
   
   
3. Especificaciones de la URL de devolución de llamada: asegúrese de que la URL de devolución de llamada sea accesible y capaz de recibir solicitudes HTTP POST que contengan cargas útiles JSON con actualizaciones de estado. Al activarse, el punto final recibirá la siguiente carga útil de JSON y debe responder con 200.

‍