Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -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

<Subtitle>Resources on the Call Fabric platform</Subtitle>
Expand All @@ -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.

<Frame caption="The Resource selection menu">
![Select a Resource in the Signalwire Dashboard.](@image/dashboard/resources/add-new-resource.png)
</Frame>


## 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]

<Frame caption="AI Agents in the Dashboard">
![The AI Agents tab in the Dashboard.](@image/dashboard/resources/ai-agent/new-agent.webp)
</Frame>
Expand Down
Original file line number Diff line number Diff line change
@@ -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

<Subtitle>Resources on the Call Fabric platform</Subtitle>

## 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.

<Frame caption="The Resource selection menu">
![Select a Resource in the Signalwire Dashboard.](@image/dashboard/resources/add-new-resource.png)
</Frame>

## Details

A Call Flow Resource will have the following details:

| Detail | Value |
|:-------|:----------------------------------------------------------|
| `Name`<span className="optional-arg">Optional</span> | The name of the Call Flow. |

<Frame caption="To edit a Call Flow, click the **Launch Call Flow Builder** button to open the visual editor.">
![Details of a Call Flow on the SignalWire Dashboard.](@image/dashboard/resources/call-flow/call-flow-details.webp)
</Frame>



## Learn more

For more information on Call Flows, please refer to the
[Call Flow Builder documentation][call-flow-builder].
Original file line number Diff line number Diff line change
Expand Up @@ -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

<Subtitle>Resources on the Call Fabric platform</Subtitle>
Expand All @@ -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.
:::


<Frame caption="The Resource selection menu">
![Select a Resource in the Signalwire Dashboard.](@image/dashboard/resources/add-new-resource.png)
</Frame>


## Details

A cXML Script Resource has a single text box where the cXML should be input.
A cXML Script Resource has the following details:

