diff --git a/specs/signalwire-rest/fabric-api/sip-endpoints/models/core.tsp b/specs/signalwire-rest/fabric-api/sip-endpoints/models/core.tsp index 419056952..89de24b52 100644 --- a/specs/signalwire-rest/fabric-api/sip-endpoints/models/core.tsp +++ b/specs/signalwire-rest/fabric-api/sip-endpoints/models/core.tsp @@ -5,12 +5,11 @@ import "../enums.tsp"; using TypeSpec.Http; const callHandlerDescription = """ - Specify how the SIP endpoint will handle outbound calls. - These options will control if the call is simply passed to the destination or controlled by a resource. - - **default**: The default behavior for Sip Endpoints. passes the call to the destination with no additional logic. - - **passthrough**: Passes the call to the destination with no additional logic. - - **block-pstn**: Passes the call to the destination while blocking PSTN destination. - - **resource**: Sets a resource to handle the call logic. This allows users ot inject calling logic into the call when calling a destination. + 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. See the [Fabric REST API](/rest/signalwire-rest/endpoints/fabric) for valid resource types. """; model SipEndpointPathID { diff --git a/specs/signalwire-rest/fabric-api/tsp-output/@typespec/openapi3/openapi.yaml b/specs/signalwire-rest/fabric-api/tsp-output/@typespec/openapi3/openapi.yaml index e17bb5b27..9dfe85376 100644 --- a/specs/signalwire-rest/fabric-api/tsp-output/@typespec/openapi3/openapi.yaml +++ b/specs/signalwire-rest/fabric-api/tsp-output/@typespec/openapi3/openapi.yaml @@ -7938,7 +7938,7 @@ components: type: integer format: int32 maximum: 900 - description: The duration to hold the caller in seconds. + description: The duration to hold the caller in seconds. Can be a number or an object with timeout property. default: 300 maximum: 900 description: |- @@ -10008,12 +10008,11 @@ components: allOf: - $ref: '#/components/schemas/CallHandlerType' description: |- - Specify how the SIP endpoint will handle outbound calls. - These options will control if the call is simply passed to the destination or controlled by a resource. - - **default**: The default behavior for Sip Endpoints. passes the call to the destination with no additional logic. - - **passthrough**: Passes the call to the destination with no additional logic. - - **block-pstn**: Passes the call to the destination while blocking PSTN destination. - - **resource**: Sets a resource to handle the call logic. This allows users ot inject calling logic into the call when calling a destination. + 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. See the [Fabric REST API](/rest/signalwire-rest/endpoints/fabric) for valid resource types. example: default calling_handler_resource_id: type: string @@ -10122,12 +10121,11 @@ components: allOf: - $ref: '#/components/schemas/CallHandlerType' description: |- - Specify how the SIP endpoint will handle outbound calls. - These options will control if the call is simply passed to the destination or controlled by a resource. - - **default**: The default behavior for Sip Endpoints. passes the call to the destination with no additional logic. - - **passthrough**: Passes the call to the destination with no additional logic. - - **block-pstn**: Passes the call to the destination while blocking PSTN destination. - - **resource**: Sets a resource to handle the call logic. This allows users ot inject calling logic into the call when calling a destination. + 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. See the [Fabric REST API](/rest/signalwire-rest/endpoints/fabric) for valid resource types. example: default calling_handler_resource_id: type: string @@ -10285,12 +10283,11 @@ components: allOf: - $ref: '#/components/schemas/CallHandlerType' description: |- - Specify how the SIP endpoint will handle outbound calls. - These options will control if the call is simply passed to the destination or controlled by a resource. - - **default**: The default behavior for Sip Endpoints. passes the call to the destination with no additional logic. - - **passthrough**: Passes the call to the destination with no additional logic. - - **block-pstn**: Passes the call to the destination while blocking PSTN destination. - - **resource**: Sets a resource to handle the call logic. This allows users ot inject calling logic into the call when calling a destination. + 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. See the [Fabric REST API](/rest/signalwire-rest/endpoints/fabric) for valid resource types. example: default calling_handler_resource_id: type: string diff --git a/specs/swml/tsp-output/@typespec/json-schema/SWMLObject.json b/specs/swml/tsp-output/@typespec/json-schema/SWMLObject.json index 247c359c2..5877e0ce6 100644 --- a/specs/swml/tsp-output/@typespec/json-schema/SWMLObject.json +++ b/specs/swml/tsp-output/@typespec/json-schema/SWMLObject.json @@ -9113,7 +9113,7 @@ "minimum": -2147483648, "maximum": 900, "default": 300, - "description": "The duration to hold the caller in seconds." + "description": "The duration to hold the caller in seconds. Can be a number or an object with timeout property." } }, "unevaluatedProperties": { diff --git a/website/docs/main/home/calling/voice/sip/sip-endpoints/index.mdx b/website/docs/main/home/calling/voice/sip/sip-endpoints/index.mdx index 9eead329a..c26fa8414 100644 --- a/website/docs/main/home/calling/voice/sip/sip-endpoints/index.mdx +++ b/website/docs/main/home/calling/voice/sip/sip-endpoints/index.mdx @@ -14,7 +14,7 @@ x-custom: import AddResource from '/docs/main/_common/dashboard/add-resource-legacy-warning.mdx' import LegacySIP from './_legacy-dashboard.mdx'; -# Get started with SIP +# SIP Endpoints Follow this guide to create a SIP endpoint in your SignalWire Dashboard, register it to a SignalWire phone number for handling incoming calls, @@ -58,7 +58,7 @@ Set the following details: | Password Required | A password to authenticate your endpoint | | Caller ID | A SignalWire or verified phone number to show when dialing a PSTN number
*If left blank, a random number from your purchased numbers will be chosen* | | Encryption status | Set encryption to Required or Optional | -| Outbound Call Handler | Whether to allow calls to the PSTN | +| Outbound Call Handler | How the SIP endpoint handles outbound calls:
| | Codecs and Ciphers | The default codecs/ciphers you would like to use | :::tip