Update SIP address

PATCH

https://{your_space_name}.signalwire.com/api/fabric/sip_addresses/:id

PATCH

/api/fabric/sip_addresses/:id

$ curl -X PATCH https://{your_space_name}.signalwire.com/api/fabric/sip_addresses/id \
>      -H "Content-Type: application/json" \
>      -u "<project_id>:<api_token>" \
>      -d '{}'

1 {
2   "id": "b3f1c0a2-0f6e-4a9d-9b2a-1c2d3e4f5a6b",
3   "type": "sip_address",
4   "resource_id": "8a7b6c5d-4e3f-2a1b-0c9d-8e7f6a5b4c3d",
5   "name": "support-line",
6   "display_name": "support-line",
7   "context": "public",
8   "uri": "sip:my-space-support-line@sip.signalwire.com",
9   "user": "*",
10   "encryption": "optional",
11   "codecs": [
12     "PCMU",
13     "PCMA"
14   ],
15   "ciphers": [
16     "AEAD_AES_256_GCM_8",
17     "AES_256_CM_HMAC_SHA1_80",
18     "AES_CM_128_HMAC_SHA1_80",
19     "AES_256_CM_HMAC_SHA1_32",
20     "AES_CM_128_HMAC_SHA1_32"
21   ],
22   "ip_auth_enabled": false,
23   "ip_auth": [],
24   "calling_handler_resource_id": "1f2e3d4c-5b6a-7980-a1b2-c3d4e5f60718",
25   "created_at": "2024-05-06T12:20:00Z",
26   "updated_at": "2024-05-06T12:20:00Z"
27 }

Updates a SIP address by ID. Partial update: any field omitted from the body keeps its current value. calling_handler_resource_id cannot be changed via this endpoint.

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.

Updates a SIP address by ID. Partial update: any field omitted from the body keeps its current value. `calling_handler_resource_id` cannot be changed via this endpoint. #### 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](/docs/platform/your-signalwire-api-space).

Authentication

AuthorizationBasic

SignalWire Basic Authentication using Project ID and API Token.

The client sends HTTP requests with the Authorization header containing the word Basic followed by a space and a base64-encoded string of project_id:token. The project ID will be used as the username and the API token as the password.

Example:

Authorization: Basic base64(project_id:token)

SignalWire Basic Authentication using Project ID and API Token. The client sends HTTP requests with the Authorization header containing the word Basic followed by a space and a base64-encoded string of project_id:token. The project ID will be used as the username and the API token as the password. Example: ``` Authorization: Basic base64(project_id:token) ```

Path parameters

idstringRequiredformat: "uuid"

Unique ID of a SIP Address.

Request

This endpoint expects an object.

namestringOptionalformat: "^[a-z0-9]+(-[a-z0-9]+)*$"<=50 characters

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.

userstringOptionalformat: "^\S+$"

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

context_idstringOptionalformat: "uuid"

ID of the Domain this address should be grouped under. Must exist in your project. Defaults to the address's current Domain when omitted.

ip_auth_enabledbooleanOptional

Whether to enforce IP authentication for this address.

ip_authlist of stringsOptional

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

codecslist of enumsOptional

Non-empty subset of enabled codecs.

cipherslist of enumsOptional

Non-empty subset of enabled SRTP ciphers.

encryptionenumOptional

SRTP encryption requirement for calls to this address.

passwordstringOptional

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

Response

The request has succeeded.

idstringformat: "uuid"

Unique identifier for the SIP address.

typeenum

The object type. Always sip_address.

resource_idstringformat: "uuid"

ID of the resource this address belongs to.

namestring

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

display_namestring

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

contextstring

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

uristring

Full SIP URI for this address.

userstring

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

encryptionenum

SRTP encryption requirement for calls to this address.

codecslist of enums

Enabled codecs for calls to this address.

cipherslist of enums

Enabled SRTP ciphers for calls to this address.

ip_auth_enabledboolean

Whether IP authentication is enforced for this address.

ip_authlist of strings

Whitelisted IP/CIDR entries used when ip_auth_enabled is true.

calling_handler_resource_idstringformat: "uuid"

ID of the resource that handles inbound calls to this address.

created_atdatetime

Date and time when the SIP address was created.

updated_atdatetime

Date and time when the SIP address was last updated.

Errors

400

Bad Request Error

401

Unauthorized Error

404

Not Found Error

422

Unprocessable Entity Error

500

Internal Server Error