Solicitar localização

curl --request POST \
  --url https://cloud.datafyapi.com.br/v1/{phone_number_id}/messages \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "messaging_product": "whatsapp",
  "recipient_type": "individual",
  "to": "5511999999999",
  "type": "interactive",
  "interactive": {
    "type": "location_request_message",
    "body": {
      "text": "Para calcularmos o frete, compartilhe a sua localização."
    },
    "action": {
      "name": "send_location"
    }
  }
}
'

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    messaging_product: 'whatsapp',
    recipient_type: 'individual',
    to: '5511999999999',
    type: 'interactive',
    interactive: {
      type: 'location_request_message',
      body: JSON.stringify({text: 'Para calcularmos o frete, compartilhe a sua localização.'}),
      action: {name: 'send_location'}
    }
  })
};

fetch('https://cloud.datafyapi.com.br/v1/{phone_number_id}/messages', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://cloud.datafyapi.com.br/v1/{phone_number_id}/messages"

payload = {
    "messaging_product": "whatsapp",
    "recipient_type": "individual",
    "to": "5511999999999",
    "type": "interactive",
    "interactive": {
        "type": "location_request_message",
        "body": { "text": "Para calcularmos o frete, compartilhe a sua localização." },
        "action": { "name": "send_location" }
    }
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

{
  "messaging_product": "whatsapp",
  "contacts": [
    {
      "input": "5511999999999",
      "wa_id": "5511999999999"
    }
  ],
  "messages": [
    {
      "id": "wamid.HBgNNTUxMTk5OTk5OTk5ORUCABIYFjNFQjA="
    }
  ]
}

{
  "error": {
    "message": "(#100) Invalid parameter",
    "type": "OAuthException",
    "code": 100,
    "fbtrace_id": "AbCdEfGhIjK"
  }
}

{
  "statusCode": 401,
  "message": "Token inválido ou não encontrado."
}

POST

{phone_number_id}

messages

Solicitar localização

curl --request POST \
  --url https://cloud.datafyapi.com.br/v1/{phone_number_id}/messages \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "messaging_product": "whatsapp",
  "recipient_type": "individual",
  "to": "5511999999999",
  "type": "interactive",
  "interactive": {
    "type": "location_request_message",
    "body": {
      "text": "Para calcularmos o frete, compartilhe a sua localização."
    },
    "action": {
      "name": "send_location"
    }
  }
}
'

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    messaging_product: 'whatsapp',
    recipient_type: 'individual',
    to: '5511999999999',
    type: 'interactive',
    interactive: {
      type: 'location_request_message',
      body: JSON.stringify({text: 'Para calcularmos o frete, compartilhe a sua localização.'}),
      action: {name: 'send_location'}
    }
  })
};

