@lionchat/mcp-server 0.5.0 → 0.5.2
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/dist/docs/instructions.md +15 -0
- package/dist/docs/resources/api-conventions.md +26 -0
- package/dist/docs/resources/best-practices.md +22 -0
- package/dist/docs/resources/data-model.md +18 -1
- package/dist/docs/resources/flowbuilder-design-guide.md +63 -7
- package/dist/docs/resources/flowbuilder-patterns.md +50 -1
- package/dist/docs/resources/glossary.md +53 -8
- package/dist/docs/resources/kanban-deep-dive.md +26 -0
- package/dist/docs/resources/reports-guide.md +27 -0
- package/dist/tools.js +13 -4
- package/dist/tools.js.map +1 -1
- package/endpoints.json +735 -6
- package/package.json +1 -1
package/endpoints.json
CHANGED
|
@@ -2004,7 +2004,7 @@
|
|
|
2004
2004
|
"method": "GET",
|
|
2005
2005
|
"path": "/api/v1/accounts/{account_id}/conversations/{conversation_id}/messages/search",
|
|
2006
2006
|
"title": "Buscar Mensagens",
|
|
2007
|
-
"description": "Busca mensagens por texto dentro de uma conversa. Suporta private_only e file_type.\n\nNOVO (2026-06): 'q' aceita multiplos termos (espacos = E/AND, cap 5; cada termo precisa bater) e dados cadastrais (CPF/CNPJ/RG por digitos, ignora pontuacao).",
|
|
2007
|
+
"description": "Busca mensagens por texto dentro de uma conversa. Suporta private_only e file_type.\n\nNOVO (2026-06): 'q' aceita multiplos termos (espacos = E/AND, cap 5; cada termo precisa bater) e dados cadastrais (CPF/CNPJ/RG por digitos, ignora pontuacao). NOVO (2026-06-16): casa por TRECHO/substring (multi-termo AND — ex.: 'época d' acha 'época do'); e cada resultado de mensagem inclui previous_message e next_message (as mensagens anterior e seguinte da MESMA conversa, em ordem cronológica, ignorando eventos de sistema) como objeto {id, content, sender_name, message_type, private, created_at} ou null quando não há vizinha.",
|
|
2008
2008
|
"category": "Mensagens",
|
|
2009
2009
|
"params": [
|
|
2010
2010
|
{
|
|
@@ -7694,7 +7694,7 @@
|
|
|
7694
7694
|
"method": "GET",
|
|
7695
7695
|
"path": "/api/v1/accounts/{account_id}/search/messages",
|
|
7696
7696
|
"title": "Buscar Mensagens",
|
|
7697
|
-
"description": "Busca apenas em mensagens por texto.\n\nNOVO (2026-06): 'q' aceita multiplos termos (espacos = E/AND, cap 5; cada termo precisa bater) e dados cadastrais (CPF/CNPJ/RG por digitos, ignora pontuacao).",
|
|
7697
|
+
"description": "Busca apenas em mensagens por texto.\n\nNOVO (2026-06): 'q' aceita multiplos termos (espacos = E/AND, cap 5; cada termo precisa bater) e dados cadastrais (CPF/CNPJ/RG por digitos, ignora pontuacao). NOVO (2026-06-16): casa por TRECHO/substring (multi-termo AND — ex.: 'época d' acha 'época do'); e cada resultado de mensagem inclui previous_message e next_message (as mensagens anterior e seguinte da MESMA conversa, em ordem cronológica, ignorando eventos de sistema) como objeto {id, content, sender_name, message_type, private, created_at} ou null quando não há vizinha.",
|
|
7698
7698
|
"category": "Busca",
|
|
7699
7699
|
"params": [
|
|
7700
7700
|
{
|
|
@@ -12325,7 +12325,7 @@
|
|
|
12325
12325
|
"method": "POST",
|
|
12326
12326
|
"path": "/api/v1/accounts/{account_id}/account_variables",
|
|
12327
12327
|
"title": "Criar Variável",
|
|
12328
|
-
"description": "Cria uma nova variável da conta.
|
|
12328
|
+
"description": "Cria uma nova variável da conta. Para valor secreto/criptografado, use attribute_display_type=secret (o apelido legado encrypted_text também funciona). Cria novo variável de conta. Obrigatórios: key. Valida unicidade quando aplicável. Retorna o variável de conta criado com ID atribuído.",
|
|
12329
12329
|
"category": "Variaveis da Conta",
|
|
12330
12330
|
"params": [
|
|
12331
12331
|
{
|
|
@@ -12354,7 +12354,7 @@
|
|
|
12354
12354
|
"type": "string",
|
|
12355
12355
|
"location": "body",
|
|
12356
12356
|
"required": false,
|
|
12357
|
-
"description": "Tipo do valor: text (
|
|
12357
|
+
"description": "Tipo do valor: text (padrão), secret (valor secreto — guardado criptografado), number, checkbox, list, link, date. Apelido legado: encrypted_text é aceito e convertido para secret automaticamente. Tipo fora dessa lista retorna 422."
|
|
12358
12358
|
},
|
|
12359
12359
|
{
|
|
12360
12360
|
"name": "value",
|
|
@@ -19211,7 +19211,7 @@
|
|
|
19211
19211
|
"method": "POST",
|
|
19212
19212
|
"path": "/api/v1/accounts/{account_id}/inbox_members",
|
|
19213
19213
|
"title": "Definir Membros da Inbox",
|
|
19214
|
-
"description": "Define os agentes membros da inbox (substitui a lista). Para adicionar incrementalmente, leia a lista atual e mescle.",
|
|
19214
|
+
"description": "Define os agentes membros da inbox (substitui a lista). Para adicionar incrementalmente, leia a lista atual e mescle. Use supervisor_ids[] para marcar supervisores (veem tudo, fora da distribuicao automatica); a resposta traz is_supervisor por agente.",
|
|
19215
19215
|
"category": "Membros de Inbox",
|
|
19216
19216
|
"params": [
|
|
19217
19217
|
{
|
|
@@ -19227,6 +19227,13 @@
|
|
|
19227
19227
|
"location": "body",
|
|
19228
19228
|
"required": true,
|
|
19229
19229
|
"description": "Array de IDs dos agentes"
|
|
19230
|
+
},
|
|
19231
|
+
{
|
|
19232
|
+
"name": "supervisor_ids",
|
|
19233
|
+
"type": "array",
|
|
19234
|
+
"location": "body",
|
|
19235
|
+
"required": false,
|
|
19236
|
+
"description": "IDs dos membros que entram como SUPERVISORES da caixa: veem TODAS as conversas/cards dela, mas ficam FORA da distribuicao automatica (round-robin). Quem nao estiver aqui (e estiver em user_ids) vira agente normal. A resposta traz is_supervisor por agente."
|
|
19230
19237
|
}
|
|
19231
19238
|
],
|
|
19232
19239
|
"returns": "lista de agentes atualizada",
|
|
@@ -19274,7 +19281,7 @@
|
|
|
19274
19281
|
"method": "PATCH",
|
|
19275
19282
|
"path": "/api/v1/accounts/{account_id}/inbox_members",
|
|
19276
19283
|
"title": "Atualizar Membros da Inbox",
|
|
19277
|
-
"description": "Atualiza os agentes membros da inbox (substitui a lista).",
|
|
19284
|
+
"description": "Atualiza os agentes membros da inbox (substitui a lista). Use supervisor_ids[] para marcar supervisores (veem tudo, fora da distribuicao automatica); a resposta traz is_supervisor por agente.",
|
|
19278
19285
|
"category": "Membros de Inbox",
|
|
19279
19286
|
"params": [
|
|
19280
19287
|
{
|
|
@@ -19290,6 +19297,13 @@
|
|
|
19290
19297
|
"location": "body",
|
|
19291
19298
|
"required": true,
|
|
19292
19299
|
"description": "Nova lista de IDs"
|
|
19300
|
+
},
|
|
19301
|
+
{
|
|
19302
|
+
"name": "supervisor_ids",
|
|
19303
|
+
"type": "array",
|
|
19304
|
+
"location": "body",
|
|
19305
|
+
"required": false,
|
|
19306
|
+
"description": "IDs dos membros que entram como SUPERVISORES da caixa: veem TODAS as conversas/cards dela, mas ficam FORA da distribuicao automatica (round-robin). Quem nao estiver aqui (e estiver em user_ids) vira agente normal. A resposta traz is_supervisor por agente."
|
|
19293
19307
|
}
|
|
19294
19308
|
],
|
|
19295
19309
|
"returns": "lista de agentes atualizada",
|
|
@@ -23402,5 +23416,720 @@
|
|
|
23402
23416
|
"related_tools": [
|
|
23403
23417
|
"lionchat_journey_funnel_reports"
|
|
23404
23418
|
]
|
|
23419
|
+
},
|
|
23420
|
+
{
|
|
23421
|
+
"id": "lionchat_wavoip_status",
|
|
23422
|
+
"method": "GET",
|
|
23423
|
+
"path": "/api/v1/accounts/{account_id}/inboxes/{inbox_id}/wavoip/status",
|
|
23424
|
+
"title": "Status da Ligação WP (Wavoip)",
|
|
23425
|
+
"description": "Status do device Wavoip da caixa QR Code: conectado, vencimento, QR pra parear. Flag wavoip_calling.",
|
|
23426
|
+
"category": "Ligacao WP (Wavoip)",
|
|
23427
|
+
"params": [
|
|
23428
|
+
{
|
|
23429
|
+
"name": "inbox_id",
|
|
23430
|
+
"type": "integer",
|
|
23431
|
+
"location": "path",
|
|
23432
|
+
"required": true,
|
|
23433
|
+
"description": "ID da caixa de entrada (WhatsApp QR Code)"
|
|
23434
|
+
}
|
|
23435
|
+
],
|
|
23436
|
+
"returns": "{ status, due_date, qr_url, num_channels }",
|
|
23437
|
+
"common_use_cases": [
|
|
23438
|
+
"Diagnosticar ligação que não conecta"
|
|
23439
|
+
],
|
|
23440
|
+
"related_tools": [
|
|
23441
|
+
"lionchat_wavoip_connect"
|
|
23442
|
+
]
|
|
23443
|
+
},
|
|
23444
|
+
{
|
|
23445
|
+
"id": "lionchat_wavoip_calls",
|
|
23446
|
+
"method": "GET",
|
|
23447
|
+
"path": "/api/v1/accounts/{account_id}/inboxes/{inbox_id}/wavoip/calls",
|
|
23448
|
+
"title": "Histórico de Ligações WP",
|
|
23449
|
+
"description": "Histórico de ligações de voz da caixa (Wavoip), com gravação e transcrição quando configuradas. Membro da caixa pode ver.",
|
|
23450
|
+
"category": "Ligacao WP (Wavoip)",
|
|
23451
|
+
"params": [
|
|
23452
|
+
{
|
|
23453
|
+
"name": "inbox_id",
|
|
23454
|
+
"type": "integer",
|
|
23455
|
+
"location": "path",
|
|
23456
|
+
"required": true,
|
|
23457
|
+
"description": "ID da caixa de entrada (WhatsApp QR Code)"
|
|
23458
|
+
},
|
|
23459
|
+
{
|
|
23460
|
+
"name": "status",
|
|
23461
|
+
"type": "string",
|
|
23462
|
+
"location": "query",
|
|
23463
|
+
"required": false,
|
|
23464
|
+
"description": "Filtro por status"
|
|
23465
|
+
},
|
|
23466
|
+
{
|
|
23467
|
+
"name": "agent_id",
|
|
23468
|
+
"type": "integer",
|
|
23469
|
+
"location": "query",
|
|
23470
|
+
"required": false,
|
|
23471
|
+
"description": "Por agente"
|
|
23472
|
+
},
|
|
23473
|
+
{
|
|
23474
|
+
"name": "date_from",
|
|
23475
|
+
"type": "string",
|
|
23476
|
+
"location": "query",
|
|
23477
|
+
"required": false,
|
|
23478
|
+
"description": "Início ISO 8601"
|
|
23479
|
+
},
|
|
23480
|
+
{
|
|
23481
|
+
"name": "date_to",
|
|
23482
|
+
"type": "string",
|
|
23483
|
+
"location": "query",
|
|
23484
|
+
"required": false,
|
|
23485
|
+
"description": "Fim ISO 8601"
|
|
23486
|
+
},
|
|
23487
|
+
{
|
|
23488
|
+
"name": "favorited",
|
|
23489
|
+
"type": "boolean",
|
|
23490
|
+
"location": "query",
|
|
23491
|
+
"required": false,
|
|
23492
|
+
"description": "Só favoritas"
|
|
23493
|
+
},
|
|
23494
|
+
{
|
|
23495
|
+
"name": "q",
|
|
23496
|
+
"type": "string",
|
|
23497
|
+
"location": "query",
|
|
23498
|
+
"required": false,
|
|
23499
|
+
"description": "Busca por nome/telefone"
|
|
23500
|
+
}
|
|
23501
|
+
],
|
|
23502
|
+
"returns": "{ calls: [...], meta }",
|
|
23503
|
+
"common_use_cases": [
|
|
23504
|
+
"Ver ligações do dia",
|
|
23505
|
+
"Achar gravação de uma ligação"
|
|
23506
|
+
],
|
|
23507
|
+
"related_tools": [
|
|
23508
|
+
"lionchat_wavoip_settings_update"
|
|
23509
|
+
]
|
|
23510
|
+
},
|
|
23511
|
+
{
|
|
23512
|
+
"id": "lionchat_wavoip_token",
|
|
23513
|
+
"method": "GET",
|
|
23514
|
+
"path": "/api/v1/accounts/{account_id}/inboxes/{inbox_id}/wavoip/token",
|
|
23515
|
+
"title": "Token do Device Wavoip (agente)",
|
|
23516
|
+
"description": "Token do device pro agente discar/atender no widget. Membro da caixa.",
|
|
23517
|
+
"category": "Ligacao WP (Wavoip)",
|
|
23518
|
+
"params": [
|
|
23519
|
+
{
|
|
23520
|
+
"name": "inbox_id",
|
|
23521
|
+
"type": "integer",
|
|
23522
|
+
"location": "path",
|
|
23523
|
+
"required": true,
|
|
23524
|
+
"description": "ID da caixa de entrada (WhatsApp QR Code)"
|
|
23525
|
+
}
|
|
23526
|
+
],
|
|
23527
|
+
"returns": "{ token }",
|
|
23528
|
+
"common_use_cases": [
|
|
23529
|
+
"Destravar o discador de um agente"
|
|
23530
|
+
],
|
|
23531
|
+
"related_tools": []
|
|
23532
|
+
},
|
|
23533
|
+
{
|
|
23534
|
+
"id": "lionchat_wavoip_connect",
|
|
23535
|
+
"method": "POST",
|
|
23536
|
+
"path": "/api/v1/accounts/{account_id}/inboxes/{inbox_id}/wavoip/connect",
|
|
23537
|
+
"title": "Conectar Ligação WP",
|
|
23538
|
+
"description": "Cria o device Wavoip da caixa (checa limite do plano wavoip_voice_inboxes; custo R$70/device/mês). ADMIN. Mudança de config — confirme com o usuário.",
|
|
23539
|
+
"category": "Ligacao WP (Wavoip)",
|
|
23540
|
+
"params": [
|
|
23541
|
+
{
|
|
23542
|
+
"name": "inbox_id",
|
|
23543
|
+
"type": "integer",
|
|
23544
|
+
"location": "path",
|
|
23545
|
+
"required": true,
|
|
23546
|
+
"description": "ID da caixa de entrada (WhatsApp QR Code)"
|
|
23547
|
+
}
|
|
23548
|
+
],
|
|
23549
|
+
"returns": "{ status, qr_url }",
|
|
23550
|
+
"common_use_cases": [
|
|
23551
|
+
"Ativar voz numa caixa QR Code"
|
|
23552
|
+
],
|
|
23553
|
+
"related_tools": [
|
|
23554
|
+
"lionchat_wavoip_status"
|
|
23555
|
+
]
|
|
23556
|
+
},
|
|
23557
|
+
{
|
|
23558
|
+
"id": "lionchat_wavoip_disconnect",
|
|
23559
|
+
"method": "POST",
|
|
23560
|
+
"path": "/api/v1/accounts/{account_id}/inboxes/{inbox_id}/wavoip/disconnect",
|
|
23561
|
+
"title": "Desconectar Ligação WP",
|
|
23562
|
+
"description": "Deleta o device Wavoip (cancela a cobrança). ADMIN. DESTRUTIVO — confirme antes.",
|
|
23563
|
+
"category": "Ligacao WP (Wavoip)",
|
|
23564
|
+
"params": [
|
|
23565
|
+
{
|
|
23566
|
+
"name": "inbox_id",
|
|
23567
|
+
"type": "integer",
|
|
23568
|
+
"location": "path",
|
|
23569
|
+
"required": true,
|
|
23570
|
+
"description": "ID da caixa de entrada (WhatsApp QR Code)"
|
|
23571
|
+
}
|
|
23572
|
+
],
|
|
23573
|
+
"returns": "200 OK",
|
|
23574
|
+
"common_use_cases": [
|
|
23575
|
+
"Desativar voz e parar cobrança"
|
|
23576
|
+
],
|
|
23577
|
+
"related_tools": []
|
|
23578
|
+
},
|
|
23579
|
+
{
|
|
23580
|
+
"id": "lionchat_wavoip_settings_update",
|
|
23581
|
+
"method": "PUT",
|
|
23582
|
+
"path": "/api/v1/accounts/{account_id}/inboxes/{inbox_id}/wavoip/settings",
|
|
23583
|
+
"title": "Configurar Gravação/Transcrição (Wavoip)",
|
|
23584
|
+
"description": "Define gravação e transcrição automática das ligações da caixa. ADMIN.",
|
|
23585
|
+
"category": "Ligacao WP (Wavoip)",
|
|
23586
|
+
"params": [
|
|
23587
|
+
{
|
|
23588
|
+
"name": "inbox_id",
|
|
23589
|
+
"type": "integer",
|
|
23590
|
+
"location": "path",
|
|
23591
|
+
"required": true,
|
|
23592
|
+
"description": "ID da caixa de entrada (WhatsApp QR Code)"
|
|
23593
|
+
},
|
|
23594
|
+
{
|
|
23595
|
+
"name": "record_all_calls",
|
|
23596
|
+
"type": "boolean",
|
|
23597
|
+
"location": "body",
|
|
23598
|
+
"required": false,
|
|
23599
|
+
"description": "Gravar todas as ligações"
|
|
23600
|
+
},
|
|
23601
|
+
{
|
|
23602
|
+
"name": "auto_transcribe",
|
|
23603
|
+
"type": "boolean",
|
|
23604
|
+
"location": "body",
|
|
23605
|
+
"required": false,
|
|
23606
|
+
"description": "Transcrever automaticamente com IA"
|
|
23607
|
+
},
|
|
23608
|
+
{
|
|
23609
|
+
"name": "transcription_provider",
|
|
23610
|
+
"type": "string",
|
|
23611
|
+
"location": "body",
|
|
23612
|
+
"required": false,
|
|
23613
|
+
"description": "groq | openai"
|
|
23614
|
+
}
|
|
23615
|
+
],
|
|
23616
|
+
"returns": "{ settings }",
|
|
23617
|
+
"common_use_cases": [
|
|
23618
|
+
"Ligar gravação + transcrição automática"
|
|
23619
|
+
],
|
|
23620
|
+
"related_tools": []
|
|
23621
|
+
},
|
|
23622
|
+
{
|
|
23623
|
+
"id": "lionchat_contacts_documents_list",
|
|
23624
|
+
"method": "GET",
|
|
23625
|
+
"path": "/api/v1/accounts/{account_id}/contacts/{contact_id}/documents",
|
|
23626
|
+
"title": "Documentos do Contato",
|
|
23627
|
+
"description": "Central de arquivos do contato: uploads diretos + espelho dos anexos dos cards Kanban + das conversas (só imagem/documento). Dedup por arquivo.",
|
|
23628
|
+
"category": "Documentos do Contato",
|
|
23629
|
+
"params": [
|
|
23630
|
+
{
|
|
23631
|
+
"name": "contact_id",
|
|
23632
|
+
"type": "integer",
|
|
23633
|
+
"location": "path",
|
|
23634
|
+
"required": true,
|
|
23635
|
+
"description": "ID do contato"
|
|
23636
|
+
}
|
|
23637
|
+
],
|
|
23638
|
+
"returns": "{ documents: [{ id, name, source (upload|kanban|conversation), favorited, url, created_at }] }",
|
|
23639
|
+
"common_use_cases": [
|
|
23640
|
+
"Ver todos os arquivos de um cliente num lugar só"
|
|
23641
|
+
],
|
|
23642
|
+
"related_tools": [
|
|
23643
|
+
"lionchat_contacts_documents_create"
|
|
23644
|
+
]
|
|
23645
|
+
},
|
|
23646
|
+
{
|
|
23647
|
+
"id": "lionchat_contacts_documents_create",
|
|
23648
|
+
"method": "POST",
|
|
23649
|
+
"path": "/api/v1/accounts/{account_id}/contacts/{contact_id}/documents",
|
|
23650
|
+
"title": "Adicionar Documento ao Contato",
|
|
23651
|
+
"description": "Upload direto de arquivo pro contato (via MCP: use lionchat_upload_create antes e passe a URL/signed_id, se suportado — upload multipart direto não é suportado).",
|
|
23652
|
+
"category": "Documentos do Contato",
|
|
23653
|
+
"params": [
|
|
23654
|
+
{
|
|
23655
|
+
"name": "contact_id",
|
|
23656
|
+
"type": "integer",
|
|
23657
|
+
"location": "path",
|
|
23658
|
+
"required": true,
|
|
23659
|
+
"description": "ID do contato"
|
|
23660
|
+
},
|
|
23661
|
+
{
|
|
23662
|
+
"name": "file",
|
|
23663
|
+
"type": "string",
|
|
23664
|
+
"location": "body",
|
|
23665
|
+
"required": false,
|
|
23666
|
+
"description": "Arquivo (signed_id do upload ou URL)"
|
|
23667
|
+
},
|
|
23668
|
+
{
|
|
23669
|
+
"name": "name",
|
|
23670
|
+
"type": "string",
|
|
23671
|
+
"location": "body",
|
|
23672
|
+
"required": false,
|
|
23673
|
+
"description": "Nome de exibição"
|
|
23674
|
+
}
|
|
23675
|
+
],
|
|
23676
|
+
"returns": "{ document } (201)",
|
|
23677
|
+
"common_use_cases": [
|
|
23678
|
+
"Guardar contrato/documento do cliente"
|
|
23679
|
+
],
|
|
23680
|
+
"related_tools": [
|
|
23681
|
+
"lionchat_upload_create"
|
|
23682
|
+
]
|
|
23683
|
+
},
|
|
23684
|
+
{
|
|
23685
|
+
"id": "lionchat_contacts_documents_update",
|
|
23686
|
+
"method": "PATCH",
|
|
23687
|
+
"path": "/api/v1/accounts/{account_id}/contacts/{contact_id}/documents/{id}",
|
|
23688
|
+
"title": "Renomear/Favoritar Documento",
|
|
23689
|
+
"description": "Renomeia ou favorita um documento direto do contato.",
|
|
23690
|
+
"category": "Documentos do Contato",
|
|
23691
|
+
"params": [
|
|
23692
|
+
{
|
|
23693
|
+
"name": "contact_id",
|
|
23694
|
+
"type": "integer",
|
|
23695
|
+
"location": "path",
|
|
23696
|
+
"required": true,
|
|
23697
|
+
"description": "ID do contato"
|
|
23698
|
+
},
|
|
23699
|
+
{
|
|
23700
|
+
"name": "id",
|
|
23701
|
+
"type": "integer",
|
|
23702
|
+
"location": "path",
|
|
23703
|
+
"required": true,
|
|
23704
|
+
"description": "ID do documento"
|
|
23705
|
+
},
|
|
23706
|
+
{
|
|
23707
|
+
"name": "name",
|
|
23708
|
+
"type": "string",
|
|
23709
|
+
"location": "body",
|
|
23710
|
+
"required": false,
|
|
23711
|
+
"description": "Novo nome"
|
|
23712
|
+
},
|
|
23713
|
+
{
|
|
23714
|
+
"name": "favorited",
|
|
23715
|
+
"type": "boolean",
|
|
23716
|
+
"location": "body",
|
|
23717
|
+
"required": false,
|
|
23718
|
+
"description": "Favoritar"
|
|
23719
|
+
}
|
|
23720
|
+
],
|
|
23721
|
+
"returns": "{ document }",
|
|
23722
|
+
"common_use_cases": [
|
|
23723
|
+
"Organizar arquivos do cliente"
|
|
23724
|
+
],
|
|
23725
|
+
"related_tools": []
|
|
23726
|
+
},
|
|
23727
|
+
{
|
|
23728
|
+
"id": "lionchat_contacts_documents_destroy",
|
|
23729
|
+
"method": "DELETE",
|
|
23730
|
+
"path": "/api/v1/accounts/{account_id}/contacts/{contact_id}/documents/{id}",
|
|
23731
|
+
"title": "Excluir Documento do Contato",
|
|
23732
|
+
"description": "Exclui documento de upload direto. DESTRUTIVO — confirme antes. (Anexos de conversa são só-leitura.)",
|
|
23733
|
+
"category": "Documentos do Contato",
|
|
23734
|
+
"params": [
|
|
23735
|
+
{
|
|
23736
|
+
"name": "contact_id",
|
|
23737
|
+
"type": "integer",
|
|
23738
|
+
"location": "path",
|
|
23739
|
+
"required": true,
|
|
23740
|
+
"description": "ID do contato"
|
|
23741
|
+
},
|
|
23742
|
+
{
|
|
23743
|
+
"name": "id",
|
|
23744
|
+
"type": "integer",
|
|
23745
|
+
"location": "path",
|
|
23746
|
+
"required": true,
|
|
23747
|
+
"description": "ID do documento"
|
|
23748
|
+
}
|
|
23749
|
+
],
|
|
23750
|
+
"returns": "200 OK",
|
|
23751
|
+
"common_use_cases": [
|
|
23752
|
+
"Remover arquivo errado"
|
|
23753
|
+
],
|
|
23754
|
+
"related_tools": []
|
|
23755
|
+
},
|
|
23756
|
+
{
|
|
23757
|
+
"id": "lionchat_contacts_documents_mirror",
|
|
23758
|
+
"method": "POST",
|
|
23759
|
+
"path": "/api/v1/accounts/{account_id}/contacts/{contact_id}/documents/mirror",
|
|
23760
|
+
"title": "Ajustar Documento Espelhado",
|
|
23761
|
+
"description": "Define nome/favorito de um anexo espelhado (de card Kanban/conversa) sem alterar o original.",
|
|
23762
|
+
"category": "Documentos do Contato",
|
|
23763
|
+
"params": [
|
|
23764
|
+
{
|
|
23765
|
+
"name": "contact_id",
|
|
23766
|
+
"type": "integer",
|
|
23767
|
+
"location": "path",
|
|
23768
|
+
"required": true,
|
|
23769
|
+
"description": "ID do contato"
|
|
23770
|
+
},
|
|
23771
|
+
{
|
|
23772
|
+
"name": "attachment_id",
|
|
23773
|
+
"type": "integer",
|
|
23774
|
+
"location": "body",
|
|
23775
|
+
"required": true,
|
|
23776
|
+
"description": "ID do anexo espelhado"
|
|
23777
|
+
},
|
|
23778
|
+
{
|
|
23779
|
+
"name": "name",
|
|
23780
|
+
"type": "string",
|
|
23781
|
+
"location": "body",
|
|
23782
|
+
"required": false,
|
|
23783
|
+
"description": "Nome de exibição"
|
|
23784
|
+
},
|
|
23785
|
+
{
|
|
23786
|
+
"name": "favorited",
|
|
23787
|
+
"type": "boolean",
|
|
23788
|
+
"location": "body",
|
|
23789
|
+
"required": false,
|
|
23790
|
+
"description": "Favoritar"
|
|
23791
|
+
}
|
|
23792
|
+
],
|
|
23793
|
+
"returns": "{ document }",
|
|
23794
|
+
"common_use_cases": [
|
|
23795
|
+
"Renomear arquivo vindo do card"
|
|
23796
|
+
],
|
|
23797
|
+
"related_tools": []
|
|
23798
|
+
},
|
|
23799
|
+
{
|
|
23800
|
+
"id": "lionchat_contacts_documents_destroy_mirror",
|
|
23801
|
+
"method": "DELETE",
|
|
23802
|
+
"path": "/api/v1/accounts/{account_id}/contacts/{contact_id}/documents/mirror/{attachment_id}",
|
|
23803
|
+
"title": "Excluir Anexo Espelhado (card)",
|
|
23804
|
+
"description": "Exclui o anexo do CARD Kanban espelhado na aba Documentos (anexos de conversa não podem). DESTRUTIVO — confirme antes.",
|
|
23805
|
+
"category": "Documentos do Contato",
|
|
23806
|
+
"params": [
|
|
23807
|
+
{
|
|
23808
|
+
"name": "contact_id",
|
|
23809
|
+
"type": "integer",
|
|
23810
|
+
"location": "path",
|
|
23811
|
+
"required": true,
|
|
23812
|
+
"description": "ID do contato"
|
|
23813
|
+
},
|
|
23814
|
+
{
|
|
23815
|
+
"name": "attachment_id",
|
|
23816
|
+
"type": "integer",
|
|
23817
|
+
"location": "path",
|
|
23818
|
+
"required": true,
|
|
23819
|
+
"description": "ID do anexo do card"
|
|
23820
|
+
}
|
|
23821
|
+
],
|
|
23822
|
+
"returns": "200 OK",
|
|
23823
|
+
"common_use_cases": [
|
|
23824
|
+
"Limpar arquivo do card"
|
|
23825
|
+
],
|
|
23826
|
+
"related_tools": []
|
|
23827
|
+
},
|
|
23828
|
+
{
|
|
23829
|
+
"id": "lionchat_inboxes_update",
|
|
23830
|
+
"method": "PATCH",
|
|
23831
|
+
"path": "/api/v1/accounts/{account_id}/inboxes/{id}",
|
|
23832
|
+
"title": "Atualizar Caixa de Entrada",
|
|
23833
|
+
"description": "Atualiza configurações da caixa (nome, saudação, atribuição automática, atributos extras). MUDANÇA DE CONFIG — confirme com o usuário antes. additional_attributes.mark_as_seen (bool, default true, SÓ WhatsApp oficial, 2026-06-11): envia o visto/check azul quando o agente abre a conversa — desligar em coexistência app+API. ATENÇÃO: enviar additional_attributes substitui o objeto; para WAHA prefira não mexer nesse campo (config sensível).",
|
|
23834
|
+
"category": "Caixas de Entrada",
|
|
23835
|
+
"params": [
|
|
23836
|
+
{
|
|
23837
|
+
"name": "id",
|
|
23838
|
+
"type": "integer",
|
|
23839
|
+
"location": "path",
|
|
23840
|
+
"required": true,
|
|
23841
|
+
"description": "ID da caixa"
|
|
23842
|
+
},
|
|
23843
|
+
{
|
|
23844
|
+
"name": "name",
|
|
23845
|
+
"type": "string",
|
|
23846
|
+
"location": "body",
|
|
23847
|
+
"required": false,
|
|
23848
|
+
"description": "Novo nome"
|
|
23849
|
+
},
|
|
23850
|
+
{
|
|
23851
|
+
"name": "greeting_enabled",
|
|
23852
|
+
"type": "boolean",
|
|
23853
|
+
"location": "body",
|
|
23854
|
+
"required": false,
|
|
23855
|
+
"description": "Saudação automática ligada"
|
|
23856
|
+
},
|
|
23857
|
+
{
|
|
23858
|
+
"name": "greeting_message",
|
|
23859
|
+
"type": "string",
|
|
23860
|
+
"location": "body",
|
|
23861
|
+
"required": false,
|
|
23862
|
+
"description": "Texto da saudação"
|
|
23863
|
+
},
|
|
23864
|
+
{
|
|
23865
|
+
"name": "enable_auto_assignment",
|
|
23866
|
+
"type": "boolean",
|
|
23867
|
+
"location": "body",
|
|
23868
|
+
"required": false,
|
|
23869
|
+
"description": "Atribuição automática"
|
|
23870
|
+
},
|
|
23871
|
+
{
|
|
23872
|
+
"name": "additional_attributes",
|
|
23873
|
+
"type": "object",
|
|
23874
|
+
"location": "body",
|
|
23875
|
+
"required": false,
|
|
23876
|
+
"description": "Atributos extras (ex: { mark_as_seen: false } no WhatsApp oficial)"
|
|
23877
|
+
}
|
|
23878
|
+
],
|
|
23879
|
+
"returns": "{ inbox }",
|
|
23880
|
+
"common_use_cases": [
|
|
23881
|
+
"Desligar o visto numa caixa em coexistência",
|
|
23882
|
+
"Trocar saudação da caixa"
|
|
23883
|
+
],
|
|
23884
|
+
"related_tools": [
|
|
23885
|
+
"lionchat_inboxes_show"
|
|
23886
|
+
]
|
|
23887
|
+
},
|
|
23888
|
+
{
|
|
23889
|
+
"id": "lionchat_lead_origin_reports",
|
|
23890
|
+
"method": "GET",
|
|
23891
|
+
"path": "/api/v2/accounts/{account_id}/lead_origin_reports",
|
|
23892
|
+
"title": "Relatório de Origem dos Leads",
|
|
23893
|
+
"description": "SÓ LEITURA. Agregado de origem dos leads/conversas: de qual plataforma, tipo, campanha, conjunto de anúncios e criativo vieram, com totais e taxa de conversão. Janela padrão: últimos 30 dias. Cruza os atributos origin_* das conversas + leads órfãos (contatos sem conversa); 'won' = cards em estágios de ganho do Kanban; leads únicos deduplicados por telefone. Permite drill-down por níveis (plataforma → tipo → campanha → conjunto → criativo).",
|
|
23894
|
+
"category": "Relatorios",
|
|
23895
|
+
"params": [
|
|
23896
|
+
{
|
|
23897
|
+
"name": "since",
|
|
23898
|
+
"type": "string",
|
|
23899
|
+
"location": "query",
|
|
23900
|
+
"required": false,
|
|
23901
|
+
"description": "Início ISO 8601 (padrão: 30 dias atrás)"
|
|
23902
|
+
},
|
|
23903
|
+
{
|
|
23904
|
+
"name": "until",
|
|
23905
|
+
"type": "string",
|
|
23906
|
+
"location": "query",
|
|
23907
|
+
"required": false,
|
|
23908
|
+
"description": "Fim ISO 8601 (padrão: agora)"
|
|
23909
|
+
},
|
|
23910
|
+
{
|
|
23911
|
+
"name": "funnel_id",
|
|
23912
|
+
"type": "integer",
|
|
23913
|
+
"location": "query",
|
|
23914
|
+
"required": false,
|
|
23915
|
+
"description": "Filtra por funil do Kanban"
|
|
23916
|
+
},
|
|
23917
|
+
{
|
|
23918
|
+
"name": "platform",
|
|
23919
|
+
"type": "string",
|
|
23920
|
+
"location": "query",
|
|
23921
|
+
"required": false,
|
|
23922
|
+
"description": "Filtra por plataforma de origem"
|
|
23923
|
+
},
|
|
23924
|
+
{
|
|
23925
|
+
"name": "kind",
|
|
23926
|
+
"type": "string",
|
|
23927
|
+
"location": "query",
|
|
23928
|
+
"required": false,
|
|
23929
|
+
"description": "Filtra por tipo de origem"
|
|
23930
|
+
},
|
|
23931
|
+
{
|
|
23932
|
+
"name": "campaign",
|
|
23933
|
+
"type": "string",
|
|
23934
|
+
"location": "query",
|
|
23935
|
+
"required": false,
|
|
23936
|
+
"description": "Filtra por campanha"
|
|
23937
|
+
},
|
|
23938
|
+
{
|
|
23939
|
+
"name": "adset",
|
|
23940
|
+
"type": "string",
|
|
23941
|
+
"location": "query",
|
|
23942
|
+
"required": false,
|
|
23943
|
+
"description": "Filtra por conjunto de anúncios"
|
|
23944
|
+
},
|
|
23945
|
+
{
|
|
23946
|
+
"name": "group_by",
|
|
23947
|
+
"type": "string",
|
|
23948
|
+
"location": "query",
|
|
23949
|
+
"required": false,
|
|
23950
|
+
"description": "Agrupamento do resultado: platform, kind, campaign, adset ou creative"
|
|
23951
|
+
}
|
|
23952
|
+
],
|
|
23953
|
+
"returns": "{ period, totals: { conversations, classified, unclassified, orphan_leads, unique_leads, won_leads, conversion_rate }, by_platform, by_kind, by_campaign, by_adset, by_creative }",
|
|
23954
|
+
"common_use_cases": [
|
|
23955
|
+
"Ver de onde vêm os leads (campanha, anúncio, plataforma)",
|
|
23956
|
+
"Medir taxa de conversão por origem",
|
|
23957
|
+
"Comparar desempenho de campanhas/criativos"
|
|
23958
|
+
],
|
|
23959
|
+
"related_tools": [
|
|
23960
|
+
"lionchat_journey_funnel_reports"
|
|
23961
|
+
]
|
|
23962
|
+
},
|
|
23963
|
+
{
|
|
23964
|
+
"id": "lionchat_inboxes_whatsapp_history_start",
|
|
23965
|
+
"method": "POST",
|
|
23966
|
+
"path": "/api/v1/accounts/{account_id}/inboxes/{inbox_id}/whatsapp_history/start",
|
|
23967
|
+
"title": "Importar Histórico WhatsApp Cloud (Iniciar)",
|
|
23968
|
+
"description": "AÇÃO DE ESCRITA. Inicia a importação do histórico de conversas antigas para uma caixa WhatsApp Cloud (API oficial), lendo um QR Code (coexistência — não desconecta o número oficial). Só admin + requer a feature qr_history_import. Acompanhe pelo status.",
|
|
23969
|
+
"category": "Caixas de Entrada",
|
|
23970
|
+
"params": [
|
|
23971
|
+
{
|
|
23972
|
+
"name": "inbox_id",
|
|
23973
|
+
"type": "integer",
|
|
23974
|
+
"location": "path",
|
|
23975
|
+
"required": true,
|
|
23976
|
+
"description": "ID da caixa WhatsApp Cloud"
|
|
23977
|
+
},
|
|
23978
|
+
{
|
|
23979
|
+
"name": "days",
|
|
23980
|
+
"type": "integer",
|
|
23981
|
+
"location": "body",
|
|
23982
|
+
"required": false,
|
|
23983
|
+
"description": "Quantidade de dias de histórico a importar (valor inválido cai para 30)"
|
|
23984
|
+
}
|
|
23985
|
+
],
|
|
23986
|
+
"returns": "{ state, qr, days }",
|
|
23987
|
+
"common_use_cases": [
|
|
23988
|
+
"Trazer o histórico antigo ao migrar para WhatsApp oficial"
|
|
23989
|
+
],
|
|
23990
|
+
"related_tools": [
|
|
23991
|
+
"lionchat_inboxes_whatsapp_history_status",
|
|
23992
|
+
"lionchat_inboxes_whatsapp_history_cancel"
|
|
23993
|
+
]
|
|
23994
|
+
},
|
|
23995
|
+
{
|
|
23996
|
+
"id": "lionchat_inboxes_whatsapp_history_status",
|
|
23997
|
+
"method": "GET",
|
|
23998
|
+
"path": "/api/v1/accounts/{account_id}/inboxes/{inbox_id}/whatsapp_history/status",
|
|
23999
|
+
"title": "Importar Histórico WhatsApp Cloud (Status)",
|
|
24000
|
+
"description": "SÓ LEITURA. Status da importação de histórico da caixa WhatsApp Cloud: estado, QR Code (quando precisa parear), progresso e estatísticas. Estados: idle → scan_qr → importing → migrating → cleaning → done/failed.",
|
|
24001
|
+
"category": "Caixas de Entrada",
|
|
24002
|
+
"params": [
|
|
24003
|
+
{
|
|
24004
|
+
"name": "inbox_id",
|
|
24005
|
+
"type": "integer",
|
|
24006
|
+
"location": "path",
|
|
24007
|
+
"required": true,
|
|
24008
|
+
"description": "ID da caixa WhatsApp Cloud"
|
|
24009
|
+
}
|
|
24010
|
+
],
|
|
24011
|
+
"returns": "{ state, qr, days, progress, stats, error }",
|
|
24012
|
+
"common_use_cases": [
|
|
24013
|
+
"Acompanhar o andamento da importação",
|
|
24014
|
+
"Pegar o QR Code para parear"
|
|
24015
|
+
],
|
|
24016
|
+
"related_tools": [
|
|
24017
|
+
"lionchat_inboxes_whatsapp_history_start",
|
|
24018
|
+
"lionchat_inboxes_whatsapp_history_cancel"
|
|
24019
|
+
]
|
|
24020
|
+
},
|
|
24021
|
+
{
|
|
24022
|
+
"id": "lionchat_inboxes_whatsapp_history_cancel",
|
|
24023
|
+
"method": "POST",
|
|
24024
|
+
"path": "/api/v1/accounts/{account_id}/inboxes/{inbox_id}/whatsapp_history/cancel",
|
|
24025
|
+
"title": "Importar Histórico WhatsApp Cloud (Cancelar)",
|
|
24026
|
+
"description": "AÇÃO DE ESCRITA. Cancela uma importação de histórico em andamento na caixa WhatsApp Cloud.",
|
|
24027
|
+
"category": "Caixas de Entrada",
|
|
24028
|
+
"params": [
|
|
24029
|
+
{
|
|
24030
|
+
"name": "inbox_id",
|
|
24031
|
+
"type": "integer",
|
|
24032
|
+
"location": "path",
|
|
24033
|
+
"required": true,
|
|
24034
|
+
"description": "ID da caixa WhatsApp Cloud"
|
|
24035
|
+
}
|
|
24036
|
+
],
|
|
24037
|
+
"returns": "{ state }",
|
|
24038
|
+
"common_use_cases": [
|
|
24039
|
+
"Interromper uma importação demorada ou iniciada por engano"
|
|
24040
|
+
],
|
|
24041
|
+
"related_tools": [
|
|
24042
|
+
"lionchat_inboxes_whatsapp_history_start",
|
|
24043
|
+
"lionchat_inboxes_whatsapp_history_status"
|
|
24044
|
+
]
|
|
24045
|
+
},
|
|
24046
|
+
{
|
|
24047
|
+
"id": "lionchat_conversations_toggle_block",
|
|
24048
|
+
"method": "POST",
|
|
24049
|
+
"path": "/api/v1/accounts/{account_id}/conversations/{id}/toggle_block",
|
|
24050
|
+
"title": "Bloquear / Desbloquear Contato",
|
|
24051
|
+
"description": "AÇÃO DE ESCRITA. Bloqueia ou desbloqueia o CONTATO da conversa. Quando bloqueado, as mensagens RECEBIDAS desse contato passam a ser descartadas na entrada (não criam conversa/mensagem) e fica registrada uma pílula de atividade. NÃO resolve a conversa. Recebe o display_id da conversa. (Alternativa: setar o atributo blocked via lionchat_contacts_update.)",
|
|
24052
|
+
"category": "Conversas",
|
|
24053
|
+
"params": [
|
|
24054
|
+
{
|
|
24055
|
+
"name": "id",
|
|
24056
|
+
"type": "integer",
|
|
24057
|
+
"location": "path",
|
|
24058
|
+
"required": true,
|
|
24059
|
+
"description": "Display ID (ID de exibição) da conversa"
|
|
24060
|
+
},
|
|
24061
|
+
{
|
|
24062
|
+
"name": "blocked",
|
|
24063
|
+
"type": "boolean",
|
|
24064
|
+
"location": "body",
|
|
24065
|
+
"required": true,
|
|
24066
|
+
"description": "true = bloquear o contato; false = desbloquear"
|
|
24067
|
+
}
|
|
24068
|
+
],
|
|
24069
|
+
"returns": "A conversa atualizada (contato com blocked = true/false)",
|
|
24070
|
+
"common_use_cases": [
|
|
24071
|
+
"Bloquear um contato abusivo/spam",
|
|
24072
|
+
"Desbloquear um contato bloqueado por engano"
|
|
24073
|
+
],
|
|
24074
|
+
"related_tools": [
|
|
24075
|
+
"lionchat_contacts_update"
|
|
24076
|
+
]
|
|
24077
|
+
},
|
|
24078
|
+
{
|
|
24079
|
+
"id": "lionchat_wavoip_should_ring",
|
|
24080
|
+
"method": "GET",
|
|
24081
|
+
"path": "/api/v1/accounts/{account_id}/inboxes/{inbox_id}/wavoip/should_ring",
|
|
24082
|
+
"title": "Deve Tocar? (Wavoip)",
|
|
24083
|
+
"description": "SÓ LEITURA. Diz se a ligação WhatsApp (Wavoip) deve tocar para ESTE agente, segundo a regra de toque (responsável pela conversa + presença/disponibilidade do agente). Usado pela tela de atendimento para decidir o toque/ringback.",
|
|
24084
|
+
"category": "Ligacao WP (Wavoip)",
|
|
24085
|
+
"params": [
|
|
24086
|
+
{
|
|
24087
|
+
"name": "inbox_id",
|
|
24088
|
+
"type": "integer",
|
|
24089
|
+
"location": "path",
|
|
24090
|
+
"required": true,
|
|
24091
|
+
"description": "ID da caixa de entrada (WhatsApp QR Code)"
|
|
24092
|
+
}
|
|
24093
|
+
],
|
|
24094
|
+
"returns": "{ ring: boolean }",
|
|
24095
|
+
"common_use_cases": [
|
|
24096
|
+
"Decidir se toca o telefone do agente numa ligação recebida"
|
|
24097
|
+
],
|
|
24098
|
+
"related_tools": [
|
|
24099
|
+
"lionchat_wavoip_status",
|
|
24100
|
+
"lionchat_wavoip_flag_rejected"
|
|
24101
|
+
]
|
|
24102
|
+
},
|
|
24103
|
+
{
|
|
24104
|
+
"id": "lionchat_wavoip_flag_rejected",
|
|
24105
|
+
"method": "POST",
|
|
24106
|
+
"path": "/api/v1/accounts/{account_id}/inboxes/{inbox_id}/wavoip/flag_rejected",
|
|
24107
|
+
"title": "Sinalizar Recusa (Wavoip)",
|
|
24108
|
+
"description": "AÇÃO DE ESCRITA. Marca que o agente RECUSOU a ligação WhatsApp (Wavoip) de um número, para o webhook registrar o desfecho como recusada (flag de curta duração). Use ao recusar uma ligação recebida.",
|
|
24109
|
+
"category": "Ligacao WP (Wavoip)",
|
|
24110
|
+
"params": [
|
|
24111
|
+
{
|
|
24112
|
+
"name": "inbox_id",
|
|
24113
|
+
"type": "integer",
|
|
24114
|
+
"location": "path",
|
|
24115
|
+
"required": true,
|
|
24116
|
+
"description": "ID da caixa de entrada (WhatsApp QR Code)"
|
|
24117
|
+
},
|
|
24118
|
+
{
|
|
24119
|
+
"name": "phone",
|
|
24120
|
+
"type": "string",
|
|
24121
|
+
"location": "body",
|
|
24122
|
+
"required": true,
|
|
24123
|
+
"description": "Telefone do número da ligação recusada"
|
|
24124
|
+
}
|
|
24125
|
+
],
|
|
24126
|
+
"returns": "200 OK",
|
|
24127
|
+
"common_use_cases": [
|
|
24128
|
+
"Registrar que a ligação foi recusada pelo agente"
|
|
24129
|
+
],
|
|
24130
|
+
"related_tools": [
|
|
24131
|
+
"lionchat_wavoip_should_ring",
|
|
24132
|
+
"lionchat_wavoip_calls"
|
|
24133
|
+
]
|
|
23405
24134
|
}
|
|
23406
24135
|
]
|