Skip to navigation
Resource ManagementSIP Credentials

Create SIP credential

View as MarkdownOpen in Claude

Creates a project-scoped SIP Credential for a SIP device to register with SignalWire. Use it for a shared or independently managed device; use Create Subscriber SIP credential when the credential belongs to a specific Subscriber. To attach an already-existing resource as the credential’s outbound call handler, use Assign Resource to SIP credential instead.

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)

Request

This endpoint expects an object.
usernamestringRequired
The username of the Sip Endpoint
passwordstringRequired
The password the SIP device uses to register with this Sip Endpoint.
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.
encryptionenumOptionalDefaults to default
The set encryption type on the Sip Endpoint.
Allowed values:
call_handlerenumOptionalDefaults to default

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_idstringOptionalformat: "uuid"

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

Response

The request has succeeded and a new resource has been created as a result.
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