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
{
  "id": "0823a606-0aff-4c90-9eba-f88ba118fe05",
  "project_id": "bc949800-7b40-43cf-8438-a85facfcbdd1",
  "display_name": "My SIP Gateway",
  "type": "sip_gateway",
  "created_at": "2024-05-06T12:20:00Z",
  "updated_at": "2024-05-06T12:20:00Z",
  "sip_gateway": {
    "id": "cce59cad-104d-4c28-ada4-98cfd102ae09",
    "uri": "user3@domain.com",
    "name": "My SIP Gateway",
    "ciphers": [
      "AEAD_AES_256_GCM_8"
    ],
    "codecs": [
      "OPUS"
    ],
    "encryption": "required"
  }
}

Example

from signalwire.rest import RestClient
client = RestClient(
    project="your-project-id",
    token="your-api-token",
    host="your-space.signalwire.com",
)
updated = client.fabric.sip_gateways.update("gateway-id", name="updated-name")
print(f"Updated: {updated['display_name']}")