CallCollect

Represents a current or past collect session in a call. You can obtain instances of this class by starting at Collect with the following method:

• Call.collect

Example

In this example, we collect digits from the caller. Once the collect session is ended, we print the collected digits and hangup the call.

1
import { SignalWire } from "@signalwire/realtime-api";
2
3
const client = await SignalWire({ project: "ProjectID Here", token: "Token Here" })
4
5
const voiceClient = client.voice;
6
7
const call = await voiceClient.dialPhone({
8
  from: "+YYYYYYYYYY",
9
  to: "+XXXXXXXXXX",
10
});
11
12
// start Collect
13
await call.collect({
14
  partialResults: true,
15
  sendStartOfInput: true,
16
  digits: {
17
    max: 5,
18
    digitTimeout: 4,
19
    terminators: "#*",
20
  },
21
  listen: {
22
    onStarted: async () => {
23
      console.log("Collect started");
24
      await call.playTTS({
25
        text: "Please enter your PIN"
26
      });
27
    },
28
    onInputStarted: () => {
29
      console.log("Collect input started");
30
    },
31
    onUpdated: (collect) => {
32
      console.log("Collect updated:", collect.digits);
33
    },
34
    onEnded: async (collect) => {
35
      console.log("Collect ended:", collect.result);
36
      console.log("PIN collected:", collect.digits);
37
      call.hangup();
38
    },
39
    onFailed: () => {
40
      console.log("Collect failed")
41
    }
42
  }
43
}).onStarted();

Properties

Methods

ended

• ended(): Promise<CallCollect>

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

Returns

Promise<CallCollect>

A promise that resolves to the CallCollect object when the collect session is ended.

Example

1
const collect = await call.collect({
2
  digits: {
3
    max: 4,
4
    digitTimeout: 10,
5
    terminators: "#",
6
  },
7
  partialResults: true,
8
  sendStartOfInput: true,
9
}).onStarted();
10
await collect.ended();

startInputTimers

• startInputTimers(): Promise<CallCollect>

Start the initialTimeout timer on an active collect.

Returns

Promise<CallCollect>

A promise that resolves to the CallCollect object when the collect session InputTimer is started.

Example

1
const collect = await call.collect({
2
  digits: {
3
    max: 4,
4
    digitTimeout: 10,
5
    terminators: "#",
6
  },
7
  partialResults: true,
8
  sendStartOfInput: true,
9
  startInputTimers: false,
10
}).onStarted();
11
// You can add some logic before starting input timers.
12
await collect.startInputTimers();

stop

• stop(): Promise<CallCollect>

Stops the collect session.

Returns

Promise<CallCollect>

A promise that resolves to the CallCollect object when the collect session is stopped.

Example

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
  partialResults: true,
9
  sendStartOfInput: true
10
}).onStarted();
11
await collect.stop();

Alias Types

CallingCallCollectResult

Ƭ CallingCallCollectResult: Promise<CallCollect>

The result of the collect session. Depending on the type of the collect session, the result will return different fields.

Digit Collect Results

The result of a collect session when type is "digit".

Properties

Speech Collect Results

The result of a collect session when type is "speech".

Properties

Start of Input Collect Results

The result of a collect session when type is "start_of_input".

Properties

No Input Collect Results

The result of a collect session when type is "no_input".

Properties

No Match Collect Results

The result of a collect session when type is "no_match".

Properties

Error Collect Results

The result of a collect session when type is "error".

Properties

Events

onStarted

• CallCollect.listen({ onStarted: Callback })

Emitted when the collect session is started. Your event handler will receive the CallCollect object.

Parameters

onInputStarted

• CallCollect.listen({ onInputStarted: Callback })

Emitted when the collect session starts receiving input. Your event handler will receive the CallCollect object.

Parameters

onUpdated

• CallCollect.listen({ onUpdated: Callback })

Emitted when the collect session is updated. Your event handler will receive the CallCollect object.

Parameters

onFailed

• CallCollect.listen({ onFailed: Callback })

Emitted when the collect session fails. Your event handler will receive the CallCollect object.

Parameters

onEnded

• CallCollect.listen({ onEnded: Callback })

Emitted when the collect session ends. Your event handler will receive the CallCollect object.

Parameters