setRelayTopic | SignalWire

Route inbound calls on this phone number to a RELAY topic. RELAY clients subscribed to the topic will receive the inbound call event.

This is a typed wrapper over update that sets call_handler to relay_topic and populates call_relay_topic for you.

Parameters

resourceId

stringRequired

ID of the phone number to bind.

params

SetRelayTopicParamsRequired

Topic name and options.

params.topic

stringRequired

RELAY topic name. Serialized as call_relay_topic.

params.statusCallbackUrl

string

URL that receives status updates for calls routed via this topic. Serialized as call_relay_topic_status_callback_url.

Returns

Promise<any> — The updated phone-number resource.

Example

1 import { RestClient } from "@signalwire/sdk";
2 
3 const client = new RestClient({
4   project: "your-project-id",
5   token: "your-api-token",
6   host: "your-space.signalwire.com"
7 });
8 
9 await client.phoneNumbers.setRelayTopic("phone-number-id", {
10   topic: "office",
11   statusCallbackUrl: "https://example.com/status",
12 });