Buscar Mensagem

Metodo

GET https://oapi.ogmma.com.br/v1/channels/{channelId}/messages/{messageId}

Conceituacao

Retorna os detalhes completos de uma mensagem especifica, incluindo conteudo, tipo, direcao, status atual, URL de midia (quando aplicavel) e timestamps de criacao e atualizacao.

Atributos

Header

Atributo	Tipo	Obrigatorio	Descricao
Authorization	string	Sim	Bearer {API_KEY} - Chave de autenticacao da API

Path Parameters

Atributo	Tipo	Obrigatorio	Descricao
channelId	string	Sim	ID do canal.
messageId	string	Sim	ID da mensagem.

Request

cURL

curl -X GET "https://oapi.ogmma.com.br/v1/channels/{channelId}/messages/{messageId}" \
  -H "Authorization: Bearer {API_KEY}"

Node.js

const axios = require('axios');

const response = await axios.get(
  'https://oapi.ogmma.com.br/v1/channels/{channelId}/messages/{messageId}',
  {
    headers: {
      'Authorization': 'Bearer {API_KEY}'
    }
  }
);

console.log(response.data);

Python

import requests

response = requests.get(
    'https://oapi.ogmma.com.br/v1/channels/{channelId}/messages/{messageId}',
    headers={
        'Authorization': 'Bearer {API_KEY}'
    }
)

print(response.json())

Response

200 - Sucesso

{
  "data": {
    "id": "6650a1b2c3d4e5f6a7b8c9f0",
    "conversationId": "6650a1b2c3d4e5f6a7b8c9d1",
    "channelId": "6650a1b2c3d4e5f6a7b8c9d2",
    "type": "image",
    "direction": "OUTBOUND",
    "status": "READ",
    "content": null,
    "caption": "Foto do produto",
    "mediaUrl": "https://oapi.ogmma.com.br/v1/media/6650a1b2c3d4e5f6a7b8c9f0",
    "from": "5511999998888",
    "to": "5511977776666",
    "quotedMessageId": null,
    "createdAt": "2024-01-15T10:30:00.000Z",
    "updatedAt": "2024-01-15T10:32:00.000Z"
  }
}

401 - Nao autorizado

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

404 - Mensagem nao encontrada

{
  "message": "Mensagem nao encontrada.",
  "code": "MESSAGE_NOT_FOUND"
}

429 - Rate limit excedido

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