Relay SDK for Node.js

Getting Started

The Relay SDK for Node.js enables Node.js developers to connect and use SignalWire's Relay APIs within their own Node.js code. Our Relay SDK allows developers to build or add robust and innovative communication services to their applications.

The Relay SDK for Node.js is easy to use and only takes a few minute to setup and get running.

Latest Version:

Source Code: signalwire/signalwire-node

Support: SignalWire Community Slack Channel

NOTE: This is an old version of the RELAY Node.js SDK. The RELAY Realtime SDK is the latest Node.js SDK version. While this SDK is still functional, you should consider upgrading to the newest version as this SDK moves closer to deprecation. For some pointers on migrating, please read our post "Upgrade Your RELAY Game".

Installation

Install the package using NPM:

npm install @signalwire/node

Minimum Requirements

The Node.js SDK may be used with Node.js 8.0 or greater.

Using the SDK

The Node.js SDK can be used to get up and running with Relay quickly and easily. In order to use the Node.js client, you must get your project and token from your SignalWire dashboard.

There are a few ways to get started, depending on your needs: Relay.Consumer, Relay.Task, and Relay.Client.

Relay Consumer

A Relay.Consumer creates a long running process, allowing you to respond to incoming requests and events in realtime. Relay Consumers abstract all the setup of connecting to Relay and automatically dispatches workers to handle requests; so you can concentrate on writing your code without having to worry about multi-threading or blocking, everything just works. Think of Relay Consumers like a background worker system for all your calling and messaging needs.

Relay Consumers can scale easily, simply by running multiple instances of your Relay.Consumer process. Each event will only be delivered to a single consumer, so as your volume increases, just scale up! This process works well whether you are using Docker Swarm, a Procfile on Heroku, your own webserver, and most other environments.

Setting up a new consumer is the easiest way to get up and running.

const { RelayConsumer } = require('@signalwire/node')

const consumer = new RelayConsumer({
  project: 'XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX',
  token: 'PTXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX',
  contexts: ['home', 'office'],
  ready: async ({ client }) => {
    // Consumer is successfully connected with Relay.
    // You can make calls or send messages here..
  },
  onIncomingCall: async (call) => {
    const { successful } = await call.answer()
    if (!successful) { return }

    await call.playTTS({ text: 'Welcome to SignalWire!' })
  }
})

consumer.run()

Learn more about Relay Consumers

Relay Task

A Relay.Task is simple way to send jobs to your Relay.Consumers from a short lived process, like a web framework. Relay Tasks allow you to pass commands down to your Consumers without blocking your short lived request. Think of a Relay Task as a way to queue a job for your background workers to processes asynchronously.

For example, if you wanted to make an outbound call and play a message when your user clicks a button on your web application, since Relay is a realtime protocol and relies on you to tell it what to do in realtime, if you did this within your web application, your web server would block until the call was finished... this may take a long time! Instead, simply create a new Relay Task. This task will be handled by a running Relay Consumer process and your web application can respond back to your user immediately.

Send a task in the office context with custom data.

// create-task.js
const { Task } = require('@signalwire/node')

async function main() {
  const yourTask = new Task('XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX', 'PTXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX')
  const context = 'office'
  const data = {
    uuid: 'unique id',
    data: 'data for your job'
  }
  try {
    await yourTask.deliver(context, data)
  } catch (error) {
    console.log('Error creating task!', error)
  }
}

main().catch(console.error)

Handle the task in a Consumer.

// consumer-task.js
const { RelayConsumer } = require('@signalwire/node')

const consumer = new RelayConsumer({
  project: 'XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX',
  token: 'PTXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX',
  contexts: ['office'],
  onTask: (message) => {
    console.log('Inbound task', message)
    // Retrieve your custom properties from 'message'..
    const { uuid, data } = message
  }
})

consumer.run()

Learn more about Relay Tasks

Relay Client

Relay.Client is a lower level object, giving you a basic connection to Relay but that is all. It is best used when you are creating a script only concerned with sending outbound requests or you want complete control over the Relay connection yourself.

Setting up a new client and make an outbound call.

const { RelayClient } = require('@signalwire/node')
const client = new RelayClient({
  project: 'XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX',
  token: 'PTXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX'
})

client.on('signalwire.ready', async (client) => {

  const dialResult = await client.calling.dial({
    type: 'phone',
    from: '+1XXXXXXXXXX',
    to: '+1YYYYYYYYYY'
  })

  if (dialResult.successful) {
    const { call } = dialResult
    // Your call has been answered..
  }
})

client.connect()

Learn more about Relay Clients

Contexts

Relay uses Contexts as a simple way to separate events to specific consumers, allowing you to write consumers for specific types of calls or messages or scale them independently. A Context is simply a named string, that allows you to categorize requests. When creating outbound requests, or configuring phone numbers for inbound requests, you can specify the context; Relay will then deliver that call or event to Consumers that are configured to listen for that context.

For example, you could have a customer support phone number configured to send to Relay with the support context, and a personal number configured with personal context. Relay would deliver these events to any Consumer listening for those contexts. This gives you a lot of control in how messages are delivered to your Consumers, allowing you to write Consumer classes specific to the context, scale them independently, or separate traffic based on your own business rules.

API Reference

Relay.Client

Relay.Client is the basic connection to Relay, allowing you send commands to Relay and setup handlers for inbound events.

Constructor

Constructs a client object to interact with Relay.

Parameters

Examples

Create a Client to interact with the Relay API.

const client = new RelayClient({
  project: 'my-project-id',
  token: 'my-project-token'
})

Properties

Methods

connect

Activates the connection to the Relay API. The connection to Relay does not happen automatically so that you can setup handlers to events that might occur before the connection is successfully established.

Available In:

Returns

Promise<void>

Examples

