Kapso API icon

Kapso API

Send WhatsApp messages, templates, flows, media, contacts, broadcasts, and inbox records through Kapso. Choose a resource, then follow each operation setup hints.

Message → Request Location

AI-generated

Summary

Request a user's location by sending a location request message via a specified Kapso WhatsApp phone number to a recipient's phone number.

Inputs

  • Phone Number Name or ID — Select the connected Kapso WhatsApp number to send the location request from. Options are loaded dynamically from your Kapso project.
  • Recipient Phone (required) — Enter the recipient's phone number in Meta format, using 8-15 digits without plus signs or spaces.
  • Location Request Prompt (required) — Provide a short plain-text prompt message displayed above the Share Location button, to encourage the recipient to share their location.
  • Message Send Options — Configure optional message sending settings such as the ID of a message to reply to and opaque callback data for tracking, which is not shown to the recipient.

Output shape

a single message record with the API response, including metadata about the sent location request message

The response includes details about the sent location request message. Optional fields like reply message ID and callback data are only applied if provided. The recipient must send back a location message separately to share their location.

Examples

Example 1: Send a location request message to a specified recipient using a chosen Kapso WhatsApp number with a custom prompt text and optional reply-to message ID for context.

Set 'Phone Number Name or ID' to select a Kapso number; enter the recipient phone in Meta format; provide a brief 'Location Request Prompt' message; optionally set 'Message Send Options' such as 'Reply To Message ID' or 'Callback Data'.

Links

Discussion