Ze da API icon

Ze da API

WhatsApp API powered by Ze da API - Send messages, manage groups, contacts and more

Actions137

Message → Send Location

AI-generated

Summary

Send a location message to a recipient via the ZEDA API

Inputs

  • phone (required) — Recipient phone number with country code (including country prefix).
  • delayMessage — Delay in seconds before sending the message; 0 uses the API's default random delay (1‑3 s).
  • latitude (required) — Latitude coordinate of the location.
  • longitude (required) — Longitude coordinate of the location.
  • name — Optional name or title for the location.
  • address — Optional address string for the location.
  • additionalFields — Collection of extra parameters such as typing indicator, ephemeral duration, mentions, etc.
  • requestOptions — Optional request settings like proxy, timeout, and batching configuration.
  • allowUnauthorizedCerts — If true, the API will accept responses with invalid SSL certificates.
  • proxy — HTTP proxy URL, optionally with embedded credentials.
  • timeout — Request timeout in milliseconds.

Output shape

object containing the result of the send request (e.g., message ID, status)

Success returns the created message details; failure returns an error object with code and message. The response may be paginated if multiple messages are sent in a batch.

Examples

Example 1: Send a location to a contact in Brazil

phone: 5511999999999, latitude: -23.550520, longitude: -46.633308, name: "Museu do Amanhã", address: "Rua das Flores", additionalFields: {delayTyping:0}, requestOptions: {timeout:10000}

Example 2: Broadcast a location to a group mentioning all members

phone: 5511999999999-1234567890@g.us, additionalFields: {mentionedAll:true, name:"Group Event"}

Example 3: Schedule a location message for later delivery

phone: 5511999999999, scheduledFor: "2025-01-01T12:00:00Z", name: "Meeting Place"

Links

Discussion