collect

collect(params): Promise<CallCollect> - See CallCollect for more details.

Collect user input. For methods that include a prompt to the user, please see promptAudio, promptRingtone, or promptTTS.

Parameters

Name	Type	Description
`params`	`Object`	-
`params.continuous?`	`boolean`	Detect utterances and digits until stopped. Defaults to false.
`params.digits?`	`CollectDigitsConfig`	Configuration for collecting digits. You must either set this, or `speech`.
`params.speech?`	`CollectSpeechConfig`	Configuration for collecting speech. You must either set this, or `digits`.
`params.initialTimeout?`	`number`	Number of seconds to wait for initial input before giving up. Default is 4 seconds. Will be used only when `startInputTimers` is true or when the timer is started manually via the `startInputTimers` method.
`params.partialResults?`	`boolean`	If true, partial result events are fired. Default is false.
`params.sendStartOfInput?`	`boolean`	If true, the `startOfInput` event is fired when input is detected. Default is false.
`params.startInputTimers?`	`boolean`	If true, the `initialTimeout` timer is started. Default is false.

Returns

Promise<CallCollect> - See CallCollect for more details.

Examples

Collecting digits input:

1 const collect = await call.collect({
2   digits: {
3     max: 5,
4     digitTimeout: 2,
5     terminators: "#*",
6   },
7 });
8 const { type, digits, terminator } = await collect.ended();

Collecting speech input:

1 const collect = await call.collect({
2   speech: {
3     endSilenceTimeout: 2,
4     speechTimeout: 10,
5     language: "en-US",
6     hints: ["sales", "support", "representative"],
7   },
8 });
9 const { type, speech } = await collect.ended();

Collecting digits and listening for results using the events:

1 call.on("collect.started", (collect) => {
2   console.log("collect.started", collect);
3 });
4 call.on("collect.startOfInput", (collect) => {
5   console.log("Input collection started.");
6 });
7 call.on("collect.updated", (collect) => {
8   console.log("collect.updated", collect.digits);
9 });
10 call.on("collect.ended", (collect) => {
11   console.log("collect.ended", collect.digits);
12 });
13 call.on("collect.failed", (collect) => {
14   console.log("collect.failed", collect.reason);
15 });
16 
17 const collect = await call.collect({
18   digits: {
19     max: 4,
20     digitTimeout: 10,
21     terminators: "#",
22   },
23   partialResults: true,
24   sendStartOfInput: true,
25 });