Pular para o conteúdo principal
POST
Enviar localização
Em implementação. No WhatsApp Web, o nome do lugar não é repassado: o campo name ainda não é enviado ao WhatsApp. A correção está em andamento.

Conceituação

Envia uma mensagem de localização para um contato. O campo content.type deve ser LOCATION e as coordenadas são informadas no array attachments com latitude e longitude. Os campos name e address são opcionais e permitem exibir o nome e o endereço do local diretamente na mensagem. Envie latitude e longitude em texto, como no exemplo: "-23.0696347".
A API não valida os campos latitude e longitude. Requisições sem esses valores serão aceitas, mas a mensagem não exibirá a localização corretamente no WhatsApp. Sempre informe ambos os campos.
Detalhes da regra da Meta Cloud API em janela de conversa. Veja o que cada canal aceita para todos os canais.
Com o canal desconectado, a API recusa o envio com 422 e subCode CHANNEL_DISCONNECTED, e a mensagem não é enviada. Veja Erros no envio.

Autorizações

Authorization
string
header
obrigatório

Secret Key gerada no painel de Segurança do Omni Z-API

Parâmetros de caminho

channelId
string
obrigatório

ID do canal

Exemplo:

"SEU_CHANNEL_ID"

Corpo

application/json
recipient
object
obrigatório

Dados do destinatário

content
object
obrigatório
sender
object

Dados do remetente (opcional)

Resposta

Mensagem enviada com sucesso

messageId
string

ID da mensagem enviada — hexadecimal de 32 caracteres maiúsculos