@lionchat/mcp-server 0.4.5 → 0.4.7
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 +79 -11
- package/dist/docs/prompts/customer_health.json +1 -1
- package/dist/docs/prompts/inactive_contacts.json +1 -1
- package/dist/docs/prompts/productivity_report.json +1 -1
- package/dist/docs/prompts/team_load_balance.json +1 -1
- package/dist/docs/resources/api-conventions.md +11 -3
- package/dist/docs/resources/best-practices.md +40 -6
- package/dist/docs/resources/conversation-flows.md +96 -0
- package/dist/docs/resources/data-model.md +18 -4
- package/dist/docs/resources/flowbuilder-design-guide.md +134 -16
- package/dist/docs/resources/flowbuilder-patterns.md +19 -18
- package/dist/docs/resources/glossary.md +29 -2
- package/dist/docs/resources/reports-guide.md +164 -85
- package/endpoints.json +778 -728
- package/package.json +1 -1
package/endpoints.json
CHANGED
|
@@ -324,6 +324,95 @@
|
|
|
324
324
|
"lionchat_contacts_update_1"
|
|
325
325
|
]
|
|
326
326
|
},
|
|
327
|
+
{
|
|
328
|
+
"id": "lionchat_contacts_update_cadastral",
|
|
329
|
+
"method": "PATCH",
|
|
330
|
+
"path": "/api/v1/accounts/{account_id}/contacts/{id}/update_cadastral",
|
|
331
|
+
"title": "Atualizar Dados Cadastrais do Contato",
|
|
332
|
+
"description": "Atualiza os dados cadastrais brasileiros do contato (endpoint dedicado, com validação própria de CPF/CNPJ/etc). NÃO use custom_attribute para esses dados — use este endpoint. IMPORTANTE: os campos cpf, rg, cnpj, passport, date_of_birth e gender são IMUTÁVEIS — só aceitam a PRIMEIRA escrita; depois disso a IA NÃO deve tentar sobrescrevê-los (são protegidos contra alteração automática). Os campos mutáveis (podem ser alterados a qualquer momento) são marital_status, profession e address. Envie apenas os campos que deseja gravar.",
|
|
333
|
+
"category": "Contatos",
|
|
334
|
+
"params": [
|
|
335
|
+
{
|
|
336
|
+
"name": "id",
|
|
337
|
+
"type": "integer",
|
|
338
|
+
"location": "path",
|
|
339
|
+
"required": true,
|
|
340
|
+
"description": "ID do contato"
|
|
341
|
+
},
|
|
342
|
+
{
|
|
343
|
+
"name": "marital_status",
|
|
344
|
+
"type": "string",
|
|
345
|
+
"location": "body",
|
|
346
|
+
"required": false,
|
|
347
|
+
"description": "Estado civil (mutável — pode ser alterado a qualquer momento)"
|
|
348
|
+
},
|
|
349
|
+
{
|
|
350
|
+
"name": "profession",
|
|
351
|
+
"type": "string",
|
|
352
|
+
"location": "body",
|
|
353
|
+
"required": false,
|
|
354
|
+
"description": "Profissão (mutável — pode ser alterado a qualquer momento)"
|
|
355
|
+
},
|
|
356
|
+
{
|
|
357
|
+
"name": "address",
|
|
358
|
+
"type": "object",
|
|
359
|
+
"location": "body",
|
|
360
|
+
"required": false,
|
|
361
|
+
"description": "Endereço (mutável). Objeto com cep, street, number, complement, neighborhood, city, state, country"
|
|
362
|
+
},
|
|
363
|
+
{
|
|
364
|
+
"name": "cpf",
|
|
365
|
+
"type": "string",
|
|
366
|
+
"location": "body",
|
|
367
|
+
"required": false,
|
|
368
|
+
"description": "CPF (IMUTÁVEL — só primeira escrita; a IA não deve sobrescrever)"
|
|
369
|
+
},
|
|
370
|
+
{
|
|
371
|
+
"name": "rg",
|
|
372
|
+
"type": "string",
|
|
373
|
+
"location": "body",
|
|
374
|
+
"required": false,
|
|
375
|
+
"description": "RG (IMUTÁVEL — só primeira escrita; a IA não deve sobrescrever)"
|
|
376
|
+
},
|
|
377
|
+
{
|
|
378
|
+
"name": "cnpj",
|
|
379
|
+
"type": "string",
|
|
380
|
+
"location": "body",
|
|
381
|
+
"required": false,
|
|
382
|
+
"description": "CNPJ (IMUTÁVEL — só primeira escrita; a IA não deve sobrescrever)"
|
|
383
|
+
},
|
|
384
|
+
{
|
|
385
|
+
"name": "passport",
|
|
386
|
+
"type": "string",
|
|
387
|
+
"location": "body",
|
|
388
|
+
"required": false,
|
|
389
|
+
"description": "Passaporte (IMUTÁVEL — só primeira escrita; a IA não deve sobrescrever)"
|
|
390
|
+
},
|
|
391
|
+
{
|
|
392
|
+
"name": "date_of_birth",
|
|
393
|
+
"type": "string",
|
|
394
|
+
"location": "body",
|
|
395
|
+
"required": false,
|
|
396
|
+
"description": "Data de nascimento (IMUTÁVEL — só primeira escrita; a IA não deve sobrescrever)"
|
|
397
|
+
},
|
|
398
|
+
{
|
|
399
|
+
"name": "gender",
|
|
400
|
+
"type": "string",
|
|
401
|
+
"location": "body",
|
|
402
|
+
"required": false,
|
|
403
|
+
"description": "Gênero (IMUTÁVEL — só primeira escrita; a IA não deve sobrescrever)"
|
|
404
|
+
}
|
|
405
|
+
],
|
|
406
|
+
"returns": "contato atualizado",
|
|
407
|
+
"common_use_cases": [
|
|
408
|
+
"Preencher dados cadastrais brasileiros (CPF, endereço) na primeira vez",
|
|
409
|
+
"Atualizar estado civil ou profissão do contato",
|
|
410
|
+
"Atualizar o endereço do contato"
|
|
411
|
+
],
|
|
412
|
+
"related_tools": [
|
|
413
|
+
"lionchat_contacts_update"
|
|
414
|
+
]
|
|
415
|
+
},
|
|
327
416
|
{
|
|
328
417
|
"id": "lionchat_contacts_destroy",
|
|
329
418
|
"method": "DELETE",
|
|
@@ -872,7 +961,7 @@
|
|
|
872
961
|
"method": "GET",
|
|
873
962
|
"path": "/api/v1/accounts/{account_id}/conversations/meta",
|
|
874
963
|
"title": "Contadores de Conversas",
|
|
875
|
-
"description": "Contadores REAL-TIME de conversas (mine_count, assigned_count, unassigned_count, all_count). Use quando o usuário quer SÓ NÚMERO (não lista). Bem mais barato que conversations_list.",
|
|
964
|
+
"description": "Contadores REAL-TIME de conversas (mine_count, assigned_count, unassigned_count, all_count). Use quando o usuário quer SÓ NÚMERO (não lista). Aceita os mesmos filtros de conversations_list (status, conversation_type, etc) — ex: conversation_type=unread conta as não lidas. Bem mais barato que conversations_list.",
|
|
876
965
|
"category": "Conversas",
|
|
877
966
|
"params": [
|
|
878
967
|
{
|
|
@@ -880,21 +969,28 @@
|
|
|
880
969
|
"type": "string",
|
|
881
970
|
"location": "query",
|
|
882
971
|
"required": false,
|
|
883
|
-
"description": "open, resolved, pending"
|
|
972
|
+
"description": "Status: open (padrão), resolved, pending, snoozed ou all"
|
|
884
973
|
},
|
|
885
974
|
{
|
|
886
|
-
"name": "
|
|
887
|
-
"type": "
|
|
975
|
+
"name": "conversation_type",
|
|
976
|
+
"type": "string",
|
|
888
977
|
"location": "query",
|
|
889
978
|
"required": false,
|
|
890
|
-
"description": "
|
|
979
|
+
"description": "Tipo: unread (não lidas), unattended (não atendidas), mention, participating"
|
|
980
|
+
},
|
|
981
|
+
{
|
|
982
|
+
"name": "assignee_type",
|
|
983
|
+
"type": "string",
|
|
984
|
+
"location": "query",
|
|
985
|
+
"required": false,
|
|
986
|
+
"description": "Atribuição: me, unassigned, assigned, groups. Omitir = todas"
|
|
891
987
|
},
|
|
892
988
|
{
|
|
893
989
|
"name": "inbox_id",
|
|
894
990
|
"type": "integer",
|
|
895
991
|
"location": "query",
|
|
896
992
|
"required": false,
|
|
897
|
-
"description": "ID da inbox"
|
|
993
|
+
"description": "ID da inbox/caixa de entrada"
|
|
898
994
|
},
|
|
899
995
|
{
|
|
900
996
|
"name": "team_id",
|
|
@@ -908,7 +1004,7 @@
|
|
|
908
1004
|
"type": "array",
|
|
909
1005
|
"location": "query",
|
|
910
1006
|
"required": false,
|
|
911
|
-
"description": "Labels"
|
|
1007
|
+
"description": "Labels (tags) — array de títulos"
|
|
912
1008
|
}
|
|
913
1009
|
],
|
|
914
1010
|
"returns": "{ meta: { mine_count, assigned_count, unassigned_count, all_count } }",
|
|
@@ -924,7 +1020,7 @@
|
|
|
924
1020
|
"method": "GET",
|
|
925
1021
|
"path": "/api/v1/accounts/{account_id}/conversations",
|
|
926
1022
|
"title": "Listar Conversas",
|
|
927
|
-
"description": "Lista conversas com filtros
|
|
1023
|
+
"description": "Lista conversas com filtros e ordenação. Paginado (25/página, máx 100). Retorna meta (contadores: mine/assigned/unassigned/all) + payload (array de conversas). Para SÓ contagem use conversations_meta; para busca por texto use conversations_search; para filtros avançados (custom_attributes) use conversations_filter.",
|
|
928
1024
|
"category": "Conversas",
|
|
929
1025
|
"params": [
|
|
930
1026
|
{
|
|
@@ -932,28 +1028,35 @@
|
|
|
932
1028
|
"type": "integer",
|
|
933
1029
|
"location": "query",
|
|
934
1030
|
"required": false,
|
|
935
|
-
"description": "Página"
|
|
1031
|
+
"description": "Página (1-indexado)"
|
|
936
1032
|
},
|
|
937
1033
|
{
|
|
938
1034
|
"name": "status",
|
|
939
1035
|
"type": "string",
|
|
940
1036
|
"location": "query",
|
|
941
1037
|
"required": false,
|
|
942
|
-
"description": "open, resolved, pending, snoozed"
|
|
1038
|
+
"description": "Status: open (aberta, padrão), resolved (resolvida), pending (pendente), snoozed (adiada) ou all (todas)"
|
|
943
1039
|
},
|
|
944
1040
|
{
|
|
945
|
-
"name": "
|
|
946
|
-
"type": "
|
|
1041
|
+
"name": "assignee_type",
|
|
1042
|
+
"type": "string",
|
|
947
1043
|
"location": "query",
|
|
948
1044
|
"required": false,
|
|
949
|
-
"description": "
|
|
1045
|
+
"description": "Atribuição: me (minhas conversas), unassigned (sem dono / não atribuídas), assigned (com dono), groups (grupos de WhatsApp). Omitir = todas"
|
|
1046
|
+
},
|
|
1047
|
+
{
|
|
1048
|
+
"name": "conversation_type",
|
|
1049
|
+
"type": "string",
|
|
1050
|
+
"location": "query",
|
|
1051
|
+
"required": false,
|
|
1052
|
+
"description": "Tipo: unread (NÃO LIDAS), unattended (NÃO ATENDIDAS / sem primeira resposta), mention (onde fui mencionado), participating (que participo). Omitir = sem este filtro"
|
|
950
1053
|
},
|
|
951
1054
|
{
|
|
952
1055
|
"name": "inbox_id",
|
|
953
1056
|
"type": "integer",
|
|
954
1057
|
"location": "query",
|
|
955
1058
|
"required": false,
|
|
956
|
-
"description": "ID da inbox"
|
|
1059
|
+
"description": "ID da inbox/caixa de entrada (0 = conversas de inboxes deletadas)"
|
|
957
1060
|
},
|
|
958
1061
|
{
|
|
959
1062
|
"name": "team_id",
|
|
@@ -967,14 +1070,14 @@
|
|
|
967
1070
|
"type": "array",
|
|
968
1071
|
"location": "query",
|
|
969
1072
|
"required": false,
|
|
970
|
-
"description": "Labels"
|
|
1073
|
+
"description": "Labels (tags) — array de títulos"
|
|
971
1074
|
},
|
|
972
1075
|
{
|
|
973
|
-
"name": "
|
|
1076
|
+
"name": "sort_by",
|
|
974
1077
|
"type": "string",
|
|
975
1078
|
"location": "query",
|
|
976
1079
|
"required": false,
|
|
977
|
-
"description": "
|
|
1080
|
+
"description": "Ordenação: last_activity_at_desc (MAIS RECENTES, padrão), last_activity_at_asc, created_at_desc (últimas criadas), created_at_asc (mais antigas), priority_desc (prioridade alta primeiro), waiting_since_desc (esperando há mais tempo)"
|
|
978
1081
|
}
|
|
979
1082
|
],
|
|
980
1083
|
"returns": "meta (contadores globais) + payload (array de conversas)",
|
|
@@ -1509,7 +1612,7 @@
|
|
|
1509
1612
|
"method": "POST",
|
|
1510
1613
|
"path": "/api/v1/accounts/{account_id}/conversations/{id}/unread",
|
|
1511
1614
|
"title": "Marcar como Não Lida",
|
|
1512
|
-
"description": "
|
|
1615
|
+
"description": "AÇÃO DE ESCRITA: marca uma conversa existente como não lida (volta o badge de não lida). NÃO é busca — para LISTAR conversas não lidas use conversations_list com conversation_type=unread. Recebe o display_id da conversa.",
|
|
1513
1616
|
"category": "Conversas",
|
|
1514
1617
|
"params": [
|
|
1515
1618
|
{
|
|
@@ -1517,16 +1620,17 @@
|
|
|
1517
1620
|
"type": "integer",
|
|
1518
1621
|
"location": "path",
|
|
1519
1622
|
"required": true,
|
|
1520
|
-
"description": "Display ID"
|
|
1623
|
+
"description": "Display ID (ID de exibição) da conversa"
|
|
1521
1624
|
}
|
|
1522
1625
|
],
|
|
1523
|
-
"returns": "conversa
|
|
1626
|
+
"returns": "A conversa atualizada (agent_last_seen_at zerado)",
|
|
1524
1627
|
"common_use_cases": [
|
|
1525
|
-
"
|
|
1526
|
-
"
|
|
1527
|
-
"Importação manual via API"
|
|
1628
|
+
"Marcar conversa como não lida para revisitar depois",
|
|
1629
|
+
"Sinalizar que a conversa precisa de nova atenção"
|
|
1528
1630
|
],
|
|
1529
|
-
"related_tools": [
|
|
1631
|
+
"related_tools": [
|
|
1632
|
+
"lionchat_conversations_list"
|
|
1633
|
+
]
|
|
1530
1634
|
},
|
|
1531
1635
|
{
|
|
1532
1636
|
"id": "lionchat_conversations_create_5",
|
|
@@ -3493,7 +3597,7 @@
|
|
|
3493
3597
|
"method": "POST",
|
|
3494
3598
|
"path": "/api/v1/accounts/{account_id}/contacts/import_csv",
|
|
3495
3599
|
"title": "Importar Contatos (Wizard CSV)",
|
|
3496
|
-
"description": "Importa contatos via wizard CSV. **Requer perfil Administrador
|
|
3600
|
+
"description": "Importa contatos via wizard CSV (assincrono). **Requer perfil Administrador.** Obrigatórios: file, mappings. Retorna { import_id } para acompanhar o progresso via import_status.",
|
|
3497
3601
|
"category": "Contatos",
|
|
3498
3602
|
"params": [
|
|
3499
3603
|
{
|
|
@@ -3501,33 +3605,26 @@
|
|
|
3501
3605
|
"type": "file",
|
|
3502
3606
|
"location": "body",
|
|
3503
3607
|
"required": true,
|
|
3504
|
-
"description": "Arquivo CSV"
|
|
3608
|
+
"description": "Arquivo CSV (multipart)"
|
|
3505
3609
|
},
|
|
3506
3610
|
{
|
|
3507
|
-
"name": "
|
|
3611
|
+
"name": "mappings",
|
|
3508
3612
|
"type": "string",
|
|
3509
3613
|
"location": "body",
|
|
3510
3614
|
"required": true,
|
|
3511
|
-
"description": "JSON
|
|
3512
|
-
},
|
|
3513
|
-
{
|
|
3514
|
-
"name": "validate_whatsapp",
|
|
3515
|
-
"type": "boolean",
|
|
3516
|
-
"location": "body",
|
|
3517
|
-
"required": false,
|
|
3518
|
-
"description": "Validar WhatsApp"
|
|
3615
|
+
"description": "JSON mapeando coluna do CSV -> campo do contato. Campos aceitos: name, email, phone_number, company, city, labels, instagram, facebook, linkedin, twitter (demais chaves sao ignoradas)"
|
|
3519
3616
|
}
|
|
3520
3617
|
],
|
|
3521
|
-
"returns": "
|
|
3618
|
+
"returns": "{ import_id } — use import_status para acompanhar o progresso",
|
|
3522
3619
|
"common_use_cases": [
|
|
3523
|
-
"
|
|
3524
|
-
"
|
|
3525
|
-
"
|
|
3620
|
+
"Importacao em massa de contatos a partir de planilha",
|
|
3621
|
+
"Migracao de base de outro sistema",
|
|
3622
|
+
"Atualizacao em lote de contatos existentes"
|
|
3526
3623
|
],
|
|
3527
3624
|
"related_tools": [
|
|
3528
|
-
"
|
|
3529
|
-
"
|
|
3530
|
-
"
|
|
3625
|
+
"lionchat_contacts_create_7",
|
|
3626
|
+
"lionchat_contacts_show_1",
|
|
3627
|
+
"lionchat_contacts_import"
|
|
3531
3628
|
]
|
|
3532
3629
|
},
|
|
3533
3630
|
{
|
|
@@ -3535,25 +3632,25 @@
|
|
|
3535
3632
|
"method": "GET",
|
|
3536
3633
|
"path": "/api/v1/accounts/{account_id}/contacts/import_status/{import_id}",
|
|
3537
3634
|
"title": "Status de Importação",
|
|
3538
|
-
"description": "Retorna o progresso
|
|
3635
|
+
"description": "Retorna o progresso de uma importação de contatos assíncrona (polling). NAO retorna um contato — retorna o andamento do job de import (status, total, processados, criados, atualizados, erros).",
|
|
3539
3636
|
"category": "Contatos",
|
|
3540
3637
|
"params": [
|
|
3541
3638
|
{
|
|
3542
3639
|
"name": "import_id",
|
|
3543
|
-
"type": "
|
|
3640
|
+
"type": "string",
|
|
3544
3641
|
"location": "path",
|
|
3545
3642
|
"required": true,
|
|
3546
|
-
"description": "
|
|
3643
|
+
"description": "UUID do import retornado por import_csv"
|
|
3547
3644
|
}
|
|
3548
3645
|
],
|
|
3549
|
-
"returns": "
|
|
3646
|
+
"returns": "{ status, total, processed, created, updated, error_count, labels_created, errors }",
|
|
3550
3647
|
"common_use_cases": [
|
|
3551
|
-
"
|
|
3552
|
-
"Verificar
|
|
3553
|
-
"
|
|
3648
|
+
"Acompanhar barra de progresso da importacao",
|
|
3649
|
+
"Verificar se a importacao terminou",
|
|
3650
|
+
"Listar erros de linhas que falharam"
|
|
3554
3651
|
],
|
|
3555
3652
|
"related_tools": [
|
|
3556
|
-
"
|
|
3653
|
+
"lionchat_contacts_create_8"
|
|
3557
3654
|
]
|
|
3558
3655
|
},
|
|
3559
3656
|
{
|
|
@@ -4331,172 +4428,61 @@
|
|
|
4331
4428
|
]
|
|
4332
4429
|
},
|
|
4333
4430
|
{
|
|
4334
|
-
"id": "
|
|
4335
|
-
"method": "GET",
|
|
4336
|
-
"path": "/api/v1/accounts/{account_id}/kanban/items",
|
|
4337
|
-
"title": "Listar Items Kanban (V2)",
|
|
4338
|
-
"description": "Lista items do Kanban com filtros. Lista cards Kanban paginados (per_page padrão 25, máximo 100). Retorna meta (contadores) + payload (array de card Kanban).",
|
|
4339
|
-
"category": "Kanban V2",
|
|
4340
|
-
"params": [],
|
|
4341
|
-
"returns": "meta (contadores globais) + payload (array de cards Kanban)",
|
|
4342
|
-
"common_use_cases": [
|
|
4343
|
-
"Dashboard: contar/exibir cards Kanban",
|
|
4344
|
-
"Buscar com filtros antes de outra operação",
|
|
4345
|
-
"Auditoria/relatório de cards Kanban ativas"
|
|
4346
|
-
],
|
|
4347
|
-
"related_tools": [
|
|
4348
|
-
"lionchat_kanban_v2_create",
|
|
4349
|
-
"lionchat_kanban_v2_show",
|
|
4350
|
-
"lionchat_kanban_v2_update"
|
|
4351
|
-
]
|
|
4352
|
-
},
|
|
4353
|
-
{
|
|
4354
|
-
"id": "lionchat_kanban_v2_create",
|
|
4355
|
-
"method": "POST",
|
|
4356
|
-
"path": "/api/v1/accounts/{account_id}/kanban/items",
|
|
4357
|
-
"title": "Criar Item Kanban (V2)",
|
|
4358
|
-
"description": "Cria um novo item no Kanban. Cria novo card Kanban. Obrigatórios: funnel_id, funnel_stage. Valida unicidade quando aplicável. Retorna o card Kanban criado com ID atribuído.",
|
|
4359
|
-
"category": "Kanban V2",
|
|
4360
|
-
"params": [
|
|
4361
|
-
{
|
|
4362
|
-
"name": "funnel_id",
|
|
4363
|
-
"type": "integer",
|
|
4364
|
-
"location": "body",
|
|
4365
|
-
"required": true,
|
|
4366
|
-
"description": "ID do funil"
|
|
4367
|
-
},
|
|
4368
|
-
{
|
|
4369
|
-
"name": "funnel_stage",
|
|
4370
|
-
"type": "string",
|
|
4371
|
-
"location": "body",
|
|
4372
|
-
"required": true,
|
|
4373
|
-
"description": "Etapa do funil"
|
|
4374
|
-
},
|
|
4375
|
-
{
|
|
4376
|
-
"name": "conversation_display_id",
|
|
4377
|
-
"type": "integer",
|
|
4378
|
-
"location": "body",
|
|
4379
|
-
"required": false,
|
|
4380
|
-
"description": "Display ID da conversa"
|
|
4381
|
-
},
|
|
4382
|
-
{
|
|
4383
|
-
"name": "item_details",
|
|
4384
|
-
"type": "object",
|
|
4385
|
-
"location": "body",
|
|
4386
|
-
"required": false,
|
|
4387
|
-
"description": "Detalhes do item"
|
|
4388
|
-
}
|
|
4389
|
-
],
|
|
4390
|
-
"returns": "card Kanban criado (com novo ID)",
|
|
4391
|
-
"common_use_cases": [
|
|
4392
|
-
"Cadastro inicial de card Kanban",
|
|
4393
|
-
"Automação a partir de evento externo",
|
|
4394
|
-
"Importação manual via API"
|
|
4395
|
-
],
|
|
4396
|
-
"related_tools": [
|
|
4397
|
-
"lionchat_kanban_v2_list",
|
|
4398
|
-
"lionchat_kanban_v2_show",
|
|
4399
|
-
"lionchat_kanban_v2_update"
|
|
4400
|
-
]
|
|
4401
|
-
},
|
|
4402
|
-
{
|
|
4403
|
-
"id": "lionchat_kanban_v2_show",
|
|
4431
|
+
"id": "lionchat_kanban_v2_list_1",
|
|
4404
4432
|
"method": "GET",
|
|
4405
|
-
"path": "/api/v1/accounts/{account_id}/kanban/items/{
|
|
4406
|
-
"title": "
|
|
4407
|
-
"description": "
|
|
4433
|
+
"path": "/api/v1/accounts/{account_id}/kanban/items/{item_id}/attachments",
|
|
4434
|
+
"title": "Listar Anexos do Item",
|
|
4435
|
+
"description": "Lista anexos de um item do Kanban. Lista cards Kanban paginados (per_page padrão 25, máximo 100). Retorna meta (contadores) + payload (array de card Kanban).",
|
|
4408
4436
|
"category": "Kanban V2",
|
|
4409
4437
|
"params": [
|
|
4410
4438
|
{
|
|
4411
|
-
"name": "
|
|
4439
|
+
"name": "item_id",
|
|
4412
4440
|
"type": "integer",
|
|
4413
4441
|
"location": "path",
|
|
4414
4442
|
"required": true,
|
|
4415
4443
|
"description": "ID do item"
|
|
4416
4444
|
}
|
|
4417
4445
|
],
|
|
4418
|
-
"returns": "
|
|
4446
|
+
"returns": "meta (contadores globais) + payload (array de cards Kanban)",
|
|
4419
4447
|
"common_use_cases": [
|
|
4420
|
-
"
|
|
4421
|
-
"
|
|
4422
|
-
"
|
|
4448
|
+
"Dashboard: contar/exibir cards Kanban",
|
|
4449
|
+
"Buscar com filtros antes de outra operação",
|
|
4450
|
+
"Auditoria/relatório de cards Kanban ativas"
|
|
4423
4451
|
],
|
|
4424
4452
|
"related_tools": [
|
|
4425
4453
|
"lionchat_kanban_v2_list",
|
|
4426
4454
|
"lionchat_kanban_v2_create",
|
|
4427
|
-
"
|
|
4455
|
+
"lionchat_kanban_v2_show"
|
|
4428
4456
|
]
|
|
4429
4457
|
},
|
|
4430
4458
|
{
|
|
4431
|
-
"id": "
|
|
4432
|
-
"method": "
|
|
4433
|
-
"path": "/api/v1/accounts/{account_id}/kanban/items/{
|
|
4434
|
-
"title": "
|
|
4435
|
-
"description": "
|
|
4459
|
+
"id": "lionchat_kanban_v2_attachments",
|
|
4460
|
+
"method": "POST",
|
|
4461
|
+
"path": "/api/v1/accounts/{account_id}/kanban/items/{item_id}/attachments",
|
|
4462
|
+
"title": "Adicionar Anexo ao Item",
|
|
4463
|
+
"description": "Adiciona um anexo a um item do Kanban. Cria novo card Kanban. Obrigatórios: item_id, file. Valida unicidade quando aplicável. Retorna o card Kanban criado com ID atribuído.",
|
|
4436
4464
|
"category": "Kanban V2",
|
|
4437
4465
|
"params": [
|
|
4438
4466
|
{
|
|
4439
|
-
"name": "
|
|
4467
|
+
"name": "item_id",
|
|
4440
4468
|
"type": "integer",
|
|
4441
4469
|
"location": "path",
|
|
4442
4470
|
"required": true,
|
|
4443
4471
|
"description": "ID do item"
|
|
4444
4472
|
},
|
|
4445
4473
|
{
|
|
4446
|
-
"name": "
|
|
4447
|
-
"type": "
|
|
4448
|
-
"location": "body",
|
|
4449
|
-
"required": false,
|
|
4450
|
-
"description": "Nova etapa"
|
|
4451
|
-
},
|
|
4452
|
-
{
|
|
4453
|
-
"name": "position",
|
|
4454
|
-
"type": "integer",
|
|
4455
|
-
"location": "body",
|
|
4456
|
-
"required": false,
|
|
4457
|
-
"description": "Nova posicao"
|
|
4458
|
-
},
|
|
4459
|
-
{
|
|
4460
|
-
"name": "item_details",
|
|
4461
|
-
"type": "object",
|
|
4474
|
+
"name": "file",
|
|
4475
|
+
"type": "file",
|
|
4462
4476
|
"location": "body",
|
|
4463
|
-
"required": false,
|
|
4464
|
-
"description": "Detalhes"
|
|
4465
|
-
}
|
|
4466
|
-
],
|
|
4467
|
-
"returns": "card Kanban atualizado",
|
|
4468
|
-
"common_use_cases": [
|
|
4469
|
-
"Edição parcial de card Kanban",
|
|
4470
|
-
"Alteração de status/estado",
|
|
4471
|
-
"Atualização em massa via automação"
|
|
4472
|
-
],
|
|
4473
|
-
"related_tools": [
|
|
4474
|
-
"lionchat_kanban_v2_list",
|
|
4475
|
-
"lionchat_kanban_v2_create",
|
|
4476
|
-
"lionchat_kanban_v2_show"
|
|
4477
|
-
]
|
|
4478
|
-
},
|
|
4479
|
-
{
|
|
4480
|
-
"id": "lionchat_kanban_v2_destroy",
|
|
4481
|
-
"method": "DELETE",
|
|
4482
|
-
"path": "/api/v1/accounts/{account_id}/kanban/items/{id}",
|
|
4483
|
-
"title": "Excluir Item Kanban (V2)",
|
|
4484
|
-
"description": "Remove um item do Kanban. Remove card Kanban permanentemente. CUIDADO: ação irreversível em muitos casos. Verifique dependências antes.",
|
|
4485
|
-
"category": "Kanban V2",
|
|
4486
|
-
"params": [
|
|
4487
|
-
{
|
|
4488
|
-
"name": "id",
|
|
4489
|
-
"type": "integer",
|
|
4490
|
-
"location": "path",
|
|
4491
4477
|
"required": true,
|
|
4492
|
-
"description": "
|
|
4478
|
+
"description": "Arquivo para upload"
|
|
4493
4479
|
}
|
|
4494
4480
|
],
|
|
4495
|
-
"returns": "
|
|
4481
|
+
"returns": "card Kanban criado (com novo ID)",
|
|
4496
4482
|
"common_use_cases": [
|
|
4497
|
-
"
|
|
4498
|
-
"
|
|
4499
|
-
"
|
|
4483
|
+
"Cadastro inicial de card Kanban",
|
|
4484
|
+
"Automação a partir de evento externo",
|
|
4485
|
+
"Importação manual via API"
|
|
4500
4486
|
],
|
|
4501
4487
|
"related_tools": [
|
|
4502
4488
|
"lionchat_kanban_v2_list",
|
|
@@ -4505,409 +4491,33 @@
|
|
|
4505
4491
|
]
|
|
4506
4492
|
},
|
|
4507
4493
|
{
|
|
4508
|
-
"id": "
|
|
4509
|
-
"method": "
|
|
4510
|
-
"path": "/api/v1/accounts/{account_id}/kanban/items/{item_id}/attachments",
|
|
4511
|
-
"title": "
|
|
4512
|
-
"description": "
|
|
4494
|
+
"id": "lionchat_kanban_v2_destroy_1",
|
|
4495
|
+
"method": "DELETE",
|
|
4496
|
+
"path": "/api/v1/accounts/{account_id}/kanban/items/{item_id}/attachments/{id}",
|
|
4497
|
+
"title": "Remover Anexo do Item",
|
|
4498
|
+
"description": "Remove um anexo de um item do Kanban. Remove card Kanban permanentemente. CUIDADO: ação irreversível em muitos casos. Verifique dependências antes.",
|
|
4513
4499
|
"category": "Kanban V2",
|
|
4514
4500
|
"params": [
|
|
4515
4501
|
{
|
|
4516
4502
|
"name": "item_id",
|
|
4517
4503
|
"type": "integer",
|
|
4518
|
-
"location": "path",
|
|
4519
|
-
"required": true,
|
|
4520
|
-
"description": "ID do item"
|
|
4521
|
-
}
|
|
4522
|
-
],
|
|
4523
|
-
"returns": "meta (contadores globais) + payload (array de cards Kanban)",
|
|
4524
|
-
"common_use_cases": [
|
|
4525
|
-
"Dashboard: contar/exibir cards Kanban",
|
|
4526
|
-
"Buscar com filtros antes de outra operação",
|
|
4527
|
-
"Auditoria/relatório de cards Kanban ativas"
|
|
4528
|
-
],
|
|
4529
|
-
"related_tools": [
|
|
4530
|
-
"lionchat_kanban_v2_list",
|
|
4531
|
-
"lionchat_kanban_v2_create",
|
|
4532
|
-
"lionchat_kanban_v2_show"
|
|
4533
|
-
]
|
|
4534
|
-
},
|
|
4535
|
-
{
|
|
4536
|
-
"id": "lionchat_kanban_v2_attachments",
|
|
4537
|
-
"method": "POST",
|
|
4538
|
-
"path": "/api/v1/accounts/{account_id}/kanban/items/{item_id}/attachments",
|
|
4539
|
-
"title": "Adicionar Anexo ao Item",
|
|
4540
|
-
"description": "Adiciona um anexo a um item do Kanban. Cria novo card Kanban. Obrigatórios: item_id, file. Valida unicidade quando aplicável. Retorna o card Kanban criado com ID atribuído.",
|
|
4541
|
-
"category": "Kanban V2",
|
|
4542
|
-
"params": [
|
|
4543
|
-
{
|
|
4544
|
-
"name": "item_id",
|
|
4545
|
-
"type": "integer",
|
|
4546
|
-
"location": "path",
|
|
4547
|
-
"required": true,
|
|
4548
|
-
"description": "ID do item"
|
|
4549
|
-
},
|
|
4550
|
-
{
|
|
4551
|
-
"name": "file",
|
|
4552
|
-
"type": "file",
|
|
4553
|
-
"location": "body",
|
|
4554
|
-
"required": true,
|
|
4555
|
-
"description": "Arquivo para upload"
|
|
4556
|
-
}
|
|
4557
|
-
],
|
|
4558
|
-
"returns": "card Kanban criado (com novo ID)",
|
|
4559
|
-
"common_use_cases": [
|
|
4560
|
-
"Cadastro inicial de card Kanban",
|
|
4561
|
-
"Automação a partir de evento externo",
|
|
4562
|
-
"Importação manual via API"
|
|
4563
|
-
],
|
|
4564
|
-
"related_tools": [
|
|
4565
|
-
"lionchat_kanban_v2_list",
|
|
4566
|
-
"lionchat_kanban_v2_create",
|
|
4567
|
-
"lionchat_kanban_v2_show"
|
|
4568
|
-
]
|
|
4569
|
-
},
|
|
4570
|
-
{
|
|
4571
|
-
"id": "lionchat_kanban_v2_destroy_1",
|
|
4572
|
-
"method": "DELETE",
|
|
4573
|
-
"path": "/api/v1/accounts/{account_id}/kanban/items/{item_id}/attachments/{id}",
|
|
4574
|
-
"title": "Remover Anexo do Item",
|
|
4575
|
-
"description": "Remove um anexo de um item do Kanban. Remove card Kanban permanentemente. CUIDADO: ação irreversível em muitos casos. Verifique dependências antes.",
|
|
4576
|
-
"category": "Kanban V2",
|
|
4577
|
-
"params": [
|
|
4578
|
-
{
|
|
4579
|
-
"name": "item_id",
|
|
4580
|
-
"type": "integer",
|
|
4581
|
-
"location": "path",
|
|
4582
|
-
"required": true,
|
|
4583
|
-
"description": "ID do item"
|
|
4584
|
-
},
|
|
4585
|
-
{
|
|
4586
|
-
"name": "id",
|
|
4587
|
-
"type": "integer",
|
|
4588
|
-
"location": "path",
|
|
4589
|
-
"required": true,
|
|
4590
|
-
"description": "ID do anexo"
|
|
4591
|
-
}
|
|
4592
|
-
],
|
|
4593
|
-
"returns": "204 No Content",
|
|
4594
|
-
"common_use_cases": [
|
|
4595
|
-
"Limpeza de dados obsoletos",
|
|
4596
|
-
"Deduplicação manual",
|
|
4597
|
-
"Remoção após confirmação do cliente"
|
|
4598
|
-
],
|
|
4599
|
-
"related_tools": [
|
|
4600
|
-
"lionchat_kanban_v2_list",
|
|
4601
|
-
"lionchat_kanban_v2_create",
|
|
4602
|
-
"lionchat_kanban_v2_show"
|
|
4603
|
-
]
|
|
4604
|
-
},
|
|
4605
|
-
{
|
|
4606
|
-
"id": "lionchat_kanban_v2_create_1",
|
|
4607
|
-
"method": "POST",
|
|
4608
|
-
"path": "/api/v1/accounts/{account_id}/kanban/items/{item_id}/note_attachments",
|
|
4609
|
-
"title": "Adicionar Anexo a Nota",
|
|
4610
|
-
"description": "Adiciona um anexo a uma nota do item. Cria novo card Kanban. Obrigatórios: item_id, file. Valida unicidade quando aplicável. Retorna o card Kanban criado com ID atribuído.",
|
|
4611
|
-
"category": "Kanban V2",
|
|
4612
|
-
"params": [
|
|
4613
|
-
{
|
|
4614
|
-
"name": "item_id",
|
|
4615
|
-
"type": "integer",
|
|
4616
|
-
"location": "path",
|
|
4617
|
-
"required": true,
|
|
4618
|
-
"description": "ID do item"
|
|
4619
|
-
},
|
|
4620
|
-
{
|
|
4621
|
-
"name": "file",
|
|
4622
|
-
"type": "file",
|
|
4623
|
-
"location": "body",
|
|
4624
|
-
"required": true,
|
|
4625
|
-
"description": "Arquivo para upload"
|
|
4626
|
-
}
|
|
4627
|
-
],
|
|
4628
|
-
"returns": "card Kanban criado (com novo ID)",
|
|
4629
|
-
"common_use_cases": [
|
|
4630
|
-
"Cadastro inicial de card Kanban",
|
|
4631
|
-
"Automação a partir de evento externo",
|
|
4632
|
-
"Importação manual via API"
|
|
4633
|
-
],
|
|
4634
|
-
"related_tools": [
|
|
4635
|
-
"lionchat_kanban_v2_list",
|
|
4636
|
-
"lionchat_kanban_v2_create",
|
|
4637
|
-
"lionchat_kanban_v2_show"
|
|
4638
|
-
]
|
|
4639
|
-
},
|
|
4640
|
-
{
|
|
4641
|
-
"id": "lionchat_kanban_v2_destroy_2",
|
|
4642
|
-
"method": "DELETE",
|
|
4643
|
-
"path": "/api/v1/accounts/{account_id}/kanban/items/{item_id}/note_attachments/{id}",
|
|
4644
|
-
"title": "Remover Anexo de Nota",
|
|
4645
|
-
"description": "Remove um anexo de nota do item. Remove card Kanban permanentemente. CUIDADO: ação irreversível em muitos casos. Verifique dependências antes.",
|
|
4646
|
-
"category": "Kanban V2",
|
|
4647
|
-
"params": [
|
|
4648
|
-
{
|
|
4649
|
-
"name": "item_id",
|
|
4650
|
-
"type": "integer",
|
|
4651
|
-
"location": "path",
|
|
4652
|
-
"required": true,
|
|
4653
|
-
"description": "ID do item"
|
|
4654
|
-
},
|
|
4655
|
-
{
|
|
4656
|
-
"name": "id",
|
|
4657
|
-
"type": "integer",
|
|
4658
|
-
"location": "path",
|
|
4659
|
-
"required": true,
|
|
4660
|
-
"description": "ID do anexo"
|
|
4661
|
-
}
|
|
4662
|
-
],
|
|
4663
|
-
"returns": "204 No Content",
|
|
4664
|
-
"common_use_cases": [
|
|
4665
|
-
"Limpeza de dados obsoletos",
|
|
4666
|
-
"Deduplicação manual",
|
|
4667
|
-
"Remoção após confirmação do cliente"
|
|
4668
|
-
],
|
|
4669
|
-
"related_tools": [
|
|
4670
|
-
"lionchat_kanban_v2_list",
|
|
4671
|
-
"lionchat_kanban_v2_create",
|
|
4672
|
-
"lionchat_kanban_v2_show"
|
|
4673
|
-
]
|
|
4674
|
-
},
|
|
4675
|
-
{
|
|
4676
|
-
"id": "lionchat_kanban_v2_list_2",
|
|
4677
|
-
"method": "GET",
|
|
4678
|
-
"path": "/api/v1/accounts/{account_id}/kanban/funnels",
|
|
4679
|
-
"title": "Listar Funis (V2)",
|
|
4680
|
-
"description": "Lista todos os funis do Kanban. Lista cards Kanban paginados (per_page padrão 25, máximo 100). Retorna meta (contadores) + payload (array de card Kanban).",
|
|
4681
|
-
"category": "Kanban V2",
|
|
4682
|
-
"params": [],
|
|
4683
|
-
"returns": "meta (contadores globais) + payload (array de cards Kanban)",
|
|
4684
|
-
"common_use_cases": [
|
|
4685
|
-
"Dashboard: contar/exibir cards Kanban",
|
|
4686
|
-
"Buscar com filtros antes de outra operação",
|
|
4687
|
-
"Auditoria/relatório de cards Kanban ativas"
|
|
4688
|
-
],
|
|
4689
|
-
"related_tools": [
|
|
4690
|
-
"lionchat_kanban_v2_list",
|
|
4691
|
-
"lionchat_kanban_v2_create",
|
|
4692
|
-
"lionchat_kanban_v2_show"
|
|
4693
|
-
]
|
|
4694
|
-
},
|
|
4695
|
-
{
|
|
4696
|
-
"id": "lionchat_kanban_v2_create_2",
|
|
4697
|
-
"method": "POST",
|
|
4698
|
-
"path": "/api/v1/accounts/{account_id}/kanban/funnels",
|
|
4699
|
-
"title": "Criar Funil (V2)",
|
|
4700
|
-
"description": "Cria um novo funil no Kanban. Cria novo card Kanban. Obrigatórios: name, stages. Valida unicidade quando aplicável. Retorna o card Kanban criado com ID atribuído.",
|
|
4701
|
-
"category": "Kanban V2",
|
|
4702
|
-
"params": [
|
|
4703
|
-
{
|
|
4704
|
-
"name": "name",
|
|
4705
|
-
"type": "string",
|
|
4706
|
-
"location": "body",
|
|
4707
|
-
"required": true,
|
|
4708
|
-
"description": "Nome do funil"
|
|
4709
|
-
},
|
|
4710
|
-
{
|
|
4711
|
-
"name": "stages",
|
|
4712
|
-
"type": "array",
|
|
4713
|
-
"location": "body",
|
|
4714
|
-
"required": true,
|
|
4715
|
-
"description": "Etapas do funil"
|
|
4716
|
-
}
|
|
4717
|
-
],
|
|
4718
|
-
"returns": "card Kanban criado (com novo ID)",
|
|
4719
|
-
"common_use_cases": [
|
|
4720
|
-
"Cadastro inicial de card Kanban",
|
|
4721
|
-
"Automação a partir de evento externo",
|
|
4722
|
-
"Importação manual via API"
|
|
4723
|
-
],
|
|
4724
|
-
"related_tools": [
|
|
4725
|
-
"lionchat_kanban_v2_list",
|
|
4726
|
-
"lionchat_kanban_v2_create",
|
|
4727
|
-
"lionchat_kanban_v2_show"
|
|
4728
|
-
]
|
|
4729
|
-
},
|
|
4730
|
-
{
|
|
4731
|
-
"id": "lionchat_kanban_v2_show_1",
|
|
4732
|
-
"method": "GET",
|
|
4733
|
-
"path": "/api/v1/accounts/{account_id}/kanban/funnels/{id}",
|
|
4734
|
-
"title": "Detalhes Funil (V2)",
|
|
4735
|
-
"description": "Retorna detalhes de um funil. Retorna detalhes completos de UM card Kanban específico pelo ID. Inclui campos relacionais quando aplicável.",
|
|
4736
|
-
"category": "Kanban V2",
|
|
4737
|
-
"params": [
|
|
4738
|
-
{
|
|
4739
|
-
"name": "id",
|
|
4740
|
-
"type": "integer",
|
|
4741
|
-
"location": "path",
|
|
4742
|
-
"required": true,
|
|
4743
|
-
"description": "ID do funil"
|
|
4744
|
-
}
|
|
4745
|
-
],
|
|
4746
|
-
"returns": "card Kanban (objeto completo com associações)",
|
|
4747
|
-
"common_use_cases": [
|
|
4748
|
-
"Ver dados completos antes de editar",
|
|
4749
|
-
"Verificar estado atual antes de uma ação",
|
|
4750
|
-
"Mostrar perfil ou ficha de card Kanban"
|
|
4751
|
-
],
|
|
4752
|
-
"related_tools": [
|
|
4753
|
-
"lionchat_kanban_v2_list",
|
|
4754
|
-
"lionchat_kanban_v2_create",
|
|
4755
|
-
"lionchat_kanban_v2_show"
|
|
4756
|
-
]
|
|
4757
|
-
},
|
|
4758
|
-
{
|
|
4759
|
-
"id": "lionchat_kanban_v2_update_1",
|
|
4760
|
-
"method": "PUT",
|
|
4761
|
-
"path": "/api/v1/accounts/{account_id}/kanban/funnels/{id}",
|
|
4762
|
-
"title": "Atualizar Funil (V2)",
|
|
4763
|
-
"description": "Atualiza um funil. Atualiza campos do card Kanban existente. Suporta atualização parcial (PATCH) — só campos enviados são alterados. Campos suportados: name, stages.",
|
|
4764
|
-
"category": "Kanban V2",
|
|
4765
|
-
"params": [
|
|
4766
|
-
{
|
|
4767
|
-
"name": "id",
|
|
4768
|
-
"type": "integer",
|
|
4769
|
-
"location": "path",
|
|
4770
|
-
"required": true,
|
|
4771
|
-
"description": "ID do funil"
|
|
4772
|
-
},
|
|
4773
|
-
{
|
|
4774
|
-
"name": "name",
|
|
4775
|
-
"type": "string",
|
|
4776
|
-
"location": "body",
|
|
4777
|
-
"required": false,
|
|
4778
|
-
"description": "Nome"
|
|
4779
|
-
},
|
|
4780
|
-
{
|
|
4781
|
-
"name": "stages",
|
|
4782
|
-
"type": "array",
|
|
4783
|
-
"location": "body",
|
|
4784
|
-
"required": false,
|
|
4785
|
-
"description": "Etapas"
|
|
4786
|
-
}
|
|
4787
|
-
],
|
|
4788
|
-
"returns": "card Kanban atualizado",
|
|
4789
|
-
"common_use_cases": [
|
|
4790
|
-
"Edição parcial de card Kanban",
|
|
4791
|
-
"Alteração de status/estado",
|
|
4792
|
-
"Atualização em massa via automação"
|
|
4793
|
-
],
|
|
4794
|
-
"related_tools": [
|
|
4795
|
-
"lionchat_kanban_v2_list",
|
|
4796
|
-
"lionchat_kanban_v2_create",
|
|
4797
|
-
"lionchat_kanban_v2_show"
|
|
4798
|
-
]
|
|
4799
|
-
},
|
|
4800
|
-
{
|
|
4801
|
-
"id": "lionchat_kanban_v2_destroy_3",
|
|
4802
|
-
"method": "DELETE",
|
|
4803
|
-
"path": "/api/v1/accounts/{account_id}/kanban/funnels/{id}",
|
|
4804
|
-
"title": "Excluir Funil (V2)",
|
|
4805
|
-
"description": "Remove um funil do Kanban. Remove card Kanban permanentemente. CUIDADO: ação irreversível em muitos casos. Verifique dependências antes.",
|
|
4806
|
-
"category": "Kanban V2",
|
|
4807
|
-
"params": [
|
|
4808
|
-
{
|
|
4809
|
-
"name": "id",
|
|
4810
|
-
"type": "integer",
|
|
4811
|
-
"location": "path",
|
|
4812
|
-
"required": true,
|
|
4813
|
-
"description": "ID do funil"
|
|
4814
|
-
}
|
|
4815
|
-
],
|
|
4816
|
-
"returns": "204 No Content",
|
|
4817
|
-
"common_use_cases": [
|
|
4818
|
-
"Limpeza de dados obsoletos",
|
|
4819
|
-
"Deduplicação manual",
|
|
4820
|
-
"Remoção após confirmação do cliente"
|
|
4821
|
-
],
|
|
4822
|
-
"related_tools": [
|
|
4823
|
-
"lionchat_kanban_v2_list",
|
|
4824
|
-
"lionchat_kanban_v2_create",
|
|
4825
|
-
"lionchat_kanban_v2_show"
|
|
4826
|
-
]
|
|
4827
|
-
},
|
|
4828
|
-
{
|
|
4829
|
-
"id": "lionchat_kanban_v2_list_3",
|
|
4830
|
-
"method": "GET",
|
|
4831
|
-
"path": "/api/v1/accounts/{account_id}/kanban/stages",
|
|
4832
|
-
"title": "Listar Etapas Kanban",
|
|
4833
|
-
"description": "Lista todas as etapas configuradas. Lista cards Kanban paginados (per_page padrão 25, máximo 100). Retorna meta (contadores) + payload (array de card Kanban).",
|
|
4834
|
-
"category": "Kanban V2",
|
|
4835
|
-
"params": [],
|
|
4836
|
-
"returns": "meta (contadores globais) + payload (array de cards Kanban)",
|
|
4837
|
-
"common_use_cases": [
|
|
4838
|
-
"Dashboard: contar/exibir cards Kanban",
|
|
4839
|
-
"Buscar com filtros antes de outra operação",
|
|
4840
|
-
"Auditoria/relatório de cards Kanban ativas"
|
|
4841
|
-
],
|
|
4842
|
-
"related_tools": [
|
|
4843
|
-
"lionchat_kanban_v2_list",
|
|
4844
|
-
"lionchat_kanban_v2_create",
|
|
4845
|
-
"lionchat_kanban_v2_show"
|
|
4846
|
-
]
|
|
4847
|
-
},
|
|
4848
|
-
{
|
|
4849
|
-
"id": "lionchat_kanban_v2_create_3",
|
|
4850
|
-
"method": "POST",
|
|
4851
|
-
"path": "/api/v1/accounts/{account_id}/kanban/stages",
|
|
4852
|
-
"title": "Criar Etapa Kanban",
|
|
4853
|
-
"description": "Cria uma nova etapa no Kanban. Cria novo card Kanban. Obrigatórios: name, funnel_id. Valida unicidade quando aplicável. Retorna o card Kanban criado com ID atribuído.",
|
|
4854
|
-
"category": "Kanban V2",
|
|
4855
|
-
"params": [
|
|
4856
|
-
{
|
|
4857
|
-
"name": "name",
|
|
4858
|
-
"type": "string",
|
|
4859
|
-
"location": "body",
|
|
4860
|
-
"required": true,
|
|
4861
|
-
"description": "Nome da etapa"
|
|
4862
|
-
},
|
|
4863
|
-
{
|
|
4864
|
-
"name": "funnel_id",
|
|
4865
|
-
"type": "integer",
|
|
4866
|
-
"location": "body",
|
|
4867
|
-
"required": true,
|
|
4868
|
-
"description": "ID do funil"
|
|
4869
|
-
},
|
|
4870
|
-
{
|
|
4871
|
-
"name": "position",
|
|
4872
|
-
"type": "integer",
|
|
4873
|
-
"location": "body",
|
|
4874
|
-
"required": false,
|
|
4875
|
-
"description": "Posicao"
|
|
4876
|
-
}
|
|
4877
|
-
],
|
|
4878
|
-
"returns": "card Kanban criado (com novo ID)",
|
|
4879
|
-
"common_use_cases": [
|
|
4880
|
-
"Cadastro inicial de card Kanban",
|
|
4881
|
-
"Automação a partir de evento externo",
|
|
4882
|
-
"Importação manual via API"
|
|
4883
|
-
],
|
|
4884
|
-
"related_tools": [
|
|
4885
|
-
"lionchat_kanban_v2_list",
|
|
4886
|
-
"lionchat_kanban_v2_create",
|
|
4887
|
-
"lionchat_kanban_v2_show"
|
|
4888
|
-
]
|
|
4889
|
-
},
|
|
4890
|
-
{
|
|
4891
|
-
"id": "lionchat_kanban_v2_show_2",
|
|
4892
|
-
"method": "GET",
|
|
4893
|
-
"path": "/api/v1/accounts/{account_id}/kanban/stages/{id}",
|
|
4894
|
-
"title": "Detalhes Etapa Kanban",
|
|
4895
|
-
"description": "Retorna detalhes de uma etapa. Retorna detalhes completos de UM card Kanban específico pelo ID. Inclui campos relacionais quando aplicável.",
|
|
4896
|
-
"category": "Kanban V2",
|
|
4897
|
-
"params": [
|
|
4504
|
+
"location": "path",
|
|
4505
|
+
"required": true,
|
|
4506
|
+
"description": "ID do item"
|
|
4507
|
+
},
|
|
4898
4508
|
{
|
|
4899
4509
|
"name": "id",
|
|
4900
4510
|
"type": "integer",
|
|
4901
4511
|
"location": "path",
|
|
4902
4512
|
"required": true,
|
|
4903
|
-
"description": "ID
|
|
4513
|
+
"description": "ID do anexo"
|
|
4904
4514
|
}
|
|
4905
4515
|
],
|
|
4906
|
-
"returns": "
|
|
4516
|
+
"returns": "204 No Content",
|
|
4907
4517
|
"common_use_cases": [
|
|
4908
|
-
"
|
|
4909
|
-
"
|
|
4910
|
-
"
|
|
4518
|
+
"Limpeza de dados obsoletos",
|
|
4519
|
+
"Deduplicação manual",
|
|
4520
|
+
"Remoção após confirmação do cliente"
|
|
4911
4521
|
],
|
|
4912
4522
|
"related_tools": [
|
|
4913
4523
|
"lionchat_kanban_v2_list",
|
|
@@ -4916,40 +4526,33 @@
|
|
|
4916
4526
|
]
|
|
4917
4527
|
},
|
|
4918
4528
|
{
|
|
4919
|
-
"id": "
|
|
4920
|
-
"method": "
|
|
4921
|
-
"path": "/api/v1/accounts/{account_id}/kanban/
|
|
4922
|
-
"title": "
|
|
4923
|
-
"description": "
|
|
4529
|
+
"id": "lionchat_kanban_v2_create_1",
|
|
4530
|
+
"method": "POST",
|
|
4531
|
+
"path": "/api/v1/accounts/{account_id}/kanban/items/{item_id}/note_attachments",
|
|
4532
|
+
"title": "Adicionar Anexo a Nota",
|
|
4533
|
+
"description": "Adiciona um anexo a uma nota do item. Cria novo card Kanban. Obrigatórios: item_id, file. Valida unicidade quando aplicável. Retorna o card Kanban criado com ID atribuído.",
|
|
4924
4534
|
"category": "Kanban V2",
|
|
4925
4535
|
"params": [
|
|
4926
4536
|
{
|
|
4927
|
-
"name": "
|
|
4537
|
+
"name": "item_id",
|
|
4928
4538
|
"type": "integer",
|
|
4929
4539
|
"location": "path",
|
|
4930
4540
|
"required": true,
|
|
4931
|
-
"description": "ID
|
|
4932
|
-
},
|
|
4933
|
-
{
|
|
4934
|
-
"name": "name",
|
|
4935
|
-
"type": "string",
|
|
4936
|
-
"location": "body",
|
|
4937
|
-
"required": false,
|
|
4938
|
-
"description": "Nome"
|
|
4541
|
+
"description": "ID do item"
|
|
4939
4542
|
},
|
|
4940
4543
|
{
|
|
4941
|
-
"name": "
|
|
4942
|
-
"type": "
|
|
4544
|
+
"name": "file",
|
|
4545
|
+
"type": "file",
|
|
4943
4546
|
"location": "body",
|
|
4944
|
-
"required":
|
|
4945
|
-
"description": "
|
|
4547
|
+
"required": true,
|
|
4548
|
+
"description": "Arquivo para upload"
|
|
4946
4549
|
}
|
|
4947
4550
|
],
|
|
4948
|
-
"returns": "card Kanban
|
|
4551
|
+
"returns": "card Kanban criado (com novo ID)",
|
|
4949
4552
|
"common_use_cases": [
|
|
4950
|
-
"
|
|
4951
|
-
"
|
|
4952
|
-
"
|
|
4553
|
+
"Cadastro inicial de card Kanban",
|
|
4554
|
+
"Automação a partir de evento externo",
|
|
4555
|
+
"Importação manual via API"
|
|
4953
4556
|
],
|
|
4954
4557
|
"related_tools": [
|
|
4955
4558
|
"lionchat_kanban_v2_list",
|
|
@@ -4958,19 +4561,26 @@
|
|
|
4958
4561
|
]
|
|
4959
4562
|
},
|
|
4960
4563
|
{
|
|
4961
|
-
"id": "
|
|
4564
|
+
"id": "lionchat_kanban_v2_destroy_2",
|
|
4962
4565
|
"method": "DELETE",
|
|
4963
|
-
"path": "/api/v1/accounts/{account_id}/kanban/
|
|
4964
|
-
"title": "
|
|
4965
|
-
"description": "Remove
|
|
4566
|
+
"path": "/api/v1/accounts/{account_id}/kanban/items/{item_id}/note_attachments/{id}",
|
|
4567
|
+
"title": "Remover Anexo de Nota",
|
|
4568
|
+
"description": "Remove um anexo de nota do item. Remove card Kanban permanentemente. CUIDADO: ação irreversível em muitos casos. Verifique dependências antes.",
|
|
4966
4569
|
"category": "Kanban V2",
|
|
4967
4570
|
"params": [
|
|
4571
|
+
{
|
|
4572
|
+
"name": "item_id",
|
|
4573
|
+
"type": "integer",
|
|
4574
|
+
"location": "path",
|
|
4575
|
+
"required": true,
|
|
4576
|
+
"description": "ID do item"
|
|
4577
|
+
},
|
|
4968
4578
|
{
|
|
4969
4579
|
"name": "id",
|
|
4970
4580
|
"type": "integer",
|
|
4971
4581
|
"location": "path",
|
|
4972
4582
|
"required": true,
|
|
4973
|
-
"description": "ID
|
|
4583
|
+
"description": "ID do anexo"
|
|
4974
4584
|
}
|
|
4975
4585
|
],
|
|
4976
4586
|
"returns": "204 No Content",
|
|
@@ -6250,7 +5860,7 @@
|
|
|
6250
5860
|
"method": "POST",
|
|
6251
5861
|
"path": "/api/v1/accounts/{account_id}/captain/bulk_actions",
|
|
6252
5862
|
"title": "Acoes em Massa IA",
|
|
6253
|
-
"description": "Executa
|
|
5863
|
+
"description": "Executa uma acao em massa sobre varios recursos do Captain de uma vez (ex: exclusao em lote). NAO cria um assistente. Informe o tipo da acao, os IDs alvo e os campos da operacao.",
|
|
6254
5864
|
"category": "Assistentes",
|
|
6255
5865
|
"params": [
|
|
6256
5866
|
{
|
|
@@ -6258,21 +5868,28 @@
|
|
|
6258
5868
|
"type": "string",
|
|
6259
5869
|
"location": "body",
|
|
6260
5870
|
"required": true,
|
|
6261
|
-
"description": "Tipo da acao"
|
|
5871
|
+
"description": "Tipo da acao em massa (ex: Documents para excluir documentos)"
|
|
6262
5872
|
},
|
|
6263
5873
|
{
|
|
6264
5874
|
"name": "ids",
|
|
6265
5875
|
"type": "array",
|
|
6266
5876
|
"location": "body",
|
|
6267
5877
|
"required": true,
|
|
6268
|
-
"description": "Array de IDs"
|
|
5878
|
+
"description": "Array de IDs dos recursos alvo"
|
|
5879
|
+
},
|
|
5880
|
+
{
|
|
5881
|
+
"name": "fields",
|
|
5882
|
+
"type": "object",
|
|
5883
|
+
"location": "body",
|
|
5884
|
+
"required": true,
|
|
5885
|
+
"description": "Campos da operacao em massa (ex: { action: 'delete' })"
|
|
6269
5886
|
}
|
|
6270
5887
|
],
|
|
6271
|
-
"returns": "
|
|
5888
|
+
"returns": "resultado da acao em massa (lista de respostas por item)",
|
|
6272
5889
|
"common_use_cases": [
|
|
6273
|
-
"
|
|
6274
|
-
"
|
|
6275
|
-
"
|
|
5890
|
+
"Excluir varios documentos da base de conhecimento de uma vez",
|
|
5891
|
+
"Aplicar uma acao em lote a multiplos recursos do Captain",
|
|
5892
|
+
"Operacoes de limpeza em massa"
|
|
6276
5893
|
],
|
|
6277
5894
|
"related_tools": [
|
|
6278
5895
|
"lionchat_captain_assistants_list",
|
|
@@ -7084,6 +6701,133 @@
|
|
|
7084
6701
|
],
|
|
7085
6702
|
"related_tools": []
|
|
7086
6703
|
},
|
|
6704
|
+
{
|
|
6705
|
+
"id": "lionchat_teams_create",
|
|
6706
|
+
"method": "POST",
|
|
6707
|
+
"path": "/api/v1/accounts/{account_id}/teams",
|
|
6708
|
+
"title": "Criar Time",
|
|
6709
|
+
"description": "Cria um novo time/equipe na conta. Obrigatório: name. Opcionais: description, allow_auto_assign (distribuição automática de conversas), assignment_mode. Para adicionar agentes ao time depois, use lionchat_team_members_create.",
|
|
6710
|
+
"category": "Times",
|
|
6711
|
+
"params": [
|
|
6712
|
+
{
|
|
6713
|
+
"name": "name",
|
|
6714
|
+
"type": "string",
|
|
6715
|
+
"location": "body",
|
|
6716
|
+
"required": true,
|
|
6717
|
+
"description": "Nome do time/equipe"
|
|
6718
|
+
},
|
|
6719
|
+
{
|
|
6720
|
+
"name": "description",
|
|
6721
|
+
"type": "string",
|
|
6722
|
+
"location": "body",
|
|
6723
|
+
"required": false,
|
|
6724
|
+
"description": "Descrição do time/equipe"
|
|
6725
|
+
},
|
|
6726
|
+
{
|
|
6727
|
+
"name": "allow_auto_assign",
|
|
6728
|
+
"type": "boolean",
|
|
6729
|
+
"location": "body",
|
|
6730
|
+
"required": false,
|
|
6731
|
+
"description": "Habilita atribuição automática de conversas aos membros"
|
|
6732
|
+
},
|
|
6733
|
+
{
|
|
6734
|
+
"name": "assignment_mode",
|
|
6735
|
+
"type": "string",
|
|
6736
|
+
"location": "body",
|
|
6737
|
+
"required": false,
|
|
6738
|
+
"description": "Modo de atribuição de conversas no time"
|
|
6739
|
+
}
|
|
6740
|
+
],
|
|
6741
|
+
"returns": "time/equipe criado (com novo ID)",
|
|
6742
|
+
"common_use_cases": [
|
|
6743
|
+
"Cadastro inicial de time/equipe",
|
|
6744
|
+
"Organizar agentes por departamento ou função",
|
|
6745
|
+
"Automação a partir de evento externo"
|
|
6746
|
+
],
|
|
6747
|
+
"related_tools": [
|
|
6748
|
+
"lionchat_team_members_create"
|
|
6749
|
+
]
|
|
6750
|
+
},
|
|
6751
|
+
{
|
|
6752
|
+
"id": "lionchat_teams_update",
|
|
6753
|
+
"method": "PUT",
|
|
6754
|
+
"path": "/api/v1/accounts/{account_id}/teams/{team_id}",
|
|
6755
|
+
"title": "Atualizar Time",
|
|
6756
|
+
"description": "Atualiza um time/equipe existente. Campos suportados: name, description, allow_auto_assign, assignment_mode. Edita o time em si (não os membros — para membros use lionchat_team_members_update).",
|
|
6757
|
+
"category": "Times",
|
|
6758
|
+
"params": [
|
|
6759
|
+
{
|
|
6760
|
+
"name": "team_id",
|
|
6761
|
+
"type": "integer",
|
|
6762
|
+
"location": "path",
|
|
6763
|
+
"required": true,
|
|
6764
|
+
"description": "ID do time"
|
|
6765
|
+
},
|
|
6766
|
+
{
|
|
6767
|
+
"name": "name",
|
|
6768
|
+
"type": "string",
|
|
6769
|
+
"location": "body",
|
|
6770
|
+
"required": false,
|
|
6771
|
+
"description": "Novo nome do time/equipe"
|
|
6772
|
+
},
|
|
6773
|
+
{
|
|
6774
|
+
"name": "description",
|
|
6775
|
+
"type": "string",
|
|
6776
|
+
"location": "body",
|
|
6777
|
+
"required": false,
|
|
6778
|
+
"description": "Nova descrição do time/equipe"
|
|
6779
|
+
},
|
|
6780
|
+
{
|
|
6781
|
+
"name": "allow_auto_assign",
|
|
6782
|
+
"type": "boolean",
|
|
6783
|
+
"location": "body",
|
|
6784
|
+
"required": false,
|
|
6785
|
+
"description": "Habilita atribuição automática de conversas aos membros"
|
|
6786
|
+
},
|
|
6787
|
+
{
|
|
6788
|
+
"name": "assignment_mode",
|
|
6789
|
+
"type": "string",
|
|
6790
|
+
"location": "body",
|
|
6791
|
+
"required": false,
|
|
6792
|
+
"description": "Modo de atribuição de conversas no time"
|
|
6793
|
+
}
|
|
6794
|
+
],
|
|
6795
|
+
"returns": "time/equipe atualizado",
|
|
6796
|
+
"common_use_cases": [
|
|
6797
|
+
"Renomear um time/equipe",
|
|
6798
|
+
"Ligar ou desligar a atribuição automática",
|
|
6799
|
+
"Ajustar descrição ou modo de atribuição"
|
|
6800
|
+
],
|
|
6801
|
+
"related_tools": [
|
|
6802
|
+
"lionchat_team_members_update"
|
|
6803
|
+
]
|
|
6804
|
+
},
|
|
6805
|
+
{
|
|
6806
|
+
"id": "lionchat_teams_destroy",
|
|
6807
|
+
"method": "DELETE",
|
|
6808
|
+
"path": "/api/v1/accounts/{account_id}/teams/{team_id}",
|
|
6809
|
+
"title": "Excluir Time",
|
|
6810
|
+
"description": "Exclui permanentemente um time/equipe. CUIDADO: ação irreversível — remove o time e seus vínculos com agentes. Para apenas remover agentes mantendo o time, use lionchat_team_members_destroy.",
|
|
6811
|
+
"category": "Times",
|
|
6812
|
+
"params": [
|
|
6813
|
+
{
|
|
6814
|
+
"name": "team_id",
|
|
6815
|
+
"type": "integer",
|
|
6816
|
+
"location": "path",
|
|
6817
|
+
"required": true,
|
|
6818
|
+
"description": "ID do time"
|
|
6819
|
+
}
|
|
6820
|
+
],
|
|
6821
|
+
"returns": "200 OK",
|
|
6822
|
+
"common_use_cases": [
|
|
6823
|
+
"Remover time/equipe obsoleto",
|
|
6824
|
+
"Limpeza após reorganização da equipe",
|
|
6825
|
+
"Exclusão após confirmação do cliente"
|
|
6826
|
+
],
|
|
6827
|
+
"related_tools": [
|
|
6828
|
+
"lionchat_team_members_destroy"
|
|
6829
|
+
]
|
|
6830
|
+
},
|
|
7087
6831
|
{
|
|
7088
6832
|
"id": "lionchat_teams_list_1",
|
|
7089
6833
|
"method": "GET",
|
|
@@ -8009,7 +7753,7 @@
|
|
|
8009
7753
|
"method": "POST",
|
|
8010
7754
|
"path": "/api/v1/accounts/{account_id}/account_tasks/{id}/snooze",
|
|
8011
7755
|
"title": "Adiar Tarefa",
|
|
8012
|
-
"description": "Adia tarefa para nova data
|
|
7756
|
+
"description": "Adia (snooze) uma tarefa existente para uma nova data, mudando seu status para snoozed. NAO cria uma tarefa nova. Retorna a tarefa atualizada.",
|
|
8013
7757
|
"category": "Agenda / Tarefas",
|
|
8014
7758
|
"params": [
|
|
8015
7759
|
{
|
|
@@ -8017,21 +7761,21 @@
|
|
|
8017
7761
|
"type": "integer",
|
|
8018
7762
|
"location": "path",
|
|
8019
7763
|
"required": true,
|
|
8020
|
-
"description": "ID"
|
|
7764
|
+
"description": "ID da tarefa"
|
|
8021
7765
|
},
|
|
8022
7766
|
{
|
|
8023
7767
|
"name": "snoozed_until",
|
|
8024
7768
|
"type": "string",
|
|
8025
7769
|
"location": "body",
|
|
8026
7770
|
"required": true,
|
|
8027
|
-
"description": "Nova data ISO 8601"
|
|
7771
|
+
"description": "Nova data/hora ISO 8601 ate quando adiar"
|
|
8028
7772
|
}
|
|
8029
7773
|
],
|
|
8030
|
-
"returns": "tarefa
|
|
7774
|
+
"returns": "tarefa atualizada (status snoozed)",
|
|
8031
7775
|
"common_use_cases": [
|
|
8032
|
-
"
|
|
8033
|
-
"
|
|
8034
|
-
"
|
|
7776
|
+
"Adiar uma tarefa para depois",
|
|
7777
|
+
"Reagendar lembrete que ainda nao deve aparecer",
|
|
7778
|
+
"Tirar a tarefa da lista ativa temporariamente"
|
|
8035
7779
|
],
|
|
8036
7780
|
"related_tools": []
|
|
8037
7781
|
},
|
|
@@ -8672,7 +8416,7 @@
|
|
|
8672
8416
|
"method": "POST",
|
|
8673
8417
|
"path": "/api/v1/accounts/{account_id}/kanban_items/{id}/create_note",
|
|
8674
8418
|
"title": "Criar Nota",
|
|
8675
|
-
"description": "Cria nota no item
|
|
8419
|
+
"description": "Cria nota no item do kanban. Obrigatórios: id, text. Retorna o item com a nota adicionada.",
|
|
8676
8420
|
"category": "Notas",
|
|
8677
8421
|
"params": [
|
|
8678
8422
|
{
|
|
@@ -8683,14 +8427,14 @@
|
|
|
8683
8427
|
"description": "ID"
|
|
8684
8428
|
},
|
|
8685
8429
|
{
|
|
8686
|
-
"name": "
|
|
8430
|
+
"name": "text",
|
|
8687
8431
|
"type": "string",
|
|
8688
8432
|
"location": "body",
|
|
8689
8433
|
"required": true,
|
|
8690
|
-
"description": "Conteudo"
|
|
8434
|
+
"description": "Conteudo da nota"
|
|
8691
8435
|
}
|
|
8692
8436
|
],
|
|
8693
|
-
"returns": "nota
|
|
8437
|
+
"returns": "nota criada (com novo ID)",
|
|
8694
8438
|
"common_use_cases": [
|
|
8695
8439
|
"Cadastro inicial de nota",
|
|
8696
8440
|
"Automação a partir de evento externo",
|
|
@@ -9627,11 +9371,11 @@
|
|
|
9627
9371
|
]
|
|
9628
9372
|
},
|
|
9629
9373
|
{
|
|
9630
|
-
"id": "
|
|
9374
|
+
"id": "lionchat_team_members_create",
|
|
9631
9375
|
"method": "POST",
|
|
9632
9376
|
"path": "/api/v1/accounts/{account_id}/teams/{team_id}/team_members",
|
|
9633
9377
|
"title": "Adicionar Membros ao Time",
|
|
9634
|
-
"description": "Adiciona membros a um time.
|
|
9378
|
+
"description": "Adiciona agentes (membros) a um time/equipe existente. NÃO cria o time — apenas vincula agentes a ele. Obrigatórios: team_id (path) e user_ids (array de IDs de agentes). Para criar o time em si, use lionchat_teams_create.",
|
|
9635
9379
|
"category": "Times",
|
|
9636
9380
|
"params": [
|
|
9637
9381
|
{
|
|
@@ -9658,11 +9402,11 @@
|
|
|
9658
9402
|
"related_tools": []
|
|
9659
9403
|
},
|
|
9660
9404
|
{
|
|
9661
|
-
"id": "
|
|
9405
|
+
"id": "lionchat_team_members_update",
|
|
9662
9406
|
"method": "PATCH",
|
|
9663
9407
|
"path": "/api/v1/accounts/{account_id}/teams/{team_id}/team_members",
|
|
9664
9408
|
"title": "Atualizar Membros do Time",
|
|
9665
|
-
"description": "Substitui a lista de membros
|
|
9409
|
+
"description": "Substitui a lista de membros (agentes) de um time/equipe existente. NÃO altera nome/configuração do time — apenas o conjunto de agentes vinculados. Obrigatórios: team_id (path) e user_ids (nova lista de IDs). Para editar o time em si, use lionchat_teams_update.",
|
|
9666
9410
|
"category": "Times",
|
|
9667
9411
|
"params": [
|
|
9668
9412
|
{
|
|
@@ -9689,11 +9433,11 @@
|
|
|
9689
9433
|
"related_tools": []
|
|
9690
9434
|
},
|
|
9691
9435
|
{
|
|
9692
|
-
"id": "
|
|
9436
|
+
"id": "lionchat_team_members_destroy",
|
|
9693
9437
|
"method": "DELETE",
|
|
9694
9438
|
"path": "/api/v1/accounts/{account_id}/teams/{team_id}/team_members",
|
|
9695
9439
|
"title": "Remover Membros do Time",
|
|
9696
|
-
"description": "Remove membros de um time.
|
|
9440
|
+
"description": "Remove agentes (membros) de um time/equipe. NÃO apaga o time — apenas desvincula os agentes informados. Obrigatórios: team_id (path) e user_ids (IDs dos agentes a remover). Para excluir o time em si, use lionchat_teams_destroy.",
|
|
9697
9441
|
"category": "Times",
|
|
9698
9442
|
"params": [
|
|
9699
9443
|
{
|
|
@@ -12075,7 +11819,7 @@
|
|
|
12075
11819
|
"method": "POST",
|
|
12076
11820
|
"path": "/public/api/v1/booking/{account_id}/{event_slug}/reserve",
|
|
12077
11821
|
"title": "Reservar Horário",
|
|
12078
|
-
"description": "Reserva um horário. Cria contato, tarefa e confirmação via WhatsApp. Sem autenticação, com rate limiting.
|
|
11822
|
+
"description": "Reserva um horário. Cria contato, tarefa e confirmação via WhatsApp. Sem autenticação, com rate limiting. Obrigatórios: event_slug (path), name, email, phone, date, slot. Retorna a reserva confirmada.",
|
|
12079
11823
|
"category": "Publica",
|
|
12080
11824
|
"params": [
|
|
12081
11825
|
{
|
|
@@ -12135,11 +11879,11 @@
|
|
|
12135
11879
|
"description": "Fuso horário"
|
|
12136
11880
|
}
|
|
12137
11881
|
],
|
|
12138
|
-
"returns": "
|
|
11882
|
+
"returns": "{ status: 'confirmed', booking: { scheduled_at, duration_minutes, event_type, agent_name } }",
|
|
12139
11883
|
"common_use_cases": [
|
|
12140
|
-
"
|
|
12141
|
-
"
|
|
12142
|
-
"
|
|
11884
|
+
"Cliente final reserva um horario na pagina publica de agendamento",
|
|
11885
|
+
"Confirmar agendamento sem login",
|
|
11886
|
+
"Integracao de booking externo via link publico"
|
|
12143
11887
|
],
|
|
12144
11888
|
"related_tools": [
|
|
12145
11889
|
"lionchat_public_booking_list",
|
|
@@ -12324,58 +12068,133 @@
|
|
|
12324
12068
|
"category": "Base de Conhecimento",
|
|
12325
12069
|
"params": [
|
|
12326
12070
|
{
|
|
12327
|
-
"name": "name",
|
|
12328
|
-
"type": "string",
|
|
12329
|
-
"location": "body",
|
|
12330
|
-
"required": false,
|
|
12331
|
-
"description": "Nome do documento"
|
|
12071
|
+
"name": "name",
|
|
12072
|
+
"type": "string",
|
|
12073
|
+
"location": "body",
|
|
12074
|
+
"required": false,
|
|
12075
|
+
"description": "Nome do documento"
|
|
12076
|
+
},
|
|
12077
|
+
{
|
|
12078
|
+
"name": "external_link",
|
|
12079
|
+
"type": "string",
|
|
12080
|
+
"location": "body",
|
|
12081
|
+
"required": false,
|
|
12082
|
+
"description": "URL externa para indexar (alternativa ao upload)"
|
|
12083
|
+
},
|
|
12084
|
+
{
|
|
12085
|
+
"name": "pdf_file",
|
|
12086
|
+
"type": "file",
|
|
12087
|
+
"location": "body",
|
|
12088
|
+
"required": false,
|
|
12089
|
+
"description": "Arquivo PDF para indexar (multipart upload)"
|
|
12090
|
+
},
|
|
12091
|
+
{
|
|
12092
|
+
"name": "content",
|
|
12093
|
+
"type": "string",
|
|
12094
|
+
"location": "body",
|
|
12095
|
+
"required": false,
|
|
12096
|
+
"description": "Texto direto do documento"
|
|
12097
|
+
},
|
|
12098
|
+
{
|
|
12099
|
+
"name": "description",
|
|
12100
|
+
"type": "string",
|
|
12101
|
+
"location": "body",
|
|
12102
|
+
"required": false,
|
|
12103
|
+
"description": "Descricao do documento"
|
|
12104
|
+
},
|
|
12105
|
+
{
|
|
12106
|
+
"name": "assistant_id",
|
|
12107
|
+
"type": "integer",
|
|
12108
|
+
"location": "body",
|
|
12109
|
+
"required": true,
|
|
12110
|
+
"description": "ID do assistant ao qual associar este documento"
|
|
12111
|
+
}
|
|
12112
|
+
],
|
|
12113
|
+
"returns": "documento KB criado (com novo ID)",
|
|
12114
|
+
"common_use_cases": [
|
|
12115
|
+
"Cadastro inicial de documento KB",
|
|
12116
|
+
"Automação a partir de evento externo",
|
|
12117
|
+
"Importação manual via API"
|
|
12118
|
+
],
|
|
12119
|
+
"related_tools": [
|
|
12120
|
+
"lionchat_captain_documents_list",
|
|
12121
|
+
"lionchat_captain_documents_destroy",
|
|
12122
|
+
"lionchat_captain_documents_create_1"
|
|
12123
|
+
],
|
|
12124
|
+
"body_wrapper": "document"
|
|
12125
|
+
},
|
|
12126
|
+
{
|
|
12127
|
+
"id": "lionchat_captain_documents_show",
|
|
12128
|
+
"method": "GET",
|
|
12129
|
+
"path": "/api/v1/accounts/{account_id}/captain/documents/{id}",
|
|
12130
|
+
"title": "Detalhe do Documento",
|
|
12131
|
+
"description": "Retorna os detalhes completos de UM documento da base de conhecimento pelo ID (título, conteúdo, descrição, status de indexação e assistant associado).",
|
|
12132
|
+
"category": "Base de Conhecimento",
|
|
12133
|
+
"params": [
|
|
12134
|
+
{
|
|
12135
|
+
"name": "id",
|
|
12136
|
+
"type": "integer",
|
|
12137
|
+
"location": "path",
|
|
12138
|
+
"required": true,
|
|
12139
|
+
"description": "ID do documento"
|
|
12140
|
+
}
|
|
12141
|
+
],
|
|
12142
|
+
"returns": "documento KB (objeto completo)",
|
|
12143
|
+
"common_use_cases": [
|
|
12144
|
+
"Ver dados completos antes de editar",
|
|
12145
|
+
"Verificar status de indexação do documento",
|
|
12146
|
+
"Mostrar o conteúdo atual de um documento manual"
|
|
12147
|
+
],
|
|
12148
|
+
"related_tools": [
|
|
12149
|
+
"lionchat_captain_documents_list",
|
|
12150
|
+
"lionchat_captain_documents_update"
|
|
12151
|
+
]
|
|
12152
|
+
},
|
|
12153
|
+
{
|
|
12154
|
+
"id": "lionchat_captain_documents_update",
|
|
12155
|
+
"method": "PATCH",
|
|
12156
|
+
"path": "/api/v1/accounts/{account_id}/captain/documents/{id}",
|
|
12157
|
+
"title": "Editar Documento",
|
|
12158
|
+
"description": "Edita um documento manual da base de conhecimento. Campos suportados: name (título), content (conteúdo) e description (descrição). Ao alterar o conteúdo, a reindexação acontece automaticamente.",
|
|
12159
|
+
"category": "Base de Conhecimento",
|
|
12160
|
+
"params": [
|
|
12161
|
+
{
|
|
12162
|
+
"name": "id",
|
|
12163
|
+
"type": "integer",
|
|
12164
|
+
"location": "path",
|
|
12165
|
+
"required": true,
|
|
12166
|
+
"description": "ID do documento"
|
|
12332
12167
|
},
|
|
12333
12168
|
{
|
|
12334
|
-
"name": "
|
|
12169
|
+
"name": "name",
|
|
12335
12170
|
"type": "string",
|
|
12336
12171
|
"location": "body",
|
|
12337
12172
|
"required": false,
|
|
12338
|
-
"description": "
|
|
12339
|
-
},
|
|
12340
|
-
{
|
|
12341
|
-
"name": "pdf_file",
|
|
12342
|
-
"type": "file",
|
|
12343
|
-
"location": "body",
|
|
12344
|
-
"required": false,
|
|
12345
|
-
"description": "Arquivo PDF para indexar (multipart upload)"
|
|
12173
|
+
"description": "Novo título do documento"
|
|
12346
12174
|
},
|
|
12347
12175
|
{
|
|
12348
12176
|
"name": "content",
|
|
12349
12177
|
"type": "string",
|
|
12350
12178
|
"location": "body",
|
|
12351
12179
|
"required": false,
|
|
12352
|
-
"description": "
|
|
12180
|
+
"description": "Novo conteúdo do documento (dispara reindexação)"
|
|
12353
12181
|
},
|
|
12354
12182
|
{
|
|
12355
12183
|
"name": "description",
|
|
12356
12184
|
"type": "string",
|
|
12357
12185
|
"location": "body",
|
|
12358
12186
|
"required": false,
|
|
12359
|
-
"description": "
|
|
12360
|
-
},
|
|
12361
|
-
{
|
|
12362
|
-
"name": "assistant_id",
|
|
12363
|
-
"type": "integer",
|
|
12364
|
-
"location": "body",
|
|
12365
|
-
"required": true,
|
|
12366
|
-
"description": "ID do assistant ao qual associar este documento"
|
|
12187
|
+
"description": "Nova descrição do documento"
|
|
12367
12188
|
}
|
|
12368
12189
|
],
|
|
12369
|
-
"returns": "documento KB
|
|
12190
|
+
"returns": "documento KB atualizado",
|
|
12370
12191
|
"common_use_cases": [
|
|
12371
|
-
"
|
|
12372
|
-
"
|
|
12373
|
-
"
|
|
12192
|
+
"Corrigir o conteúdo de um documento manual",
|
|
12193
|
+
"Renomear um documento da base de conhecimento",
|
|
12194
|
+
"Ajustar a descrição de um documento"
|
|
12374
12195
|
],
|
|
12375
12196
|
"related_tools": [
|
|
12376
|
-
"
|
|
12377
|
-
"lionchat_captain_documents_destroy",
|
|
12378
|
-
"lionchat_captain_documents_create_1"
|
|
12197
|
+
"lionchat_captain_documents_show"
|
|
12379
12198
|
],
|
|
12380
12199
|
"body_wrapper": "document"
|
|
12381
12200
|
},
|
|
@@ -14204,7 +14023,7 @@
|
|
|
14204
14023
|
"method": "GET",
|
|
14205
14024
|
"path": "/api/v1/accounts/{account_id}/inboxes/{inbox_id}/migration/preview",
|
|
14206
14025
|
"title": "Preview de Migracao",
|
|
14207
|
-
"description": "
|
|
14026
|
+
"description": "Calcula uma previa da migracao de conversas da inbox de origem para a inbox de destino (target_inbox_id). NAO retorna lista paginada — retorna contagens: quantas conversas sao migraveis, conflitantes (ja existem no destino) e nao-migraveis (arquivadas como historico). Requer admin.",
|
|
14208
14027
|
"category": "Migracao de Inbox",
|
|
14209
14028
|
"params": [
|
|
14210
14029
|
{
|
|
@@ -14213,13 +14032,20 @@
|
|
|
14213
14032
|
"location": "path",
|
|
14214
14033
|
"required": true,
|
|
14215
14034
|
"description": "ID da inbox de origem"
|
|
14035
|
+
},
|
|
14036
|
+
{
|
|
14037
|
+
"name": "target_inbox_id",
|
|
14038
|
+
"type": "integer",
|
|
14039
|
+
"location": "query",
|
|
14040
|
+
"required": true,
|
|
14041
|
+
"description": "ID da inbox de destino"
|
|
14216
14042
|
}
|
|
14217
14043
|
],
|
|
14218
|
-
"returns": "
|
|
14044
|
+
"returns": "{ total_conversations, migratable, conflicting, archived_as_history, contacts_affected }",
|
|
14219
14045
|
"common_use_cases": [
|
|
14220
|
-
"
|
|
14221
|
-
"
|
|
14222
|
-
"
|
|
14046
|
+
"Conferir o impacto antes de migrar conversas entre inboxes",
|
|
14047
|
+
"Detectar conflitos antes de executar a migracao",
|
|
14048
|
+
"Estimar quantos contatos serao afetados"
|
|
14223
14049
|
],
|
|
14224
14050
|
"related_tools": [
|
|
14225
14051
|
"lionchat_inboxes_inbox_migration_execute",
|
|
@@ -14596,7 +14422,7 @@
|
|
|
14596
14422
|
"method": "POST",
|
|
14597
14423
|
"path": "/api/v1/accounts/{account_id}/assignment_policies",
|
|
14598
14424
|
"title": "Criar Politica de Atribuicao",
|
|
14599
|
-
"description": "Cria uma nova politica de atribuicao.
|
|
14425
|
+
"description": "Cria uma nova politica de atribuicao. Obrigatório: name. Retorna a política de atribuição criada com ID atribuído.",
|
|
14600
14426
|
"category": "Politicas de Atribuicao",
|
|
14601
14427
|
"params": [
|
|
14602
14428
|
{
|
|
@@ -14607,21 +14433,49 @@
|
|
|
14607
14433
|
"description": "Nome da politica"
|
|
14608
14434
|
},
|
|
14609
14435
|
{
|
|
14610
|
-
"name": "
|
|
14436
|
+
"name": "description",
|
|
14611
14437
|
"type": "string",
|
|
14612
14438
|
"location": "body",
|
|
14613
|
-
"required":
|
|
14614
|
-
"description": "
|
|
14439
|
+
"required": false,
|
|
14440
|
+
"description": "Descricao da politica"
|
|
14615
14441
|
},
|
|
14616
14442
|
{
|
|
14617
|
-
"name": "
|
|
14443
|
+
"name": "assignment_order",
|
|
14444
|
+
"type": "string",
|
|
14445
|
+
"location": "body",
|
|
14446
|
+
"required": false,
|
|
14447
|
+
"description": "Ordem de atribuicao: round_robin ou balanced"
|
|
14448
|
+
},
|
|
14449
|
+
{
|
|
14450
|
+
"name": "conversation_priority",
|
|
14451
|
+
"type": "string",
|
|
14452
|
+
"location": "body",
|
|
14453
|
+
"required": false,
|
|
14454
|
+
"description": "Prioridade das conversas: earliest_created ou longest_waiting"
|
|
14455
|
+
},
|
|
14456
|
+
{
|
|
14457
|
+
"name": "fair_distribution_limit",
|
|
14618
14458
|
"type": "integer",
|
|
14619
14459
|
"location": "body",
|
|
14620
14460
|
"required": false,
|
|
14621
|
-
"description": "Limite
|
|
14461
|
+
"description": "Limite de conversas por agente na distribuicao justa"
|
|
14462
|
+
},
|
|
14463
|
+
{
|
|
14464
|
+
"name": "fair_distribution_window",
|
|
14465
|
+
"type": "integer",
|
|
14466
|
+
"location": "body",
|
|
14467
|
+
"required": false,
|
|
14468
|
+
"description": "Janela de tempo (segundos) da distribuicao justa"
|
|
14469
|
+
},
|
|
14470
|
+
{
|
|
14471
|
+
"name": "enabled",
|
|
14472
|
+
"type": "boolean",
|
|
14473
|
+
"location": "body",
|
|
14474
|
+
"required": false,
|
|
14475
|
+
"description": "Politica ativa ou nao"
|
|
14622
14476
|
}
|
|
14623
14477
|
],
|
|
14624
|
-
"returns": "política de atribuição
|
|
14478
|
+
"returns": "política de atribuição criada (com novo ID)",
|
|
14625
14479
|
"common_use_cases": [
|
|
14626
14480
|
"Cadastro inicial de política de atribuição",
|
|
14627
14481
|
"Automação a partir de evento externo",
|
|
@@ -14667,7 +14521,7 @@
|
|
|
14667
14521
|
"method": "PUT",
|
|
14668
14522
|
"path": "/api/v1/accounts/{account_id}/assignment_policies/{id}",
|
|
14669
14523
|
"title": "Atualizar Politica de Atribuicao",
|
|
14670
|
-
"description": "Atualiza uma politica de atribuicao.
|
|
14524
|
+
"description": "Atualiza uma politica de atribuicao. Suporta atualização parcial — só campos enviados são alterados. Campos suportados: name, description, assignment_order, conversation_priority, fair_distribution_limit, fair_distribution_window, enabled.",
|
|
14671
14525
|
"category": "Politicas de Atribuicao",
|
|
14672
14526
|
"params": [
|
|
14673
14527
|
{
|
|
@@ -14685,21 +14539,49 @@
|
|
|
14685
14539
|
"description": "Nome"
|
|
14686
14540
|
},
|
|
14687
14541
|
{
|
|
14688
|
-
"name": "
|
|
14542
|
+
"name": "description",
|
|
14689
14543
|
"type": "string",
|
|
14690
14544
|
"location": "body",
|
|
14691
14545
|
"required": false,
|
|
14692
|
-
"description": "
|
|
14546
|
+
"description": "Descricao da politica"
|
|
14693
14547
|
},
|
|
14694
14548
|
{
|
|
14695
|
-
"name": "
|
|
14549
|
+
"name": "assignment_order",
|
|
14550
|
+
"type": "string",
|
|
14551
|
+
"location": "body",
|
|
14552
|
+
"required": false,
|
|
14553
|
+
"description": "Ordem de atribuicao: round_robin ou balanced"
|
|
14554
|
+
},
|
|
14555
|
+
{
|
|
14556
|
+
"name": "conversation_priority",
|
|
14557
|
+
"type": "string",
|
|
14558
|
+
"location": "body",
|
|
14559
|
+
"required": false,
|
|
14560
|
+
"description": "Prioridade das conversas: earliest_created ou longest_waiting"
|
|
14561
|
+
},
|
|
14562
|
+
{
|
|
14563
|
+
"name": "fair_distribution_limit",
|
|
14564
|
+
"type": "integer",
|
|
14565
|
+
"location": "body",
|
|
14566
|
+
"required": false,
|
|
14567
|
+
"description": "Limite de conversas por agente na distribuicao justa"
|
|
14568
|
+
},
|
|
14569
|
+
{
|
|
14570
|
+
"name": "fair_distribution_window",
|
|
14696
14571
|
"type": "integer",
|
|
14697
14572
|
"location": "body",
|
|
14698
14573
|
"required": false,
|
|
14699
|
-
"description": "
|
|
14574
|
+
"description": "Janela de tempo (segundos) da distribuicao justa"
|
|
14575
|
+
},
|
|
14576
|
+
{
|
|
14577
|
+
"name": "enabled",
|
|
14578
|
+
"type": "boolean",
|
|
14579
|
+
"location": "body",
|
|
14580
|
+
"required": false,
|
|
14581
|
+
"description": "Politica ativa ou nao"
|
|
14700
14582
|
}
|
|
14701
14583
|
],
|
|
14702
|
-
"returns": "política de atribuição
|
|
14584
|
+
"returns": "política de atribuição atualizada",
|
|
14703
14585
|
"common_use_cases": [
|
|
14704
14586
|
"Edição parcial de política de atribuição",
|
|
14705
14587
|
"Alteração de status/estado",
|
|
@@ -17818,7 +17700,7 @@
|
|
|
17818
17700
|
"method": "POST",
|
|
17819
17701
|
"path": "/api/v1/accounts/{account_id}/captain/documents/{id}/recrawl",
|
|
17820
17702
|
"title": "Re-indexar Documento",
|
|
17821
|
-
"description": "
|
|
17703
|
+
"description": "Reprocessa e reindexa um documento JA EXISTENTE da base de conhecimento (recrawl). NAO cria um documento novo. Reseta o status do documento e dispara o reprocessamento (crawl/chunks/FAQs). Retorna o mesmo documento atualizado.",
|
|
17822
17704
|
"category": "Base de Conhecimento",
|
|
17823
17705
|
"params": [
|
|
17824
17706
|
{
|
|
@@ -17826,14 +17708,14 @@
|
|
|
17826
17708
|
"type": "integer",
|
|
17827
17709
|
"location": "path",
|
|
17828
17710
|
"required": true,
|
|
17829
|
-
"description": "ID do documento"
|
|
17711
|
+
"description": "ID do documento existente"
|
|
17830
17712
|
}
|
|
17831
17713
|
],
|
|
17832
|
-
"returns": "documento
|
|
17714
|
+
"returns": "documento atualizado (mesmo ID, status reprocessando)",
|
|
17833
17715
|
"common_use_cases": [
|
|
17834
|
-
"
|
|
17835
|
-
"
|
|
17836
|
-
"
|
|
17716
|
+
"Reprocessar documento que falhou na indexacao",
|
|
17717
|
+
"Forcar reindexacao apos atualizar a fonte",
|
|
17718
|
+
"Recuperar documento travado em erro"
|
|
17837
17719
|
],
|
|
17838
17720
|
"related_tools": [
|
|
17839
17721
|
"lionchat_captain_documents_list",
|
|
@@ -18388,11 +18270,19 @@
|
|
|
18388
18270
|
"id": "lionchat_agent_availability_list",
|
|
18389
18271
|
"method": "GET",
|
|
18390
18272
|
"path": "/api/v1/accounts/{account_id}/agent_availability",
|
|
18391
|
-
"title": "Ver Disponibilidade",
|
|
18392
|
-
"description": "Retorna
|
|
18273
|
+
"title": "Ver Grade de Disponibilidade",
|
|
18274
|
+
"description": "Retorna a grade semanal de disponibilidade (slots) do agente logado, ou de outro agente via user_id (admin ou agenda publica). Cada slot tem dia da semana e faixa de horario. Tambem retorna timezone e cor da agenda.",
|
|
18393
18275
|
"category": "Disponibilidade",
|
|
18394
|
-
"params": [
|
|
18395
|
-
|
|
18276
|
+
"params": [
|
|
18277
|
+
{
|
|
18278
|
+
"name": "user_id",
|
|
18279
|
+
"type": "integer",
|
|
18280
|
+
"location": "query",
|
|
18281
|
+
"required": false,
|
|
18282
|
+
"description": "ID de outro agente para ver a grade dele (requer admin ou agenda publica). Sem este param, retorna a grade do agente logado"
|
|
18283
|
+
}
|
|
18284
|
+
],
|
|
18285
|
+
"returns": "{ user_id, agenda_color, timezone, slots: [{ id, day_of_week, start_time, end_time }] }",
|
|
18396
18286
|
"common_use_cases": [
|
|
18397
18287
|
"Dashboard: contar/exibir disponibilidades",
|
|
18398
18288
|
"Buscar com filtros antes de outra operação",
|
|
@@ -18408,19 +18298,19 @@
|
|
|
18408
18298
|
"id": "lionchat_agent_availability_update",
|
|
18409
18299
|
"method": "PUT",
|
|
18410
18300
|
"path": "/api/v1/accounts/{account_id}/agent_availability",
|
|
18411
|
-
"title": "Atualizar Disponibilidade",
|
|
18412
|
-
"description": "
|
|
18301
|
+
"title": "Atualizar Grade de Disponibilidade",
|
|
18302
|
+
"description": "Substitui (replace-all) a grade semanal de disponibilidade do agente logado. Apaga todos os slots atuais e recria com o array enviado. Cada slot define um dia da semana e uma faixa de horario. NAO eh status de presenca (online/offline/busy).",
|
|
18413
18303
|
"category": "Disponibilidade",
|
|
18414
18304
|
"params": [
|
|
18415
18305
|
{
|
|
18416
|
-
"name": "
|
|
18417
|
-
"type": "
|
|
18306
|
+
"name": "slots",
|
|
18307
|
+
"type": "array",
|
|
18418
18308
|
"location": "body",
|
|
18419
18309
|
"required": true,
|
|
18420
|
-
"description": "
|
|
18310
|
+
"description": "Array de slots: [{ day_of_week (0=domingo a 6=sabado), start_time (HH:MM), end_time (HH:MM) }]. Substitui toda a grade existente"
|
|
18421
18311
|
}
|
|
18422
18312
|
],
|
|
18423
|
-
"returns": "
|
|
18313
|
+
"returns": "{ user_id, slots: [{ id, day_of_week, start_time, end_time }] }",
|
|
18424
18314
|
"common_use_cases": [
|
|
18425
18315
|
"Edição parcial de disponibilidade",
|
|
18426
18316
|
"Alteração de status/estado",
|
|
@@ -18436,11 +18326,26 @@
|
|
|
18436
18326
|
"id": "lionchat_agent_availability_list_1",
|
|
18437
18327
|
"method": "GET",
|
|
18438
18328
|
"path": "/api/v1/accounts/{account_id}/agent_availability/check",
|
|
18439
|
-
"title": "Verificar Disponibilidade",
|
|
18440
|
-
"description": "Verifica
|
|
18329
|
+
"title": "Verificar Disponibilidade num Horario",
|
|
18330
|
+
"description": "Verifica se um agente esta disponivel num horario especifico, considerando a grade semanal e tarefas conflitantes. Por padrao checa o agente logado; use user_id para checar outro.",
|
|
18441
18331
|
"category": "Disponibilidade",
|
|
18442
|
-
"params": [
|
|
18443
|
-
|
|
18332
|
+
"params": [
|
|
18333
|
+
{
|
|
18334
|
+
"name": "time",
|
|
18335
|
+
"type": "string",
|
|
18336
|
+
"location": "query",
|
|
18337
|
+
"required": true,
|
|
18338
|
+
"description": "Horario a verificar, em ISO8601 (ex: 2026-05-29T14:00:00-03:00)"
|
|
18339
|
+
},
|
|
18340
|
+
{
|
|
18341
|
+
"name": "user_id",
|
|
18342
|
+
"type": "integer",
|
|
18343
|
+
"location": "query",
|
|
18344
|
+
"required": false,
|
|
18345
|
+
"description": "ID do agente a verificar (requer admin ou agenda publica). Sem este param, verifica o agente logado"
|
|
18346
|
+
}
|
|
18347
|
+
],
|
|
18348
|
+
"returns": "{ available, time, user_id, reason?, conflicting_task?, available_until? }",
|
|
18444
18349
|
"common_use_cases": [
|
|
18445
18350
|
"Dashboard: contar/exibir disponibilidades",
|
|
18446
18351
|
"Buscar com filtros antes de outra operação",
|
|
@@ -18456,11 +18361,19 @@
|
|
|
18456
18361
|
"id": "lionchat_agent_availability_list_2",
|
|
18457
18362
|
"method": "GET",
|
|
18458
18363
|
"path": "/api/v1/accounts/{account_id}/agent_availability/available_agents",
|
|
18459
|
-
"title": "Agentes Disponiveis",
|
|
18460
|
-
"description": "Lista agentes
|
|
18364
|
+
"title": "Agentes Disponiveis num Horario",
|
|
18365
|
+
"description": "Lista todos os agentes disponiveis num horario especifico (para auto-atribuicao/IA). Requer admin ou bot. Considera a grade semanal de cada agente.",
|
|
18461
18366
|
"category": "Disponibilidade",
|
|
18462
|
-
"params": [
|
|
18463
|
-
|
|
18367
|
+
"params": [
|
|
18368
|
+
{
|
|
18369
|
+
"name": "time",
|
|
18370
|
+
"type": "string",
|
|
18371
|
+
"location": "query",
|
|
18372
|
+
"required": true,
|
|
18373
|
+
"description": "Horario a verificar, em ISO8601 (ex: 2026-05-29T14:00:00-03:00)"
|
|
18374
|
+
}
|
|
18375
|
+
],
|
|
18376
|
+
"returns": "{ time, agents: [{ id, name, available_until }] }",
|
|
18464
18377
|
"common_use_cases": [
|
|
18465
18378
|
"Dashboard: contar/exibir disponibilidades",
|
|
18466
18379
|
"Buscar com filtros antes de outra operação",
|
|
@@ -18473,11 +18386,11 @@
|
|
|
18473
18386
|
]
|
|
18474
18387
|
},
|
|
18475
18388
|
{
|
|
18476
|
-
"id": "
|
|
18389
|
+
"id": "lionchat_agents_assigned_resources",
|
|
18477
18390
|
"method": "GET",
|
|
18478
18391
|
"path": "/api/v1/accounts/{account_id}/agents/{id}/assigned_resources",
|
|
18479
18392
|
"title": "Recursos Atribuidos ao Agente",
|
|
18480
|
-
"description": "Lista recursos
|
|
18393
|
+
"description": "Lista os recursos (conversas, times, inboxes etc.) vinculados a um agente. Útil antes de excluir o agente para saber se é preciso reatribuir os recursos a outro (ver lionchat_agents_destroy).",
|
|
18481
18394
|
"category": "Agentes",
|
|
18482
18395
|
"params": [
|
|
18483
18396
|
{
|
|
@@ -18488,20 +18401,20 @@
|
|
|
18488
18401
|
"description": "ID do agente"
|
|
18489
18402
|
}
|
|
18490
18403
|
],
|
|
18491
|
-
"returns": "
|
|
18404
|
+
"returns": "recursos atribuídos ao agente (has_resources + detalhamento)",
|
|
18492
18405
|
"common_use_cases": [
|
|
18493
|
-
"
|
|
18494
|
-
"
|
|
18495
|
-
"Auditoria
|
|
18406
|
+
"Checar dependências antes de excluir um agente",
|
|
18407
|
+
"Decidir se é necessário reatribuir recursos",
|
|
18408
|
+
"Auditoria de carga de trabalho do agente"
|
|
18496
18409
|
],
|
|
18497
18410
|
"related_tools": []
|
|
18498
18411
|
},
|
|
18499
18412
|
{
|
|
18500
|
-
"id": "
|
|
18413
|
+
"id": "lionchat_agents_bulk_create",
|
|
18501
18414
|
"method": "POST",
|
|
18502
18415
|
"path": "/api/v1/accounts/{account_id}/agents/bulk_create",
|
|
18503
|
-
"title": "
|
|
18504
|
-
"description": "
|
|
18416
|
+
"title": "Convidar Agentes em Massa",
|
|
18417
|
+
"description": "Convida vários agentes de uma vez por e-mail. Obrigatório: emails (array de e-mails). Cada agente convidado recebe o convite e entra como agent. Para convidar UM agente com nome/cargo/disponibilidade definidos, use lionchat_agents_create.",
|
|
18505
18418
|
"category": "Agentes",
|
|
18506
18419
|
"params": [
|
|
18507
18420
|
{
|
|
@@ -18509,16 +18422,160 @@
|
|
|
18509
18422
|
"type": "array",
|
|
18510
18423
|
"location": "body",
|
|
18511
18424
|
"required": true,
|
|
18512
|
-
"description": "Array de
|
|
18425
|
+
"description": "Array de e-mails dos agentes a convidar"
|
|
18513
18426
|
}
|
|
18514
18427
|
],
|
|
18515
|
-
"returns": "
|
|
18428
|
+
"returns": "lista de agentes convidados (com novos IDs)",
|
|
18516
18429
|
"common_use_cases": [
|
|
18517
|
-
"
|
|
18518
|
-
"
|
|
18519
|
-
"
|
|
18430
|
+
"Onboarding de uma equipe inteira de uma vez",
|
|
18431
|
+
"Importação manual de vários agentes via API",
|
|
18432
|
+
"Automação de convites a partir de evento externo"
|
|
18520
18433
|
],
|
|
18521
|
-
"related_tools": [
|
|
18434
|
+
"related_tools": [
|
|
18435
|
+
"lionchat_agents_create"
|
|
18436
|
+
]
|
|
18437
|
+
},
|
|
18438
|
+
{
|
|
18439
|
+
"id": "lionchat_agents_create",
|
|
18440
|
+
"method": "POST",
|
|
18441
|
+
"path": "/api/v1/accounts/{account_id}/agents",
|
|
18442
|
+
"title": "Convidar Agente",
|
|
18443
|
+
"description": "Convida um único agente para a conta. Obrigatório: email. Opcionais: name, role (agent ou administrator), availability, auto_offline. O agente recebe um convite por e-mail. Para convidar vários de uma vez, use lionchat_agents_bulk_create.",
|
|
18444
|
+
"category": "Agentes",
|
|
18445
|
+
"params": [
|
|
18446
|
+
{
|
|
18447
|
+
"name": "email",
|
|
18448
|
+
"type": "string",
|
|
18449
|
+
"location": "body",
|
|
18450
|
+
"required": true,
|
|
18451
|
+
"description": "E-mail do agente a convidar"
|
|
18452
|
+
},
|
|
18453
|
+
{
|
|
18454
|
+
"name": "name",
|
|
18455
|
+
"type": "string",
|
|
18456
|
+
"location": "body",
|
|
18457
|
+
"required": false,
|
|
18458
|
+
"description": "Nome do agente"
|
|
18459
|
+
},
|
|
18460
|
+
{
|
|
18461
|
+
"name": "role",
|
|
18462
|
+
"type": "string",
|
|
18463
|
+
"location": "body",
|
|
18464
|
+
"required": false,
|
|
18465
|
+
"description": "Papel do agente: agent ou administrator"
|
|
18466
|
+
},
|
|
18467
|
+
{
|
|
18468
|
+
"name": "availability",
|
|
18469
|
+
"type": "string",
|
|
18470
|
+
"location": "body",
|
|
18471
|
+
"required": false,
|
|
18472
|
+
"description": "Disponibilidade inicial do agente (online, busy, offline)"
|
|
18473
|
+
},
|
|
18474
|
+
{
|
|
18475
|
+
"name": "auto_offline",
|
|
18476
|
+
"type": "boolean",
|
|
18477
|
+
"location": "body",
|
|
18478
|
+
"required": false,
|
|
18479
|
+
"description": "Define se o agente fica offline automaticamente por inatividade"
|
|
18480
|
+
}
|
|
18481
|
+
],
|
|
18482
|
+
"returns": "agente convidado (com novo ID)",
|
|
18483
|
+
"common_use_cases": [
|
|
18484
|
+
"Adicionar um novo agente à equipe",
|
|
18485
|
+
"Convidar um administrador com papel definido",
|
|
18486
|
+
"Cadastro individual de agente via API"
|
|
18487
|
+
],
|
|
18488
|
+
"related_tools": [
|
|
18489
|
+
"lionchat_agents_bulk_create",
|
|
18490
|
+
"lionchat_agents_update"
|
|
18491
|
+
]
|
|
18492
|
+
},
|
|
18493
|
+
{
|
|
18494
|
+
"id": "lionchat_agents_update",
|
|
18495
|
+
"method": "PATCH",
|
|
18496
|
+
"path": "/api/v1/accounts/{account_id}/agents/{id}",
|
|
18497
|
+
"title": "Atualizar Agente",
|
|
18498
|
+
"description": "Atualiza um agente existente. Campos suportados: name, role (agent ou administrator), availability, auto_offline. Use para promover/rebaixar papel ou ajustar disponibilidade.",
|
|
18499
|
+
"category": "Agentes",
|
|
18500
|
+
"params": [
|
|
18501
|
+
{
|
|
18502
|
+
"name": "id",
|
|
18503
|
+
"type": "integer",
|
|
18504
|
+
"location": "path",
|
|
18505
|
+
"required": true,
|
|
18506
|
+
"description": "ID do agente"
|
|
18507
|
+
},
|
|
18508
|
+
{
|
|
18509
|
+
"name": "name",
|
|
18510
|
+
"type": "string",
|
|
18511
|
+
"location": "body",
|
|
18512
|
+
"required": false,
|
|
18513
|
+
"description": "Novo nome do agente"
|
|
18514
|
+
},
|
|
18515
|
+
{
|
|
18516
|
+
"name": "role",
|
|
18517
|
+
"type": "string",
|
|
18518
|
+
"location": "body",
|
|
18519
|
+
"required": false,
|
|
18520
|
+
"description": "Novo papel: agent ou administrator"
|
|
18521
|
+
},
|
|
18522
|
+
{
|
|
18523
|
+
"name": "availability",
|
|
18524
|
+
"type": "string",
|
|
18525
|
+
"location": "body",
|
|
18526
|
+
"required": false,
|
|
18527
|
+
"description": "Nova disponibilidade (online, busy, offline)"
|
|
18528
|
+
},
|
|
18529
|
+
{
|
|
18530
|
+
"name": "auto_offline",
|
|
18531
|
+
"type": "boolean",
|
|
18532
|
+
"location": "body",
|
|
18533
|
+
"required": false,
|
|
18534
|
+
"description": "Define se o agente fica offline automaticamente por inatividade"
|
|
18535
|
+
}
|
|
18536
|
+
],
|
|
18537
|
+
"returns": "agente atualizado",
|
|
18538
|
+
"common_use_cases": [
|
|
18539
|
+
"Promover um agente a administrador",
|
|
18540
|
+
"Alterar disponibilidade de um agente",
|
|
18541
|
+
"Ajustar o comportamento de offline automático"
|
|
18542
|
+
],
|
|
18543
|
+
"related_tools": [
|
|
18544
|
+
"lionchat_agents_create"
|
|
18545
|
+
]
|
|
18546
|
+
},
|
|
18547
|
+
{
|
|
18548
|
+
"id": "lionchat_agents_destroy",
|
|
18549
|
+
"method": "DELETE",
|
|
18550
|
+
"path": "/api/v1/accounts/{account_id}/agents/{id}",
|
|
18551
|
+
"title": "Excluir Agente",
|
|
18552
|
+
"description": "Remove um agente da conta. ATENÇÃO: se o agente tiver recursos vinculados (conversas, times, inboxes etc.), o parâmetro reassign_to_agent_id é OBRIGATÓRIO para reatribuir esses recursos a outro agente — sem ele a exclusão é recusada. Use lionchat_agents_assigned_resources antes para checar dependências.",
|
|
18553
|
+
"category": "Agentes",
|
|
18554
|
+
"params": [
|
|
18555
|
+
{
|
|
18556
|
+
"name": "id",
|
|
18557
|
+
"type": "integer",
|
|
18558
|
+
"location": "path",
|
|
18559
|
+
"required": true,
|
|
18560
|
+
"description": "ID do agente a excluir"
|
|
18561
|
+
},
|
|
18562
|
+
{
|
|
18563
|
+
"name": "reassign_to_agent_id",
|
|
18564
|
+
"type": "integer",
|
|
18565
|
+
"location": "body",
|
|
18566
|
+
"required": false,
|
|
18567
|
+
"description": "ID do agente que receberá os recursos. Obrigatório quando o agente possui recursos vinculados."
|
|
18568
|
+
}
|
|
18569
|
+
],
|
|
18570
|
+
"returns": "200 OK",
|
|
18571
|
+
"common_use_cases": [
|
|
18572
|
+
"Desligar um agente reatribuindo suas conversas",
|
|
18573
|
+
"Limpeza de agentes inativos",
|
|
18574
|
+
"Remoção após confirmação do cliente"
|
|
18575
|
+
],
|
|
18576
|
+
"related_tools": [
|
|
18577
|
+
"lionchat_agents_assigned_resources"
|
|
18578
|
+
]
|
|
18522
18579
|
},
|
|
18523
18580
|
{
|
|
18524
18581
|
"id": "lionchat_custom_attributes_list",
|
|
@@ -18545,7 +18602,7 @@
|
|
|
18545
18602
|
"method": "POST",
|
|
18546
18603
|
"path": "/api/v1/accounts/{account_id}/custom_attribute_definitions",
|
|
18547
18604
|
"title": "Criar Definicao de Atributo",
|
|
18548
|
-
"description": "Cria uma nova definicao de atributo personalizado.
|
|
18605
|
+
"description": "Cria uma nova definicao de atributo personalizado. **Requer perfil Administrador.** Obrigatórios: attribute_display_name, attribute_display_type, attribute_key. attribute_model tem default 'conversation_attribute' — para um atributo de contato, passe 'contact_attribute'. Retorna o atributo personalizado criado com ID atribuído.",
|
|
18549
18606
|
"category": "Atributos Personalizados",
|
|
18550
18607
|
"params": [
|
|
18551
18608
|
{
|
|
@@ -18566,8 +18623,8 @@
|
|
|
18566
18623
|
"name": "attribute_model",
|
|
18567
18624
|
"type": "string",
|
|
18568
18625
|
"location": "body",
|
|
18569
|
-
"required":
|
|
18570
|
-
"description": "Modelo: contact_attribute ou conversation_attribute"
|
|
18626
|
+
"required": false,
|
|
18627
|
+
"description": "Modelo: contact_attribute ou conversation_attribute (default: conversation_attribute)"
|
|
18571
18628
|
},
|
|
18572
18629
|
{
|
|
18573
18630
|
"name": "attribute_key",
|
|
@@ -18603,13 +18660,6 @@
|
|
|
18603
18660
|
"location": "body",
|
|
18604
18661
|
"required": false,
|
|
18605
18662
|
"description": "Dica de formato exibida ao usuario quando regex_pattern falha"
|
|
18606
|
-
},
|
|
18607
|
-
{
|
|
18608
|
-
"name": "default_value",
|
|
18609
|
-
"type": "string",
|
|
18610
|
-
"location": "body",
|
|
18611
|
-
"required": false,
|
|
18612
|
-
"description": "Valor default do atributo"
|
|
18613
18663
|
}
|
|
18614
18664
|
],
|
|
18615
18665
|
"returns": "atributo personalizado criado (com novo ID)",
|
|
@@ -18817,4 +18867,4 @@
|
|
|
18817
18867
|
],
|
|
18818
18868
|
"related_tools": []
|
|
18819
18869
|
}
|
|
18820
|
-
]
|
|
18870
|
+
]
|