// Make sure you have attached the listeners you need before connecting the client, or you might miss some events.
await client.connect()

disconnect

Disconnect the client from Relay.

Available In:

Returns

void

Examples

client.disconnect()

on

Attach an event handler for a specific type of event.

Available In:

Parameters

Returns

Relay.Client - The client object itself.

Examples

Subscribe to the signalwire.ready and signalwire.error events.

client.on('signalwire.ready', (client) => {
  // Your client is ready!
}).on('signalwire.error', (error) => {
  // Got an error...
})

off

Remove an event handler that were attached with .on(). If no handler parameter is passed, all listeners for that event will be removed.

Parameters

Returns

Relay.Client - The client object itself.

Examples

Subscribe to the signalwire.error and then, remove the event handler.

const errorHandler = (error) => {
  // Log the error..
}

client.on('signalwire.error', errorHandler)

// .. later
client.off('signalwire.error', errorHandler)

Events

All available events you can attach a listener on.

Relay.Calling

This represents the API interface for the Calling Relay Service. This object is used to make requests related to managing end to end calls.

Methods

dial

Make an outbound Call and waits until it has been answered or hung up.

Available In:

Parameters

Returns

Promise<DialResult> - Promise that will be fulfilled with a Relay.Calling.DialResult object.

Examples

Make an outbound Call and grab the call object is it was answered.

async function main() {
  const dialResult = await client.calling.dial({
    type: 'phone',
    from: '+1XXXXXXXXXX',
    to: '+1YYYYYYYYYY',
    timeout: 30
  })

  if (dialResult.successful) {
    const { call } = dialResult
  }
}

main().catch(console.error)

Make an outbound Call to a SIP endpoint.

async function main() {
  const dialResult = await client.calling.dial({
    type: 'sip',
    from: 'sip:XXXX@XXXXX.XXX',
    to: 'sip:YYYY@YYYYY.YYY',
    timeout: 30
  })

  if (dialResult.successful) {
    const { call } = dialResult
  }
}

main().catch(console.error)

Dial a SIP endpoint with custom headers.

client.calling.dial({
  type: 'sip',
  from: 'sip:XXXX@XXXXX.XXX',
  to: 'sip:YYYY@YYYYY.YYY',
  timeout: 30,
  headers: [{
    "name": "X-Relay-Call-ID",
    "value": "697a4e98-f452-416f-b11e-63c19112f542"
  }, {
    "name": "X-CID",
    "value": "124077399_129412436@206.117.11.72"
  }, {
    "name": "X-Target-Type",
    "value": "classic"
  }]
})

newCall

Create a new Call object. The call has not started yet allowing you to attach event listeners on it.

Available In:

Parameters

See Relay.Calling.Dial for the parameter list.

Returns

Call - A new Relay.Calling.Call object.

Examples

Create a new Call object.

const call = client.calling.newCall({
  type: 'phone',
  from: '+1XXXXXXXXXX',
  to: '+1YYYYYYYYYY',
  timeout: 30
})

// Use the call object..

Relay.Calling.AnswerResult

This object returned from answer method.

Properties

Relay.Calling.Call

All calls in SignalWire have a common generic interface, Call. A Call is a connection between SignalWire and another device.

Properties

Methods

amd

Alias for detectAnsweringMachine.

amdAsync

Alias for detectAnsweringMachineAsync.

answer

Answer an inbound call.

Available In:

Parameters

None

Returns

Promise<AnswerResult> - Promise object that will be fulfilled with a Relay.Calling.AnswerResult object.

Examples

Answer an inbound call and check if it was successful.

// within an async function ..
const answerResult = await call.answer()
if (answerResult.successful) {

}

connect

Attempt to connect an existing call to a new outbound call and waits until one of the remote party picks the call or the connect fails.
This method involves complex nested parameters. You can connect to multiple devices in series, parallel, or any combination of both with creative use of the parameters. Series implies one device at a time, while parallel implies multiple devices at the same time.

Available In:

Parameters

• Structure of a device:

Returns

Promise<ConnectResult> - Promise object that will be fulfilled with a Relay.Calling.ConnectResult object.

Examples

Try connecting by calling +18991114444 and +18991114445 in series.

const connectResult = await call.connect(
  { type: 'phone', to: '+18991114444', timeout: 30 },
  { type: 'phone', to: '+18991114445', timeout: 20 }
)

if (connectResult.successful) {
  // connectResult.call is the remote leg connected with yours.
}

Combine serial and parallel calling. Call +18991114443 first and - if it doesn't answer - try calling in parallel +18991114444 and +18991114445. If none of the devices answer, continue the same process with +18991114446 and +18991114447.

const result = await call.connect(
  { type: 'phone', to: '+18991114443', timeout: 30 },
  [
    { type: 'phone', to: '+18991114444', timeout: 30 },
    { type: 'phone', to: '+18991114445', timeout: 20 }
  ],
  [
    { type: 'phone', to: '+18991114446', timeout: 30 },
    { type: 'phone', to: '+18991114447', timeout: 20 }
  ]
)

if (connectResult.successful) {
  // connectResult.call is the remote leg connected with yours.
}

Try connecting by calling +18991114444 and +18991114445 in series playing the US ringtone.

const params = {
  devices: [
    { type: 'phone', to: '+18991114444' },
    { type: 'phone', to: '+18991114445' }
  ],
  ringback: { type: 'ringtone', name: 'us' }
}
const connectResult = await call.connect(params)
if (connectResult.successful) {
  // connectResult.call is the remote leg connected with yours.
}

connectAsync

Asynchronous version of connect. It does not wait the connect to completes or fails but returns a Relay.Calling.ConnectAction you can interact with.

Available In:

Parameters

See connect for the parameter list.

Returns

Promise<ConnectAction> - Promise object that will be fulfilled with a Relay.Calling.ConnectAction object.

