Skip to main content
GET
Consultar canal (Parceiro)

Conceituação

Retorna um canal do workspace da sua Secret Key, com os mesmos campos da listagem e mais os webhooks cadastrados nele — id, URL e eventos de cada endpoint.
Canal de outro workspace responde 404, igual a canal inexistente. A resposta não distingue os dois casos de propósito.

Webhooks

Diferente da Z-API, onde cada instância tem uma URL fixa por tipo de callback, no Omni um canal pode ter vários endpoints, cada um inscrito nos eventos que você escolher. Para criar, editar ou remover, use as rotas de webhooks do canal.
O channelId é obtido através do endpoint Criar canal ou de Listar canais.

Autorizações

Authorization
string
header
obrigatório

Secret Key gerada no painel de Seguranca do Omni Z-API

Parâmetros de caminho

channelId
string
obrigatório

Identificador do canal

Exemplo:

"AA0C61D24A6549A3BF83239847DE1CC2"

Resposta

Canal encontrado

id
string
Exemplo:

"AA0C61D24A6549A3BF83239847DE1CC2"

name
string
Exemplo:

"Suporte"

token
string | null
Exemplo:

"F1B29C3D4E5A6B7C8D9E0F1A2B3C4D5E"

tenant
string
Exemplo:

"01A090B7FB82798CB38AB259C0B65FBE"

type
enum<string>
Opções disponíveis:
META_WHATSAPP,
Z_API_WHATSAPP,
META_INSTAGRAM,
META_MESSENGER,
BOT_TELEGRAM
Exemplo:

"META_WHATSAPP"

created
string<date-time>
Exemplo:

"2026-03-11T14:02:00.000Z"

due
integer<int64> | null
Exemplo:

1774915200000

paymentStatus
enum<string>
Opções disponíveis:
PAID,
PENDING,
BOLETO_PENDING,
CANCELLATION_PROCESS,
CANCELED,
TRIAL
Exemplo:

"PAID"

phoneConnected
boolean
Exemplo:

true

whatsappConnected
boolean
Exemplo:

true

phoneNumberConnected
string | null
Exemplo:

"5585999999999"

businessId
string | null
Exemplo:

"102938475610293"

whatsappCoexistence
boolean
Exemplo:

false

webhooks
object[]