Skip to main content

Conceito

Um Channel é a conexão entre um agente Timely.ai e uma plataforma de mensagens onde seus clientes estão. Cada canal representa uma conta ou número ativo: um número WhatsApp Business, um perfil Instagram Business, um bot do Telegram ou um widget de chat embutido no seu site. O agente associado ao canal recebe todas as mensagens que chegam por aquele canal e responde por ele. Um agente pode ter múltiplos canais associados. Um canal, no entanto, pertence a exatamente um agente por vez — se você precisar trocar o agente de um canal, basta atualizar a associação.

Tipos de canal

TipoIdentificadorObservações
WhatsApp BusinesswhatsappRequer WABA aprovada pela Meta
InstagraminstagramRequer perfil Business e Página vinculada
TelegramtelegramRequer Bot Token do @BotFather
Widget (site)widgetSem conta externa — gerado pela Timely

Ciclo de vida

criar canal (disconnected)


conectar (scanning QR / inserindo token)


connected → recebe mensagens → agente processa

    ├── reconectar se cair → connected


desconectar ou deletar
Canais WhatsApp passam pelo fluxo de leitura de QR code ou vinculação com número oficial. O endpoint GET /v1/channels/{id}/qr-code retorna o QR code em base64 durante a janela de conexão.

Campos principais

CampoTipoDescrição
idstring (UUID)ID único do canal
agent_idstring (UUID)Agente associado
typeenumwhatsapp | instagram | telegram | widget
namestringNome descritivo do canal
statusenumconnected | disconnected | error
phone_numberstringNúmero associado (para WhatsApp/Telegram)
usernamestringUsername do perfil (para Instagram/Telegram)
widget_tokenstringToken público de inicialização do widget
created_atstringISO 8601 de criação
last_connected_atstringISO 8601 da última conexão bem-sucedida

Endpoints disponíveis

Consulte a barra lateral à esquerda para a lista completa de endpoints deste grupo. Cada endpoint tem sua própria página com schema de request/response, exemplos em cURL/JS/Python e playground interativo.

Próximos passos

Primeira requisição

Se você ainda não fez sua primeira chamada, comece por aqui.