Examples

Trying to connect a call by calling in series +18991114444 and +18991114445.

async function main() {
  const connectAction = await call.connectAsync(
    { type: 'phone', to: '+18991114444', timeout: 30 },
    { type: 'phone', to: '+18991114445', timeout: 20 }
  )
  // .. do other important things while Relay try to connect your call..

  // Check whether the action has completed
  if (connectAction.completed) {

  }
}

main().catch(console.error)

detect

Start a detector on the call and waits until it has finished or failed.

The detect method is a generic method for all types of detecting, see detectAnsweringMachine, detectDigit or detectFax for more specific usage.

Available In:

Parameters

• To detect an answering machine:

• To detect digits:

• To detect a fax:

Returns

Promise<DetectResult> - Promise object that will be fulfilled with a Relay.Calling.DetectResult object.

Examples

Detect a machine with custom parameters and timeout.

// within an async function ..
const detectResult = await call.detect({ type: 'machine', timeout: 45, initial_timeout: 3 })
if (detectResult.successful) {

}

Detect a Fax setting timeout only.

// within an async function ..
const detectResult = await call.detect({ type: 'fax', timeout: 45 })
if (detectResult.successful) {

}

detectAsync

Asynchronous version of detect. It does not wait the detector ends but returns a Relay.Calling.DetectAction you can interact with.

Available In:

Parameters

See detect for the parameter list.

Returns

Promise<DetectAction> - Promise object that will be fulfilled with a Relay.Calling.DetectAction object.

Examples

Detect all the digits using default parameters. Stop the action after 5 seconds.

async function main() {
  call.on('detect.update', (call, params) => {
    console.log('Detector event:', params)
  })

  const detectAction = await call.detectAsync('fax')
  // Do other things while detector runs and then stop it..
  setTimeout(async () => {
    await detectAction.stop()
  }, 5000)
}

main().catch(console.error)

detectAnsweringMachine

This is a helper function that refines the use of detect. The Promise will be resolved with a Relay.Calling.DetectResult object as soon as the detector decided who answered the call: MACHINE, HUMAN or UNKNOWN.

Available In:

Parameters

Returns

React\Promise\Promise - Promise object that will be fulfilled with a Relay.Calling.DetectResult object.

Examples

Perform an AMD and wait until the machine is ready.

// within an async function ..
const { successful, result } = await call.detectAnsweringMachine({ wait_for_beep: true })
if (successful) {
  console.log('AMD result:', result) // MACHINE || HUMAN || UNKNOWN
}

detectAnsweringMachineAsync

Asynchronous version of detectAnsweringMachine. It does not wait the detector ends but returns a Relay.Calling.DetectAction you can interact with.

Available In:

Parameters

See detectAnsweringMachine for the parameter list.

Returns

React\Promise\Promise - Promise object that will be fulfilled with a Relay.Calling.DetectAction object.

Examples

Perform an asynchronous AMD on the call. Then stop the action if not completed yet.

// within an async function ..
call.on('detect.update', (call, params) => {
  // Handle a detector event here..
  console.log(params)
})
const detectAction = await call.detectAnsweringMachineAsync()
// Do other things while detector runs and then stop it.
if (detectAction.completed) {
  detectAction.stop()
}

detectDigit

This is a helper function that refines the use of detect. This simplifies detecting digits on a call.

Available In:

Parameters

Returns

Promise<DetectResult> - Promise object that will be fulfilled with a Relay.Calling.DetectResult object.

Examples

Detect digits and then write a log with the result.

// within an async function ..
const detectResult = await call.detectDigit()
if (detectResult.successful) {
  console.log('Digits detected:', detectResult.result)
}

detectDigitAsync

Asynchronous version of detectDigit. It does not wait the detector ends but returns a Relay.Calling.DetectAction you can interact with.

Available In:

Parameters

See detectDigit for the parameter list.

Returns

Promise<DetectAction> - Promise object that will be fulfilled with a Relay.Calling.DetectAction object.

Examples

Detect only 1-3 digits. Stop the action after 5 seconds.

async function main() {
  const detectAction = await call.detectDigitAsync({ digits: '123' })

  setTimeout(async () => {
    await detectAction.stop()
  }, 5000)
}

main().catch(console.error)

detectFax

This is a helper function that refines the use of detect. This simplifies detecting a fax.

Available In:

Parameters

Returns

Promise<DetectResult> - Promise object that will be fulfilled with a Relay.Calling.DetectResult object.

Examples

Detect fax on the current call.

// within an async function ..
const detectResult = await call.detectFax()
if (detectResult.successful) {
  // A fax has been detected!
}

detectFaxAsync

Asynchronous version of detectFax. It does not wait the detector ends but returns a Relay.Calling.DetectAction you can interact with.

Available In:

Parameters

See detectFax for the parameter list.

Returns

Promise<DetectAction> - Promise object that will be fulfilled with a Relay.Calling.DetectAction object.

Examples

Detect fax on the current call. Stop the action after 5 seconds.

async function main() {
  const detectAction = await call.detectFaxAsync()

  setTimeout(async () => {
    await detectAction.stop()
  }, 5000)
}

main().catch(console.error)

detectHuman

This is a helper function that refines the use of detect. This simplifies detecting a human on the call and is the inverse of detectMachine.

Deprecated since: Use detectAnsweringMachine instead.

Parameters

Returns

Promise<DetectResult> - Promise object that will be fulfilled with a Relay.Calling.DetectResult object.

Examples

Detect a human on the current call.

// within an async function ..
const detectResult = await call.detectHuman()
if (detectResult.successful) {
  // Human has been detected!
}

detectHumanAsync

Asynchronous version of detectHuman. It does not wait the detector ends but returns a Relay.Calling.DetectAction you can interact with.

Deprecated since: Use detectAnsweringMachineAsync instead.

