Skip to navigation
REST ClientFabricSIP Endpoints

get

View as MarkdownOpen in Claude

Retrieve a single SIP endpoint resource.

Path parameters

idstringRequiredformat: "uuid"
Unique ID of the SIP endpoint.

Response

idstringRequiredformat: "uuid"
Unique ID of the SIP Endpoint.
project_idstringRequiredformat: "uuid"
Unique ID of the Project.
display_namestringRequired
Display name of the SIP Endpoint Fabric Resource
typeenumRequired
Type of the Fabric Resource
Allowed values:
created_atdatetimeRequired
Date and time when the resource was created.
updated_atdatetimeRequired
Date and time when the resource was updated.
sip_endpointobjectRequired
SIP Endpoint data.

Response Example

Response
{
  "id": "993ed018-9e79-4e50-b97b-984bd5534095",
  "project_id": "1313fe58-5e14-4c11-bbe7-6fdfa11fe780",
  "display_name": "Conference Room Phone",
  "type": "sip_endpoint",
  "created_at": "2024-05-06T12:20:00Z",
  "updated_at": "2024-05-06T12:20:00Z",
  "sip_endpoint": {
    "id": "993ed018-9e79-4e50-b97b-984bd5534095",
    "username": "User",
    "caller_id": "123456789",
    "send_as": "Support",
    "ciphers": [
      "AEAD_AES_256_GCM_8",
      "AES_256_CM_HMAC_SHA1_32"
    ],
    "codecs": [
      "G722",
      "PCMA",
      "PCMU",
      "VP8"
    ],
    "encryption": "default",
    "call_handler": "default",
    "calling_handler_resource_id": "993ed018-9e79-4e50-b97b-984bd5534095"
  }
}

Example

import { RestClient } from "@signalwire/sdk";
const client = new RestClient({
  project: "your-project-id",
  token: "your-api-token",
  host: "your-space.signalwire.com",
});
const endpoint = await client.fabric.sipEndpoints.get("endpoint-id");
console.log(`Sip Endpoint: ${endpoint.display_name}, ID: ${endpoint.id}`);