Enviar mensajes de grupo

/v1/messages

Usa el extremo messages para enviar mensajes de grupo, mensajes multimedia o plantillas de mensajes a grupos de clientes.

Este documento incluye:

Requisitos previos

Solicitud

El proceso para enviar un mensaje a un grupo es muy similar al de enviar un mensaje a un usuario individual. Al establecer el parámetro to, debes especificar el identificador de grupo y definir el recipient_type en group. Puedes obtener información sobre estos campos en la documentación de Enviar mensajes de texto.

Todos los tipos de mensaje que se pueden enviar a un usuario individual se pueden enviar también a un grupo. Para crear un grupo y obtener un identificador de grupo, sigue las instrucciones de la documentación de Crear grupos.

Un campo adicional que es opcional para los mensajes de grupo es render_mentions. Este campo determinará si las menciones se permiten en los mensajes. Consulta la sección Menciones para obtener más información.

POST /v1/messages   
{
    "preview_url": false | true,
    "recipient_type": "group",
    "to": "whatsapp-group-id",
    "render_mentions": true | false,
    "type": "text",
    "text": {
        "body": "your-text-message-content"
    }
}

Ejemplo

POST /v1/messages  
{
    "recipient_type": "group",
    "to": "16315550000-1503342882",
    "render_mentions": false,
    "type": "text",
    "text": {
        "body": "WhatsApp Group Message example"
    }
}

Menciones

Puedes mencionar a una persona de un grupo para asegurarte de que reciba una notificación. En la sección body del mensaje, escribe el identificador de WhatsApp después de un símbolo de arroba (por ejemplo, @16315550000). Puedes mencionar a varias personas en el mismo mensaje.

Cuando se entrega un mensaje, el identificador de WhatsApp del usuario mencionado se sustituye por el nombre de la libreta de direcciones, el nombre de pantalla del usuario o el número de teléfono si no existe ninguno de los anteriores.

Las menciones solo se pueden usar si el parámetro render_mentions está establecido en true.

Ejemplos

Puedes usar menciones en el cuerpo de un mensaje de texto o en el texto de un mensaje multimedia.

POST /v1/messages    
{
    "recipient_type": "group",
    "to": "16315550000-1503342882",
    "type": "text",
    "render_mentions": true,
    "text": {
        "body": "WhatsApp group message @16315550000 @16315556000."
    }
}

Si la persona que recibe el mensaje tiene los números de teléfono mencionados guardados en sus libretas de direcciones como Persona1 y Persona2, la representación final del mensaje será "WhatsApp group message @Persona1 @Persona2."

Las menciones también se pueden utilizar en el texto de los mensajes multimedia.

POST /v1/messages     
{
    "recipient_type": "group",
    "to": "16315550000-1503342882",
    "type": "image",

    "image": {
        "id": "media-id",
        "caption": "Check out our new shoe collection, @16315550000!"    
    }
}

Respuesta

Una respuesta correcta incluirá un identificador de mensaje. Una respuesta incorrecta incluirá un mensaje de error. Consulta la documentación de Mensajes — Respuestas para obtener más información.