Parameters

See detectHuman for the parameter list.

Returns

Promise<DetectAction> - Promise object that will be fulfilled with a Relay.Calling.DetectAction object.

Examples

Detect a human on the current call. Stop the action after 5 seconds.

async function main() {
  const detectAction = await call.detectHumanAsync()

  setTimeout(async () => {
    await detectAction.stop()
  }, 5000)
}

main().catch(console.error)

detectMachine

This is a helper function that refines the use of detect. This simplifies detecting a machine on the call and is the inverse of detectHuman.

Deprecated since: Use detectAnsweringMachine instead.

Parameters

Returns

Promise<DetectResult> - Promise object that will be fulfilled with a Relay.Calling.DetectResult object.

Examples

Detect a machine on the current call.

// within an async function ..
const detectResult = await call.detectMachine()
if (detectResult.successful) {
  // A machine has been detected!
}

detectMachineAsync

Asynchronous version of detectMachine. It does not wait the detector ends but returns a Relay.Calling.DetectAction you can interact with.

Deprecated since: Use detectAnsweringMachineAsync instead.

Parameters

See detectMachine for the parameter list.

Returns

Promise<DetectAction> - Promise object that will be fulfilled with a Relay.Calling.DetectAction object.

Examples

Detect a machine on the current call. Stop the action after 5 seconds.

async function main() {
  const detectAction = await call.detectMachineAsync()

  setTimeout(async () => {
    await detectAction.stop()
  }, 5000)
}

main().catch(console.error)

dial

This will start a call that was created with newCall and waits until the Call has been answered or hung up.

Available In:

Parameters

None

Returns

Promise<DialResult> - Promise object that will be fulfilled with a Relay.Calling.DialResult object.

Examples

async function main() {
  const call = client.calling.newCall({ type: 'phone', from: '+1XXXXXXXXXX', to: '+1YYYYYYYYYY' })

  const dialResult = await call.dial()
}

main().catch(console.error)

faxReceive

Prepare the call to receive an inbound fax. It waits until the fax has been received or failed.

Available In:

Parameters

None

Returns

Promise<FaxResult> - Promise object that will be fulfilled with a Relay.Calling.FaxResult object.

Examples

Receiving a fax on the call and print logs for URL and number of received pages.

async function main() {
  const faxResult = await call.faxReceive()
  if (faxResult.successful) {
    console.log('URL: ', faxResult.document)
    console.log('Total pages: ', faxResult.pages)
  }
}

main().catch(console.error)

faxReceiveAsync

Asynchronous version of faxReceive. It does not wait the fax to be received but returns a Relay.Calling.FaxAction you can interact with.

Available In:

Parameters

None

Returns

Promise<FaxAction> - Promise object that will be fulfilled with a Relay.Calling.FaxAction object.

Examples

Trying to receive a fax. Stop the attempt after 5 seconds.

async function main() {
  const faxAction = await call.faxReceiveAsync()

  setTimeout(async () => {
    await faxAction.stop()
  }, 5000)
}

main().catch(console.error)

faxSend

Send a Fax through the call. It waits until the fax has been sent or failed.

Available In:

Parameters

Returns

Promise<FaxResult> - Promise object that will be fulfilled with a Relay.Calling.FaxResult object.

Examples

Sending a fax on the call and print logs the number of sent pages.

async function main() {
  const faxResult = await call.faxSend('https://www.w3.org/WAI/ER/tests/xhtml/testfiles/resources/pdf/dummy.pdf', null, 'Custom Header')
  if (faxResult.successful) {
    console.log('URL: ', faxResult.document)
    console.log('Total pages: ', faxResult.pages)
  }
}

main().catch(console.error)

faxSendAsync

Asynchronous version of faxSend. It does not wait the fax to be sent but returns a Relay.Calling.FaxAction you can interact with.

Available In:

Parameters

See faxSend for the parameter list.

Returns

Promise<FaxAction> - Promise object that will be fulfilled with a Relay.Calling.FaxAction object.

Examples

Trying to send a fax. Stop sending it after 5 seconds.

async function main() {
  const faxAction = await call.faxSendAsync('https://www.w3.org/WAI/ER/tests/xhtml/testfiles/resources/pdf/dummy.pdf', null, 'Custom Header')

  setTimeout(async () => {
    await faxAction.stop()
  }, 5000)
}

main().catch(console.error)

hangup

Hangup the call.

Available In:

Parameters

None

Returns

Promise<HangupResult> - Promise object that will be fulfilled with a Relay.Calling.HangupResult object.

Examples

Hangup a call and check if it was successful.

// within an async function ..
const hangupResult = await call.hangup()
if (hangupResult.successful) {

}

on

Attach an event handler for the event.

Available In:

Parameters

Returns

Relay.Calling.Call - The call object itself.

Examples

Subscribe to the answered and ended events for a given call.

call.on('answered', (call) => {
  // Call has been answered from the remote party!
}).on('ended', (call) => {
  // Call has ended.. cleanup something?
})

off

Remove an event handler that were attached with .on(). If you don't pass a handler, all listeners for that event will be removed.

Available In:

Parameters

Returns

Relay.Calling.Call - The call object itself.

Examples

Subscribe to the call ended state change and then, remove the event handler.

const callEndedHandler = (call) => {
  // Call has ended.
})

call.on('ended', callEndedHandler)

// .. later
call.off('ended', callEndedHandler)

play

Play one or multiple media in a Call and waits until the playing has ended.
The play method is a generic method for all types of playing, see playAudio, playSilence, playTTS or playRingtone for more specific usage.

Available In:

Parameters

params	object	required	Object with the following properties:
volume	number	optional	Volume value between -40dB and +40dB where 0 is unchanged. Default is 0.
media	array	required	Array of media objects to play. See below for each type:

