WhatsApp

create_whatsapp_template

Write

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.

Permission

whatsapp:manage

Operation

whatsapp.templates.create

Parameters

kindstringrequired

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

namestringrequired

bodystringrequired

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

headerobjectoptional

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

footerstringoptional

buttonsobject[]optional

categorystringoptional

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

languagestringoptional

Padrão pt_BR.

get_whatsapp_instance

Read

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.

Permission

whatsapp:read

Operation

whatsapp.instances.get

Parameters

instanceIdstringrequired

get_whatsapp_message

Read

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

Permission

whatsapp:send

Operation

whatsapp.messages.get

Parameters

messageIdstringrequired

get_whatsapp_template

Read

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

Permission

whatsapp:read

Operation

whatsapp.templates.get

Parameters

kindstringrequired

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

templateIdstringrequired

list_whatsapp_instances

Read

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.

Permission

whatsapp:read

Operation

whatsapp.instances.list

Parameters

No parameters.

list_whatsapp_templates

Read

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.

Permission

whatsapp:read

Operation

whatsapp.templates.list

Parameters

kindstringoptional

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

statusstringoptional

NONEPENDINGAPPROVEDREJECTEDDISABLED

refreshbooleanoptional

send_whatsapp_message

Write

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.

Permission

whatsapp:send

Operation

whatsapp.messages.send

Parameters

tostringrequired

Telefone no formato +5511999999999.

typestringoptional

TEXTMEDIATEMPLATE

textstringoptional

mediaobjectoptional

media.urlstring (uri)required

media.typestringrequired

imagevideodocumentaudio

media.captionstringoptional

templateobjectoptional

template.namestringrequired

template.languagestringoptional

template.variablesstring[]optional

instanceIdstringoptional

Número que envia (de list_whatsapp_instances).

idempotencyKeystringoptional

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

channelstringoptional

CLOUD_APIEVOLUTION

submit_whatsapp_template

Write

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.

Permission

whatsapp:manage

Operation

whatsapp.templates.submit

Parameters

kindstringrequired

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

templateIdstringrequired

instanceIdstringrequired

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

update_whatsapp_instance

Write

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.

Permission

whatsapp:manage

Operation

whatsapp.instances.update

Parameters

instanceIdstringrequired

namestringoptional

aiModestringoptional

agentIdstringoptional

defaultDepartmentIdstringoptional

applyToExistingbooleanoptional

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

receiveInboundbooleanoptional

warmupbooleanoptional

Só números não oficiais.

update_whatsapp_template

Write

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.

Permission

whatsapp:manage

Operation

whatsapp.templates.update

Parameters

kindstringrequired

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

templateIdstringrequired

namestringoptional

bodystringoptional

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

headerobjectoptional

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

footerstringoptional

buttonsobject[]optional

categorystringoptional

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

languagestringoptional

Padrão pt_BR.