Desconectar Canal

Metodo

POST https://oapi.ogmma.com.br/v1/channels/:id/disconnect

Conceituacao

Desconecta um canal ativo. A sessao WhatsApp sera encerrada e o canal passara para o status DISCONNECTED. As mensagens pendentes na fila nao serao enviadas enquanto o canal estiver desconectado.

O canal pode ser reconectado a qualquer momento atraves do endpoint de conexao.

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 a ser desconectado.

Request

cURL

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

Node.js

const axios = require('axios');

const channelId = '6650a1b2c3d4e5f6a7b8c9d0';

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

console.log(response.data);

Python

import requests

channel_id = '6650a1b2c3d4e5f6a7b8c9d0'

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

print(response.json())

Response

200 - Canal desconectado com sucesso

{
  "data": {
    "id": "6650a1b2c3d4e5f6a7b8c9d0",
    "name": "Atendimento Principal",
    "type": "WHATSAPP_BAILEYS",
    "status": "DISCONNECTED",
    "phone": "5511999998888",
    "updatedAt": "2024-01-15T18:00:00.000Z"
  }
}

400 - Canal ja desconectado

{
  "message": "O canal ja esta desconectado.",
  "code": "CHANNEL_ALREADY_DISCONNECTED"
}

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