• To play an audio file:

• To play a text to speech string:

• To play silence:

• To play ringtone:

Returns

Promise<PlayResult> - Promise object that will be fulfilled with a Relay.Calling.PlayResult object.

Examples

Play multiple media in one request setting volume to 6dB.

async function main() {
  const params = {
    media: [
      { type: 'tts', text: 'Listen this awesome file!' },
      { type: 'audio', url: 'https://cdn.signalwire.com/default-music/welcome.mp3' },
      { type: 'silence', duration: 5 },
      { type: 'tts', text: 'Did you like it?' }
    ],
    volume: 6
  }
  const playResult = await call.play(params)
}

main().catch(console.error)

playAsync

Asynchronous version of play. It does not wait the playing to completes but returns a Relay.Calling.PlayAction you can interact with.

Available In:

Parameters

See play for the parameter list.

Returns

Promise<PlayAction> - Promise object that will be fulfilled with a Relay.Calling.PlayAction object.

Examples

Play multiple media elements in the call and stop them after 5 seconds.

async function main() {
  const params = {
    media: [
      { type: 'tts', text: 'Listen this awesome file!' },
      { type: 'audio', url: 'https://cdn.signalwire.com/default-music/welcome.mp3' },
      { type: 'silence', duration: 5 },
      { type: 'tts', text: 'Did you like it?' }
    ],
    volume: 6
  }
  const playAction = await call.playAsync(params)

  setTimeout(async () => {
    await playAction.stop()
  }, 5000)
}

main().catch(console.error)

playAudio

This is a helper function that refines the use of play. This simplifies playing an audio file.

Available In:

Parameters

params	object	required	Object with the following properties:
url	string	required	Http(s) URL to audio resource to play.
volume	number	optional	Volume value between -40dB and +40dB where 0 is unchanged. Default is 0.

Returns

Promise<PlayResult> - Promise object that will be fulfilled with a Relay.Calling.PlayResult object.

Examples

Play an Mp3 file using the signature with a string as parameter.

// within an async function ..
const playResult = await call.playAudio('https://cdn.signalwire.com/default-music/welcome.mp3')

Play an Mp3 file setting volume level to 4dB. Require v2.3+

// within an async function ..
const params = {
  url: 'https://cdn.signalwire.com/default-music/welcome.mp3',
  volume: 4
}
const playResult = await call.playAudio(params)

playAudioAsync

Asynchronous version of playAudio. It does not wait the playing to completes but returns a Relay.Calling.PlayAction you can interact with.

Available In:

Parameters

See playAudio for the parameter list.

Returns

Promise<PlayAction> - Promise object that will be fulfilled with a Relay.Calling.PlayAction object.

Examples

Play an Mp3 file and stop it after 5 seconds.

// within an async function ..
const playAction = await call.playAudioAsync('https://cdn.signalwire.com/default-music/welcome.mp3')

setTimeout(async () => {
  await playAction.stop()
}, 5000)

Play an Mp3 file setting the volume and stop it after 5 seconds.

// within an async function ..
const params = {
  url: 'https://cdn.signalwire.com/default-music/welcome.mp3',
  volume: 4
}
const playAction = await call.playAudioAsync(params)

setTimeout(async () => {
  await playAction.stop()
}, 5000)

playRingtone

This is a helper function that refines the use of play. This simplifies playing TTS.

Available In:

Parameters

params	object	required	Object with the following properties:
name	string	required	The name of the ringtone. See ringtones for the supported values.
duration	number	optional	Duration of ringtone to play. Default to 1 ringtone iteration.
volume	number	optional	Volume value between -40dB and +40dB where 0 is unchanged. Default is 0.

Returns

Promise<PlayResult> - Promise object that will be fulfilled with a Relay.Calling.PlayResult object.

Examples

Play a single US ringtone.

// within an async function ..
const playResult = await call.playRingtone({ name: 'us' })

playRingtoneAsync

Asynchronous version of playRingtone. It does not wait the playing to completes but returns a Relay.Calling.PlayAction you can interact with.

Available In:

Parameters

See playRingtone for the parameter list.

Returns

Promise<PlayAction> - Promise object that will be fulfilled with a Relay.Calling.PlayAction object.

Examples

Play US ringtone for 30 seconds and stop it after 5 seconds.

// within an async function ..
const playAction = await call.playRingtoneAsync({ name: 'us', duration: 30 })

setTimeout(async () => {
  await playAction.stop()
}, 5000)

playSilence

This is a helper function that refines the use of play. This simplifies playing silence.

Available In:

Parameters

Returns

Promise<PlayResult> - Promise object that will be fulfilled with a Relay.Calling.PlayResult object.

Examples

Play silence for 10 seconds.

// within an async function ..
const playResult = await call.playSilence(10)

playSilenceAsync

Asynchronous version of playSilence. It does not wait the playing to completes but returns a Relay.Calling.PlayAction you can interact with.

Available In:

Parameters

See playSilence for the parameter list.

Returns

Promise<PlayAction> - Promise object that will be fulfilled with a Relay.Calling.PlayAction object.

Examples

Play silence for 60 seconds, if Agent is available, stop the play.

// within an async function ..
const playAction = await await call.playSilenceAsync(60)

if (Agent.available()) {
  await playAction.stop()
}

playTTS

This is a helper function that refines the use of play. This simplifies playing TTS.

Available In:

Parameters

params	object	required	Object with the following properties:
text	string	required	TTS to play.
language	string	optional	Default to en-US.
gender	string	optional	male or female. Default to female.
volume	number	optional	Volume value between -40dB and +40dB where 0 is unchanged. Default is 0.

Returns

Promise<PlayResult> - Promise object that will be fulfilled with a Relay.Calling.PlayResult object.

Examples

Play TTS.

