Actions

Action objects are returned from call control methods like play(), record(), and detect(). They provide a common interface for tracking and controlling in-progress operations on a Call.

All action classes extend a shared base that provides isDone, completed, result, controlId, and the wait() method. Specific action types add methods relevant to their operation (e.g., pause() and resume() on PlayAction).

1
import { RelayClient } from '@signalwire/sdk';
2
3
const client = new RelayClient({
4
  project: process.env.SIGNALWIRE_PROJECT_ID!,
5
  token: process.env.SIGNALWIRE_TOKEN!,
6
  contexts: ['default']
7
});
8
9
client.onCall(async (call) => {
10
  await call.answer();
11
  const playAction = await call.play([{ type: 'tts', text: 'Hello!' }]);
12
13
  // Control the in-progress operation
14
  await playAction.pause();
15
  await playAction.resume();
16
17
  // Wait for completion
18
  const event = await playAction.wait();
19
});
20
21
await client.run();

Action (Base Interface)

All action classes share these properties and methods.

Properties

Methods

wait

Await the action’s completion and return the terminal event.

Subclasses