TypeScript — referência de recursos

import SparkCRM from "sparkcrm";

const client = new SparkCRM({ apiKey: process.env.SPARK_API_KEY });

client.whatsappConnectionSessions // conexão de números da API oficial do WhatsApp
client.entrypoints                // canais conectados
client.chats                      // criar ou atualizar conversas
client.forms                      // formulários de captação
client.messaging                  // mídia e mensagens
client.messageTemplates           // modelos de mensagem
client.campaigns                  // disparos em massa
// SparkCRM.*Webhook              // só tipos, sem métodos HTTP

const { sessionId, url, expiresAt } =
  await client.whatsappConnectionSessions.create({
    funnelStepId: "funnel_step_…",
    returnUrl: "https://seuapp.com/whatsapp/conectado",
  });

const session = await client.whatsappConnectionSessions.retrieve(sessionId);

const all = await client.entrypoints.list();
const instagram = await client.entrypoints.list({ platform: "instagram" });

const { entrypoint } = await client.entrypoints.retrieve("wa_entrypoint_…");

const { chatId, leadId } = await client.chats.upsert({
  entrypointId: "wa_entrypoint_…",
  phone: "5511987654321",
  name: "Maria Silva",
});

const { queued } = await client.chats.upsertBatch({
  entrypointId: "wa_entrypoint_…",
  batch: [
    { phone: "5511987654321", name: "Maria Silva" },
    { phone: "5511912345678" },
  ],
});

const { form } = await client.forms.retrieve(publicFormId);

const policy = await client.forms.retrieveEmbedFramePolicy(publicFormId);

const result = await client.forms.submitResponse(publicFormId, {
  name: "João",
  phone: "5581987654321",
  answers: [{ questionKey: "porte", value: "pequena" }],
});

const results = await client.messaging.uploadMedia({
  files: [file],
});

const page = await client.messaging.chats.listMessages(chatId, {
  limit: 30,
});

if (page.nextCursor) {
  const older = await client.messaging.chats.listMessages(chatId, {
    cursor: page.nextCursor,
  });
}

await client.messaging.chats.sendMessage(chatId, {
  text: "Confirmado para amanhã às 10h.",
  replyToId: messageId,
});

await client.messaging.chats.sendMessageTemplate(chatId, {
  templateId: "message_template_…",
  commonVariables: {
    var1: "Black Friday",
    var2: "20OFF",
  },
});

await client.messaging.chats.messages.markAsRead(messageId, { chatId });

await client.messaging.chats.messages.markAsReadAndType(messageId, { chatId });

const { templates } = await client.messageTemplates.list();

const template = await client.messageTemplates.retrieve("message_template_…");
console.log(template.commonVariables); // [{ key: "var1", label: "…", required: true }]

const created = await client.messageTemplates.create({
  name: "promo_maio",
  isOfficial: true,
  whatsappEntrypointId: "wa_entrypoint_…",
  metaTemplateName: "promo_maio",
  category: "MARKETING",
  language: "pt_BR",
  body: "Olá {{1}}, seu código é {{2}}.",
  variables: [
    { index: 1, title: "Nome", example: "Maria", kind: "lead", source: "chat.name" },
    { index: 2, title: "Código", example: "A123", kind: "common" },
  ],
});

const preview = await client.campaigns.previewAudience({
  filters: [
    {
      combinator: "and",
      statements: [
        { field: "chat.platform", operator: "equals", value: "whatsapp" },
      ],
    },
  ],
});

const execution = await client.campaigns.retrieveExecution(executionId, {
  id: campaignId,
});

const { entrypoints } = await client.get("/v1/entrypoints", {
  query: { platform: "telegram" },
});