WhatsApp

create_whatsapp_template

Escrita

Cria um modelo de WhatsApp (ainda não vai para a Meta). Depois mande para aprovação com submit_whatsapp_template; a Meta costuma responder em minutos. Para oferta e novidade use MARKETING; para aviso de pedido, lembrete e cobrança, UTILITY.

Permissão

whatsapp:manage

Operação

whatsapp.templates.create

Parâmetros

kindstringobrigatório

send_api: modelos do envio direto (send_whatsapp_message, pelo nome aprovado). campaign: modelos das campanhas de WhatsApp.send_apicampaign

namestringobrigatório

bodystringobrigatório

Texto da mensagem. Variáveis com nome, como {{contact.firstName}} e {{organization.name}}; o Cognizy converte para o formato da Meta.

headerobjectopcional

Cabeçalho: texto curto ou imagem (https).

footerstringopcional

buttonsobject[]opcional

categorystringopcional

MARKETING (oferta, novidade), UTILITY (pedido, lembrete, aviso) ou AUTHENTICATION (código).MARKETINGUTILITYAUTHENTICATION

languagestringopcional

Padrão pt_BR.

get_whatsapp_instance

Leitura

Um número de WhatsApp em detalhe: conexão, saúde dos envios (HEALTHY, DEGRADED, SUSPECT), qualidade e faixa de envio da Meta (oficial), avisos de pagamento/registro, aquecimento (dia e limite de hoje), limite diário do plano, quem responde (modo da IA, agente) e o departamento padrão.

Permissão

whatsapp:read

Operação

whatsapp.instances.get

Parâmetros

instanceIdstringobrigatório

get_whatsapp_message

Leitura

Situação de uma mensagem enviada por send_whatsapp_message (na fila, enviada, entregue, lida ou falhou).

Permissão

whatsapp:send

Operação

whatsapp.messages.get

Parâmetros

messageIdstringobrigatório

get_whatsapp_template

Leitura

Um modelo de WhatsApp completo: texto, cabeçalho, rodapé, botões e a situação na Meta.

Permissão

whatsapp:read

Operação

whatsapp.templates.get

Parâmetros

kindstringobrigatório

send_api: modelos do envio direto (send_whatsapp_message, pelo nome aprovado). campaign: modelos das campanhas de WhatsApp.send_apicampaign

templateIdstringobrigatório

list_whatsapp_instances

Leitura

Números de WhatsApp da empresa: id, nome, telefone, canal (oficial ou não) e se está conectado. Use antes de send_whatsapp_message para escolher o instanceId.

Permissão

whatsapp:read

Operação

whatsapp.instances.list

Parâmetros

Sem parâmetros.

list_whatsapp_templates

Leitura

Modelos de WhatsApp com a situação na Meta (NONE não enviado, PENDING em análise, APPROVED, REJECTED, DISABLED). Fora da janela de 24 h, o número oficial só fala por modelo aprovado: send_whatsapp_message usa o metaName. refresh: true confere antes a situação na Meta.

Permissão

whatsapp:read

Operação

whatsapp.templates.list

Parâmetros

kindstringopcional

send_api: modelos do envio direto (send_whatsapp_message, pelo nome aprovado). campaign: modelos das campanhas de WhatsApp.send_apicampaign

statusstringopcional

NONEPENDINGAPPROVEDREJECTEDDISABLED

refreshbooleanopcional

send_whatsapp_message

Escrita

Envia uma mensagem de WhatsApp direto por um número conectado — texto, mídia ou modelo aprovado —, SEM aprovação e SEM criar conversa na caixa de entrada. A entrega é assíncrona: acompanhe com get_whatsapp_message. No canal oficial, texto e mídia livres só dentro da janela de 24 h; fora dela, use modelo. Para responder um cliente numa conversa, prefira send_message_to_contact.

Permissão

whatsapp:send

Operação

whatsapp.messages.send

Parâmetros

tostringobrigatório

Telefone no formato +5511999999999.

typestringopcional

TEXTMEDIATEMPLATE

textstringopcional

mediaobjectopcional

media.urlstring (uri)obrigatório

media.typestringobrigatório

imagevideodocumentaudio

media.captionstringopcional

templateobjectopcional

template.namestringobrigatório

template.languagestringopcional

template.variablesstring[]opcional

instanceIdstringopcional

Número que envia (de list_whatsapp_instances).

idempotencyKeystringopcional

Repetir com a mesma chave não envia de novo.

channelstringopcional

CLOUD_APIEVOLUTION

submit_whatsapp_template

Escrita

Manda um modelo para aprovação da Meta pela conta (WABA) de um número oficial conectado. Reprovado volta com nome novo. Acompanhe com list_whatsapp_templates refresh: true.

Permissão

whatsapp:manage

Operação

whatsapp.templates.submit

Parâmetros

kindstringobrigatório

send_api: modelos do envio direto (send_whatsapp_message, pelo nome aprovado). campaign: modelos das campanhas de WhatsApp.send_apicampaign

templateIdstringobrigatório

instanceIdstringobrigatório

Número oficial (CLOUD_API) conectado da conta que vai usar o modelo.

update_whatsapp_instance

Escrita

Ajusta um número: nome, quem responde (aiMode: internal = IA do Cognizy, approval = IA com aprovação, external = sua própria IA pela API, off = só equipe; null herda da empresa), agente de IA do número, departamento padrão (applyToExisting leva as conversas atuais), receber mensagens (false = só envia; o que chegar é descartado) e aquecimento. Confirme com a pessoa antes de desligar a IA ou o recebimento.

Permissão

whatsapp:manage

Operação

whatsapp.instances.update

Parâmetros

instanceIdstringobrigatório

namestringopcional

aiModestringopcional

agentIdstringopcional

defaultDepartmentIdstringopcional

applyToExistingbooleanopcional

Com agentId/defaultDepartmentId: vale também para as conversas abertas.

receiveInboundbooleanopcional

warmupbooleanopcional

Só números não oficiais.

update_whatsapp_template

Escrita

Edita um modelo de WhatsApp. Modelo de campanha já registrado na Meta volta a precisar de aprovação (ganha um nome novo). Modelo da API de envio em análise ou aprovado não muda: crie outro.

Permissão

whatsapp:manage

Operação

whatsapp.templates.update

Parâmetros

kindstringobrigatório

send_api: modelos do envio direto (send_whatsapp_message, pelo nome aprovado). campaign: modelos das campanhas de WhatsApp.send_apicampaign

templateIdstringobrigatório

namestringopcional

bodystringopcional

Texto da mensagem. Variáveis com nome, como {{contact.firstName}} e {{organization.name}}; o Cognizy converte para o formato da Meta.

headerobjectopcional

Cabeçalho: texto curto ou imagem (https).

footerstringopcional

buttonsobject[]opcional

categorystringopcional

MARKETING (oferta, novidade), UTILITY (pedido, lembrete, aviso) ou AUTHENTICATION (código).MARKETINGUTILITYAUTHENTICATION

languagestringopcional

Padrão pt_BR.