Outbound calls

1
VoxEngine.addEventListener(AppEvents.Started, () => {
2
  // Retrieve information passed when the scenario was triggered
3
  const { destination, callerId } = JSON.parse(VoxEngine.customData());
4
5
  // Choose your call method based on the destination & desired network
6
  const call = VoxEngine.callPSTN(destination, callerId);
7
  // const call = VoxEngine.callUser({ username: destination, callerid: callerId });
8
  // const call = VoxEngine.callSIP(`sip:${destination}@your-sip-domain`, callerId);
9
  // const call = VoxEngine.callWhatsappUser({ number: destination, callerid: callerId });
10
11
  // Handle call events
12
  call.addEventListener(CallEvents.Disconnected, ()=>VoxEngine.terminate());
13
  call.addEventListener(CallEvents.Failed, ()=>VoxEngine.terminate());
14
15
  // Set up the Voice AI client and media bridging only after the call is connected
16
  call.addEventListener(CallEvents.Connected, async () => {
17
    const voiceAIClient = OpenAI.createRealtimeAPIClient({apiKey: "your-key", model: "your-realtime-model"});
18
    // Bridge media between the call and the Voice AI client so they can speak and hear each other
19
    VoxEngine.sendMediaBetween(call, voiceAIClient);
20
  });
21
});

$
curl -X POST "https://api.voximplant.com/platform_api/StartScenarios/" \
>
  --data-urlencode "account_id=$VOX_ACCOUNT_ID" \
>
  --data-urlencode "api_key=$VOX_API_KEY" \
>
  --data-urlencode "rule_id=$VOX_RULE_ID" \
>
  --data-urlencode "script_custom_data={\"destination\":\"+15551234567\",\"callerId\":\"+15557654321\"}"

1
require(Modules.CallList); // Enable CallList methods
2
3
VoxEngine.addEventListener(AppEvents.Started, () => {
4
  const task = JSON.parse(VoxEngine.customData() || "{}");
5
  const destination = task.destination;
6
  const callerId = task.callerId;
7
8
  if (!destination || !callerId) {
9
    CallList.reportError({
10
      status: "invalid_task_data",
11
      destination: destination || null
12
    });
13
    VoxEngine.terminate();
14
    return;
15
  }
16
17
  const call = VoxEngine.callPSTN(destination, callerId);
18
19
  call.addEventListener(CallEvents.Connected, () => {
20
    CallList.reportProgress({
21
      status: "connected",
22
      destination: destination
23
    });
24
    // Create/attach your Voice AI connector here.
25
  });
26
27
  call.addEventListener(CallEvents.Disconnected, () => {
28
    CallList.reportResult({
29
      status: "completed",
30
      destination: destination
31
    });
32
    VoxEngine.terminate();
33
  });
34
35
  call.addEventListener(CallEvents.Failed, () => {
36
    CallList.reportError({
37
      status: "failed",
38
      destination: destination
39
    });
40
    VoxEngine.terminate();
41
  });
42
});