// within an async function ..
const playResult = await call.playTTS({ text: 'Welcome to SignalWire!', gender: 'male' })

playTTSAsync

Asynchronous version of playTTS. It does not wait the playing to completes but returns a Relay.Calling.PlayAction you can interact with.

Available In:

Parameters

See playTTS for the parameter list.

Returns

Promise<PlayAction> - Promise object that will be fulfilled with a Relay.Calling.PlayAction object.

Examples

Play TTS and stop it after 5 seconds.

// within an async function ..
const playAction = await call.playTTSAsync({ text: 'Welcome to SignalWire!', gender: 'male' })

setTimeout(async () => {
  await playAction.stop()
}, 5000)

prompt

Play one or multiple media while collecting user's input from the call at the same time, such as digits and speech.
It waits until the collection succeed or timeout is reached.
The prompt method is a generic method, see promptAudio, promptTTS or promptRingtone for more specific usage.

Available In:

Parameters

params	object	required	Object with the following properties:
type	string	required	digits, speech or both.
media	array	required	List of media elements to play. See play parameters for the object structure.
initial_timeout	number	optional	Initial timeout in seconds. Default to 4 seconds.
volume	number	optional	Volume value between -40dB and +40dB where 0 is unchanged. Default is 0.

• To collect digits:

• To collect speech:

Returns

Promise<PromptResult> - Promise object that will be fulfilled with a Relay.Calling.PromptResult object.

Examples

Ask user to enter their PIN and collect the digits.

async function main() {
  const params = {
    type: 'digits',
    digits_max: 4,
    digits_terminators: '#',
    media: [
      { type: 'tts', text: 'Welcome at SignalWire. Please, enter your PIN and then # to proceed' }
    ]
  }
  const promptResult = await call.prompt(params)

  if (promptResult.successful) {
    const type = promptResult.type // digit
    const pin = promptResult.result // pin entered by the user
  }
}

main().catch(console.error)

promptAsync

Asynchronous version of prompt. It does not wait the collection to completes but returns a Relay.Calling.PromptAction you can interact with.

Available In:

Parameters

See prompt for the parameter list.

Returns

Promise<PromptAction> - Promise object that will be fulfilled with a Relay.Calling.PromptAction object.

Examples

Ask user to enter their PIN and collect the digits.

async function main() {
  const params = {
    type: 'digits',
    digits_max: 4,
    digits_terminators: '#',
    media: [
      { type: 'tts', text: 'Welcome at SignalWire. Please, enter your PIN and then # to proceed' },
      { type: 'audio', url: 'https://cdn.signalwire.com/default-music/welcome.mp3' }
    ]
  }
  const promptAction = await call.promptAsync(params)
  // .. do other important things while collecting user digits..

  if (promptAction.completed) {
    const result = promptAction.result // => PromptResult object
  }
}

main().catch(console.error)

promptAudio

This is a helper function that refines the use of prompt.
This function simplifies playing an audio file while collecting user's input from the call, such as digits and speech.

Available In:

Parameters

You can set all the properties that prompt accepts replacing media with:

The SDK will build the media for you.

Returns

Promise<PromptResult> - Promise object that will be fulfilled with a Relay.Calling.PromptResult object.

Examples

Collect user's digits while playing an Mp3 file.

async function main() {
  const params = {
    type: 'digits',
    digits_max: 4,
    url: 'https://cdn.signalwire.com/default-music/welcome.mp3'
  }
  const promptResult = await call.promptAudio(params)

  if (promptResult.successful) {
    const type = promptResult.type // digit
    const digits = promptResult.result // digits entered by the user
  }
}

main().catch(console.error)

promptAudioAsync

Asynchronous version of promptAudio. It does not wait the collection to completes but returns a Relay.Calling.PromptAction you can interact with.

Available In:

Parameters

See promptAudio for the parameter list.

Returns

Promise<PromptAction> - Promise object that will be fulfilled with a Relay.Calling.PromptAction object.

Examples

Ask user to enter their PIN and collect the digits.

async function main() {
  const params = {
    type: 'digits',
    digits_max: 4,
    url: 'https://cdn.signalwire.com/default-music/welcome.mp3'
  }
  const promptAction = await call.promptAudioAsync(params)
  // .. do other important things while collecting user digits..

  if (promptAction.completed) {
    const result = promptAction.result // => PromptResult object
  }
}

main().catch(console.error)

promptRingtone

This is a helper function that refines the use of prompt.
This function simplifies playing TTS while collecting user's input from the call, such as digits and speech.

Available In:

Parameters

You can set all the properties that prompt accepts replacing media with:

The SDK will build the media for you.

Returns

Promise<PromptResult> - Promise object that will be fulfilled with a Relay.Calling.PromptResult object.

Examples

Play US ringtone for 30 seconds while collect digits.

async function main() {
  const params = {
    type: 'digits',
    digits_max: 3,
    name: 'us',
    duration: 30
  }
  const promptResult = await call.promptRingtone(params)
  if (promptResult.successful) {
    const type = promptResult.type // digit
    const pin = promptResult.result // pin entered by the user
  }
}

main().catch(console.error)

promptRingtoneAsync

Asynchronous version of promptRingtone. It does not wait the collection to completes but returns a Relay.Calling.PromptAction you can interact with.

Available In:

Parameters

See promptRingtone for the parameter list.

Returns

Promise<PromptAction> - Promise object that will be fulfilled with a Relay.Calling.PromptAction object.

Examples

Play US ringtone for 30 seconds while collect digits in asynchronous.

async function main() {
  const params = {
    type: 'digits',
    digits_max: 3,
    name: 'us',
    duration: 30
  }
  const promptAction = await call.promptRingtoneAsync(params)
  // .. do other important things while collecting user digits..

  if (promptAction.completed) {
    const result = promptAction.result // => PromptResult object
  }
}

