Update SIP gateway

PATCH

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

PATCH

/api/fabric/resources/sip_gateways/:id

curl -X PATCH https://{your_space_name}.signalwire.com/api/fabric/resources/sip_gateways/id \
     -H "Content-Type: application/json" \
     -u "<project_id>:<api_token>" \
     -d '{
  "name": "My SIP Gateway",
  "uri": "sip:user2@domain.com",
  "encryption": "required",
  "ciphers": [
    "AEAD_AES_256_GCM_8",
    "AES_256_CM_HMAC_SHA1_80"
  ],
  "codecs": [
    "OPUS"
  ]
}'

{
  "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"
  }
}

Changes the destination or supported media settings of a SIP Gateway identified by resource ID. Use it when outbound SIP routing changes; update a registering device through Update SIP credential instead.

This is not a partial update: send every field, including the ones you aren’t changing. A field you leave out isn’t kept from the current gateway, and the request fails validation.

Permissions

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

Learn more about API scopes.

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)

Path parameters

idstringRequiredformat: "uuid"

Unique ID of a SIP Gateway.

Request

This endpoint expects an object.

namestringRequired

Display name for the SIP Gateway.

uristringRequired

External SIP URI, including the sip: or sips: scheme. Must be unique within the project. SignalWire dials the URI exactly as configured, with one exception: when a call to one of your phone numbers routes to this gateway and the URI has no user part, SignalWire adds the dialed number, without the leading +, as the user part.

encryptionenumRequired

Specifies the encryption requirement for the SIP connection.

Allowed values:

cipherslist of enumsRequired

List of supported SIP ciphers.

Allowed values:

codecslist of enumsRequired

List of supported codecs for media transmission.

Response

The request has succeeded.

idstringformat: "uuid"

Unique ID of the resource.

project_idstringformat: "uuid"

Project ID associated with the resource.

display_namestring

Display name of the SIP Gateway.

typeenum

Type of the resource.

Allowed values:

created_atdatetime

Timestamp when the resource was created.

updated_atdatetime

Timestamp when the resource was last updated.

sip_gatewayobject

SIP Gateway configuration details.

Errors

422

Unprocessable Entity Error

500

Internal Server Error