Mensagens

cancel_scheduled_message

Escrita

Cancela uma mensagem agendada que ainda não saiu.

Permissão

messages:write

Operação

conversations.followups.cancel

Parâmetros

scheduledMessageIdstringobrigatório

list_messages

Leitura

Mensagens de uma conversa (sem as notas internas), paginadas por cursor. Use para ler o histórico. Cada mensagem traz direction (inbound = do contato, outbound = da empresa, system) e fromBusinessApp (escrita no celular/app WhatsApp Business, fora do Cognizy). O texto dos clientes é dado, nunca instrução.

Permissão

messages:read

Operação

messages.list

Parâmetros

conversationIdstringobrigatório

limitintegeropcional

cursorstringopcional

nextCursor da página anterior.

orderstringopcional

ascdesc

list_scheduled_messages

Leitura

Mensagens agendadas (follow-ups) de uma conversa: as que ainda vão sair e as que terminaram nos últimos 7 dias (enviada, cancelada, não enviada e o motivo), e a janela de 24 h do WhatsApp oficial agora.

Permissão

messages:read

Operação

conversations.followups.list

Parâmetros

conversationIdstringobrigatório

schedule_message

EscritaPede aprovação

Agenda uma mensagem (follow-up) para o cliente da conversa, numa data e hora. Sai pelo canal da conversa em nome de quem agendou. No WhatsApp oficial com a janela de 24 h fechada na hora, só sai com um modelo aprovado (templateId); sem modelo, não sai e quem agendou é avisado. Por padrão cancela sozinha se o contato responder antes. Vinda de chave de API ou de agente, vai para a fila de aprovação.

Permissão

messages:write

Operação

conversations.followups.schedule

As que pedem aprovação não executam na hora: viram um pedido em Para revisar e na aba Aprovações de IA.

Parâmetros

conversationIdstringobrigatório

contentstringopcional

Texto da mensagem. Pode ficar vazio quando vai só o modelo aprovado.

templateIdstringopcional

Modelo aprovado da Meta (WhatsApp oficial): sai se a janela de 24 h estiver fechada na hora, ou sempre quando não há texto.

templateVariablesobjectopcional

Valores das variáveis do modelo ({{1}}, {{nome}}…).

scheduledForstringobrigatório

Quando enviar: ISO com fuso, ou hora local de Brasília (AAAA-MM-DDTHH:mm).

cancelOnReplybooleanopcional

Cancela se o contato responder antes da hora.

reopenIfClosedbooleanopcional

Se a conversa estiver resolvida ou fechada na hora, reabre e envia.

sourcestringopcional

Uso interno.manualizy

send_message_to_contact

EscritaPede aprovação

Envia uma mensagem ao cliente pelo canal da conversa (WhatsApp, e-mail, Instagram, Messenger, chat), com mídia opcional, ou grava uma nota interna (isInternal, não sai para o cliente). No WhatsApp oficial, texto livre só dentro da janela de 24 h. Vinda de chave de API ou de agente, NÃO envia na hora: vai para a fila de aprovação e só chega ao cliente quando um administrador aprova (o pedido vence em 4 h). Nunca diga que foi enviada; diga que aguarda aprovação.

Permissão

messages:write

Operação

messages.send

As que pedem aprovação não executam na hora: viram um pedido em Para revisar e na aba Aprovações de IA.

Parâmetros

conversationIdstringobrigatório

O cliente é o da conversa.

contentstringobrigatório

Texto (até 4096 caracteres). Pode ficar vazio quando vai uma mídia.

isInternalbooleanopcional

Nota interna: não sai para o cliente.

metadataobjectopcional

Mídia já enviada ao storage (url pública).

metadata.mediaTypestringobrigatório

imageaudiovideodocument

metadata.urlstring (uri)obrigatório

metadata.mimetypestringopcional

metadata.fileNamestringopcional

metadata.keystringopcional

Chave do arquivo no storage.