main().catch(console.error)

promptTTS

This is a helper function that refines the use of prompt.
This function simplifies playing TTS while collecting user's input from the call, such as digits and speech.

Available In:

Parameters

You can set all the properties that prompt accepts replacing media with:

The SDK will build the media for you.

Returns

Promise<PromptResult> - Promise object that will be fulfilled with a Relay.Calling.PromptResult object.

Examples

Ask user to enter their PIN and collect the digits.

async function main() {
  const params = {
    type: 'digits',
    digits_max: 3,
    text: 'Please, enter your 3 digit PIN',
    gender: 'male'
  }
  const promptResult = await call.promptTTS(params)
  if (promptResult.successful) {
    const type = promptResult.type // digit
    const pin = promptResult.result // pin entered by the user
  }
}

main().catch(console.error)

promptTTSAsync

Asynchronous version of promptTTS. It does not wait the collection to completes but returns a Relay.Calling.PromptAction you can interact with.

Available In:

Parameters

See promptTTS for the parameter list.

Returns

Promise<PromptAction> - Promise object that will be fulfilled with a Relay.Calling.PromptAction object.

Examples

Ask user to enter their PIN and collect the digits.

async function main() {
  const params = {
    type: 'digits',
    digits_max: 3,
    text: 'Please, enter your 3 digit PIN',
    gender: 'male'
  }
  const promptAction = await call.promptTTSAsync(params)
  // .. do other important things while collecting user digits..

  if (promptAction.completed) {
    const result = promptAction.result // => PromptResult object
  }
}

main().catch(console.error)

record

Start recording the call and waits until the recording ends or fails.

Available In:

Parameters

Returns

Promise<RecordResult> - Promise object that will be fulfilled with a Relay.Calling.RecordResult object.

Examples

Start recording audio in the call for both direction in stereo mode, if successful, grab url, duration and size from the RecordResult object.

async function main() {
  const params = {
    stereo: true,
    direction: 'both'
  }
  const recordResult = await call.record(params)

  if (recordResult.successful) {
    const { url, duration, size } = recordResult
  }
}

main().catch(console.error)

recordAsync

Asynchronous version of record. It does not wait the end of recording but returns a Relay.Calling.RecordAction you can interact with.

Available In:

Parameters

See record for the parameter list.

Returns

Promise<RecordAction> - Promise object that will be fulfilled with a Relay.Calling.RecordAction object.

Examples

Start recording audio in the call for both direction in stereo mode and stop it after 5 seconds.

async function main() {
  const params = {
    stereo: true,
    direction: 'both'
  }
  const recordAction = await call.recordAsync(params)

  setTimeout(async () => {
    await recordAction.stop()
  }, 5000)
}

main().catch(console.error)

refer

Transfer a SIP call to an external SIP endpoint.

Available In:

Parameters

Returns

Promise<ReferResult> - Promise object that will be fulfilled with a Relay.Calling.ReferResult object.

Examples

Transfer the call to another SIP endpoint.

async function main() {
  const params = {
    to: 'sip:user@sip.example.com',
  }
  const referResult = await call.refer(params)

  if (referResult.successful) {
    const { referTo, referNotifyCode, referResponseCode } = referResult
  }
}

main().catch(console.error)

referAsync

Asynchronous version of refer. It does not wait the end of the REFER but returns a Relay.Calling.ReferAction you can interact with.

Available In:

Parameters

See refer for the parameter list.

Returns

Promise<ReferAction> - Promise object that will be fulfilled with a Relay.Calling.ReferAction object.

Examples

Async transfer the call to another SIP endpoint.

async function main() {
  const params = {
    to: 'sip:user@sip.example.com',
  }

  call.on('refer.success', (params) => {
    // listen for the success event
    console.log('Refer success', params)
  })

  const referAction = await call.referAsync(params)
}

main().catch(console.error)

sendDigits

This method sends DTMF digits to the other party on the call.

Available In:

Parameters

Returns

Promise<SendDigitsResult> - Promise object that will be fulfilled with a Relay.Calling.SendDigitsResult object.

Examples

Send some digits.

async function main() {
  const result = await call.sendDigits('123')
}

main().catch(console.error)

sendDigitsAsync

Asynchronous version of sendDigits. It does not wait for the sending event to complete, and immediately returns a Relay.Calling.SendDigitsAction object you can interact with.

Available In:

Parameters

See sendDigits for the parameter list.

Returns

Promise<SendDigitsAction> - Promise object that will be fulfilled with a Relay.Calling.SendDigitsAction

Examples

Send some digits and then check if the operation is completed using the SendDigitsAction object.

async function main() {
  const action = await call.sendDigitsAsync('123')

  setTimeout(() => {
    if (action.completed) {
      // ...
    }
  }, 1000)
}

main().catch(console.error)

tap

Intercept call media and stream it to the specify endpoint. It waits until the end of the call.

Available In:

Parameters

• To tap through RTP:

Returns

Promise<TapResult> - Promise object that will be fulfilled with a Relay.Calling.TapResult object.

Examples

Tapping audio from the call, if successful, print both source and destination devices from the TapResult object.

// within an async function ..
const params = {
  audio_direction: 'both',
  target_type: 'rtp',
  target_addr: '192.168.1.1',
  target_port: 1234
}
const tapResult = await call.tap(params)
if (tapResult.successful) {
  const { sourceDevice, destinationDevice } = tapResult
  console.log(sourceDevice)
  console.log(destinationDevice)
}

tapAsync

Asynchronous version of tap. It does not wait the end of tapping but returns a Relay.Calling.TapAction you can interact with.

Available In:

Parameters

See tap for the parameter list.

Returns

Promise<TapAction> - Promise object that will be fulfilled with a Relay.Calling.TapAction object.

Examples

Tapping audio from the call and then stop it using the TapAction object.

