> ## Documentation Index
> Fetch the complete documentation index at: https://developer.omni.z-api.io/llms.txt
> Use this file to discover all available pages before exploring further.
# Enviar localização
> Envie mensagens de localização
export const ChannelSupport = ({whatsapp = 'yes', web = 'yes', instagram = 'yes', messenger = 'yes', telegram = 'yes', lang = 'pt'}) => {
const L = ({
pt: {
title: 'Disponibilidade por canal',
win: 'No WhatsApp Oficial exige a janela de 24 horas aberta. Nos outros canais não há janela.',
names: ['WhatsApp Oficial', 'WhatsApp Web', 'Instagram', 'Messenger', 'Telegram']
},
en: {
title: 'Availability per channel',
win: 'On WhatsApp Official it requires the 24-hour window to be open. The other channels have no window.',
names: ['WhatsApp Official', 'WhatsApp Web', 'Instagram', 'Messenger', 'Telegram']
},
es: {
title: 'Disponibilidad por canal',
win: 'En WhatsApp Oficial exige que la ventana de 24 horas esté abierta. Los demás canales no tienen ventana.',
names: ['WhatsApp Oficial', 'WhatsApp Web', 'Instagram', 'Messenger', 'Telegram']
}
})[lang];
const mark = v => v === 'yes' ? '✅' : v === 'partial' ? '⚠️' : '❌';
const vals = [whatsapp, web, instagram, messenger, telegram];
return
{L.title}
{L.names.map(n => | {n} | )}
{vals.map((v, i) => | {mark(v)} | )}
{whatsapp === 'yes' &&
{L.win}
}
;
};
## 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.
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 do WhatsApp Oficial em [janela de conversa](/conversation-window). Veja a [matriz de capacidades](/channels/overview) para todos os canais.
## OpenAPI
````yaml pt/messages/openapi-location.json POST /v1/channels/{channelId}/messages
openapi: 3.1.0
info:
title: Omni Z-API - Enviar Localização
version: 1.0.0
servers:
- url: https://api.omni.z-api.io
security:
- bearerAuth: []
paths:
/v1/channels/{channelId}/messages:
post:
tags:
- Mensagens
summary: Enviar localização
description: >-
Envia uma mensagem de localização. Funciona apenas quando a janela de
conversa de 24 horas estiver aberta.
operationId: sendLocationMessage
parameters:
- name: channelId
in: path
required: true
description: ID do canal
schema:
type: string
example: SEU_CHANNEL_ID
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/SendLocationRequest'
example:
recipient:
identifier: '5544936181064'
name: Nome do Destinatário
subject: Título
picture: ''
sender:
identifier: '5544936181064'
name: Nome do Remetente
picture: ''
content:
type: LOCATION
attachments:
- name: Google Brasil
address: >-
Av. Brg. Faria Lima, 3477 - Itaim Bibi, São Paulo - SP,
04538-133
latitude: '-23.0696347'
longitude: '-50.4357913'
responses:
'200':
$ref: '#/components/responses/MessageSuccess'
'401':
$ref: '#/components/responses/Unauthorized'
'422':
$ref: '#/components/responses/WindowClosed'
components:
schemas:
SendLocationRequest:
type: object
required:
- recipient
- content
properties:
recipient:
type: object
required:
- identifier
description: Dados do destinatário
properties:
identifier:
type: string
description: Telefone do destinatário (DDI + DDD + número)
example: '5544936181064'
name:
type: string
description: Nome do destinatário (opcional)
example: Nome do Destinatário
subject:
type: string
description: Título ou assunto (opcional)
example: Título
picture:
type: string
description: URL da foto do destinatário (opcional)
example: ''
sender:
type: object
description: Dados do remetente (opcional)
properties:
identifier:
type: string
description: Telefone do remetente
example: '5544936181064'
name:
type: string
description: Nome do remetente
example: Nome do Remetente
picture:
type: string
description: URL da foto do remetente
example: ''
content:
type: object
required:
- type
- attachments
properties:
type:
type: string
description: Tipo da mensagem
enum:
- LOCATION
attachments:
type: array
description: Lista com os dados da localização
items:
type: object
properties:
latitude:
type: string
description: >-
Latitude da localização. Não é validado pela API, mas
necessário para exibir o pin corretamente no WhatsApp.
example: '-23.0696347'
longitude:
type: string
description: >-
Longitude da localização. Não é validado pela API, mas
necessário para exibir o pin corretamente no WhatsApp.
example: '-50.4357913'
name:
type: string
description: Nome do local (opcional)
example: Google Brasil
address:
type: string
description: Endereço do local (opcional)
example: >-
Av. Brg. Faria Lima, 3477 - Itaim Bibi, São Paulo - SP,
04538-133
MessageResponse:
type: object
properties:
messageId:
type: string
description: ID da mensagem enviada
Error:
type: object
properties:
error:
type: integer
message:
type: string
responses:
MessageSuccess:
description: Mensagem enviada com sucesso
content:
application/json:
schema:
$ref: '#/components/schemas/MessageResponse'
example:
messageId: wamid.HBgNNTU0NDk3MDUwNzg1FQIAERgSM0
Unauthorized:
description: Token inválido ou ausente.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
example:
error: 401
message: Unauthorized
WindowClosed:
description: Janela de conversa de 24 horas fechada.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
example:
error: 422
message: Conversation window is closed
securitySchemes:
bearerAuth:
type: http
scheme: bearer
description: Secret Key gerada no painel de Segurança do Omni Z-API
````