@voctiv/agent-sdk 0.2.14 → 0.2.16

package/examples/read-recall-from-params.ts

@@ -0,0 +1,41 @@
+/**
+ * Read recall settings from legacy dialog/call params and schedule outbound.
+ */
+import {
+  defineScript,
+  parseRecallCount,
+  parseRecallDelaySeconds,
+} from '@voctiv/agent-sdk';
+
+export default defineScript(async ({ context, logger, platform }) => {
+  const params = context.dialogParams ?? {};
+
+  const rawCount = params.recall_count ?? params.recallCount;
+  const rawDelay = params.recall_delay ?? params.recallDelay;
+
+  const recallCount =
+    parseRecallCount(rawCount) ?? context.recallCount ?? context.agent?.recallCount;
+  const recallDelaySec =
+    parseRecallDelaySeconds(rawDelay) ??
+    context.recallDelay ??
+    context.agent?.recallDelay;
+
+  logger.log('Parsed recall from params', {
+    rawCount,
+    rawDelay,
+    recallCount,
+    recallDelaySec,
+    attempt: context.attempt,
+  });
+
+  const msisdn = context.msisdn || context.callerId;
+  if (!msisdn || recallCount == null || recallDelaySec == null) {
+    logger.warn('Missing msisdn or recall config — skipping schedule');
+    return;
+  }
+
+  await platform.call(msisdn, {
+    recallCount,
+    recallDelay: recallDelaySec,
+  });
+});

package/examples/recall-routing-by-attempt.ts

@@ -0,0 +1,55 @@
+/**
+ * Handle the first outbound attempt vs automatic recall attempts.
+ *
+ * Recall calls are still **online** SIP sessions (`getScriptPhase` → `'online'`).
+ * Use `context.attempt` (from `dialog.params.attempt`, starts at 0) to branch inside
+ * your single `defineScript` handler — the host does not invoke a separate function.
+ */
+import { defineScript, getScriptPhase } from '@voctiv/agent-sdk';
+
+export default defineScript(async ({ channel, context, logger }) => {
+  const phase = getScriptPhase(context);
+  const attempt = context.attempt ?? 0;
+
+  logger.log('Call leg', {
+    phase,
+    attempt,
+    headless: context.headless,
+    recallCount: context.recallCount,
+    recallDelay: context.recallDelay,
+  });
+
+  channel.sip.answer();
+
+  if (!context.headless && attempt > 0) {
+    await channel.audio.say(
+      `This is follow-up attempt number ${attempt + 1}. Please stay on the line.`,
+    );
+  } else if (!context.headless) {
+    await channel.audio.say('Hello, this is our first call to you today.');
+  }
+
+  const asr = await channel.createAsr({ language: context.language || 'ru-RU' });
+
+  return new Promise((resolve) => {
+    asr.result$.subscribe(async (text) => {
+      if (!text.trim()) return;
+
+      if (/voicemail|leave a message/i.test(text)) {
+        logger.log('Voicemail detected — host may schedule recall', { attempt });
+        channel.sip.hangup();
+        resolve({ output: { outcome: 'voicemail', attempt } });
+        return;
+      }
+
+      await channel.audio.say('Thank you. Goodbye.');
+      channel.sip.hangup();
+      resolve({ output: { outcome: 'answered', attempt } });
+    });
+
+    channel.events.terminated$.subscribe(() => {
+      asr.destroy();
+      resolve({ output: { outcome: 'terminated', attempt } });
+    });
+  });
+});

package/examples/schedule-call-with-defaults.ts

@@ -0,0 +1,31 @@
+/**
+ * Schedule outbound using CMS contact-rules defaults already resolved on `context`.
+ *
+ * When `recallCount` / `recallDelay` are omitted from `platform.call()` options, the host
+ * fills them from `context.recallCount` / `context.recallDelay` only when `onFailedCall` is
+ * not configured for that scheduled call.
+ */
+import { defineScript } from '@voctiv/agent-sdk';
+
+export default defineScript(async ({ channel, context, logger, platform }) => {
+  channel.sip.answer();
+
+  const msisdn = context.msisdn || context.callerId;
+  if (!msisdn) return;
+
+  logger.log('Recall configuration snapshot', {
+    effective: {
+      count: context.recallCount,
+      delaySec: context.recallDelay,
+    },
+    agentDefaults: {
+      count: context.agent?.recallCount,
+      delaySec: context.agent?.recallDelay,
+    },
+    attempt: context.attempt,
+  });
+
+  await platform.call(msisdn);
+
+  await channel.audio.say('We have scheduled a call using your agent recall settings.');
+});

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@voctiv/agent-sdk",
-  "version": "0.2.14",
+  "version": "0.2.16",
   "description": "Voctiv TypeScript agent SDK: defineScript and platform types for the voice/dialog scripting runtime.",
   "license": "UNLICENSED",
   "author": "",
@@ -23,7 +23,8 @@
   },
   "files": [
     "dist",
-    "README.md"
+    "README.md",
+    "examples"
   ],
   "scripts": {
     "build": "tsc -p tsconfig.build.json",