Pular para o conteúdo principal
POST
Criar canal

Conceituação

Cria um novo canal. Após a criação, o canal precisa ser conectado (via painel ou SDK) para começar a enviar e receber mensagens. O id retornado é o channelId usado em todas as chamadas de API.

Token do canal

Quando a criação é autenticada pela Secret Key do workspace, a resposta 201 traz também o token do canal:
É o mesmo token que Consultar canal devolve com a Secret Key. Use-o nas rotas de QR Code e de status do canal, sem precisar consultar o canal depois de criá-lo. Quando a criação é feita com o token OAuth de um app autorizado, a resposta continua só com o id: a chave token não aparece. Trate o campo como opcional. As respostas de erro não mudam e não trazem token.
O mesmo vale para as rotas equivalentes POST /v1/instances e POST /v1/devices.

Tipos disponíveis

Autorizações

Authorization
string
header
obrigatório

Secret Key gerada no painel de Segurança do Omni Z-API

Corpo

application/json
name
string
obrigatório

Nome do canal

type
enum<string>
obrigatório

Tipo do canal (plataforma)

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

Resposta

Canal criado com sucesso. Com a Secret Key, a resposta traz id e token; com o token OAuth de um app autorizado, só id.

id
string

ID do canal criado (channelId)

token
string

Token do canal, o mesmo devolvido por GET /v1/channels/{channelId}. Use nas rotas de QR Code e de status do canal. Presente só quando a criação é autenticada pela Secret Key do workspace; com o token OAuth de um app, a chave não aparece na resposta.