Deletar Canal

Metodo

DELETE https://oapi.ogmma.com.br/v1/channels/:id

Conceituacao

Remove permanentemente um canal e todos os dados de sessao associados. Esta acao e irreversivel. O canal sera desconectado automaticamente antes da exclusao, caso esteja conectado.

As mensagens e conversas associadas ao canal nao sao removidas e continuam disponiveis para consulta.

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 deletado.

Request

cURL

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

Node.js

const axios = require('axios');

const channelId = '6650a1b2c3d4e5f6a7b8c9d0';

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

console.log(response.data);

Python

import requests

channel_id = '6650a1b2c3d4e5f6a7b8c9d0'

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

print(response.json())

Response

200 - Canal deletado com sucesso

{
  "data": {
    "id": "6650a1b2c3d4e5f6a7b8c9d0",
    "deletedAt": "2024-01-15T18:00:00.000Z"
  }
}

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

Atencao

Esta acao e permanente e nao pode ser desfeita. Certifique-se de que o canal nao esta mais em uso antes de remove-lo.