In this area
WhatsApp groups
14 tools
act_on_group_opportunity
Write
Transforma uma oportunidade dos grupos em tarefa, negócio no funil ou contato (com título, quadro/coluna, responsável e valor opcionais).
- Permission
whatsapp-groups:write- Operation
whatsapp_groups.opportunities.act
Parameters
opportunityIdstringrequiredactionstringrequiredTASKDEALCONTACTtitlestringoptionalboardIdstringoptionalcolumnIdstringoptionalassigneeIdstringoptionalvaluenumberoptional
| Field | Type | Description |
|---|---|---|
opportunityIdrequired | string | |
actionrequired | string | TASKDEALCONTACT |
titleoptional | string | |
boardIdoptional | string | |
columnIdoptional | string | |
assigneeIdoptional | string | |
valueoptional | number |
cancel_group_campaign
Write
Cancela uma publicação aprovada, agendada, enviando ou pausada: o que ainda não saiu não sai mais. Só gestor (OWNER/ADMIN).
- Permission
whatsapp-groups:write- Operation
whatsapp_groups.campaigns.cancel
Parameters
campaignIdstringrequired
| Field | Type | Description |
|---|---|---|
campaignIdrequired | string |
create_group_campaign
Write
Escreve uma publicação para grupos e canais (texto, mídia, enquete, menção a todos e mensagens em sequência) e manda para a caixa de Aprovações da tela. Nada sai antes de alguém aprovar lá. Com sendAt, sai na hora marcada depois de aprovada.
- Permission
whatsapp-groups:write- Operation
whatsapp_groups.campaigns.create
Parameters
namestringrequiredcontentobjectrequired- O que sai. Variáveis: {membros} (quantos no grupo), {grupo} (nome). Enquete não sai em canal nem em grupo da Meta.
content.textstringoptionalcontent.mediaUrlstringoptional- Foto, vídeo, documento ou áudio (https).
content.mediaTypestringoptionalimagevideodocumentaudiocontent.fileNamestringoptionalcontent.pttbooleanoptional- Áudio como mensagem de voz.
content.pollobjectoptionalcontent.mentionAllbooleanoptional- Menciona todo mundo do grupo.
content.sequenceobject[]optional- Mensagens seguintes, cada uma com a espera depois da anterior.
selectorobjectrequired- Para onde vai: os filtros se somam (E). Comece por list_whatsapp_groups.
selector.groupIdsstring[]optionalselector.collectionIdsstring[]optionalselector.purposesstring[]optionalselector.kindsstring[]optionalselector.departmentIdsstring[]optionalselector.offersOnlybooleanoptional- Só grupos que aceitam ofertas.
sendAtstringoptional- Quando sai depois de aprovada (sem fuso = Brasília). Sem: sai quando aprovarem.
| Field | Type | Description |
|---|---|---|
namerequired | string | |
contentrequired | object | O que sai. Variáveis: {membros} (quantos no grupo), {grupo} (nome). Enquete não sai em canal nem em grupo da Meta. |
content.textoptional | string | |
content.mediaUrloptional | string | Foto, vídeo, documento ou áudio (https). |
content.mediaTypeoptional | string | imagevideodocumentaudio |
content.fileNameoptional | string | |
content.pttoptional | boolean | Áudio como mensagem de voz. |
content.polloptional | object | |
content.mentionAlloptional | boolean | Menciona todo mundo do grupo. |
content.sequenceoptional | object[] | Mensagens seguintes, cada uma com a espera depois da anterior. |
selectorrequired | object | Para onde vai: os filtros se somam (E). Comece por list_whatsapp_groups. |
selector.groupIdsoptional | string[] | |
selector.collectionIdsoptional | string[] | |
selector.purposesoptional | string[] | |
selector.kindsoptional | string[] | |
selector.departmentIdsoptional | string[] | |
selector.offersOnlyoptional | boolean | Só grupos que aceitam ofertas. |
sendAtoptional | string | Quando sai depois de aprovada (sem fuso = Brasília). Sem: sai quando aprovarem. |
dismiss_group_opportunity
Write
Descarta uma oportunidade dos grupos que não vale a pena.
- Permission
whatsapp-groups:write- Operation
whatsapp_groups.opportunities.dismiss
Parameters
opportunityIdstringrequired
| Field | Type | Description |
|---|---|---|
opportunityIdrequired | string |
get_group_campaign
Read
Uma publicação em grupo: conteúdo atual, destinos, entrega por grupo (enviada, falhou, pendente), quem escreveu e quem aprovou, e o motivo se voltou para rascunho.
- Permission
whatsapp-groups:read- Operation
whatsapp_groups.campaigns.get
Parameters
campaignIdstringrequired
| Field | Type | Description |
|---|---|---|
campaignIdrequired | string |
get_whatsapp_group
Read
Um grupo: descrição, finalidade, modo da IA e o painel do período (entradas, saídas, membros ativos, mensagens e horário de pico).
- Permission
whatsapp-groups:read- Operation
whatsapp_groups.get
Parameters
groupIdstringrequireddaysnumberoptional
| Field | Type | Description |
|---|---|---|
groupIdrequired | string | |
daysoptional | number |
get_whatsapp_groups_day
Read
O que aconteceu nos grupos num dia (no fuso da empresa): mensagens, quem falou, perguntas sem resposta e o resumo da IA — de todos os grupos com IA ou de um.
- Permission
whatsapp-groups:read- Operation
whatsapp_groups.day
Parameters
datestringoptional- AAAA-MM-DD; sem = hoje.
groupIdstringoptional
| Field | Type | Description |
|---|---|---|
dateoptional | string | AAAA-MM-DD; sem = hoje. |
groupIdoptional | string |
get_whatsapp_groups_overview
Read
Visão geral dos grupos e canais de WhatsApp: membros, crescimento e saídas no período, atividade e os grupos que precisam de atenção.
- Permission
whatsapp-groups:read- Operation
whatsapp_groups.overview
Parameters
daysnumberoptional- 7, 30 ou 90 (padrão 30).
| Field | Type | Description |
|---|---|---|
daysoptional | number | 7, 30 ou 90 (padrão 30). |
list_group_campaigns
Read
Publicações em grupo (avulsas e regras recorrentes): nome, situação (rascunho, em aprovação, aprovada, agendada, enviando, concluída…), quando sai e quando foi aprovada.
- Permission
whatsapp-groups:read- Operation
whatsapp_groups.campaigns.list
Parameters
statusstringoptionalDRAFTPENDING_APPROVALAPPROVEDSCHEDULEDRUNNINGPAUSEDCOMPLETEDCANCELLEDFAILED
| Field | Type | Description |
|---|---|---|
statusoptional | string | DRAFTPENDING_APPROVALAPPROVEDSCHEDULEDRUNNINGPAUSEDCOMPLETEDCANCELLEDFAILED |
list_group_members
Read
Membros dos grupos (dados pessoais: nome e telefone): busca, só ativos ou que saíram, admins, ligados a contato, ativos ou calados no período.
- Permission
whatsapp-groups:read- Operation
whatsapp_groups.members.list
Parameters
groupIdstringoptionalsearchstringoptionalstatusstringoptionalACTIVELEFTALLrolestringoptionalADMINMEMBERlinkstringoptionalCONTACTUSERNONEactivitystringoptionalACTIVEINACTIVEpageintegeroptionalpageSizeintegeroptional
| Field | Type | Description |
|---|---|---|
groupIdoptional | string | |
searchoptional | string | |
statusoptional | string | ACTIVELEFTALL |
roleoptional | string | ADMINMEMBER |
linkoptional | string | CONTACTUSERNONE |
activityoptional | string | ACTIVEINACTIVE |
pageoptional | integer | |
pageSizeoptional | integer |
list_group_opportunities
Read
Oportunidades achadas nas conversas dos grupos (venda, lead, suporte, pergunta): a mensagem, quem mandou, o grupo e a situação. OPEN = esperando alguém agir.
- Permission
whatsapp-groups:read- Operation
whatsapp_groups.opportunities.list
Parameters
statusstringoptionalOPENPENDINGAPPROVEDDISMISSEDEXECUTEDtypestringoptionalSALELEADSUPPORTQUESTIONOTHERgroupIdstringoptionalcursorstringoptionallimitintegeroptional
| Field | Type | Description |
|---|---|---|
statusoptional | string | OPENPENDINGAPPROVEDDISMISSEDEXECUTED |
typeoptional | string | SALELEADSUPPORTQUESTIONOTHER |
groupIdoptional | string | |
cursoroptional | string | |
limitoptional | integer |
list_whatsapp_groups
Read
Grupos, comunidades e canais conectados: nome, tipo, finalidade (VIP, comunidade, suporte, turma, ofertas, interno), modo da IA, departamento, número e quantos membros.
- Permission
whatsapp-groups:read- Operation
whatsapp_groups.list
Parameters
statusstringoptionalACTIVEPAUSEDARCHIVEDDISCONNECTEDpurposestringoptionalINTERNALCOMMUNITYVIPSUPPORTCLASSOFFERSdepartmentIdstringoptional
| Field | Type | Description |
|---|---|---|
statusoptional | string | ACTIVEPAUSEDARCHIVEDDISCONNECTED |
purposeoptional | string | INTERNALCOMMUNITYVIPSUPPORTCLASSOFFERS |
departmentIdoptional | string |
pause_group_campaign
Write
Pausa uma publicação agendada ou enviando (o que não saiu espera). Retomar fica na tela. Só gestor (OWNER/ADMIN).
- Permission
whatsapp-groups:write- Operation
whatsapp_groups.campaigns.pause
Parameters
campaignIdstringrequired
| Field | Type | Description |
|---|---|---|
campaignIdrequired | string |
update_group_campaign
Write
Ajusta uma publicação ainda não aprovada (rascunho ou em aprovação): nome, conteúdo, destinos ou horário. Volta para a caixa de Aprovações. Aprovada ou agendada só muda na tela.
- Permission
whatsapp-groups:write- Operation
whatsapp_groups.campaigns.update
Parameters
campaignIdstringrequirednamestringoptionalcontentobjectoptional- O que sai. Variáveis: {membros} (quantos no grupo), {grupo} (nome). Enquete não sai em canal nem em grupo da Meta.
content.textstringoptionalcontent.mediaUrlstringoptional- Foto, vídeo, documento ou áudio (https).
content.mediaTypestringoptionalimagevideodocumentaudiocontent.fileNamestringoptionalcontent.pttbooleanoptional- Áudio como mensagem de voz.
content.pollobjectoptionalcontent.mentionAllbooleanoptional- Menciona todo mundo do grupo.
content.sequenceobject[]optional- Mensagens seguintes, cada uma com a espera depois da anterior.
selectorobjectoptional- Para onde vai: os filtros se somam (E). Comece por list_whatsapp_groups.
selector.groupIdsstring[]optionalselector.collectionIdsstring[]optionalselector.purposesstring[]optionalselector.kindsstring[]optionalselector.departmentIdsstring[]optionalselector.offersOnlybooleanoptional- Só grupos que aceitam ofertas.
sendAtstringoptional- Quando sai depois de aprovada (sem fuso = Brasília). Sem: sai quando aprovarem.
| Field | Type | Description |
|---|---|---|
campaignIdrequired | string | |
nameoptional | string | |
contentoptional | object | O que sai. Variáveis: {membros} (quantos no grupo), {grupo} (nome). Enquete não sai em canal nem em grupo da Meta. |
content.textoptional | string | |
content.mediaUrloptional | string | Foto, vídeo, documento ou áudio (https). |
content.mediaTypeoptional | string | imagevideodocumentaudio |
content.fileNameoptional | string | |
content.pttoptional | boolean | Áudio como mensagem de voz. |
content.polloptional | object | |
content.mentionAlloptional | boolean | Menciona todo mundo do grupo. |
content.sequenceoptional | object[] | Mensagens seguintes, cada uma com a espera depois da anterior. |
selectoroptional | object | Para onde vai: os filtros se somam (E). Comece por list_whatsapp_groups. |
selector.groupIdsoptional | string[] | |
selector.collectionIdsoptional | string[] | |
selector.purposesoptional | string[] | |
selector.kindsoptional | string[] | |
selector.departmentIdsoptional | string[] | |
selector.offersOnlyoptional | boolean | Só grupos que aceitam ofertas. |
sendAtoptional | string | Quando sai depois de aprovada (sem fuso = Brasília). Sem: sai quando aprovarem. |