Skip to main content

​
Request

Use type as interactive and set interactive.type to location_request_message.

​
Field types

  • to: string (required)
  • type: string = interactive (required)
  • interactive: object (required)
  • interactive.type: string = location_request_message (required)
  • interactive.body: object (required)
  • interactive.body.text: string (required)
  • interactive.action: object (optional)
  • interactive.action.name: string (optional, defaults to send_location)
  • interactive.action.parameters: object (optional)
  • interactive.action.parameters.display_text: string (optional)

​
Field behavior and limits

  • interactive.body.text is required, max 1024 characters.
  • interactive.action.name defaults to send_location when omitted.
  • interactive.action.parameters.display_text is optional, max 20 characters when provided.
{
  "to": "+573001112233",
  "type": "interactive",
  "interactive": {
    "type": "location_request_message",
    "body": {
      "text": "Comparte tu ubicacion actual"
    },
    "action": {
      "name": "send_location",
      "parameters": {
        "display_text": "Compartir ubicacion"
      }
    }
  }
}