Create SIP Endpoint | SignalWire

Creates a SIP Endpoint

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)

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.

Specify how the SIP endpoint will handle outbound calls. - **default**: The SIP endpoint will pull the outbound policy setting from the [SIP Profile Settings](https://my.signalwire.com?page=sip_profile/edit). 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.

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

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.

1	curl -X POST https://{your_space_name}.signalwire.com/api/fabric/resources/sip_endpoints \
2	-H "Content-Type: application/json" \
3	-u "<project_id>:<api_token>" \
4	-d '{
5	"id": "993ed018-9e79-4e50-b97b-984bd5534095",
6	"username": "User",
7	"caller_id": "123456789",
8	"send_as": "Support",
9	"ciphers": [
10	"AEAD_AES_256_GCM_8",
11	"AES_256_CM_HMAC_SHA1_32"
12	],
13	"codecs": [
14	"G722",
15	"PCMA",
16	"PCMU",
17	"VP8"
18	],
19	"encryption": "default",
20	"call_handler": "default",
21	"calling_handler_resource_id": "993ed018-9e79-4e50-b97b-984bd5534095"
22	}'

1	{
2	"id": "993ed018-9e79-4e50-b97b-984bd5534095",
3	"project_id": "1313fe58-5e14-4c11-bbe7-6fdfa11fe780",
4	"display_name": "Conference Room Phone",
5	"type": "sip_endpoint",
6	"created_at": "2024-05-06T12:20:00Z",
7	"updated_at": "2024-05-06T12:20:00Z",
8	"sip_endpoint": {
9	"id": "993ed018-9e79-4e50-b97b-984bd5534095",
10	"username": "User",
11	"caller_id": "123456789",
12	"send_as": "Support",
13	"ciphers": [
14	"AEAD_AES_256_GCM_8",
15	"AES_256_CM_HMAC_SHA1_32"
16	],
17	"codecs": [
18	"G722",
19	"PCMA",
20	"PCMU",
21	"VP8"
22	],
23	"encryption": "default",
24	"call_handler": "default",
25	"calling_handler_resource_id": "993ed018-9e79-4e50-b97b-984bd5534095"
26	}
27	}