@botozap/sdk 0.21.0 → 0.23.0
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/CHANGELOG.md +50 -0
- package/README.md +60 -3
- package/dist/index.cjs +296 -6
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +572 -5
- package/dist/index.d.ts +572 -5
- package/dist/index.js +296 -6
- package/dist/index.js.map +1 -1
- package/package.json +1 -1
package/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,55 @@
|
|
|
1
1
|
# @botozap/sdk
|
|
2
2
|
|
|
3
|
+
## 0.23.0
|
|
4
|
+
|
|
5
|
+
### Minor Changes
|
|
6
|
+
|
|
7
|
+
- 394ca5e: Conversas antigas do app WhatsApp Business (coexistência, botozap#1004):
|
|
8
|
+
`phoneNumbers.getHistoryImport` e `phoneNumbers.setHistoryImport` (`GET` e
|
|
9
|
+
`PUT /v1/phone_numbers/{id}/history-import`, `{ window_days: 0 | 30 | 180 }`), com os
|
|
10
|
+
tipos `HistoryImport`, `HistoryImportStatus`, `HistoryImportWindowDays` e
|
|
11
|
+
`SetHistoryImportParams` e os erros `history_import_not_available` (404) e
|
|
12
|
+
`history_import_locked` (409). CLI `numbers history-import get <id>` e
|
|
13
|
+
`numbers history-import set <id> --days 0|30|180`; tools
|
|
14
|
+
`get_phone_number_history_import` (leitura) e `set_phone_number_history_import`
|
|
15
|
+
(escolha única por conexão, `destructiveHint`), só no catálogo completo: o perfil
|
|
16
|
+
`assistant` (OAuth) não muda.
|
|
17
|
+
|
|
18
|
+
## 0.22.0
|
|
19
|
+
|
|
20
|
+
### Minor Changes
|
|
21
|
+
|
|
22
|
+
- 8eba0bc: Paridade com a API de 23/10/2026. "Digitando…" e leitura: `conversations.typing` e
|
|
23
|
+
`conversations.markRead` (`POST /v1/conversations/{id}/typing` e `/read`; CLI
|
|
24
|
+
`conversations typing` e `read`; tools `conversation_typing` e `mark_conversation_read`),
|
|
25
|
+
com o erro `no_inbound_message` (409). Responder citando: `reply_to: { message_id }` em
|
|
26
|
+
texto, template, mídia, interactive e localização (não em reação) e em
|
|
27
|
+
`conversations.reply`; o recibo e as mensagens trazem `reply_to`, e as mensagens trazem
|
|
28
|
+
`played_at` (voz ouvida, evento `whatsapp.message.played`) e `transcription` (áudio
|
|
29
|
+
recebido já transcrito pela IA); erros `reply_target_not_found` e
|
|
30
|
+
`reply_target_unavailable` (CLI `--reply-to` em send, send-media, send-interactive e
|
|
31
|
+
send-location; MCP `reply_to` em `send_message` e `send_media_message` e
|
|
32
|
+
`reply_to_message_id` em `reply_to_conversation`). Mensagem de voz: `voice: true` em áudio
|
|
33
|
+
(CLI `send-media --voice`; MCP `voice` em `send_media_message`), com `invalid_voice` e
|
|
34
|
+
`unsupported_voice`. Modelos prontos de Régua:
|
|
35
|
+
`journeys.catalog` e `journeys.enableModel` (CLI `journeys catalog` e `enable-model`;
|
|
36
|
+
tools `list_journey_models` e `enable_journey_model`). Diagnóstico do agente:
|
|
37
|
+
`ai.agents.diagnostic` (CLI `ai agents diagnostic`; tool `ai_agents_diagnostic`). IA:
|
|
38
|
+
`AiToolId` e o enum das tools `ai_*` aceitam `conversations.reply_options`.
|
|
39
|
+
Configurações do número do WhatsApp: `phoneNumbers.getProfile`, `updateProfile`,
|
|
40
|
+
`uploadProfilePhoto`, `getConversationalAutomation`, `updateConversationalAutomation`,
|
|
41
|
+
`clearConversationalAutomation`, `phoneNumbers.qrCodes` (`list`, `create`, `get`,
|
|
42
|
+
`update`, `delete`) e `phoneNumbers.blockedUsers` (`list`, `block`, `unblock`), com os
|
|
43
|
+
códigos de erro da Meta (`coexistence_not_supported`, `block_window_closed`,
|
|
44
|
+
`meta_unconfirmed`…); CLI `numbers profile|prompts|qr|blocked`; tools
|
|
45
|
+
`get_phone_number_profile`, `update_phone_number_profile` (por OAuth a API responde 403),
|
|
46
|
+
`get_conversational_automation`, `update_conversational_automation`,
|
|
47
|
+
`clear_conversational_automation`, `list_qr_codes`, `create_qr_code`, `get_qr_code`,
|
|
48
|
+
`update_qr_code`, `delete_qr_code`, `list_blocked_users`, `block_contact` e
|
|
49
|
+
`unblock_contact`. Tudo novo do MCP fica só no catálogo completo: o perfil `assistant`
|
|
50
|
+
(OAuth) não ganha tools, e `send_message`, `reply_to_conversation`, `list_messages` e
|
|
51
|
+
`get_message` mantêm nele a mesma entrada, saída e descrição revisadas.
|
|
52
|
+
|
|
3
53
|
## 0.21.0
|
|
4
54
|
|
|
5
55
|
### Minor Changes
|
package/README.md
CHANGED
|
@@ -504,6 +504,60 @@ As Palavras de saída e de volta e os textos de confirmação são do Cliente
|
|
|
504
504
|
template, `templates.update(id, { opt_out_buttons })` (ou `opt_out_buttons` em
|
|
505
505
|
`templates.create`) marca os botões de resposta rápida que são de saída.
|
|
506
506
|
|
|
507
|
+
### Responder citando, voz e "digitando…"
|
|
508
|
+
|
|
509
|
+
```ts
|
|
510
|
+
// "Digitando…" enquanto prepara a resposta (só com mensagem recebida e janela aberta;
|
|
511
|
+
// repetir em menos de 20 s não chama a Meta de novo) e marcar como lida.
|
|
512
|
+
await boto.conversations.typing(conversationId);
|
|
513
|
+
await boto.conversations.markRead(conversationId);
|
|
514
|
+
|
|
515
|
+
// Responder citando uma mensagem da mesma conversa (UUID ou wamid/mid).
|
|
516
|
+
await boto.messages.send({ to, text: "Combinado!", reply_to: { message_id: wamid } });
|
|
517
|
+
await boto.conversations.reply(conversationId, { text: "Sim", reply_to: { message_id: wamid } });
|
|
518
|
+
|
|
519
|
+
// Mensagem de voz (WhatsApp; .ogg com Opus mono). "Ouvida" chega em
|
|
520
|
+
// whatsapp.message.played e em Message.played_at; o status continua read.
|
|
521
|
+
await boto.messages.sendMedia({ to, type: "audio", link: "https://cdn.exemplo.com/oi.ogg", voice: true });
|
|
522
|
+
```
|
|
523
|
+
|
|
524
|
+
Recusas: `no_inbound_message` (409, "digitando…" sem mensagem do contato),
|
|
525
|
+
`reply_target_not_found` e `reply_target_unavailable` (422), `invalid_voice` e
|
|
526
|
+
`unsupported_voice` (422).
|
|
527
|
+
|
|
528
|
+
### Conversas antigas do app WhatsApp Business
|
|
529
|
+
|
|
530
|
+
Número em coexistência (também no app WhatsApp Business do celular) pode trazer
|
|
531
|
+
as conversas antigas logo depois de conectar: 0 (nada), 30 ou 180 dias.
|
|
532
|
+
|
|
533
|
+
```ts
|
|
534
|
+
const historico = await boto.phoneNumbers.getHistoryImport(id); // status, window_days, can_choose, deadline_at
|
|
535
|
+
await boto.phoneNumbers.setHistoryImport(id, { window_days: 180 });
|
|
536
|
+
```
|
|
537
|
+
|
|
538
|
+
A escolha vale uma vez por conexão, enquanto `can_choose`; repetir a mesma
|
|
539
|
+
escolha devolve 200 e outra responde 409 `history_import_locked`. Sem escolha,
|
|
540
|
+
o último mês (30 dias) vale 20 h depois da conexão. Número sem importação
|
|
541
|
+
responde 404 `history_import_not_available`.
|
|
542
|
+
|
|
543
|
+
### Configurações do número do WhatsApp
|
|
544
|
+
|
|
545
|
+
Perfil, perguntas prontas e comandos, QR codes e bloqueados, direto na Meta (sem
|
|
546
|
+
sandbox). `{id}` aceita o UUID interno ou o `phone_number_id` da Meta.
|
|
547
|
+
|
|
548
|
+
```ts
|
|
549
|
+
const perfil = await boto.phoneNumbers.getProfile(id); // editable=false em coexistência
|
|
550
|
+
await boto.phoneNumbers.updateProfile(id, { about: "Atendemos de segunda a sábado" });
|
|
551
|
+
await boto.phoneNumbers.uploadProfilePhoto(id, { file: blob, mime_type: "image/png" });
|
|
552
|
+
await boto.phoneNumbers.updateConversationalAutomation(id, { prompts: ["Ver horários"] });
|
|
553
|
+
const qr = await boto.phoneNumbers.qrCodes.create(id, { prefilled_message: "Oi!" }); // não é idempotente
|
|
554
|
+
await boto.phoneNumbers.blockedUsers.block(id, { contact_id }); // só quem escreveu nas últimas 24 h
|
|
555
|
+
```
|
|
556
|
+
|
|
557
|
+
Mudar o perfil por token OAuth responde 403 (só painel e chave de API); em
|
|
558
|
+
coexistência, 409 `coexistence_not_supported`. Gravar perguntas ou comandos
|
|
559
|
+
exige plano com automações (403 `plan_restricted`).
|
|
560
|
+
|
|
507
561
|
### Excluir conversa
|
|
508
562
|
|
|
509
563
|
`conversations.delete(id)` exclui a conversa sem volta, com efeito imediato:
|
|
@@ -579,15 +633,15 @@ new BotoZap({
|
|
|
579
633
|
|
|
580
634
|
O SDK cobre os recursos da API `/v1`:
|
|
581
635
|
|
|
582
|
-
- `messages` — enviar texto (com `quick_replies` no Instagram), template e mídia por link, **listar** e buscar por id
|
|
636
|
+
- `messages` — enviar texto (com `quick_replies` no Instagram), template e mídia por link, **listar** e buscar por id; `reply_to` (responder citando) em todos os envios menos reação, `voice: true` em áudio (mensagem de voz); leituras trazem `reply_to`, `played_at` e `transcription`
|
|
583
637
|
- `customers` — listar, buscar, criar, **atualizar** (nome, id externo e Palavras de saída/volta com os textos de confirmação), **remover**, e **links de setup** (listar/criar/atualizar; `channel` `whatsapp` ou `instagram`, um canal por link)
|
|
584
638
|
- `templates` — listar, buscar, **criar**, **atualizar** (`opt_out_buttons`)
|
|
585
639
|
- `broadcasts` — criar, destinatários, agendar, enviar, cancelar
|
|
586
640
|
- `contacts` — listar, buscar, criar, atualizar, remover, **`listConsents`/`recordConsent`**; `display_name` é o nome que a empresa dá ao Contato (1–200 caracteres; `null` limpa), separado do `profile_name` que vem do canal
|
|
587
|
-
- `conversations` — **`requestConsent`** e **`delete`**; listar (filtros `channel` e `channel_account_id`), buscar, atualizar, responder, atribuições; leituras trazem `entry_point` (`ctwa`/`organic`/`null`), `referral` do último clique em anúncio Click-to-WhatsApp, `fep_expires_at` (fim da janela grátis informado pela Meta) e `fep_reply_by` (estimativa do prazo para responder)
|
|
641
|
+
- `conversations` — **`typing`** ("digitando…") e **`markRead`** (marcar como lida); **`requestConsent`** e **`delete`**; `reply` aceita `reply_to`; listar (filtros `channel` e `channel_account_id`), buscar, atualizar, responder, atribuições; leituras trazem `entry_point` (`ctwa`/`organic`/`null`), `referral` do último clique em anúncio Click-to-WhatsApp, `fep_expires_at` (fim da janela grátis informado pela Meta) e `fep_reply_by` (estimativa do prazo para responder)
|
|
588
642
|
- `webhooks` — CRUD e teste; `customer_id` opcional limita as entregas a um Cliente da Conta (`null` no update remove o filtro); `channel_account_ids` limita a alguns canais (`null` = todos) e `channels_health` traz a saúde por canal
|
|
589
643
|
- `channelAccounts` — listar e buscar Contas de canal (WhatsApp e Instagram); **Regras de comentário** do Instagram (listar, buscar, criar, atualizar, excluir) e **Perguntas e menu** (ler, salvar/aplicar, remover, verificar/reaplicar)
|
|
590
|
-
- `phoneNumbers` — listar, buscar, **atualizar o `label`** (nome local, até 100 caracteres; `null` limpa), remover, saúde
|
|
644
|
+
- `phoneNumbers` — listar, buscar, **atualizar o `label`** (nome local, até 100 caracteres; `null` limpa), remover, saúde; configurações do número do WhatsApp: `getProfile`/`updateProfile`/`uploadProfilePhoto`, `get`/`update`/`clearConversationalAutomation` (perguntas prontas e comandos), `qrCodes.list`/`create`/`get`/`update`/`delete` e `blockedUsers.list`/`block`/`unblock`; conversas antigas do app WhatsApp Business (coexistência): `getHistoryImport`/`setHistoryImport`
|
|
591
645
|
- `media` — subir arquivo (obter um media_id) e **buscar metadados + URL de download** de uma mídia recebida
|
|
592
646
|
- `events` — reler inbound e mudanças de status pelo cursor durável da Conta/ambiente
|
|
593
647
|
- `usage` — `metaCosts`: custo aproximado da Meta por dia, categoria e moeda (Pricing Analytics), com estimativa por tarifa publicada onde a Meta não devolveu custo
|
|
@@ -732,6 +786,9 @@ respostas pessoais pertencem à sessão do Painel. Autorize Google Calendar no
|
|
|
732
786
|
Painel antes de gerenciar conexões pelo SDK.
|
|
733
787
|
|
|
734
788
|
Exemplo: `client.savedReplies.update(id, { body, expected_updated_at: row.updated_at })`.
|
|
789
|
+
Modelos prontos de Régua: `client.journeys.catalog()` lista os modelos da galeria
|
|
790
|
+
e `client.journeys.enableModel(key, { customer_id })` liga um no Cliente (cria e
|
|
791
|
+
submete o template; a Régua liga sozinha quando a Meta aprova).
|
|
735
792
|
Não arredonde `updated_at`: preserve a precisão recebida do servidor.
|
|
736
793
|
Criação de compromisso aceita segundo argumento `{ idempotencyKey: 'chave-estavel' }`.
|
|
737
794
|
[Contratos, exemplos e roteiro de release](https://github.com/bytecraft-fernando/botozap-js/blob/main/docs/attendance-release.md).
|
package/dist/index.cjs
CHANGED
|
@@ -3854,6 +3854,25 @@ var AI_OPERATIONS = [
|
|
|
3854
3854
|
}
|
|
3855
3855
|
}
|
|
3856
3856
|
},
|
|
3857
|
+
// Diagnóstico do agente, o mesmo do painel (paridade tela ⇄ API, out/2026).
|
|
3858
|
+
{
|
|
3859
|
+
group: "agents",
|
|
3860
|
+
name: "diagnostic",
|
|
3861
|
+
method: "GET",
|
|
3862
|
+
path: "/ai/agents/:id/diagnostic",
|
|
3863
|
+
shape: "item",
|
|
3864
|
+
description: "Diagn\xF3stico do agente, o mesmo do painel, para o rascunho ou, sem rascunho, a vers\xE3o publicada: checks com status ok/warning/blocked/unknown, ready e a \xFAltima prova de gera\xE7\xE3o registrada. S\xF3 l\xEA: n\xE3o faz prova nem chamada ao provedor e n\xE3o gera custo. ready=false \xE9 a mesma regra que recusa a publica\xE7\xE3o (diagnostic_blocked).",
|
|
3865
|
+
fields: {
|
|
3866
|
+
customer_id: {
|
|
3867
|
+
type: "uuid",
|
|
3868
|
+
optional: false
|
|
3869
|
+
},
|
|
3870
|
+
id: {
|
|
3871
|
+
type: "uuid",
|
|
3872
|
+
optional: false
|
|
3873
|
+
}
|
|
3874
|
+
}
|
|
3875
|
+
},
|
|
3857
3876
|
{
|
|
3858
3877
|
group: "evolution",
|
|
3859
3878
|
name: "get",
|
|
@@ -4029,6 +4048,14 @@ var AiAgentsResource = class {
|
|
|
4029
4048
|
capabilityUsage(input) {
|
|
4030
4049
|
return request(this.client, named("agents", "capabilityUsage"), input);
|
|
4031
4050
|
}
|
|
4051
|
+
/**
|
|
4052
|
+
* Diagnóstico do agente, o mesmo do painel (rascunho, ou a versão publicada
|
|
4053
|
+
* sem rascunho). Só lê: não faz prova de geração nem chama o provedor.
|
|
4054
|
+
* `ready: false` é a regra que recusa a publicação com `diagnostic_blocked`.
|
|
4055
|
+
*/
|
|
4056
|
+
diagnostic(input) {
|
|
4057
|
+
return request(this.client, named("agents", "diagnostic"), input);
|
|
4058
|
+
}
|
|
4032
4059
|
};
|
|
4033
4060
|
var AiCredentialsResource = class {
|
|
4034
4061
|
constructor(client) {
|
|
@@ -4981,6 +5008,36 @@ var Journeys = class {
|
|
|
4981
5008
|
query: { ...params }
|
|
4982
5009
|
});
|
|
4983
5010
|
}
|
|
5011
|
+
/**
|
|
5012
|
+
* Lista os modelos prontos de Régua, os mesmos da galeria de Automações do
|
|
5013
|
+
* painel, com gatilho, texto do template, `variable_map` e os `examples` que
|
|
5014
|
+
* vão à Meta. Scope `journeys:read`.
|
|
5015
|
+
*/
|
|
5016
|
+
catalog() {
|
|
5017
|
+
return this.client.requestItem("GET", "/journeys/catalog");
|
|
5018
|
+
}
|
|
5019
|
+
/**
|
|
5020
|
+
* Liga um modelo pronto no Cliente, como "Usar modelo" no painel: cria o
|
|
5021
|
+
* template do modelo no número e o envia à aprovação da Meta (reaproveita o
|
|
5022
|
+
* template se já existe), cria o campo de data do modelo e a Régua. Com o
|
|
5023
|
+
* template aprovado a Régua já nasce ativa e pode enviar mensagens
|
|
5024
|
+
* automáticas; senão fica pausada (`pending_template`) e liga sozinha na
|
|
5025
|
+
* aprovação. Se o modelo já tem Régua no Cliente, responde `created: false`
|
|
5026
|
+
* sem mudar nada, exceto quando ela está pausada com `template_rejected`: aí
|
|
5027
|
+
* reenvia o template (`resubmitted: true`).
|
|
5028
|
+
*
|
|
5029
|
+
* Scope `journeys:write`; exige plano com automações (403 `plan_restricted`).
|
|
5030
|
+
* Recusas: `not_found` (modelo, Cliente ou número), `validation_error` (422,
|
|
5031
|
+
* falta `customer_id` ou o número com mais de um no Cliente), `not_connected`
|
|
5032
|
+
* (409), `meta_error` (422 recusa da Meta; 502 Meta indisponível).
|
|
5033
|
+
*/
|
|
5034
|
+
enableModel(key, params) {
|
|
5035
|
+
return this.client.requestItem(
|
|
5036
|
+
"POST",
|
|
5037
|
+
`/journeys/catalog/${encodeURIComponent(key)}/enable`,
|
|
5038
|
+
{ body: params }
|
|
5039
|
+
);
|
|
5040
|
+
}
|
|
4984
5041
|
get(id, params = {}) {
|
|
4985
5042
|
return this.client.requestItem(
|
|
4986
5043
|
"GET",
|
|
@@ -5200,7 +5257,8 @@ var Messages = class {
|
|
|
5200
5257
|
type: "text",
|
|
5201
5258
|
text: { body: params.text },
|
|
5202
5259
|
from: params.from,
|
|
5203
|
-
...params.quick_replies !== void 0 ? { quick_replies: params.quick_replies } : {}
|
|
5260
|
+
...params.quick_replies !== void 0 ? { quick_replies: params.quick_replies } : {},
|
|
5261
|
+
...replyTo(params.reply_to)
|
|
5204
5262
|
}
|
|
5205
5263
|
});
|
|
5206
5264
|
return assertSendResult(result);
|
|
@@ -5214,7 +5272,8 @@ var Messages = class {
|
|
|
5214
5272
|
type: "template",
|
|
5215
5273
|
template: params.template,
|
|
5216
5274
|
from: params.from,
|
|
5217
|
-
...params.consent_basis !== void 0 ? { consent_basis: params.consent_basis } : {}
|
|
5275
|
+
...params.consent_basis !== void 0 ? { consent_basis: params.consent_basis } : {},
|
|
5276
|
+
...replyTo(params.reply_to)
|
|
5218
5277
|
}
|
|
5219
5278
|
});
|
|
5220
5279
|
return assertSendResult(result);
|
|
@@ -5228,13 +5287,17 @@ var Messages = class {
|
|
|
5228
5287
|
if ("filename" in params && params.filename !== void 0) {
|
|
5229
5288
|
media.filename = params.filename;
|
|
5230
5289
|
}
|
|
5290
|
+
if ("voice" in params && params.voice !== void 0) {
|
|
5291
|
+
media.voice = params.voice;
|
|
5292
|
+
}
|
|
5231
5293
|
const result = await this.client.requestObject("POST", "/messages", {
|
|
5232
5294
|
idempotencyKey: options.idempotencyKey,
|
|
5233
5295
|
body: {
|
|
5234
5296
|
to: params.to,
|
|
5235
5297
|
from: params.from,
|
|
5236
5298
|
type: params.type,
|
|
5237
|
-
[params.type]: media
|
|
5299
|
+
[params.type]: media,
|
|
5300
|
+
...replyTo(params.reply_to)
|
|
5238
5301
|
}
|
|
5239
5302
|
});
|
|
5240
5303
|
return assertSendResult(result);
|
|
@@ -5251,7 +5314,8 @@ var Messages = class {
|
|
|
5251
5314
|
from: params.from,
|
|
5252
5315
|
type: "interactive",
|
|
5253
5316
|
interactive: params.interactive,
|
|
5254
|
-
...params.tag !== void 0 ? { tag: params.tag } : {}
|
|
5317
|
+
...params.tag !== void 0 ? { tag: params.tag } : {},
|
|
5318
|
+
...replyTo(params.reply_to)
|
|
5255
5319
|
},
|
|
5256
5320
|
options
|
|
5257
5321
|
);
|
|
@@ -5266,7 +5330,7 @@ var Messages = class {
|
|
|
5266
5330
|
if (params.address !== void 0) location.address = params.address;
|
|
5267
5331
|
return postMessage(
|
|
5268
5332
|
this.client,
|
|
5269
|
-
{ to: params.to, from: params.from, type: "location", location },
|
|
5333
|
+
{ to: params.to, from: params.from, type: "location", location, ...replyTo(params.reply_to) },
|
|
5270
5334
|
options
|
|
5271
5335
|
);
|
|
5272
5336
|
}
|
|
@@ -5311,6 +5375,9 @@ var Messages = class {
|
|
|
5311
5375
|
);
|
|
5312
5376
|
}
|
|
5313
5377
|
};
|
|
5378
|
+
function replyTo(value) {
|
|
5379
|
+
return value === void 0 ? {} : { reply_to: { message_id: value.message_id } };
|
|
5380
|
+
}
|
|
5314
5381
|
async function postMessage(client, body, options) {
|
|
5315
5382
|
const result = await client.requestObject("POST", "/messages", {
|
|
5316
5383
|
idempotencyKey: options.idempotencyKey,
|
|
@@ -5697,7 +5764,8 @@ var Conversations = class {
|
|
|
5697
5764
|
to,
|
|
5698
5765
|
text: params.text,
|
|
5699
5766
|
from,
|
|
5700
|
-
...params.quick_replies !== void 0 ? { quick_replies: params.quick_replies } : {}
|
|
5767
|
+
...params.quick_replies !== void 0 ? { quick_replies: params.quick_replies } : {},
|
|
5768
|
+
...params.reply_to !== void 0 ? { reply_to: params.reply_to } : {}
|
|
5701
5769
|
},
|
|
5702
5770
|
options
|
|
5703
5771
|
);
|
|
@@ -5724,6 +5792,43 @@ var Conversations = class {
|
|
|
5724
5792
|
{ body: params }
|
|
5725
5793
|
);
|
|
5726
5794
|
}
|
|
5795
|
+
/**
|
|
5796
|
+
* Mostra "digitando…" ao contato enquanto a integração prepara a resposta,
|
|
5797
|
+
* como o Painel quando o atendente digita. O sinal vai na última mensagem
|
|
5798
|
+
* recebida do contato, que fica como lida (tiques azuis no WhatsApp, "visto"
|
|
5799
|
+
* no Instagram); a Meta tira o indicador quando a resposta sai ou em ~25 s.
|
|
5800
|
+
* Repetir em menos de 20 s não chama a Meta de novo (`repeated: true`); para
|
|
5801
|
+
* uma resposta demorada, chame de novo a cada 20 s. Sem corpo. Scope
|
|
5802
|
+
* `messages:send`; não aceita chave sandbox.
|
|
5803
|
+
*
|
|
5804
|
+
* Recusas: `no_inbound_message` (409, a conversa não tem mensagem recebida:
|
|
5805
|
+
* template e primeira mensagem não têm "digitando…"), `outside_window`
|
|
5806
|
+
* (WhatsApp) ou `window_closed` (Instagram) com a janela de 24h fechada (422),
|
|
5807
|
+
* `not_connected` (409), `meta_error` (422 na recusa da Meta, 502 se ela
|
|
5808
|
+
* falhar; a resposta em si pode ser enviada normalmente) e `not_found` (404).
|
|
5809
|
+
*/
|
|
5810
|
+
typing(id) {
|
|
5811
|
+
return this.client.requestItem(
|
|
5812
|
+
"POST",
|
|
5813
|
+
`/conversations/${enc4(id)}/typing`
|
|
5814
|
+
);
|
|
5815
|
+
}
|
|
5816
|
+
/**
|
|
5817
|
+
* Marca a conversa como lida, como abrir a conversa no Painel: grava
|
|
5818
|
+
* `last_read_at` (a conversa deixa de aparecer como não lida) e, logo depois
|
|
5819
|
+
* da resposta, a última mensagem recebida fica como lida para o contato
|
|
5820
|
+
* (tiques azuis no WhatsApp, "visto" no Instagram). A mesma mensagem não é
|
|
5821
|
+
* marcada duas vezes na Meta: repetir só atualiza `last_read_at`. O aviso ao
|
|
5822
|
+
* contato é de melhor esforço (canal desconectado ou recusa da Meta não mudam
|
|
5823
|
+
* a resposta). Sem corpo. Scope `conversations:write`; aceita chave sandbox
|
|
5824
|
+
* (grava a leitura sem avisar a Meta).
|
|
5825
|
+
*/
|
|
5826
|
+
markRead(id) {
|
|
5827
|
+
return this.client.requestItem(
|
|
5828
|
+
"POST",
|
|
5829
|
+
`/conversations/${enc4(id)}/read`
|
|
5830
|
+
);
|
|
5831
|
+
}
|
|
5727
5832
|
/**
|
|
5728
5833
|
* Exclui a conversa, com efeito imediato e sem volta: mensagens, notas,
|
|
5729
5834
|
* atribuições, vínculos com oportunidades e demandas e o que a IA guardou
|
|
@@ -5821,11 +5926,106 @@ function enc5(id) {
|
|
|
5821
5926
|
}
|
|
5822
5927
|
|
|
5823
5928
|
// src/resources/phone-numbers.ts
|
|
5929
|
+
var PhoneNumberQrCodes = class {
|
|
5930
|
+
constructor(client) {
|
|
5931
|
+
this.client = client;
|
|
5932
|
+
}
|
|
5933
|
+
client;
|
|
5934
|
+
/** Lista os QR codes do número (sem a imagem; use `get`). Scope `numbers:read`. */
|
|
5935
|
+
list(id) {
|
|
5936
|
+
return this.client.requestItem("GET", `/phone_numbers/${enc6(id)}/qr-codes`);
|
|
5937
|
+
}
|
|
5938
|
+
/**
|
|
5939
|
+
* Cria um QR code com mensagem pronta (até 140 caracteres) e devolve
|
|
5940
|
+
* `qr_image_url` (201). NÃO é idempotente: em 504 `meta_unconfirmed`, liste
|
|
5941
|
+
* antes de criar de novo para não duplicar. Scope `numbers:write`.
|
|
5942
|
+
*/
|
|
5943
|
+
create(id, params) {
|
|
5944
|
+
return this.client.requestItem("POST", `/phone_numbers/${enc6(id)}/qr-codes`, {
|
|
5945
|
+
body: params
|
|
5946
|
+
});
|
|
5947
|
+
}
|
|
5948
|
+
/**
|
|
5949
|
+
* Um QR code com `qr_image_url` no formato pedido (`PNG` padrão, ou `SVG`).
|
|
5950
|
+
* A URL é temporária, do CDN da Meta: baixe na hora. Scope `numbers:read`.
|
|
5951
|
+
*/
|
|
5952
|
+
get(id, code, params = {}) {
|
|
5953
|
+
return this.client.requestItem(
|
|
5954
|
+
"GET",
|
|
5955
|
+
`/phone_numbers/${enc6(id)}/qr-codes/${enc6(code)}`,
|
|
5956
|
+
{ query: { image_format: params.image_format } }
|
|
5957
|
+
);
|
|
5958
|
+
}
|
|
5959
|
+
/** Troca a mensagem pronta; código, link e imagem continuam os mesmos. Scope `numbers:write`. */
|
|
5960
|
+
update(id, code, params) {
|
|
5961
|
+
return this.client.requestItem(
|
|
5962
|
+
"PATCH",
|
|
5963
|
+
`/phone_numbers/${enc6(id)}/qr-codes/${enc6(code)}`,
|
|
5964
|
+
{ body: { prefilled_message: params.prefilled_message } }
|
|
5965
|
+
);
|
|
5966
|
+
}
|
|
5967
|
+
/**
|
|
5968
|
+
* Apaga o QR code na Meta, SEM VOLTA: quem escanear o código impresso ou
|
|
5969
|
+
* abrir o link passa a ver "expirado". Responde 204. No acesso por OAuth, só
|
|
5970
|
+
* Administrador. Scope `numbers:write`.
|
|
5971
|
+
*/
|
|
5972
|
+
delete(id, code) {
|
|
5973
|
+
return this.client.request("DELETE", `/phone_numbers/${enc6(id)}/qr-codes/${enc6(code)}`);
|
|
5974
|
+
}
|
|
5975
|
+
};
|
|
5976
|
+
var PhoneNumberBlockedUsers = class {
|
|
5977
|
+
constructor(client) {
|
|
5978
|
+
this.client = client;
|
|
5979
|
+
}
|
|
5980
|
+
client;
|
|
5981
|
+
/**
|
|
5982
|
+
* Bloqueados do número, 100 por página. A próxima página vem em
|
|
5983
|
+
* `paging.cursors.after` (passe em `after`); `null` quando acabou. Quando o
|
|
5984
|
+
* `wa_id` é de um contato da Conta, vêm `contact_id` e `name`. Scope
|
|
5985
|
+
* `numbers:read`.
|
|
5986
|
+
*/
|
|
5987
|
+
list(id, params = {}) {
|
|
5988
|
+
return this.client.requestCursorList(
|
|
5989
|
+
"GET",
|
|
5990
|
+
`/phone_numbers/${enc6(id)}/blocked-users`,
|
|
5991
|
+
{ query: { after: params.after } }
|
|
5992
|
+
);
|
|
5993
|
+
}
|
|
5994
|
+
/**
|
|
5995
|
+
* Bloqueia um contato no número, por `contact_id` (contato da Conta neste
|
|
5996
|
+
* número) ou `user` (telefone com DDI). Contato bloqueado não manda mensagem
|
|
5997
|
+
* nem liga, e o número não envia nada para ele. Regra da Meta: só quem
|
|
5998
|
+
* escreveu nas últimas 24 h (senão 422 `block_window_closed`). Outros:
|
|
5999
|
+
* `cannot_block_self`, `blocklist_full` (409), `contact_other_number`,
|
|
6000
|
+
* `channel_not_supported` (contato do Instagram). Scope `numbers:write`.
|
|
6001
|
+
*/
|
|
6002
|
+
block(id, params) {
|
|
6003
|
+
return this.client.requestItem("POST", `/phone_numbers/${enc6(id)}/blocked-users`, {
|
|
6004
|
+
body: params
|
|
6005
|
+
});
|
|
6006
|
+
}
|
|
6007
|
+
/**
|
|
6008
|
+
* Desbloqueia pelo `wa_id` da lista (ou telefone com DDI). Para bloquear de
|
|
6009
|
+
* novo, o contato precisa ter escrito nas últimas 24 h. Scope `numbers:write`.
|
|
6010
|
+
*/
|
|
6011
|
+
unblock(id, user) {
|
|
6012
|
+
return this.client.requestItem(
|
|
6013
|
+
"DELETE",
|
|
6014
|
+
`/phone_numbers/${enc6(id)}/blocked-users/${enc6(user)}`
|
|
6015
|
+
);
|
|
6016
|
+
}
|
|
6017
|
+
};
|
|
5824
6018
|
var PhoneNumbers = class {
|
|
5825
6019
|
constructor(client) {
|
|
5826
6020
|
this.client = client;
|
|
6021
|
+
this.qrCodes = new PhoneNumberQrCodes(client);
|
|
6022
|
+
this.blockedUsers = new PhoneNumberBlockedUsers(client);
|
|
5827
6023
|
}
|
|
5828
6024
|
client;
|
|
6025
|
+
/** QR codes com mensagem pronta e link curto `wa.me/message`. */
|
|
6026
|
+
qrCodes;
|
|
6027
|
+
/** Contatos bloqueados no número. */
|
|
6028
|
+
blockedUsers;
|
|
5829
6029
|
/** Lista os números da conta (paginação por offset/página). */
|
|
5830
6030
|
list(params = {}) {
|
|
5831
6031
|
return this.client.requestOffsetList(
|
|
@@ -5863,6 +6063,96 @@ var PhoneNumbers = class {
|
|
|
5863
6063
|
delete(id) {
|
|
5864
6064
|
return this.client.request("DELETE", `/phone_numbers/${enc6(id)}`);
|
|
5865
6065
|
}
|
|
6066
|
+
/**
|
|
6067
|
+
* Perfil do WhatsApp do número, lido na Meta: Sobre, descrição, endereço,
|
|
6068
|
+
* e-mail, sites, categoria e foto. `editable: false` em coexistência.
|
|
6069
|
+
* Recusas comuns às configurações do número: `sandbox_not_supported`,
|
|
6070
|
+
* `connection_inactive`, `reconnect_required` (409), `meta_rate_limited`
|
|
6071
|
+
* (429), `meta_permission_denied` (403), `meta_unavailable` (504) e
|
|
6072
|
+
* `meta_error` (502). Scope `numbers:read`.
|
|
6073
|
+
*/
|
|
6074
|
+
getProfile(id) {
|
|
6075
|
+
return this.client.requestItem("GET", `/phone_numbers/${enc6(id)}/profile`);
|
|
6076
|
+
}
|
|
6077
|
+
/**
|
|
6078
|
+
* Muda campos do perfil na Meta e devolve o perfil relido. É o contato
|
|
6079
|
+
* público do negócio: mude só a pedido de quem opera. Coexistência responde
|
|
6080
|
+
* 409 `coexistence_not_supported`. Pelo acesso OAuth (apps conectados), a
|
|
6081
|
+
* API responde 403: só painel e chave de API mudam o perfil. Em 502
|
|
6082
|
+
* `saved_unread` a Meta recebeu e a releitura falhou: confira com
|
|
6083
|
+
* `getProfile` antes de repetir. Scope `numbers:write`.
|
|
6084
|
+
*/
|
|
6085
|
+
updateProfile(id, params) {
|
|
6086
|
+
return this.client.requestItem("PATCH", `/phone_numbers/${enc6(id)}/profile`, {
|
|
6087
|
+
body: params
|
|
6088
|
+
});
|
|
6089
|
+
}
|
|
6090
|
+
/**
|
|
6091
|
+
* Troca a foto do perfil (`multipart/form-data`, campo `file`; JPG ou PNG
|
|
6092
|
+
* até 4 MB) e devolve o perfil relido. Mesmas regras de `updateProfile`
|
|
6093
|
+
* (coexistência 409, OAuth 403). Recusas da foto: `invalid_picture` (422),
|
|
6094
|
+
* `too_large` (413), `missing_file` (422). Scope `numbers:write`.
|
|
6095
|
+
*/
|
|
6096
|
+
uploadProfilePhoto(id, params) {
|
|
6097
|
+
const type = params.mime_type ?? params.file.type;
|
|
6098
|
+
const file = params.mime_type && params.file.type !== params.mime_type ? new Blob([params.file], { type: params.mime_type }) : params.file;
|
|
6099
|
+
const form = new FormData();
|
|
6100
|
+
form.append("file", file, params.file_name ?? (type === "image/png" ? "foto.png" : "foto.jpg"));
|
|
6101
|
+
return this.client.requestItem("POST", `/phone_numbers/${enc6(id)}/profile/photo`, {
|
|
6102
|
+
body: form
|
|
6103
|
+
});
|
|
6104
|
+
}
|
|
6105
|
+
/**
|
|
6106
|
+
* Perguntas prontas (`prompts`, ice breakers) e comandos (`commands`) do
|
|
6107
|
+
* número, lidos na Meta. Scope `numbers:read`.
|
|
6108
|
+
*/
|
|
6109
|
+
getConversationalAutomation(id) {
|
|
6110
|
+
return this.client.requestItem(
|
|
6111
|
+
"GET",
|
|
6112
|
+
`/phone_numbers/${enc6(id)}/conversational-automation`
|
|
6113
|
+
);
|
|
6114
|
+
}
|
|
6115
|
+
/**
|
|
6116
|
+
* Grava perguntas prontas e/ou comandos na Meta e devolve o que ficou. Campo
|
|
6117
|
+
* omitido mantém; lista vazia remove. Gravar conteúdo exige plano com
|
|
6118
|
+
* automações (403 `plan_restricted`); só remover é livre. Tocar numa
|
|
6119
|
+
* pergunta ou mandar um comando chega como mensagem de texto comum. Scope
|
|
6120
|
+
* `numbers:write`.
|
|
6121
|
+
*/
|
|
6122
|
+
updateConversationalAutomation(id, params) {
|
|
6123
|
+
return this.client.requestItem(
|
|
6124
|
+
"PATCH",
|
|
6125
|
+
`/phone_numbers/${enc6(id)}/conversational-automation`,
|
|
6126
|
+
{ body: params }
|
|
6127
|
+
);
|
|
6128
|
+
}
|
|
6129
|
+
/** Remove todas as perguntas prontas e comandos do número (livre em qualquer plano). Scope `numbers:write`. */
|
|
6130
|
+
clearConversationalAutomation(id) {
|
|
6131
|
+
return this.client.requestItem(
|
|
6132
|
+
"DELETE",
|
|
6133
|
+
`/phone_numbers/${enc6(id)}/conversational-automation`
|
|
6134
|
+
);
|
|
6135
|
+
}
|
|
6136
|
+
/**
|
|
6137
|
+
* Quanto das conversas antigas do app WhatsApp Business o número importa
|
|
6138
|
+
* (coexistência): estado, janela escolhida e até quando dá para escolher.
|
|
6139
|
+
* Número sem importação (não está em coexistência, ou foi conectado antes
|
|
6140
|
+
* deste recurso) responde 404 `history_import_not_available`. Scope `numbers:read`.
|
|
6141
|
+
*/
|
|
6142
|
+
getHistoryImport(id) {
|
|
6143
|
+
return this.client.requestItem("GET", `/phone_numbers/${enc6(id)}/history-import`);
|
|
6144
|
+
}
|
|
6145
|
+
/**
|
|
6146
|
+
* Escolhe quanto importar: `window_days` 0 (nada), 30 ou 180. Vale uma vez
|
|
6147
|
+
* por conexão, enquanto `can_choose`; repetir a mesma escolha devolve 200,
|
|
6148
|
+
* outra escolha depois responde 409 `history_import_locked`. Sem escolha,
|
|
6149
|
+
* o último mês vale 20 h depois da conexão. Scope `numbers:write`.
|
|
6150
|
+
*/
|
|
6151
|
+
setHistoryImport(id, params) {
|
|
6152
|
+
return this.client.requestItem("PUT", `/phone_numbers/${enc6(id)}/history-import`, {
|
|
6153
|
+
body: { window_days: params.window_days }
|
|
6154
|
+
});
|
|
6155
|
+
}
|
|
5866
6156
|
/** Saúde do número (qualidade, limite, status na Meta). */
|
|
5867
6157
|
health(id) {
|
|
5868
6158
|
return this.client.requestItem(
|