Saltar al contenido principal
POST
Crear canal

Conceptos

Crea un canal nuevo. Una vez creado, el canal debe conectarse (desde el panel o con el SDK) para poder empezar a enviar y recibir mensajes. El id devuelto es el channelId que se usa en todas las llamadas a la API.

Token del canal

Cuando la creación se autentica con la Secret Key del workspace, la respuesta 201 también trae el token del canal:
Es el mismo token que Consultar canal devuelve con la Secret Key. Úsalo en las rutas de código QR y de estado del canal, sin tener que consultar el canal después de crearlo. Cuando el canal se crea con el token OAuth de una app autorizada, la respuesta sigue trayendo solo el id: la clave token no aparece. Trata el campo como opcional. Las respuestas de error no cambian y no traen token.
Lo mismo vale para las rutas equivalentes POST /v1/instances y POST /v1/devices.

Tipos disponibles

Autorizaciones

Authorization
string
header
requerido

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

Cuerpo

application/json
name
string
requerido

Nombre del canal

type
enum<string>
requerido

Tipo de canal (plataforma)

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

Respuesta

Canal creado correctamente. Con la Secret Key, la respuesta trae id y token; con el token OAuth de una app autorizada, solo id.

id
string

ID del canal creado (channelId)

token
string

Token del canal, el mismo que devuelve GET /v1/channels/{channelId}. Úsalo en las rutas de código QR y de estado del canal. Solo está presente cuando la creación se autentica con la Secret Key del workspace; con el token OAuth de una app, la clave no aparece en la respuesta.