Conversas

add_tag_to_conversation

Escrita

Coloca uma etiqueta existente numa conversa (repetir não faz nada). Dispara as automações de etiqueta adicionada.

Permissão

conversations:write

Operação

conversations.tags.add

Parâmetros

conversationIdstringobrigatório

tagIdstringobrigatório

assign_conversation

Escrita

Atribui a conversa a um atendente da equipe, ou tira o responsável (userId nulo ou omitido). Dispara SLA e avisos como na tela; a nota vira uma nota interna na conversa.

Permissão

conversations:write

Operação

conversations.assign

Parâmetros

conversationIdstringobrigatório

userIdstringopcional

Atendente. Nulo ou omitido: sem responsável.

notestringopcional

Motivo, como nota interna.

get_conversation

Leitura

Uma conversa: canal, número de WhatsApp em que entrou, status, contato e se a IA está ativa nela.

Permissão

conversations:read

Operação

conversations.get

Parâmetros

conversationIdstringobrigatório

list_reply_drafts

Leitura

Respostas que a IA escreveu e esperam alguém aprovar antes de ir ao cliente (até 50, das mais antigas): a conversa, o contato, o canal, o texto e há quanto tempo espera. Aprovar fica na tela.

Permissão

conversations:read

Operação

reply_drafts.list

Parâmetros

Sem parâmetros.

remove_tag_from_conversation

Escrita

Tira uma etiqueta de uma conversa (se não tinha, não faz nada).

Permissão

conversations:write

Operação

conversations.tags.remove

Parâmetros

conversationIdstringobrigatório

tagIdstringobrigatório

search_conversations

Leitura

Lista ou busca conversas (nome do contato ou assunto), com filtros por status, canal, número de WhatsApp, responsável, etiquetas e período de criação. Paginado, com prévia da última mensagem. Cada conversa traz o número de WhatsApp em que entrou (whatsappNumber).

Permissão

conversations:read

Operação

conversations.list

Parâmetros

searchstringopcional

statusstringopcional

OPENPENDINGRESOLVEDCLOSED

channelstringopcional

WEB_CHATWHATSAPPEMAILINSTAGRAMMESSENGERTELEGRAMAPI

whatsAppInstanceIdstringopcional

Só as conversas deste número de WhatsApp (ids em list_whatsapp_instances).

assignedToIdstringopcional

tagIdsstring[]opcional

Com pelo menos uma destas etiquetas.

fromstringopcional

Criadas a partir de (data ou data e hora ISO).

tostringopcional

Criadas antes de (data ou data e hora ISO).

pageintegeropcional

limitintegeropcional

set_conversation_status

Escrita

Muda o status de uma conversa: aberta, pendente, resolvida ou fechada. Resolver ou fechar tira as etiquetas marcadas para sair ao fechar e dispara as automações de conversa encerrada.

Permissão

conversations:write

Operação

conversations.status

Parâmetros

conversationIdstringobrigatório

statusstringobrigatório

OPENPENDINGRESOLVEDCLOSED