SIP Addresses

Update SIP address

Changed on

Partially updates a standalone SIP Address by ID; omitted fields retain their current values. Use it to change the URI name, Domain, registration password, media, encryption, or IP-authentication settings. calling_handler_resource_id cannot be changed through this operation. SIP Credentials and generic resource addresses have separate management endpoints.

Permissions

The API token used to authenticate must have the following scope(s) enabled to make a successful request: Calling, Fax, Messaging, or Video.

Learn more about API scopes.

patch/api/fabric/sip_addresses/{id}

Request

  • Base URL
    https://{Your_Space_Name}.signalwire.com
  • URL
    https://{Your_Space_Name}.signalwire.com/api/fabric/sip_addresses/{id}
  • Auth
    HTTP basic

Path parameters

idstring uuid required

Universal Unique Identifier.

Unique ID of a SIP Address.

Request body

namestring

URL-safe name for the SIP address — lowercase letters, numbers, and hyphens only (no spaces or other special characters). Must be unique within the project. Defaults to the current value when omitted.

userstring

SIP username used to reach this address (no spaces). Together with the address's Domain, must be unique across your SignalWire account.

context_idstring uuid

Universal Unique Identifier.

ip_auth_enabledboolean

Whether to enforce IP authentication for this address.

ip_authstring[]

Whitelisted IP/CIDR entries. Required (at least one) when ip_auth_enabled is true. Maximum 256 entries.

codecsAddressCodec[]

Non-empty subset of enabled codecs.

ciphersCiphers[]

Non-empty subset of enabled SRTP ciphers.

encryption'required' | 'optional' | 'forbidden'
passwordstring

Write-only SIP registration password. Never returned in any response.

Example request

{
  "name": "renamed-line",
  "user": "agent",
  "ip_auth_enabled": true,
  "ip_auth": [
    "10.0.0.0/24"
  ],
  "codecs": [
    "OPUS"
  ],
  "ciphers": [
    "AES_256_CM_HMAC_SHA1_80"
  ],
  "password": "sup3r-s3cret"
}

Response

The request has succeeded.

idstring uuid required

Universal Unique Identifier.

type'sip' required

The object type. Always sip.

resource_idstring uuid required

Universal Unique Identifier.

namestring required

URL-safe name for the SIP address. Used to build its SIP URI.

display_namestring required

Human-friendly label for the SIP address. Defaults to name.

contextstring required

The Domain this address is grouped under — for example, public for your project's default Domain.

uristring required

Full SIP URI for this address.

userstring required

SIP username used to reach this address. * accepts any username.

encryption'required' | 'optional' | 'forbidden' required
codecsAddressCodec[] required

Enabled codecs for calls to this address.

ciphersCiphers[] required

Enabled SRTP ciphers for calls to this address.

ip_auth_enabledboolean required

Whether IP authentication is enforced for this address.

ip_authstring[] required

Whitelisted IP/CIDR entries used when ip_auth_enabled is true.

calling_handler_resource_idstring uuid required

Universal Unique Identifier.

created_atstring date-time required

Date and time when the SIP address was created.

updated_atstring date-time required

Date and time when the SIP address was last updated.

Example response

{
  "type": "sip",
  "name": "support-line",
  "display_name": "support-line",
  "context": "public",
  "uri": "sip:my-space-support-line@sip.signalwire.com",
  "user": "*",
  "codecs": [
    "PCMU",
    "PCMA"
  ],
  "ciphers": [
    "AEAD_AES_256_GCM_8",
    "AES_256_CM_HMAC_SHA1_80",
    "AES_CM_128_HMAC_SHA1_80",
    "AES_256_CM_HMAC_SHA1_32",
    "AES_CM_128_HMAC_SHA1_32"
  ],
  "ip_auth": [],
  "created_at": "2024-05-06T12:20:00Z",
  "updated_at": "2024-05-06T12:20:00Z"
}

Changes

  • f0464a93a362Revision changes
    • warning

      added the new sip enum value to the response property for the response status

    • info

      removed the sip_address enum value from the response property for the response status

  • 5f33aa5a5865Revision changes
    • info

      endpoint added

Some revisions have not been checked yet.