Types

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

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

1
const collectObj = await call.collect({
2
  speech: {
3
    endSilenceTimeout: 2,
4
    speechTimeout: 30,
5
    language: "en-US",
6
    hints: ["yes", "no", "maybe"]
7
  }
8
});
9
const { speech, text } = await collectObj.ended();

1
const prompt = await call.promptTTS({
2
  text: "Please say yes or no",
3
  speech: {
4
    endSilenceTimeout: 1,
5
    speechTimeout: 60,
6
    language: "en-US",
7
    hints: ["yes", "no"]
8
  }
9
});
10
const { type, text } = await prompt.ended();

1
import { Voice } from "@signalwire/realtime-api";
2
3
const devices = new Voice.DeviceBuilder().add(
4
  Voice.DeviceBuilder.Sip({
5
    from: "sip:user1@domain.com",
6
    to: "sip:user2@domain.com",
7
    codecs: ["OPUS", "PCMU"]
8
  })
9
);
10
11
const call = await client.voice.dial({ devices });

1
import { Voice } from "@signalwire/realtime-api";
2
3
const devices = new Voice.DeviceBuilder().add(
4
  Voice.DeviceBuilder.Sip({
5
    from: "sip:user1@domain.com",
6
    to: "sip:user2@domain.com",
7
    headers: [
8
      { name: "X-Custom-Header", value: "my-value" },
9
      { name: "X-Account-ID", value: "12345" }
10
    ]
11
  })
12
);
13
14
const call = await client.voice.dial({ devices });

1
import { Voice } from "@signalwire/realtime-api";
2
3
const playlist = new Voice.Playlist()
4
  .add(Voice.Playlist.Ringtone({ name: "us", duration: 10 }));
5
6
await call.play(playlist);

1
const prompt = await call.promptRingtone({
2
  name: "it",
3
  duration: 10,
4
  digits: {
5
    max: 1,
6
    digitTimeout: 5
7
  }
8
});
9
const { digits } = await prompt.ended();

1
const tap = await call.tapAudio({
2
  direction: "both",
3
  device: {
4
    type: "ws",
5
    uri: "wss://example.domain.com/endpoint"
6
  }
7
});
8
9
// Stop the tap when done
10
await tap.stop();

1
const tap = await call.tap({
2
  audio: {
3
    direction: "speak"
4
  },
5
  device: {
6
    type: "rtp",
7
    addr: "192.0.2.1",
8
    port: "1234",
9
    codec: "PCMU"
10
  }
11
});
12
13
await tap.stop();