Status do Canal

Metodo

GET https://oapi.ogmma.com.br/v1/channels/:id/status

Conceituacao

Retorna informacoes detalhadas sobre o estado atual de um canal, incluindo metricas de uso nas ultimas 24 horas. Util para monitorar a saude e a atividade de cada canal.

Atributos

Header

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

Path Parameters

Atributo	Tipo	Obrigatorio	Descricao
id	string	Sim	ID do canal.

Request

cURL

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

Node.js

const axios = require('axios');

const channelId = '6650a1b2c3d4e5f6a7b8c9d0';

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

console.log(response.data);

Python

import requests

channel_id = '6650a1b2c3d4e5f6a7b8c9d0'

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

print(response.json())

Response

200 - Sucesso

{
  "data": {
    "id": "6650a1b2c3d4e5f6a7b8c9d0",
    "name": "Atendimento Principal",
    "type": "WHATSAPP_BAILEYS",
    "status": "CONNECTED",
    "phone": "5511999998888",
    "uptime": "3d 14h 22m",
    "lastActivity": "2024-01-18T14:30:00.000Z",
    "messagesSent24h": 142,
    "messagesReceived24h": 89
  }
}

401 - Nao autorizado

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

404 - Canal nao encontrado

{
  "message": "Canal nao encontrado.",
  "code": "CHANNEL_NOT_FOUND"
}

429 - Rate limit excedido

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