Enviar Mensaje de Texto

Ejemplo de Envio

El formato de request es JSON

POST /toolbox/api/whatsapp/v1/{API_KEY}/message

Authorization: Bearer {AUTH_TOKEN}
Content-Type: application/json
{
    "preview_url": "false | true",
    "recipient_type": "individual"
    "to": "5xxxxxxxxx" | "whatsapp-id",
    "type": "text",
    "text": {
    "body": "your-text-message-content"
}

Parametros

NombreObligatorioDescripción
preview_urlNoOpciones:false (predeterminada) o true.Si tu mensaje no incluye una URL, especificar preview_url en la solicitud es opcional. Para incluir una vista previa de la URL, configura preview_url como true en el cuerpo del mensaje y asegúrate de que la URL comienza con http:// o https:/ Para obtener más información, consulta la sección sobre enviar URL en el documento Mensajes de texto.
recipient_typeNoOpciones:individual (predeterminada) o group. Determina si el destinatario es un usuario individual o un grupo. Cuando el valor es individual, especificar recipient_type en la solicitud es opcional. Sin embargo, recipient_type es obligatorio si se usa group. Si envías un mensaje de texto a un grupo, consulta la documentación sobre el envío de mensajes grupales.
toSiCuando recipient_type es individual, este campo es el identificador (número de teléfono) de WhatsApp que devuelve el extremo contacts. Cuando recipient_type es group, este campo es el identificador de grupos de WhatsApp.
typeNoOpción predeterminada: text Cuando envías un mensaje de texto especificar type en la solicitud es opcional. Para conocer los tipos de mensaje multimedia, consulta la documentación sobre el envío de mensajes multimedia.
textSiContiene el campo body

Object Text

NombreObligatorioDescripción
bodyTexto del mensaje de texto, que puede contener formato y URL.Para obtener más información, consulta las secciones sobre enviar URL en mensajes de texto y aplicar formato en mensajes de text

Enviar URL en mensajes de texto

De forma predeterminada, la aplicación WhatsApp para celulares reconoce las URL y permite hacer clic en ellas. Para incluir una vista previa de la URL, incluye "preview_url": true en el cuerpo del mensaje y asegúrate de que la URL comienza con http:// o https://. También se debe incluir el nombre del host, ya que las direcciones IP no se reconocen correctamente.

{
  "preview_url": true,
  "to": "whatsapp-id",
  "text": {
    "body": "You have to check out this messaging service https://www.whatsapp.com/"
  }
}

La mayor parte del tiempo, cuando envías una URL, ya sea con o sin vista previa, el destinatario del mensaje verá una URL en la que puede hacer clic. La excepción a esto es cuando creas un grupo y envías una URL de invitación para unirse a ese grupo. Incluirás la URL de invitación como se muestra en el ejemplo anterior, pero cuando el usuario reciba el mensaje, se le indicará “Cancelar” o “Unirse al grupo” en lugar de ver un enlace en el que puede hacer clic

Aplicar formato en mensajes de texto

WhatsApp permite aplicar formato en los mensajes. Para aplicar formato en todo o parte del mensaje, usa los siguientes símbolos de formato:

Aplicar formatoSímboloEjemplo
NegritaAsterisco ( * )Tu total es 10.50 USD.
CursivaGuion bajo ( _ )Tu total es 10.50 USD.
TachadoTilde (~)Tu total es 10.50 USD.
CodigoTres acentos graves (```)Tu total es 10.50 USD.

Respuesta

Una respuesta exitosa incluye un objeto messages con un identificador para el mensaje creado recientemente.

{
  "messages": [
    {
      "id": "gBEGkYiEB1VXAglK1ZEqA1YKPrU"
    }
  ]
}

Una vez que tengas el identificador de WhatsApp o del grupo de WhatsApp del usuario o grupo al que quieres enviar un mensaje, utilízalo para enviar un mensaje de texto. Un mensaje de texto puede tener, como máximo, 4096 caracteres .