Listar Mensagens

Metodo

GET https://oapi.ogmma.com.br/v1/channels/{channelId}/conversations/{conversationId}

Conceituacao

Retorna uma lista de mensagens de uma conversa especifica em um canal. Util para consultar o historico de mensagens de uma conversa.

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.
conversationId	string	Sim	ID da conversa.

Query Parameters

Atributo	Tipo	Obrigatorio	Descricao
limit	number	Nao	Quantidade de mensagens retornadas. Padrao: 50. Maximo: 500.

Request

cURL

curl -X GET "https://oapi.ogmma.com.br/v1/channels/{channelId}/conversations/{conversationId}?limit=50" \
  -H "Authorization: Bearer {API_KEY}"

Node.js

const axios = require('axios');

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

console.log(response.data);

Python

import requests

response = requests.get(
    'https://oapi.ogmma.com.br/v1/channels/{channelId}/conversations/{conversationId}',
    params={
        'limit': 50
    },
    headers={
        'Authorization': 'Bearer {API_KEY}'
    }
)

print(response.json())

Response

200 - Sucesso

{
  "data": [
    {
      "id": "6650a1b2c3d4e5f6a7b8c9f0",
      "conversationId": "6650a1b2c3d4e5f6a7b8c9d1",
      "channelId": "6650a1b2c3d4e5f6a7b8c9d2",
      "type": "text",
      "direction": "OUTBOUND",
      "status": "DELIVERED",
      "content": "Ola! Como posso ajudar?",
      "mediaUrl": null,
      "from": "5511999998888",
      "to": "5511977776666",
      "createdAt": "2024-01-15T10:30:00.000Z",
      "updatedAt": "2024-01-15T10:30:05.000Z"
    },
    {
      "id": "6650a1b2c3d4e5f6a7b8c9f1",
      "conversationId": "6650a1b2c3d4e5f6a7b8c9d1",
      "channelId": "6650a1b2c3d4e5f6a7b8c9d2",
      "type": "text",
      "direction": "INBOUND",
      "status": "READ",
      "content": "Preciso de ajuda com meu pedido",
      "mediaUrl": null,
      "from": "5511977776666",
      "to": "5511999998888",
      "createdAt": "2024-01-15T10:29:00.000Z",
      "updatedAt": "2024-01-15T10:29:01.000Z"
    }
  ],
  "meta": {
    "limit": 50
  }
}

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