execute | SignalWire

Send a raw JSON-RPC 2.0 request to the RELAY server and return the parsed response. This is the low-level RPC method that all other client and call control methods are built on.

If the client is not currently connected (e.g., during a reconnect cycle), the request is automatically queued and sent after re-authentication completes.

This method has a default timeout of 30 seconds. If no response is received within that window, it throws RelayError and forces a reconnection attempt, as the timeout may indicate a half-open WebSocket connection.

Most developers should use the higher-level methods like dial(), sendMessage(), and the Call control methods instead of calling execute() directly. Use execute() only for custom or unsupported RPC methods.

Parameters

method

stringRequired

Full JSON-RPC method name (e.g., "calling.answer", "calling.play", "messaging.send"). The method name must include the namespace prefix.

params

Record<string, unknown>Required

Parameters for the RPC call. Typically includes node_id and call_id for calling methods, along with method-specific parameters.

Returns

Promise<Record<string, unknown>> — The result object from the JSON-RPC response. Structure depends on the method called.

Example

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   // Send a custom RPC request using the call's identifiers
11   const result = await client.execute('calling.answer', {
12     node_id: call.nodeId,
13     call_id: call.callId,
14   });
15   console.log(`Answer result: ${JSON.stringify(result)}`);
16 });
17 
18 await client.run();