get_sip_endpoint

View as MarkdownOpen in Claude

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.
Allowed values:
codecslist of enumsRequired
Codecs of the Sip Endpoint.
encryptionenumRequired
Encryption requirement of the Sip Endpoint.
Allowed values:

Response Example

Response
{
"id": "acaa5c49-be5e-4477-bce0-48f4b23b7720",
"username": "justice-league",
"caller_id": "call-id-123",
"send_as": "+14632322867",
"ciphers": [
"AEAD_AES_256_GCM_8"
],
"codecs": [
"PCMU"
],
"encryption": "optional"
}

Example

from signalwire.rest import RestClient
client = RestClient(
project="your-project-id",
token="your-api-token",
host="your-space.signalwire.com",
)
endpoint = client.fabric.subscribers.get_sip_endpoint("subscriber-id", "endpoint-id")
print(f"SIP Endpoint: {endpoint['username']}, ID: {endpoint['id']}")