getSipEndpoint | SignalWire

Retrieve a single SIP endpoint for a subscriber.

Path parameters

idstringRequiredformat: "uuid"

Unique ID of a Sip Endpoint.

fabric_subscriber_idstringRequiredformat: "uuid"

Unique ID of a Fabric Subscriber.

Response

idstringRequiredformat: "uuid"

Unique ID of the Sip Endpoint.

usernamestringRequired

Username of the Sip Endpoint.

caller_idstringRequired

Caller ID of the Sip Endpoint.

send_asstringRequired

Purchased or verified number

cipherslist of enumsRequired

Ciphers of the Sip Endpoint.

codecslist of enumsRequired

Codecs of the Sip Endpoint.

encryptionenumRequired

Encryption requirement of the Sip Endpoint.

Response Example

Response

1 {
2   "id": "acaa5c49-be5e-4477-bce0-48f4b23b7720",
3   "username": "justice-league",
4   "caller_id": "call-id-123",
5   "send_as": "+14632322867",
6   "ciphers": [
7     "AEAD_AES_256_GCM_8"
8   ],
9   "codecs": [
10     "PCMU"
11   ],
12   "encryption": "optional"
13 }

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 const endpoint = await client.fabric.subscribers.getSipEndpoint("subscriber-id", "endpoint-id");
10 console.log("SIP Endpoint:", endpoint.username, "ID:", endpoint.id);