Skip to main content
GET
Listar canales (Socio)

Conceptos

Devuelve los canales del workspace de tu Secret Key, del más reciente al más antiguo. Los canales eliminados no aparecen, y los de otros workspaces tampoco: el alcance es siempre la cuenta dueña de la clave.

Paginación

La respuesta trae total (canales que cumplen el filtro), totalPage, pageSize y page, con los canales en content.

Filtros

En Z-API, middleware indica si la instancia corre en web o mobile. En Omni no existe esa distinción: el campo guarda la tecnología del canal, el mismo valor aceptado en Crear canal. El parámetro middleware existe para quien migró desde Z-API y mantiene el nombre antiguo en su código.

Webhooks del canal

Cada canal trae webhooksCount, la cantidad de endpoints de webhook registrados en él. Para ver las URLs y los eventos de cada uno, usa Consultar canal o Listar webhooks.

Autorizaciones

Authorization
string
header
requerido

Secret Key generada en el panel de Seguridad de Omni Z-API

Parámetros de consulta

page
integer
predeterminado:0

Pagina deseada, empezando en 0

Rango requerido: x >= 0
pageSize
integer
predeterminado:20

Cantidad de canales por pagina (1 a 100)

Rango requerido: 1 <= x <= 100
query
string

Filtra por parte del nombre del canal o por el inicio del identificador

Ejemplo:

"suporte"

type
enum<string>

Filtra por la tecnologia del canal

Opciones disponibles:
META_WHATSAPP,
Z_API_WHATSAPP,
META_INSTAGRAM,
META_MESSENGER,
BOT_TELEGRAM
middleware
enum<string>

Sinonimo de type, para quien viene de Z-API. Si se envian ambos, prevalece type

Opciones disponibles:
META_WHATSAPP,
Z_API_WHATSAPP,
META_INSTAGRAM,
META_MESSENGER,
BOT_TELEGRAM

Respuesta

Pagina de canales del workspace

total
integer<int64>
Ejemplo:

37

totalPage
integer
Ejemplo:

2

pageSize
integer
Ejemplo:

20

page
integer
Ejemplo:

0

content
object[]