fetch('https://cloud.datafyapi.com.br/v1/{phone_number_id}/messages', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://cloud.datafyapi.com.br/v1/{phone_number_id}/messages"

payload = {
    "messaging_product": "whatsapp",
    "recipient_type": "individual",
    "to": "5511999999999",
    "type": "interactive",
    "interactive": {
        "type": "location_request_message",
        "body": { "text": "Para calcularmos o frete, compartilhe a sua localização." },
        "action": { "name": "send_location" }
    }
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

{
  "messaging_product": "whatsapp",
  "contacts": [
    {
      "input": "5511999999999",
      "wa_id": "5511999999999"
    }
  ],
  "messages": [
    {
      "id": "wamid.HBgNNTUxMTk5OTk5OTk5ORUCABIYFjNFQjA="
    }
  ]
}

{
  "error": {
    "message": "(#100) Invalid parameter",
    "type": "OAuthException",
    "code": 100,
    "fbtrace_id": "AbCdEfGhIjK"
  }
}

{
  "statusCode": 401,
  "message": "Token inválido ou não encontrado."
}

Envia uma mensagem com um texto e um botão para o cliente compartilhar a localização. É útil para calcular frete, indicar a unidade mais próxima ou confirmar um endereço de entrega. A janela de 24 horas precisa estar aberta.

O destinatário pode ser informado pelo número de telefone (to) ou pelo ID do usuário (recipient). Se os dois forem enviados, vale o to; para enviar pelo ID do usuário, deixe o to em branco. Veja a diferença em Destinatário.

Como montar o pedido

O pedido é uma mensagem interativa. Além do destinatário, ela tem só três partes:

Campo	Valor
`interactive.type`	Sempre `location_request_message`.
`interactive.body.text`	Texto do pedido, com até 1.024 caracteres. Pode conter URLs.
`interactive.action.name`	Sempre `send_location`.

Ao tocar no botão, o cliente abre a tela do WhatsApp para escolher e enviar a localização. No Testar, o texto do pedido já vem preenchido. Troque pelo texto que faz sentido para o seu atendimento.

Resposta do cliente

Quando o cliente compartilha a localização, ela chega pelo webhook como uma mensagem do tipo location. O campo context.id aponta para o pedido que você enviou:

{
  "object": "whatsapp_business_account",
  "entry": [
    {
      "id": "234567890123456",
      "changes": [
        {
          "value": {
            "messaging_product": "whatsapp",
            "metadata": {
              "display_phone_number": "5541999999999",
              "phone_number_id": "123456789012345"
            },
            "contacts": [
              {
                "profile": {
                  "name": "Camila Souza"
                },
                "wa_id": "5511999999999",
                "user_id": "BR.13491208655302741918"
              }
            ],
            "messages": [
              {
                "context": {
                  "from": "5541999999999",
                  "id": "wamid.HBgNNTUxMTk5OTk5OTk5ORUCABIYFjNFQjA="
                },
                "from": "5511999999999",
                "from_user_id": "BR.13491208655302741918",
                "id": "wamid.HBgNNTUxMTk5OTk5OTk5ORUCABIYFjJBQjE=",
                "timestamp": "1757955600",
                "location": {
                  "address": "Av. Paulista, 1578 - Bela Vista, São Paulo - SP",
                  "latitude": -23.561414,
                  "longitude": -46.655881,
                  "name": "MASP"
                },
                "type": "location"
              }
            ]
          },
          "field": "messages"
        }
      ]
    }
  ]
}

latitude e longitude sempre chegam. name e address só aparecem se o cliente escolher compartilhar um local com nome. Veja mais detalhes na documentação de pedido de localização da Meta.

Autorizações

Authorization

string

header

obrigatório

Token gerado no painel da Datafy ao criar o canal. Formato: sk_live_xxx.

Parâmetros de caminho

phone_number_id

string

obrigatório

ID do número que envia a mensagem. Descubra com GET /me.

Corpo

application/json

messaging_product

enum<string>

padrão:whatsapp

obrigatório

Sempre whatsapp.

Opções disponíveis:

whatsapp

Exemplo:

"whatsapp"

string

obrigatório

Número do destinatário com código do país e DDD, como 5511999999999. Tem prioridade sobre recipient: para enviar pelo ID do usuário, deixe em branco.

Exemplo:

"5511999999999"

type

enum<string>

padrão:interactive

obrigatório

Sempre interactive.

Opções disponíveis:

interactive

Exemplo:

"interactive"

interactive

object

obrigatório

Pedido de localização com o texto e o botão para o cliente compartilhar onde está.

Show child attributes

recipient_type

enum<string>

padrão:individual

Sempre individual.

Opções disponíveis:

individual

Exemplo:

"individual"

recipient

string

ID do usuário no WhatsApp (BSUID), recebido nos webhooks em from_user_id e contacts[].user_id, como BR.13491208655302741918. Usado quando to não é informado.

context

object

Responde citando uma mensagem anterior da conversa.

Show child attributes

Resposta

Envio aceito pela Meta. Não confirma a entrega.

Começar

Administração

Mensagens

Recursos de mensagens

Mídias

Templates

Conta e número

Endpoints Datafy

Webhooks

Solicitar localização

Como montar o pedido

Resposta do cliente

Autorizações

Parâmetros de caminho

Corpo

Resposta

​Como montar o pedido

​Resposta do cliente

Autorizações

Parâmetros de caminho

Corpo

Resposta

Como montar o pedido

Resposta do cliente