Ubicación

Last update: 4 days ago by Irais Aguirre

Resumen para integración
Endpoint: POST https://{{url}}/whatsapp-bsp-api-endpoint-ws/services/v1/messaging
Token: de mensajería, en el encabezado Authorization: Bearer {{wa-msg-api-token}} (cómo generarlo)
Campos comunes: from, to (teléfono o BSUID) y type (detalle)
Valores de type en esta página: "location", "interactive"
Respuesta: la misma para todos los mensajes (ver respuesta)

Mensajes para enviar una ubicación o pedirle al usuario que comparta la suya. Todos se envían con POST /v1/messaging; los encabezados, los campos comunes y la respuesta están en Conexión HTTP.

Ubicación

Envía una ubicación con sus coordenadas y, opcionalmente, nombre y dirección. El campo type debe ser "location".

Cuerpo

Campos de Ubicación, además de los campos comunes:

Nombre	Descripción	Tipo	Requerimientos
longitude	Longitud en grados decimales. Rango permitido: estrictamente entre -181 y 181 (exclusivo).	Number	Obligatorio.
latitude	Latitud en grados decimales. Rango permitido: estrictamente menor que 90 (límite superior exclusivo).	Number	Obligatorio.
name	Nombre de la ubicación.	String	Opcional.
address	Dirección de la ubicación.	String	Opcional.

Ejemplo

Ejemplo completo de Ubicación (petición HTTP y cuerpo JSON):

Petición HTTP

curl -X POST 'https://{{url}}/whatsapp-bsp-api-endpoint-ws/services/v1/messaging' \
-H 'Authorization: Bearer {{wa-msg-api-token}}' \
-H 'Content-Type: application/json' \
-d '{
    "from": "5215500000001",
    "to": "5215500000002",
    "type": "location",
    "longitude": -122.425332,
    "latitude": 37.758056,
    "name": "Facebook HQ",
    "address": "1 Hacker Way, Menlo Park, CA 94025"
}'

Body

{
    "from": "5215500000001",
    "to": "5215500000002",
    "type": "location",
    "longitude": -122.425332,
    "latitude": 37.758056,
    "name": "Facebook HQ",
    "address": "1 Hacker Way, Menlo Park, CA 94025"
}

Solicitud de Ubicación

Pide al usuario que comparta su ubicación. El campo type debe ser "interactive".

Cuerpo

Campos de Solicitud de Ubicación, además de los campos comunes:

Nombre	Descripción	Tipo	Requerimientos
send_location_request	Objeto que contiene la solicitud de ubicación.	Objeto	Obligatorio.
send_location_request.body	Texto simple del mensaje.	String	Obligatorio.
send_location_request.action	Objeto de la acción. Si se envía, `action.name` siempre se fuerza a `send_location`.	Objeto	Opcional.

Ejemplo

Ejemplo completo de Solicitud de Ubicación (petición HTTP y cuerpo JSON):

Petición HTTP

curl -X POST 'https://{{url}}/whatsapp-bsp-api-endpoint-ws/services/v1/messaging' \
-H 'Authorization: Bearer {{wa-msg-api-token}}' \
-H 'Content-Type: application/json' \
-d '{
    "from": "5215500000001",
    "to": "5215500000002",
    "type": "interactive",
    "send_location_request": {
        "body": "Por favor, comparte tu ubicación para continuar con el servicio.",
        "action": {
            "name": "send_location"
        }
    }
}'

Body

{
    "from": "5215500000001",
    "to": "5215500000002",
    "type": "interactive",
    "send_location_request": {
        "body": "Por favor, comparte tu ubicación para continuar con el servicio.",
        "action": {
            "name": "send_location"
        }
    }
}

Contenido multimedia

Contactos