REST ClientFabricSIP Gateways

update

View as MarkdownOpen in Claude

Partially update a SIP gateway resource. Uses PATCH for partial.

Path parameters

idstringRequiredformat: "uuid"
Unique ID of a SIP Gateway.

Request

namestringOptional
Display name for the SIP Gateway.
uristringOptional
External SIP URI.
encryptionenumOptional
Specifies the encryption requirement for the SIP connection.
Allowed values:
cipherslist of enumsOptional
List of supported SIP ciphers.
Allowed values:
codecslist of enumsOptional
List of supported codecs for media transmission.

Response

idstringRequiredformat: "uuid"
Unique ID of the resource.
project_idstringRequiredformat: "uuid"
Project ID associated with the resource.
display_namestringRequired
Display name of the SIP Gateway.
typeenumRequired
Type of the resource.
Allowed values:
created_atdatetimeRequired
Timestamp when the resource was created.
updated_atdatetimeRequired
Timestamp when the resource was last updated.
sip_gatewayobjectRequired
SIP Gateway configuration details.

Response Example

Response
1{
2  "id": "0823a606-0aff-4c90-9eba-f88ba118fe05",
3  "project_id": "bc949800-7b40-43cf-8438-a85facfcbdd1",
4  "display_name": "My SIP Gateway",
5  "type": "sip_gateway",
6  "created_at": "2024-05-06T12:20:00Z",
7  "updated_at": "2024-05-06T12:20:00Z",
8  "sip_gateway": {
9    "id": "cce59cad-104d-4c28-ada4-98cfd102ae09",
10    "uri": "user3@domain.com",
11    "name": "My SIP Gateway",
12    "ciphers": [
13      "AEAD_AES_256_GCM_8"
14    ],
15    "codecs": [
16      "OPUS"
17    ],
18    "encryption": "required"
19  }
20}

Example

1from signalwire.rest import RestClient
2
3client = RestClient(
4    project="your-project-id",
5    token="your-api-token",
6    host="your-space.signalwire.com",
7)
8
9updated = client.fabric.sip_gateways.update("gateway-id", name="updated-name")
10print(f"Updated: {updated['display_name']}")