WhatsApp Business API for delivery update — share pickup location

Use case overview

This scenario sends a map location with sendLocation during the 24-hour customer service window. Coordinates, location name, and address help the buyer navigate without copying text.

Template example

Your pickup point is ready. Tap the map pin below to navigate.

Latitude, longitude, name, and address are fixed in the integration contract for this pickup point.

When to use it

• click-and-collect orders

Business value

• Order or delivery event triggers while the WhatsApp session remains open
• Backend resolves pickup coordinates and human-readable location labels
• sendLocation delivers the map pin with name and address fields
• Client opens navigation to the pickup point from WhatsApp
• Delivery status is logged in the ecommerce or logistics platform

Workflow

1. An order status change indicates the parcel is ready for pickup.
2. Your backend loads coordinates, location name, and street address.
3. sendLocation delivers the pin to the client in the active session.
4. The client opens maps navigation from the shared location card.
5. Delivery progress is reported asynchronously — typically sent, then delivered (or failed/undelivered).
6. Your system receives status via webhook (hooks[]) or polls delivery status and handles failures if needed.

Technical implementation

Prerequisites

• An open WhatsApp session window.
• 1MSG channel with sendLocation access and valid latitude/longitude for the pickup point.

Code examples

#!/usr/bin/env node

// === Configuration (replace "___" placeholders) ===
const API_BASE_URL = "https://api.1msg.io"; // production 1MSG API base URL
const CHANNEL_ID = "___";                   // channel ID from 1MSG dashboard
const API_TOKEN = "___";                    // channel JWT token (Bearer)



// === Test data ===
const TEST_PHONE = "___";            // client phone in international format · requires open 24-hour session window

function normalizePhone(phone) {
  return String(phone).replace(/\D/g, "");
}

async function sendLocationMessage({ phone }) {
  const url = `${API_BASE_URL}/${CHANNEL_ID}/sendLocation`;
  const requestBody = {
    phone: normalizePhone(phone),
    lat: "41.40338", // latitude and longitude (code_contract)
    lng: "2.17403",
    name: "Pickup point",
    address: "Example street 1",
  };

  const res = await fetch(url, {
    method: "POST",
    headers: {
      "Content-Type": "application/json",
      Authorization: `Bearer ${API_TOKEN}`,
    },
    body: JSON.stringify(requestBody),
  });

  const raw = await res.text();
  let data;
  try {
    data = JSON.parse(raw);
  } catch {
    data = null;
  }

  if (!res.ok || !data || data.sent !== true) {
    console.error("Send failed.");
    console.error(raw);
    process.exit(1);
  }

  console.log("Message sent to client.");
  return data;
}

if (require.main === module) {
  sendLocationMessage({ phone: TEST_PHONE }).catch((err) => {
    console.error("Execution failed:", err.message);
    process.exit(1);
  });
}

module.exports = { sendLocationMessage };

Immediate API response (synchronous)

• HTTP 2xx and JSON "sent": true mean 1MSG accepted the message for sending — not that it already reached the customer's phone.
• Save the `id` field from the response (value looks like wamid.…). Use it to correlate delivery callbacks or polling.
• The response may also include message and description — informational only.

Delivery status (asynchronous)

• Register a webhook (POST …/webhook) so 1MSG POSTs delivery updates to your HTTPS endpoint in a separate `hooks[]` payload (sent, delivered, read, or failed/undelivered when applicable).
• Optionally poll: GET {base}/{channel}/hookInfo?messageId=<id from sendTemplate>.
• In practice, delivery often completes within a few seconds — but that is not guaranteed by the API contract.

Common errors

• Session window closed (no client message within 24 hours)
• Invalid or non-normalized phone number
• Missing or invalid message body / media URL
• Delivery failure — check status webhook and retry policy

FAQ

• Do I need a template? No — this scenario uses a session message inside the 24-hour customer service window.
• When does the session window close? If the client has not written or replied within 24 hours, sendMessage will fail until a template reopens the chat.
• How do I check delivery? sent: true only confirms acceptance. Track delivery via webhook hooks[] or polling.
• What if the message is not delivered? Log the failed/undelivered hook, verify the session window, then retry or use a template.
• Can I connect this to my CRM or backend? Yes — trigger the API call from your inbound webhook or workflow engine.

Related

• Knowledge base
• Creating a template
• Sending a template
• SDK