Skip to navigation
Resource ManagementSIP Credentials

Update SIP credential

View as MarkdownOpen in Claude

Changes how a project-scoped SIP device registers with SignalWire or handles outbound calls. Update a Subscriber-owned credential through Update Subscriber SIP credential.

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 the SIP endpoint.

Request

This endpoint expects an object.
usernamestringOptional
The username of the Sip Endpoint
passwordstringOptional
A new password for the Sip Endpoint. Omit to keep the current password.
caller_idstringOptional
The caller ID that will showup when dialing from this Sip Endpoint
send_asstringOptional
The Sip username that will show up on the calle's side. Overrides the username.
cipherslist of enumsOptional
Ciphers that can be enabled for calls on this Sip Endpoint.
Allowed values:
codecslist of enumsOptional
Codecs that can be enabled for calls on this Sip Endpoint.
encryptionenumOptional
The set encryption type on the Sip Endpoint. Omit to keep the current setting.
Allowed values:
call_handlerenumOptional

Specify how the SIP endpoint will handle outbound calls.

  • default: The SIP endpoint will pull the outbound policy setting from the SIP Profile Settings. This allows centralized management of outbound call behavior across multiple endpoints from a single configuration.
  • passthrough: The SIP endpoint will be allowed to dial PSTN numbers. This permits outbound calling to traditional phone numbers without restrictions.
  • block-pstn: The SIP endpoint will be blocked from dialing PSTN numbers. Use this to restrict the endpoint from initiating calls to the public telephone network.
  • resource: Outbound calls from this SIP endpoint will dial the specified resource and execute its instructions. Requires setting calling_handler_resource_id to a valid resource. This enables custom call handling workflows for outbound calls.
Allowed values:
calling_handler_resource_idstring or nullOptionalformat: "uuid"

The ID of the resource that handles outbound calls. Required when call_handler is resource.

Response

The request has succeeded.
idstringformat: "uuid"
Unique ID of the SIP Endpoint.
project_idstringformat: "uuid"
Unique ID of the Project.
display_namestring
Display name of the SIP Endpoint Fabric Resource
typeenum
Type of the Fabric Resource
Allowed values:
created_atdatetime
Date and time when the resource was created.
updated_atdatetime
Date and time when the resource was updated.
sip_endpointobject
SIP Endpoint data.

Errors

422
Unprocessable Entity Error
500
Internal Server Error