RELAY RESTSip Endpoints

Create a SIP Endpoint

View as Markdown

Creates a new SIP endpoint.

Permissions

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

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

String representing the username portion of the endpoint. Must be unique across your project and must not contain white space characters or @.

passwordstringRequired
A password to authenticate registrations to this endpoint.
caller_idstringOptional
Friendly Caller ID used as the CNAM when dialing a phone number or the From when dialing another SIP Endpoint.
send_asstringOptional

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 stringsOptional
A list of encryption ciphers this endpoint will support.
codecslist of stringsOptional
A list of codecs this endpoint will support.
encryptionenumOptional
Specifies the encryption requirements for connections to this endpoint.
Allowed values:
call_handlerenumOptional
What type of handler you want to run on inbound calls.
call_request_urlstringOptional

The LaML URL to access when a call is received. Required when call_handler is laml_webhooks.

call_request_methodenumOptional

The HTTP method to use with call_request_url.

Allowed values:
call_fallback_urlstringOptional

The LaML URL to access when the call to call_request_url fails. Required when call_handler is laml_webhooks.

call_fallback_methodenumOptional

The HTTP method to use with call_fallback_url.

Allowed values:
call_status_callback_urlstringOptional

A URL to send status change messages to. Required when call_handler is laml_webhooks.

call_status_callback_methodenumOptional

The HTTP method to use with call_status_callback_url.

Allowed values:
call_laml_application_idstringOptional

The ID of the LaML application to forward incoming calls to. Required when call_handler is laml_application.

call_dialogflow_agent_idstringOptional

The ID of the Dialogflow agent to forward incoming calls to. Required when call_handler is dialogflow.

call_relay_topicstringOptional

The Relay topic to forward incoming calls to. Required when call_handler is relay_topic.

call_relay_topic_status_callback_urlstringOptional

A URL to send status change messages to. Required when call_handler is relay_topic.

call_relay_contextstringOptional

The Relay context to forward incoming calls to. Required when call_handler is relay_context.

call_relay_context_status_callback_urlstringOptional

A URL to send status change messages to. Required when call_handler is relay_context.

call_relay_applicationstringOptional

The Relay application to forward incoming calls to. Required when call_handler is relay_application.

call_video_room_idstringOptionalformat: "uuid"

The ID of the Video Room to forward incoming calls to. Required when call_handler is video_room.

call_flow_idstringOptionalformat: "uuid"

The ID of the Call Flow to forward incoming calls to. Required when call_handler is call_flow.

call_flow_versionstringOptional

The version of the Call Flow to use. Valid values are ‘working_copy’ or ‘current_deployed’.

call_ai_agent_idstringOptionalformat: "uuid"

The ID of the AI Agent to forward incoming calls to. Required when call_handler is ai_agent.

call_relay_script_urlstringOptional

A URL of a SWML script to respond to incoming calls. Required when call_handler is relay_script.

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