Enviar Imagem

Metodo

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

Conceituacao

Envia uma mensagem de imagem para um numero de telefone atraves de um canal conectado. A imagem deve ser enviada por URL publica. Opcionalmente, uma legenda pode ser adicionada.

Formatos suportados

Formato	Extensao
JPEG	.jpg, .jpeg
PNG	.png
WebP	.webp

Limites

• Tamanho maximo: 16MB
• Imagens maiores serao rejeitadas com erro 400.

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.
imageUrl	string	Sim	URL publica da imagem.
caption	string	Nao	Legenda da imagem. Maximo 1024 caracteres.
fileName	string	Nao	Nome do arquivo da imagem.
mimeType	string	Nao	Tipo MIME da imagem (ex: image/jpeg).
fileSize	number	Nao	Tamanho do arquivo em bytes.

Request

cURL

curl -X POST "https://oapi.ogmma.com.br/v1/channels/{channelId}/messages/image" \
  -H "Authorization: Bearer {API_KEY}" \
  -H "Content-Type: application/json" \
  -d '{
    "to": "5511999998888",
    "imageUrl": "https://exemplo.com/imagem-produto.jpg",
    "caption": "Confira nosso novo produto!"
  }'

Node.js

const axios = require('axios');

const response = await axios.post(
  'https://oapi.ogmma.com.br/v1/channels/{channelId}/messages/image',
  {
    to: "5511999998888",
    imageUrl: "https://exemplo.com/imagem-produto.jpg",
    caption: "Confira nosso novo produto!"
  },
  {
    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/image',
    json={
        'to': '5511999998888',
        'imageUrl': 'https://exemplo.com/imagem-produto.jpg',
        'caption': 'Confira nosso novo produto!'
    },
    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": "imageUrl",
      "message": "A URL da imagem e obrigatoria."
    }
  ]
}

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"
}