Skip to main content
POST
Connect a channel (Step 1: connection only, no config)

Autorizações

X-Api-Key
string
header
obrigatório

Parâmetros de caminho

agentPublicId
string<uuid>
obrigatório

Corpo

application/json

Body for connecting a new channel to an agent.

channelType
enum<string>

Channel type to connect.

Opções disponíveis:
whatsapp,
z_api,
web_chat
Minimum string length: 1
Pattern: ^(whatsapp|z_api|web_chat)$
Exemplo:

"whatsapp"

isActive
boolean

Whether the channel should be active immediately after connecting.

Exemplo:

true

Resposta

Channel connection created

Agent channel connection. credentials NEVER returned.

channelName
string
channelSpecificConfig
object
channelType
string
createdAt
string<date-time>
instanceMode
enum<string>
Opções disponíveis:
STATIC,
DYNAMIC
isActive
boolean
isConfigured
boolean
publicId
string<uuid>
updatedAt
string<date-time>