Nesta área
Grupos do WhatsApp
14 ferramentas
act_on_group_opportunity
Escrita
Transforma uma oportunidade dos grupos em tarefa, negócio no funil ou contato (com título, quadro/coluna, responsável e valor opcionais).
- Permissão
whatsapp-groups:write- Operação
whatsapp_groups.opportunities.act
Parâmetros
opportunityIdstringobrigatórioactionstringobrigatórioTASKDEALCONTACTtitlestringopcionalboardIdstringopcionalcolumnIdstringopcionalassigneeIdstringopcionalvaluenumberopcional
| Campo | Tipo | Descrição |
|---|---|---|
opportunityIdobrigatório | string | |
actionobrigatório | string | TASKDEALCONTACT |
titleopcional | string | |
boardIdopcional | string | |
columnIdopcional | string | |
assigneeIdopcional | string | |
valueopcional | number |
cancel_group_campaign
Escrita
Cancela uma publicação aprovada, agendada, enviando ou pausada: o que ainda não saiu não sai mais. Só gestor (OWNER/ADMIN).
- Permissão
whatsapp-groups:write- Operação
whatsapp_groups.campaigns.cancel
Parâmetros
campaignIdstringobrigatório
| Campo | Tipo | Descrição |
|---|---|---|
campaignIdobrigatório | string |
create_group_campaign
Escrita
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.
- Permissão
whatsapp-groups:write- Operação
whatsapp_groups.campaigns.create
Parâmetros
namestringobrigatóriocontentobjectobrigatório- O que sai. Variáveis: {membros} (quantos no grupo), {grupo} (nome). Enquete não sai em canal nem em grupo da Meta.
content.textstringopcionalcontent.mediaUrlstringopcional- Foto, vídeo, documento ou áudio (https).
content.mediaTypestringopcionalimagevideodocumentaudiocontent.fileNamestringopcionalcontent.pttbooleanopcional- Áudio como mensagem de voz.
content.pollobjectopcionalcontent.mentionAllbooleanopcional- Menciona todo mundo do grupo.
content.sequenceobject[]opcional- Mensagens seguintes, cada uma com a espera depois da anterior.
selectorobjectobrigatório- Para onde vai: os filtros se somam (E). Comece por list_whatsapp_groups.
selector.groupIdsstring[]opcionalselector.collectionIdsstring[]opcionalselector.purposesstring[]opcionalselector.kindsstring[]opcionalselector.departmentIdsstring[]opcionalselector.offersOnlybooleanopcional- Só grupos que aceitam ofertas.
sendAtstringopcional- Quando sai depois de aprovada (sem fuso = Brasília). Sem: sai quando aprovarem.
| Campo | Tipo | Descrição |
|---|---|---|
nameobrigatório | string | |
contentobrigatório | object | O que sai. Variáveis: {membros} (quantos no grupo), {grupo} (nome). Enquete não sai em canal nem em grupo da Meta. |
content.textopcional | string | |
content.mediaUrlopcional | string | Foto, vídeo, documento ou áudio (https). |
content.mediaTypeopcional | string | imagevideodocumentaudio |
content.fileNameopcional | string | |
content.pttopcional | boolean | Áudio como mensagem de voz. |
content.pollopcional | object | |
content.mentionAllopcional | boolean | Menciona todo mundo do grupo. |
content.sequenceopcional | object[] | Mensagens seguintes, cada uma com a espera depois da anterior. |
selectorobrigatório | object | Para onde vai: os filtros se somam (E). Comece por list_whatsapp_groups. |
selector.groupIdsopcional | string[] | |
selector.collectionIdsopcional | string[] | |
selector.purposesopcional | string[] | |
selector.kindsopcional | string[] | |
selector.departmentIdsopcional | string[] | |
selector.offersOnlyopcional | boolean | Só grupos que aceitam ofertas. |
sendAtopcional | string | Quando sai depois de aprovada (sem fuso = Brasília). Sem: sai quando aprovarem. |
dismiss_group_opportunity
Escrita
Descarta uma oportunidade dos grupos que não vale a pena.
- Permissão
whatsapp-groups:write- Operação
whatsapp_groups.opportunities.dismiss
Parâmetros
opportunityIdstringobrigatório
| Campo | Tipo | Descrição |
|---|---|---|
opportunityIdobrigatório | string |
get_group_campaign
Leitura
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.
- Permissão
whatsapp-groups:read- Operação
whatsapp_groups.campaigns.get
Parâmetros
campaignIdstringobrigatório
| Campo | Tipo | Descrição |
|---|---|---|
campaignIdobrigatório | string |
get_whatsapp_group
Leitura
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).
- Permissão
whatsapp-groups:read- Operação
whatsapp_groups.get
Parâmetros
groupIdstringobrigatóriodaysnumberopcional
| Campo | Tipo | Descrição |
|---|---|---|
groupIdobrigatório | string | |
daysopcional | number |
get_whatsapp_groups_day
Leitura
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.
- Permissão
whatsapp-groups:read- Operação
whatsapp_groups.day
Parâmetros
datestringopcional- AAAA-MM-DD; sem = hoje.
groupIdstringopcional
| Campo | Tipo | Descrição |
|---|---|---|
dateopcional | string | AAAA-MM-DD; sem = hoje. |
groupIdopcional | string |
get_whatsapp_groups_overview
Leitura
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.
- Permissão
whatsapp-groups:read- Operação
whatsapp_groups.overview
Parâmetros
daysnumberopcional- 7, 30 ou 90 (padrão 30).
| Campo | Tipo | Descrição |
|---|---|---|
daysopcional | number | 7, 30 ou 90 (padrão 30). |
list_group_campaigns
Leitura
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.
- Permissão
whatsapp-groups:read- Operação
whatsapp_groups.campaigns.list
Parâmetros
statusstringopcionalDRAFTPENDING_APPROVALAPPROVEDSCHEDULEDRUNNINGPAUSEDCOMPLETEDCANCELLEDFAILED
| Campo | Tipo | Descrição |
|---|---|---|
statusopcional | string | DRAFTPENDING_APPROVALAPPROVEDSCHEDULEDRUNNINGPAUSEDCOMPLETEDCANCELLEDFAILED |
list_group_members
Leitura
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.
- Permissão
whatsapp-groups:read- Operação
whatsapp_groups.members.list
Parâmetros
groupIdstringopcionalsearchstringopcionalstatusstringopcionalACTIVELEFTALLrolestringopcionalADMINMEMBERlinkstringopcionalCONTACTUSERNONEactivitystringopcionalACTIVEINACTIVEpageintegeropcionalpageSizeintegeropcional
| Campo | Tipo | Descrição |
|---|---|---|
groupIdopcional | string | |
searchopcional | string | |
statusopcional | string | ACTIVELEFTALL |
roleopcional | string | ADMINMEMBER |
linkopcional | string | CONTACTUSERNONE |
activityopcional | string | ACTIVEINACTIVE |
pageopcional | integer | |
pageSizeopcional | integer |
list_group_opportunities
Leitura
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.
- Permissão
whatsapp-groups:read- Operação
whatsapp_groups.opportunities.list
Parâmetros
statusstringopcionalOPENPENDINGAPPROVEDDISMISSEDEXECUTEDtypestringopcionalSALELEADSUPPORTQUESTIONOTHERgroupIdstringopcionalcursorstringopcionallimitintegeropcional
| Campo | Tipo | Descrição |
|---|---|---|
statusopcional | string | OPENPENDINGAPPROVEDDISMISSEDEXECUTED |
typeopcional | string | SALELEADSUPPORTQUESTIONOTHER |
groupIdopcional | string | |
cursoropcional | string | |
limitopcional | integer |
list_whatsapp_groups
Leitura
Grupos, comunidades e canais conectados: nome, tipo, finalidade (VIP, comunidade, suporte, turma, ofertas, interno), modo da IA, departamento, número e quantos membros.
- Permissão
whatsapp-groups:read- Operação
whatsapp_groups.list
Parâmetros
statusstringopcionalACTIVEPAUSEDARCHIVEDDISCONNECTEDpurposestringopcionalINTERNALCOMMUNITYVIPSUPPORTCLASSOFFERSdepartmentIdstringopcional
| Campo | Tipo | Descrição |
|---|---|---|
statusopcional | string | ACTIVEPAUSEDARCHIVEDDISCONNECTED |
purposeopcional | string | INTERNALCOMMUNITYVIPSUPPORTCLASSOFFERS |
departmentIdopcional | string |
pause_group_campaign
Escrita
Pausa uma publicação agendada ou enviando (o que não saiu espera). Retomar fica na tela. Só gestor (OWNER/ADMIN).
- Permissão
whatsapp-groups:write- Operação
whatsapp_groups.campaigns.pause
Parâmetros
campaignIdstringobrigatório
| Campo | Tipo | Descrição |
|---|---|---|
campaignIdobrigatório | string |
update_group_campaign
Escrita
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.
- Permissão
whatsapp-groups:write- Operação
whatsapp_groups.campaigns.update
Parâmetros
campaignIdstringobrigatórionamestringopcionalcontentobjectopcional- O que sai. Variáveis: {membros} (quantos no grupo), {grupo} (nome). Enquete não sai em canal nem em grupo da Meta.
content.textstringopcionalcontent.mediaUrlstringopcional- Foto, vídeo, documento ou áudio (https).
content.mediaTypestringopcionalimagevideodocumentaudiocontent.fileNamestringopcionalcontent.pttbooleanopcional- Áudio como mensagem de voz.
content.pollobjectopcionalcontent.mentionAllbooleanopcional- Menciona todo mundo do grupo.
content.sequenceobject[]opcional- Mensagens seguintes, cada uma com a espera depois da anterior.
selectorobjectopcional- Para onde vai: os filtros se somam (E). Comece por list_whatsapp_groups.
selector.groupIdsstring[]opcionalselector.collectionIdsstring[]opcionalselector.purposesstring[]opcionalselector.kindsstring[]opcionalselector.departmentIdsstring[]opcionalselector.offersOnlybooleanopcional- Só grupos que aceitam ofertas.
sendAtstringopcional- Quando sai depois de aprovada (sem fuso = Brasília). Sem: sai quando aprovarem.
| Campo | Tipo | Descrição |
|---|---|---|
campaignIdobrigatório | string | |
nameopcional | string | |
contentopcional | object | O que sai. Variáveis: {membros} (quantos no grupo), {grupo} (nome). Enquete não sai em canal nem em grupo da Meta. |
content.textopcional | string | |
content.mediaUrlopcional | string | Foto, vídeo, documento ou áudio (https). |
content.mediaTypeopcional | string | imagevideodocumentaudio |
content.fileNameopcional | string | |
content.pttopcional | boolean | Áudio como mensagem de voz. |
content.pollopcional | object | |
content.mentionAllopcional | boolean | Menciona todo mundo do grupo. |
content.sequenceopcional | object[] | Mensagens seguintes, cada uma com a espera depois da anterior. |
selectoropcional | object | Para onde vai: os filtros se somam (E). Comece por list_whatsapp_groups. |
selector.groupIdsopcional | string[] | |
selector.collectionIdsopcional | string[] | |
selector.purposesopcional | string[] | |
selector.kindsopcional | string[] | |
selector.departmentIdsopcional | string[] | |
selector.offersOnlyopcional | boolean | Só grupos que aceitam ofertas. |
sendAtopcional | string | Quando sai depois de aprovada (sem fuso = Brasília). Sem: sai quando aprovarem. |