Skip to main content
GET
Consultar canal (Socio)

Conceptos

Devuelve un canal del workspace de tu Secret Key, con los mismos campos del listado más los webhooks registrados en él: id, URL y eventos de cada endpoint.
Un canal de otro workspace responde 404, igual que un canal inexistente. La respuesta no distingue entre los dos casos a propósito.

Webhooks

A diferencia de Z-API, donde cada instancia tiene una URL fija por tipo de callback, en Omni un canal puede tener varios endpoints, cada uno suscrito a los eventos que elijas. Para crearlos, editarlos o eliminarlos, usa las rutas de webhooks del canal.
El channelId se obtiene mediante el endpoint Crear canal o Listar canales.

Autorizaciones

Authorization
string
header
requerido

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

Parámetros de ruta

channelId
string
requerido

Identificador del canal

Ejemplo:

"AA0C61D24A6549A3BF83239847DE1CC2"

Respuesta

Canal encontrado

id
string
Ejemplo:

"AA0C61D24A6549A3BF83239847DE1CC2"

name
string
Ejemplo:

"Suporte"

token
string | null
Ejemplo:

"F1B29C3D4E5A6B7C8D9E0F1A2B3C4D5E"

tenant
string
Ejemplo:

"01A090B7FB82798CB38AB259C0B65FBE"

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

"META_WHATSAPP"

created
string<date-time>
Ejemplo:

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

due
integer<int64> | null
Ejemplo:

1774915200000

paymentStatus
enum<string>
Opciones disponibles:
PAID,
PENDING,
BOLETO_PENDING,
CANCELLATION_PROCESS,
CANCELED,
TRIAL
Ejemplo:

"PAID"

phoneConnected
boolean
Ejemplo:

true

whatsappConnected
boolean
Ejemplo:

true

phoneNumberConnected
string | null
Ejemplo:

"5585999999999"

businessId
string | null
Ejemplo:

"102938475610293"

whatsappCoexistence
boolean
Ejemplo:

false

webhooks
object[]