Example: Placing an outbound call

1
{"destination":"+15551234567","callerId":"+15557654321"}

1
call = VoxEngine.callPSTN(destination, callerId);
2
call.addEventListener(CallEvents.Connected, async () => {
3
  // ...
4
});

1
voiceAgentClient = await Deepgram.createVoiceAgentClient({ apiKey, settingsOptions: SETTINGS_OPTIONS });
2
VoxEngine.sendMediaBetween(call, voiceAgentClient);

1
voiceAgentClient.addEventListener(Deepgram.VoiceAgentEvents.UserStartedSpeaking, () => {
2
  voiceAgentClient.clearMediaBuffer();
3
});

1
/**
2
 * Voximplant + Deepgram Voice Agent connector demo
3
 * Scenario: place an outbound PSTN call and bridge it to Deepgram Voice Agent.
4
 */
5
6
require(Modules.Deepgram);
7
require(Modules.ApplicationStorage);
8
9
const SYSTEM_PROMPT = `
10
You are Voxi, a helpful voice assistant for phone callers.
11
Keep responses short and telephony-friendly (usually 1-2 sentences).
12
`;
13
14
// -------------------- Deepgram Voice Agent settings --------------------
15
const SETTINGS_OPTIONS = {
16
    tags: ["voximplant", "deepgram", "voice_agent_connector", "outbound_call_demo"],
17
    agent: {
18
        language: "en",
19
        greeting: "Hi! This is Voxi from Voximplant. How can I help today?",
20
        listen: {
21
            provider: {
22
                type: "deepgram",
23
                model: "flux-general-en",
24
            },
25
        },
26
        think: {
27
            provider: {
28
                type: "open_ai",
29
                model: "gpt-4o-mini",
30
            },
31
            prompt: SYSTEM_PROMPT,
32
        },
33
        speak: {
34
            provider: {
35
                type: "deepgram",
36
                model: "aura-2-cordelia-en",
37
            },
38
        },
39
    },
40
};
41
42
VoxEngine.addEventListener(AppEvents.Started, async () => {
43
    let call;
44
    let voiceAIClient;
45
46
    try {
47
        // This can be provided when manually running a routing rule in the Control Panel,
48
        // or via Management API using the `script_custom_data` parameter.
49
        // example: {"destination": "+15551234567","callerId": "+15557654321"}
50
        const {destination, callerId} = JSON.parse(VoxEngine.customData());
51
52
        // Place the outbound call
53
        call = VoxEngine.callPSTN(destination, callerId);
54
55
        // Termination functions - add cleanup and logging as needed
56
        call.addEventListener(CallEvents.Failed, ()=>VoxEngine.terminate());
57
        call.addEventListener(CallEvents.Disconnected, ()=>VoxEngine.terminate());
58
59
        call.addEventListener(CallEvents.Connected, async () => {
60
            // Optional: record once connected
61
            call.record({hd_audio: true, stereo: true});
62
63
            // Create client and wire media after the callee answers
64
            const apiKey = (await ApplicationStorage.get("DEEPGRAM_API_KEY")).value;
65
            voiceAIClient = await Deepgram.createVoiceAgentClient({
66
                apiKey,
67
                settingsOptions: SETTINGS_OPTIONS,
68
            });
69
            VoxEngine.sendMediaBetween(call, voiceAIClient);
70
71
            // Barge-in: keep conversation responsive
72
            voiceAIClient.addEventListener(Deepgram.VoiceAgentEvents.UserStartedSpeaking, () => {
73
                Logger.write("===BARGE-IN: Deepgram.VoiceAgentEvents.UserStartedSpeaking===");
74
                voiceAIClient.clearMediaBuffer();
75
            });
76
77
            // Capture transcript
78
            voiceAIClient.addEventListener(Deepgram.VoiceAgentEvents.ConversationText, (event) => {
79
                const {role, text} = event?.data?.payload || {};
80
                if (role && text) Logger.write(`===TRANSCRIPT=== ${role}: ${text}`);
81
            });
82
83
            // Consolidated "log-only" handlers - key Deepgram/VoxEngine debugging events
84
            [
85
                Deepgram.VoiceAgentEvents.Welcome,
86
                Deepgram.VoiceAgentEvents.SettingsApplied,
87
                Deepgram.VoiceAgentEvents.AgentThinking,
88
                Deepgram.VoiceAgentEvents.AgentAudioDone,
89
                Deepgram.VoiceAgentEvents.ConnectorInformation,
90
                Deepgram.VoiceAgentEvents.HTTPResponse,
91
                Deepgram.VoiceAgentEvents.Warning,
92
                Deepgram.VoiceAgentEvents.Error,
93
                Deepgram.VoiceAgentEvents.Unknown,
94
                Deepgram.Events.WebSocketMediaStarted,
95
                Deepgram.Events.WebSocketMediaEnded,
96
            ].forEach((eventName) => {
97
                voiceAIClient.addEventListener(eventName, (event) => {
98
                    Logger.write(`===${event.name}===`);
99
                    Logger.write(JSON.stringify(event));
100
                });
101
            });
102
        });
103
    } catch (e) {
104
        Logger.write("===UNHANDLED_ERROR===");
105
        Logger.write(e);
106
        voiceAIClient?.close();
107
        VoxEngine.terminate();
108
    }
109
});