Conversations

add_tag_to_conversation

Write

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

Permission

conversations:write

Operation

conversations.tags.add

Parameters

conversationIdstringrequired

tagIdstringrequired

assign_conversation

Write

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.

Permission

conversations:write

Operation

conversations.assign

Parameters

conversationIdstringrequired

userIdstringoptional

Atendente. Nulo ou omitido: sem responsável.

notestringoptional

Motivo, como nota interna.

get_conversation

Read

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

Permission

conversations:read

Operation

conversations.get

Parameters

conversationIdstringrequired

list_reply_drafts

Read

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.

Permission

conversations:read

Operation

reply_drafts.list

Parameters

No parameters.

remove_tag_from_conversation

Write

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

Permission

conversations:write

Operation

conversations.tags.remove

Parameters

conversationIdstringrequired

tagIdstringrequired

search_conversations

Read

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).

Permission

conversations:read

Operation

conversations.list

Parameters

searchstringoptional

statusstringoptional

OPENPENDINGRESOLVEDCLOSED

channelstringoptional

WEB_CHATWHATSAPPEMAILINSTAGRAMMESSENGERTELEGRAMAPI

whatsAppInstanceIdstringoptional

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

assignedToIdstringoptional

tagIdsstring[]optional

Com pelo menos uma destas etiquetas.

fromstringoptional

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

tostringoptional

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

pageintegeroptional

limitintegeroptional

set_conversation_status

Write

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.

Permission

conversations:write

Operation

conversations.status

Parameters

conversationIdstringrequired

statusstringrequired

OPENPENDINGRESOLVEDCLOSED