Recursos
Conversas
Uma conversa é o atendimento de um contato em um canal (WhatsApp, Instagram, chat do site, e-mail, entre outros), identificada nas rotas por {entryType} (o canal) e {entryId}. A lista da caixa de entrada, o histórico, o envio de mensagens, a atribuição e a mudança de status acontecem pelo WebSocket de conversas (veja WebSockets). Este grupo traz as rotas HTTP de apoio: mídia, eventos, dados e variáveis da conversa, chamadas de ferramenta da IA, permissão de ligação no WhatsApp, delegação a um agente ou fluxo, ligar e desligar a automação e as preferências pessoais da caixa de entrada. O acesso segue o departamento e o responsável da conversa. Para os conceitos e exemplos, leia Guia de conversas e canais e Filtros de leads e conversas.
Guias deste recurso
Rotas 23
- GETTransferência para outro número
/conversations/unofficial_whatsapp/{entryId}/number-transfer - GETNúmeros para responder
/conversations/unofficial_whatsapp/{entryId}/number-transfer/numbers - GETConsultar permissão para ligar
/conversations/{entryType}/{entryId}/call-permission - GETVariáveis da conversa para uma automação
/conversations/{entryType}/{entryId}/variables - GETPreferências pessoais da caixa de entrada
/inbox/preferences - GETListar as chamadas de ferramenta da IA em uma conversa
/v1/conversations/{entryType}/{entryId}/ai-tool-calls - GETListar eventos de uma conversa
/v1/conversations/{entryType}/{entryId}/events - GETObter mídia de uma conversa
/v1/conversations/{entryType}/{entryId}/media/{mediaId} - GETListar as mensagens de uma conversa
/v1/conversations/{entryType}/{entryId}/messages - GETVer um e-mail como foi enviado
/v1/conversations/{entryType}/{entryId}/messages/{messageId}/email-html - GETFluxo responsável pela conversa
/v1/conversations/{entryType}/{entryId}/responsible-workflow - GETDados da conversa
/v1/conversations/{entryType}/{entryId}/variable-values - POSTTransferir para outro número
/conversations/unofficial_whatsapp/{entryId}/number-transfer - POSTResponder pelo novo número
/conversations/unofficial_whatsapp/{entryId}/number-transfer/link - POSTSolicitar permissão para ligar
/conversations/{entryType}/{entryId}/call-permission-request - POSTEnviar mídia para uma conversa
/v1/conversations/{entryType}/{entryId}/media - POSTEnviar uma mensagem na conversa
/v1/conversations/{entryType}/{entryId}/messages - PUTPreencher variáveis da conversa
/conversations/{entryType}/{entryId}/variables - PUTSalvar as preferências pessoais da caixa de entrada
/inbox/preferences - PUTDelegar conversa a um agente ou fluxo
/v1/conversations/{entryType}/{entryId}/delegation - PUTEditar um dado da conversa
/v1/conversations/{entryType}/{entryId}/variable-values/{name} - PATCHAtivar/desativar automação de uma conversa
/v1/conversations/{entryType}/{entryId}/automation - DELETECancelar transferência
/conversations/unofficial_whatsapp/{entryId}/number-transfer