Sign inGet started

Mensajes de ubicación de WhatsApp

Un mensaje de ubicación envía un pin: un punto en el mapa, con un nombre y una dirección opcionales debajo. Esta es la parte de envío; para pedirle a un contacto que comparta su ubicación, consulta solicitudes de ubicación.

Enviar una ubicación

Establece location.latitude y location.longitude:
const msg = await bird.whatsapp.send({
  to: "+16505551234",
  from: "+13124495648",
  location: { latitude: 37.7793, longitude: -122.4193 },
});
console.log(msg.id, msg.status);
La forma completa añade name y address:
Ejemplo de código
{
  "to": "+16505551234",
  "from": "+13124495648",
  "location": {
    "latitude": 37.7793,
    "longitude": -122.4193,
    "name": "Ferry Building Pickup",
    "address": "1 Market St, San Francisco, CA 94105"
  }
}
address solo se muestra al destinatario cuando name también está establecido. from es obligatorio en cada mensaje de servicio: un número que pertenece a tu espacio de trabajo, no uno gestionado por Bird.

Límites

CampoRestricciónAplicado por
latitudeobligatorio, -90 a 90, grados decimalesBird, al aceptar (422)
longitudeobligatorio, -180 a 180, grados decimalesBird, al aceptar (422)
nameopcional, hasta 1000 caracteresBird, al aceptar (422)
addressopcional, hasta 1000 caracteres, se muestra solo cuando name está establecidoBird, al aceptar (422)
La documentación propia de WhatsApp indica latitude y longitude como obligatorios sin un rango numérico declarado; la verificación de rango ±90/±180 y los límites de 1000 caracteres en name y address son restricciones propias de Bird.

Leer una ubicación entrante

Un contacto que comparte su ubicación, de forma espontánea o en respuesta a una solicitud de ubicación, genera un mensaje entrante ordinario de location. Nada en él está garantizado: un pin sin procesar puede llegar sin name ni address, y uno entrante también puede incluir un url que enlaza al lugar, algo que nunca aparece en una ubicación que tú envías. La ubicación no es un tipo de medio, así que no hay archivo que descargar. Consulta Recibir ubicaciones de WhatsApp para la lectura entrante completa, el payload de whatsapp.received y qué tener en cuenta.

Límites y casos especiales

  • La ventana de servicio al cliente debe estar abierta. Un envío de ubicación es un mensaje de servicio, entregable solo dentro de una ventana abierta; consulta la ventana de servicio al cliente del hub.
  • name y address son genuinamente opcionales en lectura, no opcionales con respaldo. Un pin sin procesar no tiene ninguno de los dos, y address nunca aparece sin name. No asumas que una dirección postal acompaña a un par de coordenadas.
  • Este no es el mismo tipo que una solicitud de ubicación. Las solicitudes de ubicación son un tipo interactivo que pide al destinatario su propia ubicación; esta página envía una hacia ellos. No confundas las dos formas de envío.
  • Un toque en una solicitud de ubicación regresa como un mensaje entrante ordinario de location, no como un interactive_reply. Una integración que solo observa interactive_reply para toques pierde esto por completo; también debe observar mensajes entrantes de location.

Próximos pasos