n8n-nodes-digisac 1.0.0 → 1.0.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +295 -75
- package/docs/api-calls.md +632 -0
- package/package.json +4 -2
package/README.md
CHANGED
|
@@ -2,63 +2,114 @@
|
|
|
2
2
|
|
|
3
3
|
[](https://github.com/PedroHSGuimaraes/n8n-nodes-digisac/actions/workflows/ci.yml)
|
|
4
4
|
|
|
5
|
-
|
|
5
|
+
Node community do [n8n](https://n8n.io/) para integrar workflows com a **API da Digisac**. O pacote expõe em um único node todas as chamadas publicadas na documentação Postman da Digisac: contatos, chamados, mensagens, campanhas, conexões, departamentos, usuários, tags, templates, webhooks, relatórios, estatísticas, agendamentos e demais recursos operacionais.
|
|
6
6
|
|
|
7
|
-
|
|
7
|
+
O projeto segue o mesmo padrão usado no `n8n-nodes-clinicorp`: um node de ação, uma credencial, TypeScript, catálogo gerado a partir da documentação da API, build validado por CI, publicação no npm via GitHub Actions e suporte a uso como Tool de Agente de IA.
|
|
8
8
|
|
|
9
|
-
##
|
|
9
|
+
## Funcionalidades
|
|
10
10
|
|
|
11
|
-
- **
|
|
12
|
-
- **
|
|
13
|
-
- **
|
|
14
|
-
- **AI Agent
|
|
15
|
-
- **
|
|
16
|
-
- **
|
|
11
|
+
- **Cobertura completa da documentação**: 298 chamadas da coleção pública Postman da Digisac, organizadas em 51 recursos no n8n.
|
|
12
|
+
- **Node único e intuitivo**: selecione **Resource -> Operation**, preencha os parâmetros obrigatórios e execute.
|
|
13
|
+
- **Credencial centralizada**: Base URL e Bearer Token ficam salvos uma única vez na credencial `Digisac API`.
|
|
14
|
+
- **Pronto para AI Agent**: o node tem `usableAsTool: true` e descrições pensadas para LLMs entenderem método, caminho, parâmetros, IDs, filtros e body JSON.
|
|
15
|
+
- **Sem dependências runtime**: usa `httpRequestWithAuthentication` do próprio n8n.
|
|
16
|
+
- **Catálogo rastreável**: `nodes/Digisac/generated/endpoints.ts` é gerado da documentação Postman; `docs/api-calls.md` lista todas as chamadas em português.
|
|
17
|
+
- **Publicação segura**: GitHub Actions publica no npm com provenance.
|
|
17
18
|
|
|
18
|
-
##
|
|
19
|
+
## Instalação
|
|
19
20
|
|
|
20
|
-
|
|
21
|
+
No n8n, acesse **Settings -> Community Nodes -> Install** e instale:
|
|
21
22
|
|
|
22
23
|
```text
|
|
23
24
|
n8n-nodes-digisac
|
|
24
25
|
```
|
|
25
26
|
|
|
26
|
-
|
|
27
|
+
Para usar community nodes como Tools de Agente de IA em n8n self-hosted, habilite:
|
|
27
28
|
|
|
28
29
|
```bash
|
|
29
30
|
N8N_COMMUNITY_PACKAGES_ALLOW_TOOL_USAGE=true
|
|
30
31
|
```
|
|
31
32
|
|
|
32
|
-
|
|
33
|
+
Sem essa variável, o node pode funcionar como node normal, mas não aparecer como tool no AI Agent em instalações self-hosted.
|
|
33
34
|
|
|
34
|
-
|
|
35
|
+
## Credenciais
|
|
35
36
|
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
|
39
|
-
|
|
|
40
|
-
|
|
|
37
|
+
Crie uma credencial chamada **Digisac API**.
|
|
38
|
+
|
|
39
|
+
| Campo | O que preencher | Onde encontrar |
|
|
40
|
+
| --- | --- | --- |
|
|
41
|
+
| **Base URL** | URL base da sua conta Digisac, sem barra final. Exemplo: `https://suaempresa.digisac.app`. | Digisac -> Conta -> Informações |
|
|
42
|
+
| **Access Token** | Token Bearer de acesso pessoal. | Digisac -> Conta -> API -> Tokens de acesso pessoal |
|
|
43
|
+
| **PDF/Base URL** | Base opcional para endpoints documentados como `URLbase`, principalmente export de PDF. Se vazio, o node reutiliza a Base URL. | Use só se sua instância separar URL de API e URL de PDF |
|
|
41
44
|
|
|
42
|
-
|
|
45
|
+
A credencial testa o acesso com:
|
|
43
46
|
|
|
44
47
|
```http
|
|
45
48
|
GET /api/v1/me
|
|
46
49
|
```
|
|
47
50
|
|
|
48
|
-
##
|
|
51
|
+
## Como usar o node
|
|
52
|
+
|
|
53
|
+
1. Adicione o node **Digisac** no workflow.
|
|
54
|
+
2. Escolha o **Resource**. O resource corresponde a uma pasta da documentação, como `Contatos`, `Mensagens`, `Chamados`, `Campanhas`, `Tags`, `Usuários`, `Webhooks`.
|
|
55
|
+
3. Escolha a **Operation**. Cada operation corresponde a uma chamada real da API.
|
|
56
|
+
4. Preencha os campos obrigatórios de path, como `contactId`, `ticketId`, `serviceId`, `messageId`, `userId`, `campaignId`.
|
|
57
|
+
5. Use **Additional Query Parameters JSON** para filtros, paginação e queries complexas.
|
|
58
|
+
6. Use **Request Body JSON** para chamadas `POST`, `PUT` e `PATCH`.
|
|
59
|
+
7. Em exports CSV/TXT/PDF, se a resposta não vier como JSON, use **Options -> Response Format -> Text**.
|
|
60
|
+
|
|
61
|
+
## Campos principais do node
|
|
62
|
+
|
|
63
|
+
| Campo | Uso |
|
|
64
|
+
| --- | --- |
|
|
65
|
+
| **Resource** | Área funcional da API Digisac, gerada a partir das pastas Postman. |
|
|
66
|
+
| **Operation** | Chamada exata da API. A descrição mostra método, endpoint, origem na documentação e placeholders. |
|
|
67
|
+
| **Path Parameters** | Campos obrigatórios extraídos de placeholders como `{{contactId}}`. |
|
|
68
|
+
| **Query: ...** | Campos opcionais extraídos de placeholders de query, como `serviceId`, `departmentId`, `from`, `to`. |
|
|
69
|
+
| **Additional Query Parameters JSON** | Objeto JSON livre mesclado na query string. Use para `perPage`, `query`, `where[...]`, filtros e includes. |
|
|
70
|
+
| **Request Body JSON** | Body enviado para operações de escrita. Aceita objeto ou array JSON. |
|
|
71
|
+
| **Options** | Controla inclusão da query documentada, formato de resposta e comportamento de placeholders não preenchidos. |
|
|
72
|
+
|
|
73
|
+
## Exemplos práticos
|
|
74
|
+
|
|
75
|
+
### Listar contatos
|
|
76
|
+
|
|
77
|
+
Resource: **Contatos (General)**
|
|
78
|
+
Operation: **Listar todos os contatos**
|
|
79
|
+
|
|
80
|
+
```json
|
|
81
|
+
{
|
|
82
|
+
"perPage": 40
|
|
83
|
+
}
|
|
84
|
+
```
|
|
85
|
+
|
|
86
|
+
### Buscar contato por número em uma conexão
|
|
87
|
+
|
|
88
|
+
Resource: **Contatos (General)**
|
|
89
|
+
Operation: **Buscar contato por numero de uma conexao especifica**
|
|
90
|
+
|
|
91
|
+
Preencha:
|
|
92
|
+
|
|
93
|
+
- `Query: Number`: número ou parte do número
|
|
94
|
+
- `Query: Service Id`: ID da conexão
|
|
95
|
+
|
|
96
|
+
Também é possível passar manualmente:
|
|
97
|
+
|
|
98
|
+
```json
|
|
99
|
+
{
|
|
100
|
+
"where[data.number][$iLike]": "%5511999999999%",
|
|
101
|
+
"where[serviceId]": "SERVICE_ID"
|
|
102
|
+
}
|
|
103
|
+
```
|
|
49
104
|
|
|
50
|
-
|
|
51
|
-
2. Select a **Resource**. Resources are generated from the Postman folders, for example Contacts, Tickets, Messages, Campaigns, Services, Departments, Users, Tags, Webhooks and Reports.
|
|
52
|
-
3. Select an **Operation**. Each operation maps to one documented API request.
|
|
53
|
-
4. Fill required path parameters such as `contactId`, `ticketId`, `serviceId`, `userId`, or `messageId`.
|
|
54
|
-
5. Add optional **Additional Query Parameters JSON** for filters, pagination, and complex Digisac `query` objects.
|
|
55
|
-
6. Add **Request Body JSON** for POST, PUT, and PATCH operations.
|
|
105
|
+
### Enviar mensagem
|
|
56
106
|
|
|
57
|
-
|
|
107
|
+
Resource: **Mensagens (General)**
|
|
108
|
+
Operation: **Enviar mensagem**
|
|
58
109
|
|
|
59
110
|
```json
|
|
60
111
|
{
|
|
61
|
-
"text": "
|
|
112
|
+
"text": "Olá, tudo bem?",
|
|
62
113
|
"type": "chat",
|
|
63
114
|
"contactId": "CONTACT_ID",
|
|
64
115
|
"userId": "USER_ID",
|
|
@@ -66,7 +117,30 @@ Example body for sending a message:
|
|
|
66
117
|
}
|
|
67
118
|
```
|
|
68
119
|
|
|
69
|
-
|
|
120
|
+
### Enviar arquivo por mensagem
|
|
121
|
+
|
|
122
|
+
Resource: **Mensagens (General)**
|
|
123
|
+
Operation: **Enviar imagem**, **Enviar PDF** ou **Enviar áudio**
|
|
124
|
+
|
|
125
|
+
Exemplo de body:
|
|
126
|
+
|
|
127
|
+
```json
|
|
128
|
+
{
|
|
129
|
+
"type": "file",
|
|
130
|
+
"contactId": "CONTACT_ID",
|
|
131
|
+
"serviceId": "SERVICE_ID",
|
|
132
|
+
"file": {
|
|
133
|
+
"base64": "BASE64_DO_ARQUIVO",
|
|
134
|
+
"mimetype": "application/pdf",
|
|
135
|
+
"name": "documento.pdf"
|
|
136
|
+
}
|
|
137
|
+
}
|
|
138
|
+
```
|
|
139
|
+
|
|
140
|
+
### Buscar chamados de um contato
|
|
141
|
+
|
|
142
|
+
Resource: **Chamados (General)**
|
|
143
|
+
Operation: **Buscar chamados do contato**
|
|
70
144
|
|
|
71
145
|
```json
|
|
72
146
|
{
|
|
@@ -75,72 +149,197 @@ Example query JSON for a contact-specific ticket lookup:
|
|
|
75
149
|
}
|
|
76
150
|
```
|
|
77
151
|
|
|
78
|
-
|
|
152
|
+
### Transferir chamado
|
|
153
|
+
|
|
154
|
+
Resource: **Chamados (General)**
|
|
155
|
+
Operation: **Transferência de chamado**
|
|
156
|
+
|
|
157
|
+
Path:
|
|
158
|
+
|
|
159
|
+
- `Contact Id`: ID do contato
|
|
160
|
+
|
|
161
|
+
Body:
|
|
79
162
|
|
|
80
163
|
```json
|
|
81
164
|
{
|
|
82
|
-
"
|
|
83
|
-
|
|
84
|
-
|
|
85
|
-
},
|
|
86
|
-
"perPage": 50
|
|
87
|
-
}
|
|
165
|
+
"departmentId": "DEPARTMENT_ID",
|
|
166
|
+
"userId": "USER_ID",
|
|
167
|
+
"comments": "Transferido pelo fluxo do n8n"
|
|
88
168
|
}
|
|
89
169
|
```
|
|
90
170
|
|
|
91
|
-
|
|
92
|
-
|
|
93
|
-
The node can be connected to n8n's **AI Agent** as a tool. Use one Digisac tool per allowed operation when possible. This limits the model's action surface and improves parameter quality.
|
|
171
|
+
### Fechar chamado com assunto
|
|
94
172
|
|
|
95
|
-
|
|
173
|
+
Resource: **Chamados (General)**
|
|
174
|
+
Operation: **Fechar um chamado com assunto**
|
|
96
175
|
|
|
97
|
-
```
|
|
98
|
-
|
|
99
|
-
|
|
100
|
-
|
|
101
|
-
|
|
102
|
-
For exports, set Response Format to Text if the response is not JSON.
|
|
176
|
+
```json
|
|
177
|
+
{
|
|
178
|
+
"ticketTopicIds": ["TICKET_TOPIC_ID"],
|
|
179
|
+
"comments": "Atendimento finalizado pelo fluxo"
|
|
180
|
+
}
|
|
103
181
|
```
|
|
104
182
|
|
|
105
|
-
|
|
183
|
+
### Buscar estatísticas de atendimento
|
|
106
184
|
|
|
107
|
-
|
|
108
|
-
|
|
185
|
+
Resource: **Estatísticas de atendimento (General)**
|
|
186
|
+
Operation: **Buscar estatísticas com todos os filtros ativos**
|
|
187
|
+
|
|
188
|
+
```json
|
|
189
|
+
{
|
|
190
|
+
"startPeriod": "2026-07-01T00:00:00.000Z",
|
|
191
|
+
"endPeriod": "2026-07-31T23:59:59.999Z",
|
|
192
|
+
"departmentId": "all",
|
|
193
|
+
"userId": "all",
|
|
194
|
+
"periodType": "openDate",
|
|
195
|
+
"status": "all"
|
|
196
|
+
}
|
|
109
197
|
```
|
|
110
198
|
|
|
111
|
-
|
|
199
|
+
### Criar webhook
|
|
112
200
|
|
|
113
|
-
|
|
201
|
+
Resource: **Webhooks (General)**
|
|
202
|
+
Operation: **Criar webhook**
|
|
114
203
|
|
|
115
|
-
```
|
|
116
|
-
|
|
204
|
+
```json
|
|
205
|
+
{
|
|
206
|
+
"active": true,
|
|
207
|
+
"name": "Webhook n8n",
|
|
208
|
+
"url": "https://seu-n8n/webhook/digisac",
|
|
209
|
+
"events": ["message.created", "ticket.closed"],
|
|
210
|
+
"type": "http"
|
|
211
|
+
}
|
|
117
212
|
```
|
|
118
213
|
|
|
119
|
-
|
|
214
|
+
## Todas as chamadas da API
|
|
215
|
+
|
|
216
|
+
O catálogo completo fica em [docs/api-calls.md](docs/api-calls.md).
|
|
217
|
+
|
|
218
|
+
Resumo por método:
|
|
120
219
|
|
|
121
220
|
```text
|
|
122
|
-
|
|
221
|
+
GET: 144 | POST: 93 | PUT: 34 | PATCH: 1 | DELETE: 26
|
|
123
222
|
```
|
|
124
223
|
|
|
125
|
-
|
|
224
|
+
Resumo por recurso:
|
|
225
|
+
|
|
226
|
+
| Recurso | Chamadas |
|
|
227
|
+
| --- | ---: |
|
|
228
|
+
| Acionamento flag no robo (General) | 1 |
|
|
229
|
+
| Agendamentos (General) | 5 |
|
|
230
|
+
| Agora (General) | 3 |
|
|
231
|
+
| Agora (Popular) | 3 |
|
|
232
|
+
| Assuntos de chamado (General) | 5 |
|
|
233
|
+
| Auditoria de autenticacao (General) | 2 |
|
|
234
|
+
| Autorizacao (General) | 1 |
|
|
235
|
+
| Autorizacao (Popular) | 1 |
|
|
236
|
+
| Avaliacoes (General) | 5 |
|
|
237
|
+
| Campanhas (General) | 7 |
|
|
238
|
+
| Campos personalizados (General) | 5 |
|
|
239
|
+
| Cargos (General) | 7 |
|
|
240
|
+
| Central de notificacoes (General) | 2 |
|
|
241
|
+
| Chamados (General) | 7 |
|
|
242
|
+
| Chamados (Popular) | 6 |
|
|
243
|
+
| Conexoes (General) | 11 |
|
|
244
|
+
| Contatos (General) | 22 |
|
|
245
|
+
| Contatos (Popular) | 22 |
|
|
246
|
+
| Controle de ausencia (General) | 1 |
|
|
247
|
+
| Creditos SMS (General) | 3 |
|
|
248
|
+
| Departamentos (General) | 6 |
|
|
249
|
+
| Distribuicao de chamados (General) | 6 |
|
|
250
|
+
| Estatisticas de atendimento (General) | 10 |
|
|
251
|
+
| Estatisticas de atendimento (Popular) | 7 |
|
|
252
|
+
| Estatisticas de avaliacoes (General) | 7 |
|
|
253
|
+
| Feriados (General) | 5 |
|
|
254
|
+
| Funil de vendas (General) | 10 |
|
|
255
|
+
| Grupos WhatsApp (General) | 4 |
|
|
256
|
+
| Historico de chamados (General) | 12 |
|
|
257
|
+
| Historico de chamados (Popular) | 9 |
|
|
258
|
+
| Idioma da plataforma (General) | 1 |
|
|
259
|
+
| Integracoes (General) | 2 |
|
|
260
|
+
| Mensagens (General) | 13 |
|
|
261
|
+
| Mensagens (Popular) | 8 |
|
|
262
|
+
| Mensagens interativas (General) | 7 |
|
|
263
|
+
| Meus dados (General) | 1 |
|
|
264
|
+
| Notificacao (General) | 3 |
|
|
265
|
+
| Organizacoes (General) | 5 |
|
|
266
|
+
| Pessoas (General) | 5 |
|
|
267
|
+
| Planos (General) | 2 |
|
|
268
|
+
| Redefinir senha (General) | 1 |
|
|
269
|
+
| Respostas rapidas (General) | 7 |
|
|
270
|
+
| Robos (General) | 6 |
|
|
271
|
+
| Tags (General) | 8 |
|
|
272
|
+
| Templates (General) | 11 |
|
|
273
|
+
| Termos de aceite (General) | 5 |
|
|
274
|
+
| Tokens (General) | 5 |
|
|
275
|
+
| Usuarios (General) | 6 |
|
|
276
|
+
| Versoes (General) | 1 |
|
|
277
|
+
| Webhooks (General) | 5 |
|
|
278
|
+
| WhatsApp (General) | 1 |
|
|
279
|
+
|
|
280
|
+
## Uso como Tool de Agente de IA
|
|
281
|
+
|
|
282
|
+
O node pode ser conectado ao **AI Agent** do n8n como uma tool. A prática recomendada é criar uma tool por operação liberada para o agente. Isso limita o escopo do modelo e reduz risco de ações erradas.
|
|
283
|
+
|
|
284
|
+
### Prompt recomendado para o System Message
|
|
126
285
|
|
|
127
286
|
```text
|
|
128
|
-
|
|
287
|
+
Você pode usar as tools Digisac somente quando o usuário pedir para consultar, criar ou alterar dados na Digisac.
|
|
288
|
+
Nunca invente IDs. Se faltar contactId, ticketId, departmentId, serviceId, userId, messageId, tagId, campaignId ou templateId, primeiro use uma operação de listagem ou busca.
|
|
289
|
+
Para operações POST, PUT e PATCH, envie um body JSON mínimo, somente com os campos necessários.
|
|
290
|
+
Para filtros de data/hora, use ISO-8601 quando o endpoint esperar timestamp.
|
|
291
|
+
Para exportações CSV, TXT ou PDF, use Response Format = Text se a resposta não for JSON.
|
|
292
|
+
Antes de criar, editar, excluir, arquivar, bloquear, fechar chamado ou enviar mensagem, confirme que a intenção do usuário está clara.
|
|
293
|
+
```
|
|
294
|
+
|
|
295
|
+
### Exemplos de `$fromAI()`
|
|
296
|
+
|
|
297
|
+
Contato existente:
|
|
298
|
+
|
|
299
|
+
```javascript
|
|
300
|
+
{{ $fromAI('contactId', 'ID existente de contato Digisac. Deve vir de uma busca/listagem anterior, nunca inventado.', 'string') }}
|
|
301
|
+
```
|
|
302
|
+
|
|
303
|
+
Texto de mensagem:
|
|
304
|
+
|
|
305
|
+
```javascript
|
|
306
|
+
{{ $fromAI('messageText', 'Texto exato que será enviado ao contato no WhatsApp/Digisac.', 'string') }}
|
|
307
|
+
```
|
|
308
|
+
|
|
309
|
+
Filtro de período:
|
|
310
|
+
|
|
311
|
+
```javascript
|
|
312
|
+
{{ $fromAI('startPeriod', 'Início do período em ISO-8601, por exemplo 2026-07-01T00:00:00.000Z.', 'string') }}
|
|
313
|
+
```
|
|
314
|
+
|
|
315
|
+
Body JSON:
|
|
316
|
+
|
|
317
|
+
```javascript
|
|
318
|
+
{{ $fromAI('body', 'Objeto JSON válido com os campos exigidos pela operação Digisac selecionada.', 'json') }}
|
|
129
319
|
```
|
|
130
320
|
|
|
131
|
-
|
|
321
|
+
### Boas práticas para LLMs
|
|
132
322
|
|
|
133
|
-
|
|
323
|
+
- Exponha apenas as operações necessárias para o caso de uso.
|
|
324
|
+
- Prefira operações de leitura antes de escrita.
|
|
325
|
+
- Nunca deixe o modelo inventar IDs.
|
|
326
|
+
- Use credenciais dedicadas por ambiente/cliente.
|
|
327
|
+
- Para operações destrutivas (`DELETE`, arquivar, bloquear, fechar chamado), coloque etapa humana de confirmação quando o fluxo for sensível.
|
|
328
|
+
- Em mensagens enviadas ao cliente, gere o texto em etapa anterior e passe o texto final para a tool.
|
|
329
|
+
- Para bodies grandes, use JSON explícito e valide campos obrigatórios no workflow antes da chamada.
|
|
330
|
+
|
|
331
|
+
## Desenvolvimento
|
|
134
332
|
|
|
135
333
|
```bash
|
|
136
334
|
npm install
|
|
137
335
|
npm run generate:endpoints
|
|
336
|
+
npm run generate:docs
|
|
138
337
|
npm run lint
|
|
139
338
|
npm run build
|
|
140
339
|
npm run dev
|
|
141
340
|
```
|
|
142
341
|
|
|
143
|
-
|
|
342
|
+
Estrutura:
|
|
144
343
|
|
|
145
344
|
```text
|
|
146
345
|
n8n-nodes-digisac/
|
|
@@ -154,28 +353,45 @@ n8n-nodes-digisac/
|
|
|
154
353
|
│ ├── helpers/
|
|
155
354
|
│ └── transport/
|
|
156
355
|
├── scripts/
|
|
356
|
+
│ ├── generate-docs.mjs
|
|
157
357
|
│ └── generate-endpoints.mjs
|
|
158
|
-
└──
|
|
358
|
+
└── docs/
|
|
359
|
+
└── api-calls.md
|
|
159
360
|
```
|
|
160
361
|
|
|
161
|
-
##
|
|
362
|
+
## Como o catálogo é gerado
|
|
162
363
|
|
|
163
|
-
|
|
364
|
+
O script `scripts/generate-endpoints.mjs` baixa a coleção pública:
|
|
164
365
|
|
|
165
|
-
|
|
366
|
+
```text
|
|
367
|
+
https://documenter.getpostman.com/view/53282970/2sBXihpXmF
|
|
368
|
+
```
|
|
369
|
+
|
|
370
|
+
E gera:
|
|
166
371
|
|
|
167
372
|
```text
|
|
168
|
-
|
|
373
|
+
nodes/Digisac/generated/endpoints.ts
|
|
169
374
|
```
|
|
170
375
|
|
|
171
|
-
|
|
376
|
+
O script `scripts/generate-docs.mjs` lê esse catálogo e gera:
|
|
377
|
+
|
|
378
|
+
```text
|
|
379
|
+
README.md
|
|
380
|
+
docs/api-calls.md
|
|
381
|
+
```
|
|
382
|
+
|
|
383
|
+
## Publicação no npm
|
|
384
|
+
|
|
385
|
+
O projeto publica pelo mesmo padrão do node Clinicorp: GitHub Actions + npm provenance.
|
|
386
|
+
|
|
387
|
+
Para publicar nova versão:
|
|
172
388
|
|
|
173
389
|
```bash
|
|
174
390
|
npm version patch
|
|
175
391
|
git push origin main --tags
|
|
176
392
|
```
|
|
177
393
|
|
|
178
|
-
|
|
394
|
+
O workflow executa:
|
|
179
395
|
|
|
180
396
|
```bash
|
|
181
397
|
npm ci --ignore-scripts
|
|
@@ -183,14 +399,18 @@ npm run build
|
|
|
183
399
|
npm publish --provenance --access public
|
|
184
400
|
```
|
|
185
401
|
|
|
186
|
-
##
|
|
402
|
+
## Versões
|
|
403
|
+
|
|
404
|
+
- **1.0.1** — Documentação reescrita em PT-BR, com exemplos práticos, instruções de AI Tool e catálogo completo de chamadas em `docs/api-calls.md`.
|
|
405
|
+
- **1.0.0** — Primeira versão publicada. Node único `Digisac`, credencial Bearer, catálogo com 298 chamadas da documentação Postman, suporte a AI Agent e publicação npm via GitHub Actions.
|
|
406
|
+
|
|
407
|
+
## Referências
|
|
187
408
|
|
|
188
|
-
- [
|
|
189
|
-
- [n8n building community nodes](https://docs.n8n.io/integrations/community-nodes/building-community-nodes/)
|
|
190
|
-
- [n8n programmatic node tutorial](https://docs.n8n.io/connect/create-nodes/build-your-node/tutorial-build-a-programmatic-style-node/)
|
|
191
|
-
- [n8n
|
|
192
|
-
- [n8n verification guidelines](https://docs.n8n.io/connect/create-nodes/build-your-node/reference/verification-guidelines/)
|
|
409
|
+
- [Documentação Postman da Digisac](https://documenter.getpostman.com/view/53282970/2sBXihpXmF)
|
|
410
|
+
- [n8n: building community nodes](https://docs.n8n.io/integrations/community-nodes/building-community-nodes/)
|
|
411
|
+
- [n8n: programmatic node tutorial](https://docs.n8n.io/connect/create-nodes/build-your-node/tutorial-build-a-programmatic-style-node/)
|
|
412
|
+
- [n8n: `$fromAI()`](https://docs.n8n.io/build/integrate-ai/ai-examples/use-ai-for-parameters/)
|
|
193
413
|
|
|
194
|
-
##
|
|
414
|
+
## Licença
|
|
195
415
|
|
|
196
416
|
[MIT](LICENSE.md)
|
|
@@ -0,0 +1,632 @@
|
|
|
1
|
+
# Catálogo completo de chamadas Digisac
|
|
2
|
+
|
|
3
|
+
Este arquivo é gerado a partir da coleção pública Postman da Digisac e lista todas as chamadas incluídas no node n8n.
|
|
4
|
+
|
|
5
|
+
Fonte da API:
|
|
6
|
+
|
|
7
|
+
```text
|
|
8
|
+
https://documenter.getpostman.com/view/53282970/2sBXihpXmF
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
Resumo:
|
|
12
|
+
|
|
13
|
+
- Total de chamadas documentadas: 298
|
|
14
|
+
- Total de recursos/pastas no node: 51
|
|
15
|
+
- Métodos: GET: 144 | POST: 93 | PUT: 34 | PATCH: 1 | DELETE: 26
|
|
16
|
+
|
|
17
|
+
## Como ler esta tabela
|
|
18
|
+
|
|
19
|
+
- **ID** é o identificador interno da operação no node. Ele aparece apenas no código gerado; na interface do n8n o usuário escolhe pelo nome da operação.
|
|
20
|
+
- **Método** é o verbo HTTP usado pela API.
|
|
21
|
+
- **Caminho** é o endpoint chamado após a Base URL configurada na credencial.
|
|
22
|
+
- **Operação** é o nome herdado da documentação Postman.
|
|
23
|
+
- **Parâmetros detectados** mostra placeholders encontrados em path e query. IDs devem vir de operações de listagem/busca, nunca de valores inventados.
|
|
24
|
+
|
|
25
|
+
## Resumo por recurso
|
|
26
|
+
|
|
27
|
+
| Recurso | Chamadas |
|
|
28
|
+
| --- | ---: |
|
|
29
|
+
| Acionamento flag no robo (General) | 1 |
|
|
30
|
+
| Agendamentos (General) | 5 |
|
|
31
|
+
| Agora (General) | 3 |
|
|
32
|
+
| Agora (Popular) | 3 |
|
|
33
|
+
| Assuntos de chamado (General) | 5 |
|
|
34
|
+
| Auditoria de autenticacao (General) | 2 |
|
|
35
|
+
| Autorizacao (General) | 1 |
|
|
36
|
+
| Autorizacao (Popular) | 1 |
|
|
37
|
+
| Avaliacoes (General) | 5 |
|
|
38
|
+
| Campanhas (General) | 7 |
|
|
39
|
+
| Campos personalizados (General) | 5 |
|
|
40
|
+
| Cargos (General) | 7 |
|
|
41
|
+
| Central de notificacoes (General) | 2 |
|
|
42
|
+
| Chamados (General) | 7 |
|
|
43
|
+
| Chamados (Popular) | 6 |
|
|
44
|
+
| Conexoes (General) | 11 |
|
|
45
|
+
| Contatos (General) | 22 |
|
|
46
|
+
| Contatos (Popular) | 22 |
|
|
47
|
+
| Controle de ausencia (General) | 1 |
|
|
48
|
+
| Creditos SMS (General) | 3 |
|
|
49
|
+
| Departamentos (General) | 6 |
|
|
50
|
+
| Distribuicao de chamados (General) | 6 |
|
|
51
|
+
| Estatisticas de atendimento (General) | 10 |
|
|
52
|
+
| Estatisticas de atendimento (Popular) | 7 |
|
|
53
|
+
| Estatisticas de avaliacoes (General) | 7 |
|
|
54
|
+
| Feriados (General) | 5 |
|
|
55
|
+
| Funil de vendas (General) | 10 |
|
|
56
|
+
| Grupos WhatsApp (General) | 4 |
|
|
57
|
+
| Historico de chamados (General) | 12 |
|
|
58
|
+
| Historico de chamados (Popular) | 9 |
|
|
59
|
+
| Idioma da plataforma (General) | 1 |
|
|
60
|
+
| Integracoes (General) | 2 |
|
|
61
|
+
| Mensagens (General) | 13 |
|
|
62
|
+
| Mensagens (Popular) | 8 |
|
|
63
|
+
| Mensagens interativas (General) | 7 |
|
|
64
|
+
| Meus dados (General) | 1 |
|
|
65
|
+
| Notificacao (General) | 3 |
|
|
66
|
+
| Organizacoes (General) | 5 |
|
|
67
|
+
| Pessoas (General) | 5 |
|
|
68
|
+
| Planos (General) | 2 |
|
|
69
|
+
| Redefinir senha (General) | 1 |
|
|
70
|
+
| Respostas rapidas (General) | 7 |
|
|
71
|
+
| Robos (General) | 6 |
|
|
72
|
+
| Tags (General) | 8 |
|
|
73
|
+
| Templates (General) | 11 |
|
|
74
|
+
| Termos de aceite (General) | 5 |
|
|
75
|
+
| Tokens (General) | 5 |
|
|
76
|
+
| Usuarios (General) | 6 |
|
|
77
|
+
| Versoes (General) | 1 |
|
|
78
|
+
| Webhooks (General) | 5 |
|
|
79
|
+
| WhatsApp (General) | 1 |
|
|
80
|
+
|
|
81
|
+
## Acionamento flag no robo (General)
|
|
82
|
+
|
|
83
|
+
| ID | Método | Caminho | Operação | Parâmetros detectados |
|
|
84
|
+
| --- | --- | --- | --- | --- |
|
|
85
|
+
| `e001` | `POST` | `/api/v1/bots/{{botId}}/trigger-signal/{{contactId}}` | Acionamento flag no robo | path:botId, path:contactId |
|
|
86
|
+
|
|
87
|
+
## Agendamentos (General)
|
|
88
|
+
|
|
89
|
+
| ID | Método | Caminho | Operação | Parâmetros detectados |
|
|
90
|
+
| --- | --- | --- | --- | --- |
|
|
91
|
+
| `e002` | `GET` | `/api/v1/schedule` | Listar agendamentos | - |
|
|
92
|
+
| `e003` | `GET` | `/api/v1/schedule/{{scheduleId}}` | Buscar agendamento | path:scheduleId |
|
|
93
|
+
| `e004` | `PUT` | `/api/v1/schedule/{{scheduleId}}` | Editar agendamento | path:scheduleId |
|
|
94
|
+
| `e005` | `POST` | `/api/v1/schedule` | Criar agendamento | - |
|
|
95
|
+
| `e006` | `DELETE` | `/api/v1/schedule/{{scheduleId}}` | Excluir agendamento | path:scheduleId |
|
|
96
|
+
|
|
97
|
+
## Agora (General)
|
|
98
|
+
|
|
99
|
+
| ID | Método | Caminho | Operação | Parâmetros detectados |
|
|
100
|
+
| --- | --- | --- | --- | --- |
|
|
101
|
+
| `e007` | `GET` | `/api/v1/now/departments-resume` | Buscar departamentos (Agora) | - |
|
|
102
|
+
| `e008` | `GET` | `/api/v1/now/attendance-resume` | Buscar atendentes (Agora) | - |
|
|
103
|
+
| `e009` | `GET` | `/api/v1/now/resume` | Buscar todos os dados (Agora) | - |
|
|
104
|
+
|
|
105
|
+
## Agora (Popular)
|
|
106
|
+
|
|
107
|
+
| ID | Método | Caminho | Operação | Parâmetros detectados |
|
|
108
|
+
| --- | --- | --- | --- | --- |
|
|
109
|
+
| `e243` | `GET` | `/api/v1/now/departments-resume` | Buscar departamentos (Agora) | - |
|
|
110
|
+
| `e244` | `GET` | `/api/v1/now/attendance-resume` | Buscar atendentes (Agora) | - |
|
|
111
|
+
| `e245` | `GET` | `/api/v1/now/resume` | Buscar todos os dados (Agora) | - |
|
|
112
|
+
|
|
113
|
+
## Assuntos de chamado (General)
|
|
114
|
+
|
|
115
|
+
| ID | Método | Caminho | Operação | Parâmetros detectados |
|
|
116
|
+
| --- | --- | --- | --- | --- |
|
|
117
|
+
| `e010` | `GET` | `/api/v1/ticket-topics` | Listar assuntos de fechamento | - |
|
|
118
|
+
| `e011` | `GET` | `/api/v1/ticket-topics/{{ticketTopicId}}` | Buscar um assunto especifico | path:ticketTopicId |
|
|
119
|
+
| `e012` | `PUT` | `/api/v1/ticket-topics/{{ticketTopicId}}` | Editar assunto especifico | path:ticketTopicId |
|
|
120
|
+
| `e013` | `POST` | `/api/v1/ticket-topics` | Criar assunto | - |
|
|
121
|
+
| `e014` | `DELETE` | `/api/v1/ticket-topics/{{ticketTopicId}}` | Excluir assunto especifico | path:ticketTopicId |
|
|
122
|
+
|
|
123
|
+
## Auditoria de autenticacao (General)
|
|
124
|
+
|
|
125
|
+
| ID | Método | Caminho | Operação | Parâmetros detectados |
|
|
126
|
+
| --- | --- | --- | --- | --- |
|
|
127
|
+
| `e015` | `GET` | `/api/v1/auth-history` | Listar auditorias de autenticacao | - |
|
|
128
|
+
| `e016` | `GET` | `/api/v1/auth-history/{{authId}}` | Buscar auditoria de autenticacao | path:authId |
|
|
129
|
+
|
|
130
|
+
## Autorizacao (General)
|
|
131
|
+
|
|
132
|
+
| ID | Método | Caminho | Operação | Parâmetros detectados |
|
|
133
|
+
| --- | --- | --- | --- | --- |
|
|
134
|
+
| `e017` | `POST` | `/api/v1/oauth/token` | Gerar Token de acesso | - |
|
|
135
|
+
|
|
136
|
+
## Autorizacao (Popular)
|
|
137
|
+
|
|
138
|
+
| ID | Método | Caminho | Operação | Parâmetros detectados |
|
|
139
|
+
| --- | --- | --- | --- | --- |
|
|
140
|
+
| `e246` | `POST` | `/api/v1/oauth/token` | Gerar Token de acesso | - |
|
|
141
|
+
|
|
142
|
+
## Avaliacoes (General)
|
|
143
|
+
|
|
144
|
+
| ID | Método | Caminho | Operação | Parâmetros detectados |
|
|
145
|
+
| --- | --- | --- | --- | --- |
|
|
146
|
+
| `e018` | `GET` | `/api/v1/questions` | Listar avaliacoes | - |
|
|
147
|
+
| `e019` | `GET` | `/api/v1/questions/{{questionId}}` | Buscar avaliacao | path:questionId |
|
|
148
|
+
| `e020` | `PUT` | `/api/v1/questions/{{questionId}}` | Editar avaliacao | path:questionId |
|
|
149
|
+
| `e021` | `POST` | `/api/v1/questions` | Criar avaliacao | - |
|
|
150
|
+
| `e022` | `DELETE` | `/api/v1/questions/{{questionId}}` | Excluir avaliacao | path:questionId |
|
|
151
|
+
|
|
152
|
+
## Campanhas (General)
|
|
153
|
+
|
|
154
|
+
| ID | Método | Caminho | Operação | Parâmetros detectados |
|
|
155
|
+
| --- | --- | --- | --- | --- |
|
|
156
|
+
| `e023` | `GET` | `/api/v1/campaigns` | Listar campanhas | - |
|
|
157
|
+
| `e024` | `GET` | `/api/v1/campaigns/{{campaignsId}}` | Buscar campanha | path:campaignsId |
|
|
158
|
+
| `e025` | `GET` | `/api/v1/campaigns/{{campaignId}}/stats` | Extrair status de uma campanha | path:campaignId |
|
|
159
|
+
| `e026` | `GET` | `/api/v1/campaigns` | Visualizar quem criou e enviou uma campanha | - |
|
|
160
|
+
| `e027` | `PUT` | `/api/v1/campaigns/{{campaignsId}}` | Editar campanha | path:campaignsId |
|
|
161
|
+
| `e028` | `POST` | `/api/v1/campaigns/export/csv` | Exportar resultados da campanha | - |
|
|
162
|
+
| `e029` | `DELETE` | `/api/v1/campaigns/{{campaignsId}}` | Excluir campanha | path:campaignsId |
|
|
163
|
+
|
|
164
|
+
## Campos personalizados (General)
|
|
165
|
+
|
|
166
|
+
| ID | Método | Caminho | Operação | Parâmetros detectados |
|
|
167
|
+
| --- | --- | --- | --- | --- |
|
|
168
|
+
| `e030` | `GET` | `/api/v1/custom-fields` | Listar campos personalizados | - |
|
|
169
|
+
| `e031` | `GET` | `/api/v1/custom-fields/{{customFieldsId}}` | Buscar campo personalizado | path:customFieldsId |
|
|
170
|
+
| `e032` | `PUT` | `/api/v1/custom-fields/{{customFieldsId}}` | Editar campo personalizado | path:customFieldsId |
|
|
171
|
+
| `e033` | `POST` | `/api/v1/custom-fields` | Criar campo personalizado | - |
|
|
172
|
+
| `e034` | `DELETE` | `/api/v1/custom-fields/{{customFieldsId}}` | Excluir campo personalizado | path:customFieldsId |
|
|
173
|
+
|
|
174
|
+
## Cargos (General)
|
|
175
|
+
|
|
176
|
+
| ID | Método | Caminho | Operação | Parâmetros detectados |
|
|
177
|
+
| --- | --- | --- | --- | --- |
|
|
178
|
+
| `e035` | `GET` | `/api/v1/roles` | Listar cargos | - |
|
|
179
|
+
| `e036` | `GET` | `/api/v1/roles/{{roleId}}` | Buscar cargo | path:roleId |
|
|
180
|
+
| `e037` | `GET` | `/api/v1/roles/{{roleId}}` | Buscar permissoes do cargo | path:roleId |
|
|
181
|
+
| `e038` | `GET` | `/api/v1/users/{{roleId}}` | Buscar cargos do usuario | path:roleId |
|
|
182
|
+
| `e039` | `PUT` | `/api/v1/roles/{{roleId}}` | Editar cargo | path:roleId |
|
|
183
|
+
| `e040` | `POST` | `/api/v1/roles` | Criar cargo | - |
|
|
184
|
+
| `e041` | `DELETE` | `/api/v1/roles/{{roleId}}` | Excluir cargo | path:roleId |
|
|
185
|
+
|
|
186
|
+
## Central de notificacoes (General)
|
|
187
|
+
|
|
188
|
+
| ID | Método | Caminho | Operação | Parâmetros detectados |
|
|
189
|
+
| --- | --- | --- | --- | --- |
|
|
190
|
+
| `e042` | `GET` | `/api/v1/notifications` | Listar central de notificacoes | - |
|
|
191
|
+
| `e043` | `GET` | `/api/v1/notifications/read-all` | Marcar todas as notificacoes como lidas | - |
|
|
192
|
+
|
|
193
|
+
## Chamados (General)
|
|
194
|
+
|
|
195
|
+
| ID | Método | Caminho | Operação | Parâmetros detectados |
|
|
196
|
+
| --- | --- | --- | --- | --- |
|
|
197
|
+
| `e044` | `GET` | `/api/v1/tickets` | Buscar chamados do contato | query:contactId |
|
|
198
|
+
| `e045` | `GET` | `/api/v1/tickets` | Buscar pelo contactid todos os chamados do cliente trazendo quem encerrou/transferiu | query:contactId |
|
|
199
|
+
| `e046` | `POST` | `/api/v1/contacts/{{contactId}}/ticket/transfer` | Transferencia de chamado | path:contactId |
|
|
200
|
+
| `e047` | `POST` | `/api/v1/contacts/ticket/bulk-transfer` | Transferencia de Transferencia em massa | - |
|
|
201
|
+
| `e048` | `POST` | `/api/v1/contacts/{{contactId}}/ticket/transfer` | Abertura de chamado | path:contactId |
|
|
202
|
+
| `e049` | `POST` | `/api/v1/contacts/{{contactId}}/ticket/close` | Fechar chamado | path:contactId |
|
|
203
|
+
| `e050` | `POST` | `/api/v1/contacts/{{contactId}}/ticket/close` | Fechar um chamado com assunto | path:contactId |
|
|
204
|
+
|
|
205
|
+
## Chamados (Popular)
|
|
206
|
+
|
|
207
|
+
| ID | Método | Caminho | Operação | Parâmetros detectados |
|
|
208
|
+
| --- | --- | --- | --- | --- |
|
|
209
|
+
| `e247` | `GET` | `/tickets` | Buscar chamados do contato | query:contactId |
|
|
210
|
+
| `e248` | `GET` | `/api/v1/tickets` | Buscar pelo contactid todos os chamados do cliente trazendo quem encerrou/transferiu | query:contactId |
|
|
211
|
+
| `e249` | `POST` | `/api/v1/contacts/{{contactId}}/ticket/transfer` | Transferencia de chamado | path:contactId |
|
|
212
|
+
| `e250` | `POST` | `/contacts/{{contactId}}/ticket/transfer` | Abertura de chamado | path:contactId |
|
|
213
|
+
| `e251` | `POST` | `/api/v1/contacts/{{contactId}}/ticket/close` | Fechar chamado | path:contactId |
|
|
214
|
+
| `e252` | `POST` | `/api/v1/contacts/{{contactId}}/ticket/close` | Fechar um chamado com assunto | path:contactId |
|
|
215
|
+
|
|
216
|
+
## Conexoes (General)
|
|
217
|
+
|
|
218
|
+
| ID | Método | Caminho | Operação | Parâmetros detectados |
|
|
219
|
+
| --- | --- | --- | --- | --- |
|
|
220
|
+
| `e051` | `GET` | `/api/v1/services` | Listar conexoes | - |
|
|
221
|
+
| `e052` | `GET` | `/api/v1/services/{{serviceId}}` | Buscar conexao | path:serviceId |
|
|
222
|
+
| `e053` | `GET` | `/api/v1/services` | Buscar conexoes ativas | - |
|
|
223
|
+
| `e054` | `PUT` | `/api/v1/services/{{serviceId}}` | Editar conexao | path:serviceId |
|
|
224
|
+
| `e055` | `POST` | `/api/v1/services/{{serviceId}}/archive` | Arquivar conexao | path:serviceId |
|
|
225
|
+
| `e056` | `POST` | `/api/v1/services` | Criar conexao | - |
|
|
226
|
+
| `e057` | `POST` | `/api/v1/services/{{serviceId}}/shutdown` | Desligar conexao | path:serviceId |
|
|
227
|
+
| `e058` | `POST` | `/api/v1/services/{{serviceId}}/start` | Iniciar conexao | path:serviceId |
|
|
228
|
+
| `e059` | `POST` | `/api/v1/services/{{serviceId}}/restart` | Reiniciar conexao | path:serviceId |
|
|
229
|
+
| `e060` | `POST` | `/api/v1/services/{{serviceId}}/logout` | Gerar QR Code | path:serviceId |
|
|
230
|
+
| `e061` | `DELETE` | `/api/v1/services/{{serviceId}}` | Excluir conexao | path:serviceId |
|
|
231
|
+
|
|
232
|
+
## Contatos (General)
|
|
233
|
+
|
|
234
|
+
| ID | Método | Caminho | Operação | Parâmetros detectados |
|
|
235
|
+
| --- | --- | --- | --- | --- |
|
|
236
|
+
| `e062` | `GET` | `/api/v1/contacts` | Listar todos os contatos | - |
|
|
237
|
+
| `e063` | `GET` | `/api/v1/contacts` | Listar contatos da conexao | query:serviceId |
|
|
238
|
+
| `e064` | `GET` | `/api/v1/contacts/{{contactId}}` | Buscar contato | path:contactId |
|
|
239
|
+
| `e065` | `GET` | `/api/v1/contacts` | Buscar contato por numero de uma conexao especifica | query:number, query:serviceId |
|
|
240
|
+
| `e066` | `GET` | `/api/v1/contacts/{{contactId}}` | Buscar tags vinculadas a um contato | path:contactId |
|
|
241
|
+
| `e067` | `GET` | `/api/v1/contacts` | Buscar contatos vinculados ao Campo Personalizado | query:customFieldName |
|
|
242
|
+
| `e068` | `GET` | `/api/v1/contacts` | Busca de contatos que possuem X campos personalizados preenchidos | query:customFieldName1, query:customFieldName2, query:customFieldName3, query:customFieldName4 |
|
|
243
|
+
| `e069` | `GET` | `/api/v1/contacts` | Buscar contatos vinculados a Organizacao | query:organizationId |
|
|
244
|
+
| `e070` | `GET` | `/api/v1/contacts` | Buscar contatos vinculados a Pessoa | query:personId |
|
|
245
|
+
| `e071` | `PUT` | `/api/v1/contacts/{{contactId}}` | Editar contato | path:contactId |
|
|
246
|
+
| `e072` | `PUT` | `/api/v1/contacts/{{contactId}}` | Editar tag do contato | path:contactId |
|
|
247
|
+
| `e073` | `PUT` | `/api/v1/contacts/{{contactId}}` | Editar campo personalizado de um contato | path:contactId |
|
|
248
|
+
| `e074` | `PUT` | `/api/v1/contacts/{{contactId}}` | Incluir tags em um contato existente | path:contactId |
|
|
249
|
+
| `e075` | `POST` | `/api/v1/contacts` | Cadastrar contato | - |
|
|
250
|
+
| `e076` | `POST` | `/api/v1/contacts/many` | Cadastrar multiplos contatos | - |
|
|
251
|
+
| `e077` | `POST` | `/api/v1/contacts/export/csv` | Exportar contatos | - |
|
|
252
|
+
| `e078` | `POST` | `/api/v1/contacts/count` | Total de contatos com filtros | - |
|
|
253
|
+
| `e079` | `POST` | `/api/v1/contacts/{{contactId}}/sync` | Sincroniza contato | path:contactId |
|
|
254
|
+
| `e080` | `POST` | `/api/v1/contacts/{{contactId}}/block` | Bloquear contato | path:contactId |
|
|
255
|
+
| `e081` | `POST` | `/api/v1/contacts/{{contactId}}/block` | Desbloquear contato | path:contactId |
|
|
256
|
+
| `e082` | `DELETE` | `/api/v1/contacts/{{contactId}}` | Excluir contato | path:contactId |
|
|
257
|
+
| `e083` | `DELETE` | `/api/v1/contacts/many` | Exclui multiplos contatos | - |
|
|
258
|
+
|
|
259
|
+
## Contatos (Popular)
|
|
260
|
+
|
|
261
|
+
| ID | Método | Caminho | Operação | Parâmetros detectados |
|
|
262
|
+
| --- | --- | --- | --- | --- |
|
|
263
|
+
| `e253` | `GET` | `/api/v1/contacts` | Listar todos os contatos | - |
|
|
264
|
+
| `e254` | `GET` | `/api/v1/contacts` | Listar contatos da conexao | query:serviceId |
|
|
265
|
+
| `e255` | `GET` | `/api/v1/contacts/{{contactId}}` | Buscar contato | path:contactId |
|
|
266
|
+
| `e256` | `GET` | `/api/v1/contacts` | Buscar contato por numero de uma conexao especifica | query:number, query:serviceId |
|
|
267
|
+
| `e257` | `GET` | `/api/v1/contacts/{{contactId}}` | Buscar tags vinculadas a um contato | path:contactId |
|
|
268
|
+
| `e258` | `GET` | `/api/v1/contacts` | Buscar contatos que possuem campo personalizado especifico | query:customFieldName |
|
|
269
|
+
| `e259` | `GET` | `/api/v1/contacts/{{contactId}}` | Buscar campos personalizados de um contato especifico | path:contactId, query:customFieldName |
|
|
270
|
+
| `e260` | `GET` | `/api/v1/contacts` | Busca de contatos que possuem X campos personalizados preenchidos | query:customFieldName1, query:customFieldName2, query:customFieldName3, query:customFieldName4 |
|
|
271
|
+
| `e261` | `GET` | `/api/v1/contacts/exists` | Verifica a existencia de um contato | query:phoneNumber, query:serviceId |
|
|
272
|
+
| `e262` | `PUT` | `/api/v1/contacts/{{contactId}}` | Editar contato | path:contactId |
|
|
273
|
+
| `e263` | `PUT` | `/api/v1/contacts/{{contactId}}` | Editar tag do contato | path:contactId |
|
|
274
|
+
| `e264` | `PUT` | `/api/v1/contacts/{{contactId}}` | Editar campo personalizado de um contato | path:contactId |
|
|
275
|
+
| `e265` | `PUT` | `/api/v1/contacts/{{contactId}}` | Incluir tags em um contato existente Copy | path:contactId |
|
|
276
|
+
| `e266` | `POST` | `/api/v1/contacts` | Cadastrar contato | - |
|
|
277
|
+
| `e267` | `POST` | `/api/v1/contacts/many` | Cadastrar multiplos contatos | - |
|
|
278
|
+
| `e268` | `POST` | `/api/v1/contacts/export/csv` | Exportar contatos | - |
|
|
279
|
+
| `e269` | `POST` | `/api/v1/contacts/count` | Total de contatos com filtros | - |
|
|
280
|
+
| `e270` | `POST` | `/api/v1/contacts/{{contactId}}/sync` | Sincroniza contato | path:contactId |
|
|
281
|
+
| `e271` | `POST` | `/api/v1/contacts/{{contactId}}/block` | Bloquear contato | path:contactId |
|
|
282
|
+
| `e272` | `POST` | `/api/v1/contacts/{{contactId}}/block` | Desbloquear contato | path:contactId |
|
|
283
|
+
| `e273` | `DELETE` | `/api/v1/contacts/{{contactId}}` | Excluir contato | path:contactId |
|
|
284
|
+
| `e274` | `DELETE` | `/api/v1/contacts/many` | Exclui multiplos contatos | - |
|
|
285
|
+
|
|
286
|
+
## Controle de ausencia (General)
|
|
287
|
+
|
|
288
|
+
| ID | Método | Caminho | Operação | Parâmetros detectados |
|
|
289
|
+
| --- | --- | --- | --- | --- |
|
|
290
|
+
| `e084` | `GET` | `/api/v1/absence` | Listar ausencias | - |
|
|
291
|
+
|
|
292
|
+
## Creditos SMS (General)
|
|
293
|
+
|
|
294
|
+
| ID | Método | Caminho | Operação | Parâmetros detectados |
|
|
295
|
+
| --- | --- | --- | --- | --- |
|
|
296
|
+
| `e085` | `GET` | `/api/v1/credit-movements` | Listagem de creditos | - |
|
|
297
|
+
| `e086` | `GET` | `/api/v1/credit-movements/balances` | Balanco | - |
|
|
298
|
+
| `e087` | `GET` | `/api/v1/credit-movements/{{movementId}}` | Buscar uma movimentacao expecifica | path:movementId |
|
|
299
|
+
|
|
300
|
+
## Departamentos (General)
|
|
301
|
+
|
|
302
|
+
| ID | Método | Caminho | Operação | Parâmetros detectados |
|
|
303
|
+
| --- | --- | --- | --- | --- |
|
|
304
|
+
| `e088` | `GET` | `/api/v1/departments` | Listar departamentos | - |
|
|
305
|
+
| `e089` | `GET` | `/api/v1/departments/{{departmentId}}` | Buscar departamento | path:departmentId |
|
|
306
|
+
| `e090` | `PUT` | `/api/v1/departments/{{departmentId}}` | Editar departamento | path:departmentId |
|
|
307
|
+
| `e091` | `POST` | `/api/v1/departments` | Criar departamento | - |
|
|
308
|
+
| `e092` | `POST` | `/api/v1/departments/{{departmentId}}/archive` | Arquivar departamento | path:departmentId |
|
|
309
|
+
| `e093` | `DELETE` | `/api/v1/departments/{{departmentId}}` | Excluir departamento | path:departmentId |
|
|
310
|
+
|
|
311
|
+
## Distribuicao de chamados (General)
|
|
312
|
+
|
|
313
|
+
| ID | Método | Caminho | Operação | Parâmetros detectados |
|
|
314
|
+
| --- | --- | --- | --- | --- |
|
|
315
|
+
| `e094` | `GET` | `/api/v1/distribution` | Listas distribuicoes de chamados | - |
|
|
316
|
+
| `e095` | `GET` | `/api/v1/distribution/{{distributionId}}` | Buscar distribuicao de chamados | path:distributionId |
|
|
317
|
+
| `e096` | `PUT` | `/api/v1/distribution/{{distributionId}}` | Editar distribuicao de chamados | path:distributionId |
|
|
318
|
+
| `e097` | `POST` | `/api/v1/distribution` | Criar distribuicao de chamados - Fila | - |
|
|
319
|
+
| `e098` | `POST` | `/api/v1/distribution` | Criar distribuicao de chamados - Padrao | - |
|
|
320
|
+
| `e099` | `DELETE` | `/api/v1/distribution/{{distributionId}}` | Excluir distribuicao de chamados | path:distributionId |
|
|
321
|
+
|
|
322
|
+
## Estatisticas de atendimento (General)
|
|
323
|
+
|
|
324
|
+
| ID | Método | Caminho | Operação | Parâmetros detectados |
|
|
325
|
+
| --- | --- | --- | --- | --- |
|
|
326
|
+
| `e100` | `GET` | `/api/v1/dashboard/general` | Buscar estatisticas por periodo | - |
|
|
327
|
+
| `e101` | `GET` | `/api/v1/dashboard/general` | Buscar estatisticas por conexao | query:serviceId |
|
|
328
|
+
| `e102` | `GET` | `/api/v1/dashboard/general` | Buscar estatisticas por departamento | query:departmentId |
|
|
329
|
+
| `e103` | `GET` | `/api/v1/dashboard/general` | Buscar estatisticas por usuario | query:userId |
|
|
330
|
+
| `e104` | `GET` | `/api/v1/dashboard/general` | Buscar estatisticas por dpt + usuario | query:departmentId, query:userId |
|
|
331
|
+
| `e105` | `GET` | `/api/v1/dashboard/general` | Buscar estatisticas por data de abertura | - |
|
|
332
|
+
| `e106` | `GET` | `/api/v1/dashboard/general` | Buscar estatisticas por data de fechamento | - |
|
|
333
|
+
| `e107` | `GET` | `/api/v1/dashboard/general` | Buscar estatisticas dos chamados abertos | - |
|
|
334
|
+
| `e108` | `GET` | `/api/v1/dashboard/general` | Buscar estatisticas dos chamados fechados | - |
|
|
335
|
+
| `e109` | `GET` | `/api/v1/dashboard/general` | Buscar estatisticas com todos os filtros ativos | query:departmentId, query:userId, query:serviceId |
|
|
336
|
+
|
|
337
|
+
## Estatisticas de atendimento (Popular)
|
|
338
|
+
|
|
339
|
+
| ID | Método | Caminho | Operação | Parâmetros detectados |
|
|
340
|
+
| --- | --- | --- | --- | --- |
|
|
341
|
+
| `e275` | `GET` | `/api/v1/dashboard/general` | Buscar estatisticas por periodo | - |
|
|
342
|
+
| `e276` | `GET` | `/api/v1/dashboard/general` | Buscar estatisticas pela conexao | query:serviceId |
|
|
343
|
+
| `e277` | `GET` | `/api/v1/dashboard/general` | Buscar estatisticas por departamento | query:departmentId |
|
|
344
|
+
| `e278` | `GET` | `/api/v1/dashboard/general` | Buscar estatisticas por usuario | query:userId |
|
|
345
|
+
| `e279` | `GET` | `/api/v1/dashboard/general` | Buscar estatisticas por departamento + usuario | query:departmentId, query:userId |
|
|
346
|
+
| `e280` | `GET` | `/api/v1/dashboard/general` | Buscar estatisticas pelo status dos chamados | - |
|
|
347
|
+
| `e281` | `GET` | `/api/v1/dashboard/general` | Buscar estatisticas com todos os filtros ativos | query:departmentId, query:userId, query:serviceId |
|
|
348
|
+
|
|
349
|
+
## Estatisticas de avaliacoes (General)
|
|
350
|
+
|
|
351
|
+
| ID | Método | Caminho | Operação | Parâmetros detectados |
|
|
352
|
+
| --- | --- | --- | --- | --- |
|
|
353
|
+
| `e110` | `GET` | `/api/v1/answers` | Buscar avaliacoes sem filtro | - |
|
|
354
|
+
| `e111` | `GET` | `/api/v1/answers/overview` | Buscar avaliacoes por periodo | - |
|
|
355
|
+
| `e112` | `GET` | `/api/v1/answers/overview` | Buscar avaliacoes por conexao | query:serviceId |
|
|
356
|
+
| `e113` | `GET` | `/api/v1/answers/overview` | Buscar avaliacoes por departamento | query:departmentId |
|
|
357
|
+
| `e114` | `GET` | `/api/v1/answers/overview` | Buscar avaliacoes por usuario | query:userId |
|
|
358
|
+
| `e115` | `GET` | `/api/v1/answers/overview` | Buscar avaliacoes por dpt + usuario | query:userId, query:departmentId |
|
|
359
|
+
| `e116` | `GET` | `/api/v1/answers/overview` | Buscar avaliacoes com todos os filtros ativos | query:userId, query:departmentId, query:serviceId |
|
|
360
|
+
|
|
361
|
+
## Feriados (General)
|
|
362
|
+
|
|
363
|
+
| ID | Método | Caminho | Operação | Parâmetros detectados |
|
|
364
|
+
| --- | --- | --- | --- | --- |
|
|
365
|
+
| `e117` | `GET` | `/api/v1/holiday` | Listar feriados | - |
|
|
366
|
+
| `e118` | `GET` | `/api/v1/holiday/{{holidayId}}` | Buscar feriado | path:holidayId |
|
|
367
|
+
| `e119` | `PUT` | `/api/v1/holiday/{{holidayId}}` | Editar feriado | path:holidayId |
|
|
368
|
+
| `e120` | `POST` | `/api/v1/holiday` | Criar feriado | - |
|
|
369
|
+
| `e121` | `DELETE` | `/api/v1/holiday/{{holidayId}}` | Excluir feriado | path:holidayId |
|
|
370
|
+
|
|
371
|
+
## Funil de vendas (General)
|
|
372
|
+
|
|
373
|
+
| ID | Método | Caminho | Operação | Parâmetros detectados |
|
|
374
|
+
| --- | --- | --- | --- | --- |
|
|
375
|
+
| `e122` | `GET` | `/api/v1/pipelines` | Listar funis de vendas | - |
|
|
376
|
+
| `e123` | `GET` | `/api/v1/pipelines/{{pipelineId}}` | Buscar funil de vendas | path:pipelineId |
|
|
377
|
+
| `e124` | `POST` | `/api/v1/pipelines` | Criar funil de vendas | - |
|
|
378
|
+
| `e125` | `PUT` | `/api/v1/pipelines/{{pipelineId}}` | Editar funil de vendas | path:pipelineId |
|
|
379
|
+
| `e126` | `DELETE` | `/api/v1/pipelines/{{pipelineId}}` | Apagar funil de vendas | path:pipelineId |
|
|
380
|
+
| `e127` | `GET` | `/api/v1/cards` | Listar oportunidades | query:pipelineId |
|
|
381
|
+
| `e128` | `GET` | `/api/v1/cards/{{cardsId}}` | Buscar oportunidades | path:cardsId |
|
|
382
|
+
| `e129` | `POST` | `/v1/cards` | Criar oportunidade | - |
|
|
383
|
+
| `e130` | `PUT` | `/v1/cards/{{cardsId}}` | Editar oportunidade | path:cardsId |
|
|
384
|
+
| `e131` | `DELETE` | `/v1/cards/{{cardsId}}` | Apagar oportunidade | path:cardsId |
|
|
385
|
+
|
|
386
|
+
## Grupos WhatsApp (General)
|
|
387
|
+
|
|
388
|
+
| ID | Método | Caminho | Operação | Parâmetros detectados |
|
|
389
|
+
| --- | --- | --- | --- | --- |
|
|
390
|
+
| `e132` | `POST` | `/api/v1/contacts/{{contactId}}/add-members` | Adicionar participante | path:contactId |
|
|
391
|
+
| `e133` | `POST` | `/api/v1/contacts/{{contactId}}/promote-members` | Atribuir cargo de administrador | path:contactId |
|
|
392
|
+
| `e134` | `POST` | `/api/v1/contacts` | Criar novo grupo | - |
|
|
393
|
+
| `e135` | `POST` | `/api/v1/contacts/{{contactId}}/demote-members` | Remover permissoes de administrador | path:contactId |
|
|
394
|
+
|
|
395
|
+
## Historico de chamados (General)
|
|
396
|
+
|
|
397
|
+
| ID | Método | Caminho | Operação | Parâmetros detectados |
|
|
398
|
+
| --- | --- | --- | --- | --- |
|
|
399
|
+
| `e136` | `GET` | `/api/v1/tickets` | Buscar chamados abertos por contactid | query:contactId |
|
|
400
|
+
| `e137` | `GET` | `/api/v1/tickets` | Buscar chamados abertos por departamento | query:departmentId |
|
|
401
|
+
| `e138` | `GET` | `/api/v1/tickets/{{ticketId}}` | Buscar por um chamado especifico | path:ticketId |
|
|
402
|
+
| `e139` | `GET` | `/api/v1/tickets` | Buscar chamados por periodo | - |
|
|
403
|
+
| `e140` | `GET` | `/api/v1/tickets` | Buscar chamados abertos por conexao | query:serviceId |
|
|
404
|
+
| `e141` | `GET` | `/api/v1/tickets` | Buscar chamados fechados por conexao | query:serviceId |
|
|
405
|
+
| `e142` | `GET` | `/api/v1/tickets` | Buscar chamados abertos + fechados por conexao | query:serviceId |
|
|
406
|
+
| `e143` | `GET` | `/api/v1/tickets` | Buscar todos os chamados da plataforma | - |
|
|
407
|
+
| `e144` | `GET` | `/pdf/tickets/{{ticketId}}/pt-BR` | Exportar historico de chamados em PDF | path:ticketId |
|
|
408
|
+
| `e145` | `POST` | `/api/v1/tickets/export` | Exportar historico de chamados em TXT | - |
|
|
409
|
+
| `e146` | `POST` | `/api/v1/tickets/export-history` | Exportar historico de chamados em CSV | - |
|
|
410
|
+
| `e147` | `POST` | `/api/v1/tickets/export-history` | Exportar historico de chamados de uma conexao especifica em CSV | query:servieId |
|
|
411
|
+
|
|
412
|
+
## Historico de chamados (Popular)
|
|
413
|
+
|
|
414
|
+
| ID | Método | Caminho | Operação | Parâmetros detectados |
|
|
415
|
+
| --- | --- | --- | --- | --- |
|
|
416
|
+
| `e282` | `GET` | `/api/v1/tickets/{{ticketId}}` | Buscar por um chamado especifico | path:ticketId |
|
|
417
|
+
| `e283` | `GET` | `/api/v1/tickets` | Buscar chamados por periodo | - |
|
|
418
|
+
| `e284` | `GET` | `/api/v1/tickets` | Buscar chamados abertos por conexao | query:serviceId |
|
|
419
|
+
| `e285` | `GET` | `/api/v1/tickets` | Buscar chamados fechados por conexao | query:serviceId |
|
|
420
|
+
| `e286` | `GET` | `/api/v1/tickets` | Buscar chamados abertos + fechados por conexao | query:serviceId |
|
|
421
|
+
| `e287` | `GET` | `/api/v1/tickets` | Buscar todos os chamados da plataforma | - |
|
|
422
|
+
| `e288` | `GET` | `/pdf/tickets/{{ticketId}}/pt-BR` | Exportar historico de chamados em PDF | path:ticketId |
|
|
423
|
+
| `e289` | `POST` | `/api/v1/tickets/export` | Exportar historico de chamados em TXT | - |
|
|
424
|
+
| `e290` | `POST` | `/api/v1/tickets/export-history` | Exportar historico de chamados em CSV | - |
|
|
425
|
+
|
|
426
|
+
## Idioma da plataforma (General)
|
|
427
|
+
|
|
428
|
+
| ID | Método | Caminho | Operação | Parâmetros detectados |
|
|
429
|
+
| --- | --- | --- | --- | --- |
|
|
430
|
+
| `e150` | `PUT` | `/api/v1/me` | Editar idioma da plataforma | - |
|
|
431
|
+
|
|
432
|
+
## Integracoes (General)
|
|
433
|
+
|
|
434
|
+
| ID | Método | Caminho | Operação | Parâmetros detectados |
|
|
435
|
+
| --- | --- | --- | --- | --- |
|
|
436
|
+
| `e148` | `GET` | `/api/v1/integrations` | Listar integracoes | - |
|
|
437
|
+
| `e149` | `GET` | `/api/v1/integrations/{{integrationId}}` | Buscar integracao | path:integrationId |
|
|
438
|
+
|
|
439
|
+
## Mensagens (General)
|
|
440
|
+
|
|
441
|
+
| ID | Método | Caminho | Operação | Parâmetros detectados |
|
|
442
|
+
| --- | --- | --- | --- | --- |
|
|
443
|
+
| `e151` | `GET` | `/api/v1/messages` | Listar mensagens | - |
|
|
444
|
+
| `e152` | `GET` | `/api/v1/messages` | Buscar total de mensagens do contato | query:contactId |
|
|
445
|
+
| `e153` | `GET` | `/api/v1/messages/{{messageId}}` | Buscar mensagem include=file | path:messageId |
|
|
446
|
+
| `e154` | `POST` | `/api/v1/messages` | Enviar mensagem para contato ja cadastrado | - |
|
|
447
|
+
| `e155` | `POST` | `/api/v1/messages` | Enviar mensagem para contato nao cadastrado | - |
|
|
448
|
+
| `e156` | `POST` | `/api/v1/messages` | Enviar mensagem SEM abrir o chamado | - |
|
|
449
|
+
| `e157` | `POST` | `/api/v1/messages` | Enviar comentario | - |
|
|
450
|
+
| `e158` | `POST` | `/api/v1/messages` | Enviar de mensagem usando bot e sem abrir chamado | - |
|
|
451
|
+
| `e159` | `POST` | `/api/v1/messages` | Enviar imagem | - |
|
|
452
|
+
| `e160` | `POST` | `/api/v1/messages` | Enviar PDF | - |
|
|
453
|
+
| `e161` | `POST` | `/api/v1/messages` | Enviar audio | - |
|
|
454
|
+
| `e162` | `POST` | `/api/v1/messages/{{messageId}}/send-reaction` | Reagir a uma mensagem | path:messageId |
|
|
455
|
+
| `e163` | `PATCH` | `/api/v1/messages/messageId` | Editar mensagem | - |
|
|
456
|
+
|
|
457
|
+
## Mensagens (Popular)
|
|
458
|
+
|
|
459
|
+
| ID | Método | Caminho | Operação | Parâmetros detectados |
|
|
460
|
+
| --- | --- | --- | --- | --- |
|
|
461
|
+
| `e291` | `POST` | `/api/v1/messages` | Enviar mensagem | - |
|
|
462
|
+
| `e292` | `POST` | `/api/v1/messages` | Enviar mensagem SEM abrir o chamado | - |
|
|
463
|
+
| `e293` | `POST` | `/api/v1/messages` | Enviar comentario (POST /api/v1/messages) | - |
|
|
464
|
+
| `e294` | `POST` | `/api/v1/messages` | Enviar de mensagem usando bot e sem abrir chamado | - |
|
|
465
|
+
| `e295` | `POST` | `/api/v1/messages` | Enviar imagem | - |
|
|
466
|
+
| `e296` | `POST` | `/api/v1/messages` | Enviar PDF | - |
|
|
467
|
+
| `e297` | `POST` | `/api/v1/messages` | Enviar comentario (POST /api/v1/messages) | - |
|
|
468
|
+
| `e298` | `POST` | `/api/v1/messages` | Enviar audio | - |
|
|
469
|
+
|
|
470
|
+
## Mensagens interativas (General)
|
|
471
|
+
|
|
472
|
+
| ID | Método | Caminho | Operação | Parâmetros detectados |
|
|
473
|
+
| --- | --- | --- | --- | --- |
|
|
474
|
+
| `e164` | `GET` | `/api/v1/interactive-messages` | Listar mensagens interativas | - |
|
|
475
|
+
| `e165` | `GET` | `/api/v1/interactive-messages/{{interactiveMessagesId}}` | Buscar mensagem interativa | path:interactiveMessagesId |
|
|
476
|
+
| `e166` | `POST` | `/api/v1/interactive-messages` | Criar mensagem interativa em lista | - |
|
|
477
|
+
| `e167` | `POST` | `/api/v1/interactive-messages` | Criar mensagem interativa com imagem | - |
|
|
478
|
+
| `e168` | `POST` | `/api/v1/messages` | Enviar mensagem interativa com botao | - |
|
|
479
|
+
| `e169` | `POST` | `/api/v1/messages` | Enviar mensagem interativa | - |
|
|
480
|
+
| `e170` | `DELETE` | `/api/v1/interactive-messages/{{interactiveMessagesId}}` | Excluir mensagem interativa | path:interactiveMessagesId |
|
|
481
|
+
|
|
482
|
+
## Meus dados (General)
|
|
483
|
+
|
|
484
|
+
| ID | Método | Caminho | Operação | Parâmetros detectados |
|
|
485
|
+
| --- | --- | --- | --- | --- |
|
|
486
|
+
| `e171` | `GET` | `/api/v1/me` | Buscar meus dados | - |
|
|
487
|
+
|
|
488
|
+
## Notificacao (General)
|
|
489
|
+
|
|
490
|
+
| ID | Método | Caminho | Operação | Parâmetros detectados |
|
|
491
|
+
| --- | --- | --- | --- | --- |
|
|
492
|
+
| `e172` | `PUT` | `/api/v1/contacts/{{contactId}}` | Marcar como nao lido | path:contactId |
|
|
493
|
+
| `e173` | `PUT` | `/api/v1/contacts/{{contactId}}` | Notificacao mensagens receptivas | path:contactId |
|
|
494
|
+
| `e174` | `PUT` | `/api/v1/contacts/{{contactId}}` | Silenciar contato | path:contactId |
|
|
495
|
+
|
|
496
|
+
## Organizacoes (General)
|
|
497
|
+
|
|
498
|
+
| ID | Método | Caminho | Operação | Parâmetros detectados |
|
|
499
|
+
| --- | --- | --- | --- | --- |
|
|
500
|
+
| `e175` | `GET` | `/api/v1/organizations` | Listar organizacoes | - |
|
|
501
|
+
| `e176` | `GET` | `/api/v1/organizations/{{organizationId}}` | Buscar organizacao | path:organizationId |
|
|
502
|
+
| `e177` | `PUT` | `/api/v1/organizations/{{organizationId}}` | Editar organizacao | path:organizationId |
|
|
503
|
+
| `e178` | `POST` | `/api/v1/organizations` | Criar organizacao | - |
|
|
504
|
+
| `e179` | `DELETE` | `/api/v1/organizations/{{organizationId}}` | Excluir organizacao | path:organizationId |
|
|
505
|
+
|
|
506
|
+
## Pessoas (General)
|
|
507
|
+
|
|
508
|
+
| ID | Método | Caminho | Operação | Parâmetros detectados |
|
|
509
|
+
| --- | --- | --- | --- | --- |
|
|
510
|
+
| `e180` | `GET` | `/api/v1/people` | Listar pessoas | - |
|
|
511
|
+
| `e181` | `GET` | `/api/v1/people/{{peopleId}}` | Buscar pessoa | path:peopleId |
|
|
512
|
+
| `e182` | `PUT` | `/api/v1/people/{{peopleId}}` | Editar pessoa | path:peopleId |
|
|
513
|
+
| `e183` | `POST` | `/api/v1/people` | Criar pessoa | - |
|
|
514
|
+
| `e184` | `DELETE` | `/api/v1/people/{{peopleId}}` | Excluir pessoa | path:peopleId |
|
|
515
|
+
|
|
516
|
+
## Planos (General)
|
|
517
|
+
|
|
518
|
+
| ID | Método | Caminho | Operação | Parâmetros detectados |
|
|
519
|
+
| --- | --- | --- | --- | --- |
|
|
520
|
+
| `e185` | `GET` | `/api/v1/plans` | Listar planos | - |
|
|
521
|
+
| `e186` | `GET` | `/api/v1/plans/{{planId}}` | Buscar plano | path:planId |
|
|
522
|
+
|
|
523
|
+
## Redefinir senha (General)
|
|
524
|
+
|
|
525
|
+
| ID | Método | Caminho | Operação | Parâmetros detectados |
|
|
526
|
+
| --- | --- | --- | --- | --- |
|
|
527
|
+
| `e187` | `POST` | `/api/v1/reset-password/request` | Solicitar uma nova senha | - |
|
|
528
|
+
|
|
529
|
+
## Respostas rapidas (General)
|
|
530
|
+
|
|
531
|
+
| ID | Método | Caminho | Operação | Parâmetros detectados |
|
|
532
|
+
| --- | --- | --- | --- | --- |
|
|
533
|
+
| `e188` | `GET` | `/api/v1/quick-replies` | Listar respostas rapidas | - |
|
|
534
|
+
| `e189` | `GET` | `/api/v1/quick-replies` | Listar textos e departamentos das respostas rapidas | - |
|
|
535
|
+
| `e190` | `GET` | `/api/v1/quick-replies` | Listar somente os textos das respostas rapidas | - |
|
|
536
|
+
| `e191` | `GET` | `/api/v1/quick-replies/{{quickRepliesId}}` | Buscar resposta rapida | path:quickRepliesId |
|
|
537
|
+
| `e192` | `PUT` | `/api/v1/quick-replies/{{quickRepliesId}}` | Editar resposta rapida | path:quickRepliesId |
|
|
538
|
+
| `e193` | `POST` | `/api/v1/quick-replies` | Criar resposta rapida | - |
|
|
539
|
+
| `e194` | `DELETE` | `/api/v1/quick-replies/{{quickRepliesId}}` | Excluir resposta rapida | path:quickRepliesId |
|
|
540
|
+
|
|
541
|
+
## Robos (General)
|
|
542
|
+
|
|
543
|
+
| ID | Método | Caminho | Operação | Parâmetros detectados |
|
|
544
|
+
| --- | --- | --- | --- | --- |
|
|
545
|
+
| `e195` | `GET` | `/api/v1/bots` | Listar bots V1 / V2 / V3 | - |
|
|
546
|
+
| `e196` | `GET` | `/api/v1/bots` | Listar bots V1 / V2 | - |
|
|
547
|
+
| `e197` | `GET` | `/api/v1/bots` | Listar bots V3 | - |
|
|
548
|
+
| `e198` | `GET` | `/api/v1/bots/{{botId}}` | Buscar bot | path:botId |
|
|
549
|
+
| `e199` | `PUT` | `/api/v1/bots/{{botId}}` | Editar bot | path:botId |
|
|
550
|
+
| `e200` | `DELETE` | `/api/v1/bots/{{botId}}` | Excluir bot | path:botId |
|
|
551
|
+
|
|
552
|
+
## Tags (General)
|
|
553
|
+
|
|
554
|
+
| ID | Método | Caminho | Operação | Parâmetros detectados |
|
|
555
|
+
| --- | --- | --- | --- | --- |
|
|
556
|
+
| `e201` | `GET` | `/api/v1/tags` | Listar tags | - |
|
|
557
|
+
| `e202` | `GET` | `/api/v1/tags/{{tagId}}` | Buscar tag | path:tagId |
|
|
558
|
+
| `e203` | `GET` | `/api/v1/contacts/{{contactId}}` | Buscar tags vinculadas a um contato | path:contactId |
|
|
559
|
+
| `e204` | `PUT` | `/api/v1/tags/{{tagId}}` | Editar tag | path:tagId |
|
|
560
|
+
| `e205` | `POST` | `/api/v1/tags` | Criar tag | - |
|
|
561
|
+
| `e206` | `POST` | `/api/v1/tags/{{tagId}}/contacts` | Adicona uma tag a multiplos contatos | path:tagId |
|
|
562
|
+
| `e207` | `DELETE` | `/api/v1/tags/{{tagId}}/contacts` | Remove uma tag a multiplos contatos | path:tagId |
|
|
563
|
+
| `e208` | `DELETE` | `/api/v1/tags/{{tagId}}` | Excluir tag | path:tagId |
|
|
564
|
+
|
|
565
|
+
## Templates (General)
|
|
566
|
+
|
|
567
|
+
| ID | Método | Caminho | Operação | Parâmetros detectados |
|
|
568
|
+
| --- | --- | --- | --- | --- |
|
|
569
|
+
| `e209` | `GET` | `/api/v1/whatsapp-business-templates` | Listar templates | - |
|
|
570
|
+
| `e210` | `GET` | `/api/v1/whatsapp-business-templates/{{templateId}}` | Buscar template | path:templateId |
|
|
571
|
+
| `e211` | `GET` | `/api/v1/whatsapp-business-templates/count` | Total de templates cadastrados | - |
|
|
572
|
+
| `e212` | `PUT` | `/api/v1/whatsapp-business-templates/{{templateId}}` | Editar template | path:templateId |
|
|
573
|
+
| `e213` | `POST` | `/api/v1/whatsapp-business-templates/{{hsmId}}/send-to-review` | Enviar template para aprovacao | path:hsmId |
|
|
574
|
+
| `e214` | `POST` | `/api/v1/whatsapp-business-templates/refresh-templates` | Sincronizar templates com o provedor | - |
|
|
575
|
+
| `e215` | `POST` | `/api/v1/messages` | Enviar template com botao | - |
|
|
576
|
+
| `e216` | `POST` | `/api/v1/messages` | Enviar template com URL no botao | - |
|
|
577
|
+
| `e217` | `POST` | `/api/v1/messages` | Envio de template com dois parametros | - |
|
|
578
|
+
| `e218` | `POST` | `/api/v1/whatsapp-business-templates` | Criar template somente com texto | - |
|
|
579
|
+
| `e219` | `DELETE` | `/api/v1/whatsapp-business-templates/{{templateId}}` | Excluir template | path:templateId |
|
|
580
|
+
|
|
581
|
+
## Termos de aceite (General)
|
|
582
|
+
|
|
583
|
+
| ID | Método | Caminho | Operação | Parâmetros detectados |
|
|
584
|
+
| --- | --- | --- | --- | --- |
|
|
585
|
+
| `e220` | `GET` | `/api/v1/acceptance-terms` | Listar termos de aceite | - |
|
|
586
|
+
| `e221` | `GET` | `/api/v1/acceptance-terms/{{termsId}}` | Buscar termo de aceite | path:termsId |
|
|
587
|
+
| `e222` | `PUT` | `/api/v1/acceptance-terms/{{termsId}}` | Editar termo de aceite | path:termsId |
|
|
588
|
+
| `e223` | `POST` | `/api/v1/acceptance-terms` | Criar termo de aceite | - |
|
|
589
|
+
| `e224` | `DELETE` | `/api/v1/acceptance-terms/{{termsId}}` | Excluir termo de aceite | path:termsId |
|
|
590
|
+
|
|
591
|
+
## Tokens (General)
|
|
592
|
+
|
|
593
|
+
| ID | Método | Caminho | Operação | Parâmetros detectados |
|
|
594
|
+
| --- | --- | --- | --- | --- |
|
|
595
|
+
| `e225` | `GET` | `/api/v1/me/tokens` | Listar tokens | - |
|
|
596
|
+
| `e226` | `GET` | `/api/v1/me/tokens/{{tokenId}}` | Buscar token | path:tokenId |
|
|
597
|
+
| `e227` | `PUT` | `/api/v1/me/tokens/{{tokenId}}` | Editar token | path:tokenId |
|
|
598
|
+
| `e228` | `POST` | `/api/v1/me/tokens` | Criar token | - |
|
|
599
|
+
| `e229` | `DELETE` | `/api/v1/me/tokens/{{tokenId}}` | Excluir token | path:tokenId |
|
|
600
|
+
|
|
601
|
+
## Usuarios (General)
|
|
602
|
+
|
|
603
|
+
| ID | Método | Caminho | Operação | Parâmetros detectados |
|
|
604
|
+
| --- | --- | --- | --- | --- |
|
|
605
|
+
| `e230` | `GET` | `/api/v1/users` | Listar usuarios | - |
|
|
606
|
+
| `e231` | `GET` | `/api/v1/users` | Listar usuarios com seus departamentos | - |
|
|
607
|
+
| `e232` | `GET` | `/api/v1/users/{{userId}}` | Buscar usuario | path:userId |
|
|
608
|
+
| `e233` | `PUT` | `/api/v1/users/{{userId}}` | Editar usuario | path:userId |
|
|
609
|
+
| `e234` | `POST` | `/api/v1/users` | Criar usuario | - |
|
|
610
|
+
| `e235` | `POST` | `/api/v1/users/{{userId}}/archive` | Arquiva usuario | path:userId |
|
|
611
|
+
|
|
612
|
+
## Versoes (General)
|
|
613
|
+
|
|
614
|
+
| ID | Método | Caminho | Operação | Parâmetros detectados |
|
|
615
|
+
| --- | --- | --- | --- | --- |
|
|
616
|
+
| `e236` | `GET` | `/api/v1/versions` | Versao da plataforma | - |
|
|
617
|
+
|
|
618
|
+
## Webhooks (General)
|
|
619
|
+
|
|
620
|
+
| ID | Método | Caminho | Operação | Parâmetros detectados |
|
|
621
|
+
| --- | --- | --- | --- | --- |
|
|
622
|
+
| `e237` | `GET` | `/api/v1/me/webhooks` | Listar webhooks | - |
|
|
623
|
+
| `e238` | `GET` | `/api/v1/me/webhooks/{{webhookId}}` | Buscar webhook | path:webhookId |
|
|
624
|
+
| `e239` | `PUT` | `/api/v1/me/webhooks/{{webhookId}}` | Editar webhook | path:webhookId |
|
|
625
|
+
| `e240` | `POST` | `/api/v1/me/webhooks` | Criar webhook | - |
|
|
626
|
+
| `e241` | `POST` | `{{link_Completo_Webhook}}` | Teste Webhook | - |
|
|
627
|
+
|
|
628
|
+
## WhatsApp (General)
|
|
629
|
+
|
|
630
|
+
| ID | Método | Caminho | Operação | Parâmetros detectados |
|
|
631
|
+
| --- | --- | --- | --- | --- |
|
|
632
|
+
| `e242` | `GET` | `/api/v1/contacts/exists` | Validacao WhatsApp | query:contactNumber, query:serviceId |
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "n8n-nodes-digisac",
|
|
3
|
-
"version": "1.0.
|
|
3
|
+
"version": "1.0.1",
|
|
4
4
|
"description": "n8n community node for the Digisac API: contacts, tickets, messages, campaigns, services, departments, users, tags, schedules, webhooks, reports and every documented Postman endpoint. Usable as an AI Agent tool.",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"n8n-community-node-package",
|
|
@@ -33,12 +33,14 @@
|
|
|
33
33
|
"dev": "tsc --watch",
|
|
34
34
|
"format": "prettier nodes credentials scripts package.json README.md --write",
|
|
35
35
|
"generate:endpoints": "node scripts/generate-endpoints.mjs",
|
|
36
|
+
"generate:docs": "node scripts/generate-docs.mjs",
|
|
36
37
|
"lint": "eslint nodes credentials package.json",
|
|
37
38
|
"lintfix": "eslint nodes credentials package.json --fix",
|
|
38
39
|
"prepublishOnly": "npm run build"
|
|
39
40
|
},
|
|
40
41
|
"files": [
|
|
41
|
-
"dist"
|
|
42
|
+
"dist",
|
|
43
|
+
"docs"
|
|
42
44
|
],
|
|
43
45
|
"n8n": {
|
|
44
46
|
"n8nNodesApiVersion": 1,
|