CallPrompt

Represents a current or past prompting session in a call.

Obtain instances of this class by starting a Prompt with one of the following methods:

• Call.prompt
• Call.promptAudio
• Call.promptRingtone
• Call.promptTTS

Example

Prompting for a PIN to be entered using the keypad, then waiting for the user to finish entering the PIN before proceeding with the next instructions.

1
import { SignalWire } from "@signalwire/realtime-api";
2
3
const client = await SignalWire({ project: "ProjectID Here", token: "Token Here" })
4
5
const call = await client.voice.dialPhone({
6
  from: "+YYYYYYYYYY",
7
  to: "+XXXXXXXXXX",
8
});
9
10
// Prompt for digits
11
await call.promptTTS({
12
  text: "Please enter your PIN",
13
  digits: {
14
    max: 5,
15
    digitTimeout: 5,
16
    terminators: "#*",
17
  },
18
  listen: {
19
    onStarted: () => console.log("Prompt started"),
20
    onUpdated: (event) => console.log("Prompt updated", event.result),
21
    onEnded: async (event) => {
22
      console.log("Prompt ended", event.result);
23
      console.log("Users Pin", event.digits);
24
      call.hangup();
25
    },
26
    onFailed: () => console.log("Prompt failed"),
27
  }
28
}).onStarted();

Properties

Methods

ended

• ended(): Promise<CallPrompt>

Returns a promise that is resolved only after this prompt finishes (or is stopped).

Returns

Promise<CallPrompt>

A promise that is resolves to CallPrompt when the prompt has been ended.

Example

1
const prompt = await call.promptTTS({
2
  text: "Please enter your PIN",
3
  digits: {
4
    max: 5,
5
    digitTimeout: 2,
6
    terminators: "#*",
7
  },
8
});
9
const { type, digits, terminator } = await prompt.ended();

setVolume

• setVolume(volume): Promise<CallPrompt>

Changes the volume of the audio.

Parameters

Returns

Promise<CallPrompt>

A promise that is resolves to CallPrompt when the volume is changed.

Example

1
const prompt = await call.promptTTS({
2
  text: "Please enter your PIN",
3
  digits: {
4
    max: 5,
5
    digitTimeout: 2,
6
    terminators: "#*",
7
  },
8
});
9
await prompt.setVolume(-20);

stop

• stop(): Promise<CallPrompt>

Stops the prompt.

Returns

Promise<CallPrompt>

A promise that is resolves to CallPrompt when the prompt stops.

Example

1
const prompt = await call.promptTTS({
2
  text: "Please enter your PIN",
3
  digits: {
4
    max: 5,
5
    digitTimeout: 2,
6
    terminators: "#*",
7
  },
8
});
9
await prompt.stop();

Events

onStarted

• CallPrompt.listen({ onStarted: Callback }})

Emitted when the prompt starts. Your event handler will receive an instance of CallPrompt.

Parameters

onUpdated

• CallPrompt.listen({ onUpdated: Callback }})

Emitted when the prompt is updated. Your event handler will receive an instance of CallPrompt.

Parameters

onFailed

• CallPrompt.listen({ onFailed: Callback }})

Emitted when the prompt fails. Your event handler will receive an instance of CallPrompt.

Parameters

onEnded

• CallPrompt.listen({ onEnded: Callback }})

Emitted when the prompt ends. Your event handler will receive an instance of CallPrompt.

Parameters