// within an async function ..
const params = {
  audio_direction: 'both',
  target_type: 'rtp',
  target_addr: '192.168.1.1',
  target_port: 1234
}
const tapAction = await call.tapAsync(params)
// Do other things while tapping the media and then stop it..
setTimeout(async () => {
  await tapAction.stop()
}, 5000)

waitFor

Wait for specific events on the Call or returns false if the Call ends without getting them.

Available In:

Parameters

Returns

Promise<boolean> - Promise resolved with true or false.

Examples

Wait for ending or ended events.

// within an async function ..
const success = await call.waitFor('ending', 'ended')
if (success) {
  // ...
}

waitForAnswered

This is a helper function that refines the use of waitFor. This simplifies waiting for the answered state.

Available In:

Parameters

None

Returns

Promise<boolean> - Promise resolved with true or false.

Examples

Wait for the answered event.

// within an async function ..
const success = await call.waitForAnswered()
if (success) {
  // ...
}

waitForEnded

This is a helper function that refines the use of waitFor. This simplifies waiting for the ended state.

Available In:

Parameters

None

Returns

Promise<boolean> - Promise resolved with true or false.

Examples

Wait for the ended event.

// within an async function ..
const success = await call.waitForEnded()
if (success) {
  // ...
}

waitForEnding

This is a helper function that refines the use of waitFor. This simplifies waiting for the ending state.

Available In:

Parameters

None

Returns

Promise<boolean> - Promise resolved with true or false.

Examples

Wait for the ending event.

// within an async function ..
const success = await call.waitForEnding()
if (success) {
  // ...
}

waitForRinging

This is a helper function that refines the use of waitFor. This simplifies waiting for the ringing state.

Available In:

Parameters

None

Returns

Promise<boolean> - Promise resolved with true or false.

Examples

Wait for ending or ended events.

// within an async function ..
const success = await call.waitForRinging()
if (success) {
  // ...
}

Events

All these events can be used to track the calls lifecycle and instruct SignalWire on what to do for each different state.

State Events

To track the state of a call.

Connect Events

To track the connect state of a call.

Play Events

To track a playback state.

Record Events

To track a recording state.

Refer Events

To track a REFER state.

Prompt Events

To track a prompt state.

Fax Events

To track a fax state.

Detect Events

To track a detector state.

Tap Events

To track a tapping state.

Digits Events

To track a send digits action state.

Ringtones

Here you can find all the accepted values for the ringtone to play, based on short country codes:

Relay.Calling.ConnectAction

This object returned from connectAsync method that represents a connecting attempt that is currently active on a call.

Properties

Relay.Calling.ConnectResult

This object returned from connect method that represents the final result of a connection between your call and a remote one.

Properties

Relay.Calling.DetectAction

This object returned from one of the asynchronous detect methods that represents a running detector on the call.

Properties

Methods

stop

Stop the action immediately.

Available In:

Parameters

None

Returns

Promise<StopResult> - Promise object that will be fulfilled with a Relay.Calling.StopResult object.

Examples

Trying to detect a machine and stop the action after 5 seconds.

async function main() {
  const detectAction = await call.detectMachineAsync()

  // For demonstration purposes only..
  setTimeout(async () => {
    const stopResult = await detectAction.stop()
  }, 5000)
}

main().catch(console.error)

Relay.Calling.DetectResult

This object returned from one of the synchronous detect methods that represents the final result of a detector.

Properties

Relay.Calling.DialResult

This object returned from dial method.

Properties

Relay.Calling.FaxAction

This object returned from faxReceiveAsync and faxSendAsync methods represents a receiving or sending Fax on the call.

Properties

Methods

stop

Stop the action immediately.

Available In:

Parameters

None

Returns

Promise<StopResult> - Promise object that will be fulfilled with a Relay.Calling.StopResult object.

Examples

Start sending fax and stop it after 5 seconds.

async function main() {
  const faxAction = await call.faxSendAsync('https://www.w3.org/WAI/ER/tests/xhtml/testfiles/resources/pdf/dummy.pdf')

  // For demonstration purposes only..
  setTimeout(async () => {
    const stopResult = await faxAction.stop()
  }, 5000)
}

main().catch(console.error)

Relay.Calling.FaxResult

This object returned from faxReceive and faxSend methods that represents the final result of a sent or received Fax.

Properties

Relay.Calling.HangupResult

This object returned from hangup method.

Properties

Relay.Calling.PlayAction

This object returned from one of asynchronous play methods that represents a playing currently active on a call.

Properties

Methods

pause

Pause the playback immediately.

Available In:

Parameters

None

Returns

Promise<PlayPauseResult> - Promise object that will be fulfilled with a Relay.Calling.PlayPauseResult object.

Examples

Start playing an audio file and pause it after 5 seconds.

// Promise to wait some seconds..
const sleep = (seconds) => new Promise(resolve => setTimeout(resolve, seconds*1000))

async function main() {
  const playAction = await call.playAudioAsync('https://cdn.signalwire.com/default-music/welcome.mp3')
  await sleep(5)
  const pauseResult = await playAction.pause()
}

main().catch(console.error)

resume

Resume the playback immediately.

Available In:

Parameters

None

Returns

Promise<PlayResumeResult> - Promise object that will be fulfilled with a Relay.Calling.PlayResumeResult object.

Examples

Start playing an audio file, stop it and then resume it after 5 seconds.

// Promise to wait some seconds..
const sleep = (seconds) => new Promise(resolve => setTimeout(resolve, seconds*1000))

async function main() {
  const playAction = await call.playAudioAsync('https://cdn.signalwire.com/default-music/welcome.mp3')
  await sleep(5)
  const pauseResult = await playAction.pause()
  await sleep(5)
  const resumeResult = await playAction.resume()
}

main().catch(console.error)