Resource ManagementSIP Credentials

Create SIP credential

View as MarkdownOpen in Claude
Creates a 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](/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) ```

Request

This endpoint expects an object.
idstringRequiredformat: "uuid"
The id of the Sip Endpoint
usernamestringRequired
The username of the Sip Endpoint
caller_idstringRequired
The caller ID that will showup when dialing from this Sip Endpoint
send_asstringRequired
The Sip username that will show up on the calle's side. Overrides the username.
cipherslist of enumsRequired
Ciphers that can be enabled for calls on this Sip Endpoint.
Allowed values:
codecslist of enumsRequired
Codecs that can be enabled for calls on this Sip Endpoint.
encryptionenumRequired
The set encryption type on the Sip Endpoint.
Allowed values:
call_handlerenumRequired

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

If call_handler is set to resource, this field expects the id of the set resouce. Will be null otherwise.

Response

The request has succeeded.
typestring
A string representation of the type of object this record is.
idstringformat: "uuid"
The unique identifier of the SIP endpoint.
usernamestring
The username for the SIP endpoint.
caller_idstring or null
Friendly Caller ID used as the CNAM when dialing a phone number or the From when dialing another SIP Endpoint.
send_asstring

When dialing a PSTN phone number, you must send it From a number you have purchased or verified. send_as indicates which number this endpoint has set as its origination. random indicates it will randomly choose a purchased or verified number from within the project.

cipherslist of strings
A list of encryption ciphers this endpoint will support.
codecslist of strings
A list of codecs this endpoint will support.
encryptionenum
Whether connections to this endpoint require encryption or if encryption is optional.
Allowed values:
call_handlerenum or null
What type of handler you want to run on inbound calls.
calling_handler_resource_idstring or nullformat: "uuid"
The unique identifier of the calling handler resource.
call_request_urlstring or null

A string representing the LaML URL to access when a call is received. This is only used (and required) when call_handler is set to laml_webhooks.

call_request_methodenum or null

A string representing the HTTP method to use with call_request_url. Valid values are GET and POST.

Allowed values:
call_fallback_urlstring or null

A string representing the LaML URL to access when the call to call_request_url fails. This is only used (and required) when call_handler is set to laml_webhooks.

call_fallback_methodenum or null

A string representing the HTTP method to use with call_fallback_url. Valid values are GET and POST.

Allowed values:
call_status_callback_urlstring or null

A string representing a URL to send status change messages to. This is only used (and required) when call_handler is set to laml_webhooks.

call_status_callback_methodenum or null

A string representing the HTTP method to use with call_status_callback_url. Valid values are GET and POST.

Allowed values:
call_laml_application_idstring or null

A string representing the ID of the LaML application to forward incoming calls to. This is only used (and required) when call_handler is set to laml_application.

call_dialogflow_agent_idstring or null

A string representing the ID of the Dialogflow agent to forward incoming calls to. This is only used (and required) when call_handler is set to dialogflow.

call_relay_topicstring or null

A string representing the Relay topic to forward incoming calls to. This is only used (and required) when call_handler is set to relay_topic.

call_relay_topic_status_callback_urlstring or null

A string representing a URL to send status change messages to. This is only used (and required) when call_handler is set to relay_topic.

call_relay_contextstring or null

A string representing the Relay context to forward incoming calls to. This is only used (and required) when call_handler is set to relay_context.

call_relay_context_status_callback_urlstring or null

A string representing a URL to send status change messages to. This is only used (and required) when call_handler is set to relay_context.

call_relay_applicationstring or null

A string representing the Relay application to forward incoming calls to. This is only used (and required) when call_handler is set to relay_application.

call_video_room_idstring or nullformat: "uuid"

A string representing the ID of the Video Room to forward incoming calls to. This is only used (and required) when call_handler is set to video_room.

call_relay_script_urlstring or null

A string representing a URL of a SWML script to respond to incoming calls. This is only used (and required) when call_handler is set to relay_script.

Errors

401
Unauthorized Error
404
Not Found Error
422
Unprocessable Entity Error
500
Internal Server Error