diff --git a/website/docs/main/home/platform/call-fabric/resources/ai-agents.mdx b/website/docs/main/home/platform/call-fabric/resources/ai-agents.mdx index e66ba4145..68efe7acd 100644 --- a/website/docs/main/home/platform/call-fabric/resources/ai-agents.mdx +++ b/website/docs/main/home/platform/call-fabric/resources/ai-agents.mdx @@ -4,6 +4,8 @@ description: Learn about the Subscriber Resource on the SignalWire platform - wh slug: /platform/call-fabric/resources/ai-agents --- +[swml-ai]: /swml/methods/ai + # AI Agents Resources on the Call Fabric platform @@ -12,6 +14,16 @@ slug: /platform/call-fabric/resources/ai-agents Use this section of the Dashboard to create, configure, and manage AI Agent Resources. + + ![Select a Resource in the Signalwire Dashboard.](@image/dashboard/resources/add-new-resource.png) + + + +## Details + +Only a `name` will be prompted upon the creation of an AI agent. The AI Agent resource contains a wide variety of options to help customize the AI Agent. +To learn information on these options, its recommended to read the descrptions provided in the Resource UI or to refer to the [AI SWML method][swml-ai] + ![The AI Agents tab in the Dashboard.](@image/dashboard/resources/ai-agent/new-agent.webp) diff --git a/website/docs/main/home/platform/call-fabric/resources/call-flows.mdx b/website/docs/main/home/platform/call-fabric/resources/call-flows.mdx new file mode 100644 index 000000000..c3387a724 --- /dev/null +++ b/website/docs/main/home/platform/call-fabric/resources/call-flows.mdx @@ -0,0 +1,44 @@ +--- +title: Call Flows +description: Learn about the Call Flow Resource on the SignalWire platform - what they are, how they work, and how to manage them in the Dashboard. +slug: /platform/call-fabric/resources/call-flows +--- + +[call-flow-builder]: /call-flow-builder + +# Call Flows + +Resources on the Call Fabric platform + +## About + +The Call Flow Resource type is used to create and manage visual, no-code voice applications. +Call Flows are created using a simple drag-and-drop interface (the [Call Flow Builder][call-flow-builder]) that generates +[SWML (SignalWire Markup Language)](/swml) under the hood, +providing all the power of SWML with an intuitive visual editor. + +Call Flows allow you to create complex call routing logic with multiple branches and decision points, +all represented as connected nodes in a visual tree structure. + + + ![Select a Resource in the Signalwire Dashboard.](@image/dashboard/resources/add-new-resource.png) + + +## Details + +A Call Flow Resource will have the following details: + +| Detail | Value | +|:-------|:----------------------------------------------------------| +| `Name`Optional | The name of the Call Flow. | + + + ![Details of a Call Flow on the SignalWire Dashboard.](@image/dashboard/resources/call-flow/call-flow-details.webp) + + + + +## Learn more + +For more information on Call Flows, please refer to the +[Call Flow Builder documentation][call-flow-builder]. \ No newline at end of file diff --git a/website/docs/main/home/platform/call-fabric/resources/cxml-scripts.mdx b/website/docs/main/home/platform/call-fabric/resources/cxml-scripts.mdx index fe576bb29..183d1b319 100644 --- a/website/docs/main/home/platform/call-fabric/resources/cxml-scripts.mdx +++ b/website/docs/main/home/platform/call-fabric/resources/cxml-scripts.mdx @@ -4,6 +4,9 @@ description: Learn about the Subscriber Resource on the SignalWire platform - wh slug: /platform/call-fabric/resources/cxml-scripts --- + +[cxml]: /compatibility-api/cxml + # cXML Scripts Resources on the Call Fabric platform @@ -16,9 +19,45 @@ The cXML (Compatibility XML) Script Resource type is used to create and manage L cXML Scripts were formerly known as LaML Webhooks and LaML Applications. ::: + + + ![Select a Resource in the Signalwire Dashboard.](@image/dashboard/resources/add-new-resource.png) + + + ## Details -A cXML Script Resource has a single text box where the cXML should be input. +A cXML Script Resource has the following details: + + + + | Detail | Description | + | :--- | :--- | + | `Name`Optional | The unique name for the cXML script resource. | + | `Script will be used for`Optional | The purpose or use-case for the cXML script, such as handling inbound/outbound calls or inbound/outbound messaging.
**Possible Values:** `Calling`, `Messaging`, `Faxing` | + | `Handle using`Optional | **Hosted Script** is cXML script that will be hosted on SignalWire. | + | `Primary Script`Optional | This is the main [cXML script][cxml] that will run when controlling a call or message. | + | `Status Change Webhook`Optional | As a call or message progresses through the various states of its lifecycle, you can receive updates to your own application. Enter a URL to receive a JSON event when the status of a call or message changes. | + + + | Detail | Description | + | :--- | :--- | + | `Name`Optional | The unique name for the cXML script resource. | + | `Script will be used for`Optional | The purpose or use-case for the cXML script, such as handling inbound/outbound calls or inbound/outbound messaging.
**Possible Values:** `Calling`, `Messaging`, `Faxing` | + | `Handle using`Optional | **External URL** indicates the cXML script lives on a remote server. | + | `Primary script URL`Required | The URL that will respond with a valid [cXML script][cxml] that will run when controlling a call or message. | + | `Fallback script URL`Optional | If the primary script cannot be reached or fails in any way, you can define a fallback script to handle the call or message. Defining a fallback ensures calls and messages are still handled even if your application experiences an issue. | + | `Status Change Webhook`Optional | As a call or message progresses through the various states of its lifecycle, you can receive updates to your own application. Enter a URL to receive a JSON event when the status of a call or message changes. | + + + + ## Learn more diff --git a/website/docs/main/home/platform/call-fabric/resources/dialogflow-agents.mdx b/website/docs/main/home/platform/call-fabric/resources/dialogflow-agents.mdx index 519765bff..dba12f7ad 100644 --- a/website/docs/main/home/platform/call-fabric/resources/dialogflow-agents.mdx +++ b/website/docs/main/home/platform/call-fabric/resources/dialogflow-agents.mdx @@ -13,6 +13,19 @@ slug: /platform/call-fabric/resources/dialogflow-agents The Dialogflow Agent Resource type is used to create and manage Google Dialogflow Agents. Create a Dialogflow Agent by first selecting AI Agent from the Resources menu. + + ![Select a Resource in the Signalwire Dashboard.](@image/dashboard/resources/add-new-resource.png) + + + +## Details + +All configuration for the Dialogflow Agent is done on the Google Dialogflow console. Upon creating a Dialogflow Agent, you will be presented a button that will redirect you to the configuration page. + + + ![Select a Resource in the Signalwire Dashboard.](@image/dashboard/resources/dialogflow/import.webp) + + ## Learn more For more information on Dialogflow Agents, please refer to the diff --git a/website/docs/main/home/platform/call-fabric/resources/freeswitch-connectors.mdx b/website/docs/main/home/platform/call-fabric/resources/freeswitch-connectors.mdx index 8042cc36d..8a880beca 100644 --- a/website/docs/main/home/platform/call-fabric/resources/freeswitch-connectors.mdx +++ b/website/docs/main/home/platform/call-fabric/resources/freeswitch-connectors.mdx @@ -12,6 +12,11 @@ slug: /platform/call-fabric/resources/freeswitch-connectors The FreeSWITCH Connector Resource type is used to create and manage FreeSWITCH Connectors. + + ![Select a Resource in the Signalwire Dashboard.](@image/dashboard/resources/add-new-resource.png) + + + ## Details A FreeSWITCH Connector Resource will have the following details: @@ -21,6 +26,13 @@ A FreeSWITCH Connector Resource will have the following details: | Name | The name of the FreeSWITCH Connector. | | Token | The token of the FreeSWITCH Connector. | + + + + ![Select a Resource in the Signalwire Dashboard.](@image/dashboard/resources/freeswitch/image.webp) + + + ## Learn more For more information on FreeSWITCH Connectors, please refer to the diff --git a/website/docs/main/home/platform/call-fabric/resources/index.mdx b/website/docs/main/home/platform/call-fabric/resources/index.mdx index 74fd6a481..b5d48344f 100644 --- a/website/docs/main/home/platform/call-fabric/resources/index.mdx +++ b/website/docs/main/home/platform/call-fabric/resources/index.mdx @@ -19,31 +19,7 @@ They are the building blocks of the system, representing the various communicati that can be used to interact with [subscribers](/platform/call-fabric#subscribers). - ## Manage Resources @@ -121,3 +97,12 @@ The **Resources experience** is not available in the Legacy Dashboard. To upgrade your Space to the New UI, [contact Support](https://support.signalwire.com/). + + +## Available Resources + +Resources are the core building blocks of SignalWire's Call Fabric platform. +Each Resource type provides specific communication capabilities - from voice and video applications to AI agents and messaging flows. +Click on any Resource below to learn how to create and configure it for your communication needs. + + diff --git a/website/docs/main/home/platform/call-fabric/resources/relay-applications.mdx b/website/docs/main/home/platform/call-fabric/resources/relay-applications.mdx index 473473850..af2ee390f 100644 --- a/website/docs/main/home/platform/call-fabric/resources/relay-applications.mdx +++ b/website/docs/main/home/platform/call-fabric/resources/relay-applications.mdx @@ -14,16 +14,21 @@ Relay Applications are powerful applications running on your own server or a cli built with one of the [Server or Client Relay SDKs](/sdks/). Use a Relay Application Resource to connect your Relay Application to SignalWire via a secure realtime websocket connection. + + ![Select a Resource in the Signalwire Dashboard.](@image/dashboard/resources/add-new-resource.png) + + + ## Details A Relay Application Resource will have the following details: -| Detail | Value | +| Detail | Description | |:----------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | Name | The name of the Relay application. | | Reference | The reference (previously known as Context) of the Relay application.
A given phone number can be configured with the desired Reference (E.g., "office").
That then assigns incoming calls to that number to be forwarded to the matching Relay application. | - + ![Details of a Relay App on the SignalWire Dashboard.](@image/dashboard/resources/relay-app.webp) diff --git a/website/docs/main/home/platform/call-fabric/resources/sip-gateways.mdx b/website/docs/main/home/platform/call-fabric/resources/sip-gateways.mdx index a601c9a22..029a68419 100644 --- a/website/docs/main/home/platform/call-fabric/resources/sip-gateways.mdx +++ b/website/docs/main/home/platform/call-fabric/resources/sip-gateways.mdx @@ -20,10 +20,15 @@ They are distinct from [SIP Domain Applications](/voice/getting-started/sip/sip- and [SIP Endpoints](/voice/sip/get-started), which are for registering your devices to SignalWire SIP addresses. ::: - - ![Creating a SIP Gateway Resource in the SignalWire Dashboard.](@image/dashboard/resources/sip/sip-gateway.png) + + ![Select a Resource in the Signalwire Dashboard.](@image/dashboard/resources/add-new-resource.png) + ## Details - \ No newline at end of file + + + + ![Creating a SIP Gateway Resource in the SignalWire Dashboard.](@image/dashboard/resources/sip/sip-gateway.png) + \ No newline at end of file diff --git a/website/docs/main/home/platform/call-fabric/resources/subscribers.mdx b/website/docs/main/home/platform/call-fabric/resources/subscribers.mdx index db92b621e..564ada5a6 100644 --- a/website/docs/main/home/platform/call-fabric/resources/subscribers.mdx +++ b/website/docs/main/home/platform/call-fabric/resources/subscribers.mdx @@ -14,22 +14,33 @@ import ResourceSubscribers from '/docs/main/_common/call-fabric/resource-subscri + + ![Select a Resource in the Signalwire Dashboard.](@image/dashboard/resources/add-new-resource.png) + + + ## Details A subscriber Resource will have the following details: | Detail | Value | |:-------------|:-------------------------------------------------------------------------------------------------------------------------------------| -| Email | The email address of the subscriber. | -| Password | The password for the subscriber. | -| First Name | The First name of the subscriber. | -| Last Name | The Last name of the subscriber. | -| Display Name | The display name of the subscriber. | -| Job Title | The job title of the subscriber. | -| Company Name | The company name of the subscriber. | -| Time Zone | The timezone of the subscriber, in [TZ database name format](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones). | -| Country | The country of the subscriber. | -| Region | The region of the subscriber. | -| Address | The Resource Address of the subscriber.
The format of the Address is as follows: `//`
(E.g. `/private/Lenny`) | +| EmailRequired | The email address of the subscriber. | +| PasswordOptional | The password for the subscriber. | +| First NameOptional | The First name of the subscriber. | +| Last NameOptional | The Last name of the subscriber. | +| Display NameOptional | The display name of the subscriber. | +| Job TitleOptional | The job title of the subscriber. | +| Company NameOptional | The company name of the subscriber. | +| Time ZoneOptional | The timezone of the subscriber, in [TZ database name format](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones). | +| CountryOptional | The country of the subscriber. | +| RegionOptional | The region of the subscriber. | +| AddressOptional | The Resource Address of the subscriber.
The format of the Address is as follows: `//`
(E.g. `/private/Lenny`) | + +
+ + + ![Select a Resource in the Signalwire Dashboard.](@image/dashboard/resources/subscriber/image.webp) + Create a Subscriber from the Resources pane of your SignalWire Space using [these instructions](/platform/call-fabric/resources#create). diff --git a/website/docs/main/home/platform/call-fabric/resources/swml-scripts.mdx b/website/docs/main/home/platform/call-fabric/resources/swml-scripts.mdx index 687f87e97..b366ff2f9 100644 --- a/website/docs/main/home/platform/call-fabric/resources/swml-scripts.mdx +++ b/website/docs/main/home/platform/call-fabric/resources/swml-scripts.mdx @@ -4,6 +4,9 @@ description: Learn about the SWML Script Resource on the SignalWire platform - w slug: /platform/call-fabric/resources/swml-scripts --- + +[swml]: /swml + # SWML Scripts Resources on the Call Fabric platform @@ -13,16 +16,43 @@ slug: /platform/call-fabric/resources/swml-scripts The SWML Resource type is used to create and manage SWML scripts. SWML allows you to write Relay applications using simple statements in a YAML or JSON document. -## Details + + ![Select a Resource in the Signalwire Dashboard.](@image/dashboard/resources/add-new-resource.png) + -A SWML Resource will have the following details: -| Detail | Value | -|:-------------|:----------------------------------------------------------| -| SWML Content | The configuration of the SWML script. | -| ID | The alphanumeric ID assigned to the Resource on creation. | +## Details - +A SWML Script Resource has the following details: + + + + | Detail | Description | + | :--- | :--- | + | `Name`Optional | The unique name for the SWML script resource. | + | `Handle using`Optional | **Hosted Script** is SWML script that will be hosted on SignalWire. | + | `Primary Script`Optional | This is the main [SWML script][swml] that will run when controlling a call or message. | + | `Status Change Webhook`Optional | As a call or message progresses through the various states of its lifecycle, you can receive updates to your own application. Enter a URL to receive a JSON event when the status of a call or message changes. | + + + | Detail | Description | + | :--- | :--- | + | `Name`Optional | The unique name for the SWML script resource. | + | `Handle using`Optional | **External URL** indicates the SWML script lives on a remote server. | + | `Primary script URL`Required | The URL that will respond with a valid [SWML script][swml] that will run when controlling a call or message. | + | `Fallback script URL`Optional | If the primary script cannot be reached or fails in any way, you can define a fallback script to handle the call or message. Defining a fallback ensures calls and messages are still handled even if your application experiences an issue. | + | `Status Change Webhook`Optional | As a call or message progresses through the various states of its lifecycle, you can receive updates to your own application. Enter a URL to receive a JSON event when the status of a call or message changes. | + + + + + ![Details of a SWML Script on the SignalWire Dashboard.](@image/dashboard/resources/swml-script.webp) diff --git a/website/docs/main/home/platform/call-fabric/resources/video-rooms.mdx b/website/docs/main/home/platform/call-fabric/resources/video-rooms.mdx index 2df3e835d..39be37b38 100644 --- a/website/docs/main/home/platform/call-fabric/resources/video-rooms.mdx +++ b/website/docs/main/home/platform/call-fabric/resources/video-rooms.mdx @@ -4,6 +4,9 @@ description: Learn about the Subscriber Resource on the SignalWire platform - wh slug: /platform/call-fabric/resources/video-rooms --- +[realtime-sdk]: /sdks/realtime-sdk +[browser-sdk]: /sdks/browser-sdk + # Video Rooms Resources on the Call Fabric platform @@ -12,11 +15,26 @@ slug: /platform/call-fabric/resources/video-rooms The Video Room Resource type is used to create and manage Video Rooms. - - ![The Resource picker menu.](@image/dashboard/resources/add-new-resource-video-marked.png) + + ![Select a Resource in the Signalwire Dashboard.](@image/dashboard/resources/add-new-resource-video-marked.png) + + + + +## Details + +A Video Room Resource has the following details: + + +| Detail | Description | +| :-- | :-- +| `Room Name`Optional | This specifies the uniqie name for the video room. | +| `Experience`Required | You can create a room with a preset embeddable UI or build your own with the [browser-sdk][browser-sdk] or our server [realtime sdk][realtime-sdk] and customize the experience to fit your needs | + + + ![The Resource picker menu.](@image/dashboard/resources/video-room/image.webp) -When creating a new Video Room Resource, select from two options: **UI Included** and **Build From Scratch**. ## Learn more diff --git a/website/images/dashboard/resources/call-flow/call-flow-details.webp b/website/images/dashboard/resources/call-flow/call-flow-details.webp new file mode 100644 index 000000000..45c51c70e Binary files /dev/null and b/website/images/dashboard/resources/call-flow/call-flow-details.webp differ diff --git a/website/images/dashboard/resources/dialogflow/import.webp b/website/images/dashboard/resources/dialogflow/import.webp new file mode 100644 index 000000000..248160f85 Binary files /dev/null and b/website/images/dashboard/resources/dialogflow/import.webp differ diff --git a/website/images/dashboard/resources/freeswitch/image.webp b/website/images/dashboard/resources/freeswitch/image.webp new file mode 100644 index 000000000..76dd4109b Binary files /dev/null and b/website/images/dashboard/resources/freeswitch/image.webp differ diff --git a/website/images/dashboard/resources/subscriber/image.webp b/website/images/dashboard/resources/subscriber/image.webp new file mode 100644 index 000000000..151959702 Binary files /dev/null and b/website/images/dashboard/resources/subscriber/image.webp differ diff --git a/website/images/dashboard/resources/video-room/image.webp b/website/images/dashboard/resources/video-room/image.webp new file mode 100644 index 000000000..2b816bf1f Binary files /dev/null and b/website/images/dashboard/resources/video-room/image.webp differ diff --git a/website/src/components/GuidesList/GuidesList.jsx b/website/src/components/GuidesList/GuidesList.jsx index 739ba7959..64925fabc 100644 --- a/website/src/components/GuidesList/GuidesList.jsx +++ b/website/src/components/GuidesList/GuidesList.jsx @@ -90,7 +90,7 @@ function GuideCardWrapper({ item }) { ); } -export default function GuidesList({ items = null }) { +export default function GuidesList({ items = null, cols = 2 }) { const sidebarItems = useCurrentSidebarCategory(); const [itemsToUse, setItemsToUse] = useState(null); @@ -103,7 +103,7 @@ export default function GuidesList({ items = null }) { }, [items, sidebarItems]); return ( - + {itemsToUse && itemsToUse ?.filter((i) => !(i?.customProps?.hideFromIndex === true || i?.draft === true))