Skip to main content
GET
Listar canais (Parceiro)

Conceituação

Retorna os canais do workspace da sua Secret Key, do mais recente para o mais antigo. Canais excluídos não aparecem, e canais de outros workspaces também não — o escopo é sempre a conta dona da chave.

Paginação

A resposta traz total (canais que atendem ao filtro), totalPage, pageSize e page, e os canais em content.

Filtros

Na Z-API, middleware diz se a instância roda em web ou mobile. No Omni não existe essa distinção: o campo guarda a tecnologia do canal, o mesmo valor aceito em Criar canal. O parâmetro middleware existe para quem migrou da Z-API e mantém o nome antigo no código.

Webhooks do canal

Cada canal traz webhooksCount, a quantidade de endpoints de webhook cadastrados nele. Para ver as URLs e os eventos de cada um, use Consultar canal ou Listar webhooks.

Autorizações

Authorization
string
header
obrigatório

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

Parâmetros de consulta

page
integer
padrão:0

Pagina desejada, comecando em 0

Intervalo obrigatório: x >= 0
pageSize
integer
padrão:20

Quantidade de canais por pagina (1 a 100)

Intervalo obrigatório: 1 <= x <= 100
query
string

Filtra por trecho do nome do canal ou pelo inicio do identificador

Exemplo:

"suporte"

type
enum<string>

Filtra pela tecnologia do canal

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

Sinonimo de type, para quem vem da Z-API. Se os dois forem enviados, type prevalece

Opções disponíveis:
META_WHATSAPP,
Z_API_WHATSAPP,
META_INSTAGRAM,
META_MESSENGER,
BOT_TELEGRAM

Resposta

Pagina de canais do workspace

total
integer<int64>
Exemplo:

37

totalPage
integer
Exemplo:

2

pageSize
integer
Exemplo:

20

page
integer
Exemplo:

0

content
object[]