Enviar Localizacao

Metodo

POST https://oapi.ogmma.com.br/v1/channels/{channelId}/messages/location

Conceituacao

Envia uma localizacao (pino no mapa) para um numero de telefone atraves de um canal conectado. O destinatario recebera um mapa interativo com a localizacao marcada, podendo abrir em seu aplicativo de mapas.

Atributos

Header

Atributo	Tipo	Obrigatorio	Descricao
Authorization	string	Sim	Bearer {API_KEY} - Chave de autenticacao da API
Content-Type	string	Sim	application/json

Path Parameters

Atributo	Tipo	Obrigatorio	Descricao
channelId	string	Sim	ID do canal pelo qual a mensagem sera enviada.

Body

Atributo	Tipo	Obrigatorio	Descricao
to	string	Sim	Numero do destinatario no formato DDI+DDD+NUM.
latitude	number	Sim	Latitude da localizacao (ex: -23.5505).
longitude	number	Sim	Longitude da localizacao (ex: -46.6333).
name	string	Nao	Nome do local (ex: "Escritorio Ogmma").
address	string	Nao	Endereco do local (ex: "Av. Paulista, 1000 - Sao Paulo").

Request

Localizacao com nome e endereco

cURL

curl -X POST "https://oapi.ogmma.com.br/v1/channels/{channelId}/messages/location" \
  -H "Authorization: Bearer {API_KEY}" \
  -H "Content-Type: application/json" \
  -d '{
    "to": "5511999998888",
    "latitude": -23.5505,
    "longitude": -46.6333,
    "name": "Escritorio Ogmma",
    "address": "Av. Paulista, 1000 - Sao Paulo, SP"
  }'

Node.js

const axios = require('axios');

const response = await axios.post(
  'https://oapi.ogmma.com.br/v1/channels/{channelId}/messages/location',
  {
    to: "5511999998888",
    latitude: -23.5505,
    longitude: -46.6333,
    name: "Escritorio Ogmma",
    address: "Av. Paulista, 1000 - Sao Paulo, SP"
  },
  {
    headers: {
      'Authorization': 'Bearer {API_KEY}',
      'Content-Type': 'application/json'
    }
  }
);

console.log(response.data);

Python

import requests

response = requests.post(
    'https://oapi.ogmma.com.br/v1/channels/{channelId}/messages/location',
    json={
        'to': '5511999998888',
        'latitude': -23.5505,
        'longitude': -46.6333,
        'name': 'Escritorio Ogmma',
        'address': 'Av. Paulista, 1000 - Sao Paulo, SP'
    },
    headers={
        'Authorization': 'Bearer {API_KEY}',
        'Content-Type': 'application/json'
    }
)

print(response.json())

Localizacao simples (apenas coordenadas)

cURL

curl -X POST "https://oapi.ogmma.com.br/v1/channels/{channelId}/messages/location" \
  -H "Authorization: Bearer {API_KEY}" \
  -H "Content-Type: application/json" \
  -d '{
    "to": "5511999998888",
    "latitude": -23.5505,
    "longitude": -46.6333
  }'

Node.js

const axios = require('axios');

const response = await axios.post(
  'https://oapi.ogmma.com.br/v1/channels/{channelId}/messages/location',
  {
    to: "5511999998888",
    latitude: -23.5505,
    longitude: -46.6333
  },
  {
    headers: {
      'Authorization': 'Bearer {API_KEY}',
      'Content-Type': 'application/json'
    }
  }
);

console.log(response.data);

Python

import requests

response = requests.post(
    'https://oapi.ogmma.com.br/v1/channels/{channelId}/messages/location',
    json={
        'to': '5511999998888',
        'latitude': -23.5505,
        'longitude': -46.6333
    },
    headers={
        'Authorization': 'Bearer {API_KEY}',
        'Content-Type': 'application/json'
    }
)

print(response.json())

Response

202 - Aceito

{
  "success": true,
  "message": "Mensagem enfileirada para envio"
}

400 - Dados invalidos

{
  "message": "Dados de entrada invalidos.",
  "code": "VALIDATION_ERROR",
  "errors": [
    {
      "field": "latitude",
      "message": "A latitude e obrigatoria e deve ser um numero."
    }
  ]
}

401 - Nao autorizado

{
  "message": "Token de autenticacao invalido ou ausente.",
  "code": "UNAUTHORIZED"
}

429 - Rate limit excedido

{
  "message": "Limite de requisicoes excedido. Tente novamente em alguns segundos.",
  "code": "RATE_LIMIT_EXCEEDED"
}