RelayError | SignalWire

Custom error class for RELAY protocol errors. Extends JavaScript’s built-in Error class. The name property is always "RelayError".

1 import { RelayError } from '@signalwire/sdk';

Properties

code

numberDefaults to 0

Numeric error code returned by the RELAY server.

message

string

Human-readable error description returned by the RELAY server.

name

string

Always "RelayError".

Examples

Catch a RELAY error

1 import { RelayClient, RelayError } 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   try {
11     await call.connect(
12       [[{ type: 'phone', params: { to_number: '+15559876543' } }]],
13     );
14   } catch (e) {
15     if (e instanceof RelayError) {
16       console.log(`Error ${e.code}: ${e.message}`);
17     }
18     await call.hangup();
19   }
20 });
21 
22 await client.run();