create_sip_endpoint | SignalWire

Create a new SIP endpoint for a subscriber.

Path parameters

fabric_subscriber_idstringRequiredformat: "uuid"

Unique ID of a Fabric Subscriber.

Request

usernamestringRequired

Username of the Sip Endpoint.

passwordstringRequired

Password of the Sip Endpoint.

caller_idstringOptional

Caller ID of the Sip Endpoint.

send_asstringOptional

The Number to send as.

cipherslist of enumsOptional

Ciphers of the Sip Endpoint.

codecslist of enumsOptional

Codecs of the Sip Endpoint.

encryptionenumOptionalDefaults to default

Encryption requirement of the Sip Endpoint.

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 from signalwire.rest import RestClient
2 
3 client = RestClient(
4     project="your-project-id",
5     token="your-api-token",
6     host="your-space.signalwire.com",
7 )
8 
9 result = client.fabric.subscribers.create_sip_endpoint(
10     "subscriber-id", username="alice-sip", password="s3cret",
11 )
12 print(f"Created SIP endpoint: {result['id']}")