<Tabs
defaultValue="hosted"
values={[
{ label: 'Hosted Scripts', value: 'hosted' },
{ label: 'External URL', value: 'external' },
]}
>
<TabItem value="hosted">
| Detail | Description |
| :--- | :--- |
| `Name`<span className="optional-arg">Optional</span> | The unique name for the cXML script resource. |
| `Script will be used for`<span className="optional-arg">Optional</span> | The purpose or use-case for the cXML script, such as handling inbound/outbound calls or inbound/outbound messaging.<br />**Possible Values:** `Calling`, `Messaging`, `Faxing` |
| `Handle using`<span className="optional-arg">Optional</span> | **Hosted Script** is cXML script that will be hosted on SignalWire. |
| `Primary Script`<span className="optional-arg">Optional</span> | This is the main [cXML script][cxml] that will run when controlling a call or message. |
| `Status Change Webhook`<span className="optional-arg">Optional</span> | 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. |
</TabItem>
<TabItem value="external">
| Detail | Description |
| :--- | :--- |
| `Name`<span className="optional-arg">Optional</span> | The unique name for the cXML script resource. |
| `Script will be used for`<span className="optional-arg">Optional</span> | The purpose or use-case for the cXML script, such as handling inbound/outbound calls or inbound/outbound messaging.<br />**Possible Values:** `Calling`, `Messaging`, `Faxing` |
| `Handle using`<span className="optional-arg">Optional</span> | **External URL** indicates the cXML script lives on a remote server. |
| `Primary script URL`<span className="required-arg">Required</span> | The URL that will respond with a valid [cXML script][cxml] that will run when controlling a call or message. |
| `Fallback script URL`<span className="optional-arg">Optional</span> | 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`<span className="optional-arg">Optional</span> | 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. |

</TabItem>
</Tabs>


## Learn more

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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.

<Frame caption="The Resource selection menu">
![Select a Resource in the Signalwire Dashboard.](@image/dashboard/resources/add-new-resource.png)
</Frame>


## 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.

<Frame caption="Import a Dialogflow Agent">
![Select a Resource in the Signalwire Dashboard.](@image/dashboard/resources/dialogflow/import.webp)
</Frame>

## Learn more

For more information on Dialogflow Agents, please refer to the
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,11 @@ slug: /platform/call-fabric/resources/freeswitch-connectors

The FreeSWITCH Connector Resource type is used to create and manage FreeSWITCH Connectors.

<Frame caption="The Resource selection menu">
![Select a Resource in the Signalwire Dashboard.](@image/dashboard/resources/add-new-resource.png)
</Frame>


## Details

A FreeSWITCH Connector Resource will have the following details:
Expand All @@ -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. |



<Frame caption="Creating a FreeSWITCH Resource">
![Select a Resource in the Signalwire Dashboard.](@image/dashboard/resources/freeswitch/image.webp)
</Frame>


## Learn more

For more information on FreeSWITCH Connectors, please refer to the
Expand Down
33 changes: 9 additions & 24 deletions website/docs/main/home/platform/call-fabric/resources/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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).

<!--todo

<CardGroup cols={4}>

<Card title="Subscribers" href="#subscribers"></Card>

<Card title="SWML Scripts" href="#swml-scripts"></Card>

<Card title="cXML Scripts" href="#cxml-scripts"></Card>

<Card title="AI Agents" href="#ai-agents"></Card>

<Card title="Video rooms" href="#video-rooms"></Card>

<Card title="RELAY Applications" href="#relay-applications"></Card>

<Card title="FreeSWITCH Connectors" href="#freeswitch-connectors"></Card>

<Card title="Call Flows" href="#call-flows"></Card>

<Card title="SIP Endpoints" href="#sip-endpoints"></Card>

</CardGroup>

-->

## Manage Resources

Expand Down Expand Up @@ -109,3 +85,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/).

<UiAccordion/>


## 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.

<GuidesList cols={3} />
Original file line number Diff line number Diff line change
Expand Up @@ -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.

<Frame caption="The Resource selection menu">
![Select a Resource in the Signalwire Dashboard.](@image/dashboard/resources/add-new-resource.png)
</Frame>


## 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.<br/>A given phone number can be configured with the desired Reference (E.g., "office").<br/>That then assigns incoming calls to that number to be forwarded to the matching Relay application. |

<Frame>
<Frame caption="Creating a Relay Application">
![Details of a Relay App on the SignalWire Dashboard.](@image/dashboard/resources/relay-app.webp)
</Frame>

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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.
:::

<Frame caption="When creating a SIP Gateway, give it a name, enter the full external URI, and configure encryption, ciphers, and codec settings.">
![Creating a SIP Gateway Resource in the SignalWire Dashboard.](@image/dashboard/resources/sip/sip-gateway.png)
<Frame caption="The Resource selection menu">
![Select a Resource in the Signalwire Dashboard.](@image/dashboard/resources/add-new-resource.png)
</Frame>


## Details

<SipGatewayParams/>
<SipGatewayParams/>

<Frame caption="When creating a SIP Gateway, give it a name, enter the full external URI, and configure encryption, ciphers, and codec settings.">
![Creating a SIP Gateway Resource in the SignalWire Dashboard.](@image/dashboard/resources/sip/sip-gateway.png)
</Frame>
Original file line number Diff line number Diff line change
Expand Up @@ -14,22 +14,33 @@ import ResourceSubscribers from '/docs/main/_common/call-fabric/resource-subscri

<ResourceSubscribers />

<Frame caption="The Resource selection menu">
![Select a Resource in the Signalwire Dashboard.](@image/dashboard/resources/add-new-resource.png)
</Frame>


## 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.<br/>The format of the Address is as follows: `/<Context>/<Name>`<br/>(E.g. `/private/Lenny`) |
| Email<span className="required-arg">Required</span> | The email address of the subscriber. |
| Password<span className="optional-arg">Optional</span> | The password for the subscriber. |
| First Name<span className="optional-arg">Optional</span> | The First name of the subscriber. |
| Last Name<span className="optional-arg">Optional</span> | The Last name of the subscriber. |
| Display Name<span className="optional-arg">Optional</span> | The display name of the subscriber. |
| Job Title<span className="optional-arg">Optional</span> | The job title of the subscriber. |
| Company Name<span className="optional-arg">Optional</span> | The company name of the subscriber. |
| Time Zone<span className="optional-arg">Optional</span> | The timezone of the subscriber, in [TZ database name format](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones). |
| Country<span className="optional-arg">Optional</span> | The country of the subscriber. |
| Region<span className="optional-arg">Optional</span> | The region of the subscriber. |
| Address<span className="optional-arg">Optional</span> | The Resource Address of the subscriber.<br/>The format of the Address is as follows: `/<Context>/<Name>`<br/>(E.g. `/private/Lenny`) |

<br />

<Frame caption="Create a Subscriber Resource">
![Select a Resource in the Signalwire Dashboard.](@image/dashboard/resources/subscriber/image.webp)
</Frame>

Create a Subscriber from the Resources pane of your SignalWire Space using [these instructions](/platform/call-fabric/resources#create).
Loading