Listar Canais

Metodo

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

Conceituacao

Retorna a lista de todos os canais vinculados a sua instituicao. Cada canal inclui informacoes sobre o tipo de conexao, status atual e numero de telefone associado.

Atributos

Header

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

Query Parameters

Atributo	Tipo	Obrigatorio	Descricao
status	string	Nao	Filtrar por status: CONNECTED, DISCONNECTED, AWAITING_QR
type	string	Nao	Filtrar por tipo: WHATSAPP_BAILEYS, WHATSAPP_WABA

Request

cURL

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

Node.js

const axios = require('axios');

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

console.log(response.data);

Python

import requests

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

print(response.json())

Response

200 - Sucesso

{
  "data": [
    {
      "id": "6650a1b2c3d4e5f6a7b8c9d0",
      "name": "Atendimento Principal",
      "type": "WHATSAPP_BAILEYS",
      "status": "CONNECTED",
      "phone": "5511999998888",
      "createdAt": "2024-01-15T10:30:00.000Z",
      "updatedAt": "2024-01-15T10:35:00.000Z"
    },
    {
      "id": "6650a1b2c3d4e5f6a7b8c9d1",
      "name": "Vendas",
      "type": "WHATSAPP_WABA",
      "status": "CONNECTED",
      "phone": "5511988887777",
      "createdAt": "2024-02-10T14:00:00.000Z",
      "updatedAt": "2024-02-10T14:05:00.000Z"
    }
  ],
  "meta": {
    "total": 2,
    "page": 1,
    "limit": 20
  }
}

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