diff --git a/fern/products/platform/pages/platform/call-fabric/resources.mdx b/fern/products/platform/pages/platform/call-fabric/resources.mdx index 2446cba690..d471063bff 100644 --- a/fern/products/platform/pages/platform/call-fabric/resources.mdx +++ b/fern/products/platform/pages/platform/call-fabric/resources.mdx @@ -11,32 +11,67 @@ x-custom: --- -Resources are the primary entities for communication within the Call Fabric ecosystem. -They are the building blocks of the system, representing the various communication elements -that can be used to interact with -[subscribers](/docs/platform/subscribers). +Resources are the core building blocks of the SignalWire ecosystem. +They are container objects that represent your choice of communication entity. +This can be anything from a SignalWire AI Agent or a SWML script, to a Subscriber that can be created, addressed and called within your SignalWire Space. + +Every Resource has a **Type** and one or more **Addresses** that make it reachable, and all Resources share the same addressing and management model. +No matter what Resource you need you can create, configure, and call them all in the same consistent way. + +## Resource types + +Call Fabric supports several Resource types. Some of the most common are: + + + + Users in your communication system, with built-in authentication and communication endpoints. + + + Conversational AI agents that can answer and place calls. + + + Programmable call logic written in SWML (JSON or YAML). + + + Twilio-compatible call logic for migrating existing applications. + + + Register SIP devices and softphones to your Space. + + + Programmable video conference rooms. + + + +Each of these Resource types use the same addressing and management patterns described below. + +## Resource addresses + +Every Resource is uniquely identified by one or more **Addresses** in the form `/context/name`. +For example, an AI Agent named `Sigmond` in the public context is reachable at `/public/Sigmond`. +The context is either `public` or `private`, and the name defaults to the Resource's name. Addresses are mutable, and a single Resource can have multiple addresses, including phone numbers and SIP URIs. + +Learn more in the [Resource Addresses](/docs/platform/addresses) guide, including contexts, naming conventions, and routing options. ## Manage Resources ### With the REST API -Use the Resources endpoints to manage your Resources programmatically. +Use the Resources endpoints to work with any Resource programmatically, regardless of type. +The generic Resources endpoint lets you [list](/docs/apis/rest/resources/list-resources) all Resources, + [retrieve](/docs/apis/rest/resources/get-resource) or [delete](/docs/apis/rest/resources/delete-resource) a Resource by +ID, and [list a Resource's addresses](/docs/apis/rest/addresses/list-resource-addresses-client). - - Control Resources using the SignalWire REST API. - +To **create** or **update** a Resource, use the endpoint for its specific type. +For example, if you wanted to create a new SWML Script you would utilize the [Create SWML Script](/docs/apis/rest/swml-scripts/create-swml-script) endpoint. ### In the Dashboard -The Dashboard is your unified command center for your SignalWire Space. Access it at `{your-space-name}.signalwire.com`. +The [SignalWire Dashboard](https://my.signalwire.com/resources) can also be used as your unified command center for your SignalWire Resources. +You can create, manage, edit, delete, and test your Space's Resources all from your web browser. #### Create - -If you don't see the **My Resources** tab, your SignalWire Space is on the **Legacy Dashboard**. -Refer to the [Legacy](#in-the-legacy-dashboard) section of this guide for instructions for your Dashboard and information about the migration. - - To create a Resource in your SignalWire Space, click on the **My Resources** tab in the left-hand navigation menu. @@ -48,15 +83,8 @@ Refer to the [Legacy](#in-the-legacy-dashboard) section of this guide for instru - - - - - + ![Create a new Resource from the Dashboard.](/assets/images/dashboard/home/home-resources-marked.webp) - Click the **Add** button to select from the grid of available Resource types. @@ -67,9 +95,13 @@ Click the **Add** button to select from the grid of available Resource types. Alternatively, you can create new Resources from their subpages in the sidebar menu, or using the shortcuts on the Dashboard homepage. -After selecting a Resource, -enter the details for the Resource on a new page, -and select Create to confirm. +After selecting a Resource, enter the details for the Resource on a new page, and select Create to confirm. + + +If you don't see the **My Resources** tab, your SignalWire Space is on the **Legacy Dashboard**, +which does not support the Resources experience. [Contact Support](https://support.signalwire.com/) +to upgrade your Space to the new UI. + #### Modify or delete @@ -80,12 +112,19 @@ Here, by selecting the `Edit` button, you can alter the specifics of the Resourc ![The list of Resources in a SignalWire Space.](/assets/images/dashboard/resources/resource-list.webp) ---- - -## In the Legacy Dashboard - -The **Resources experience** is not available in the Legacy Dashboard. - -To upgrade your Space to the New UI, [contact Support](https://support.signalwire.com/). - - +## Next steps + + + + Manage the users in your communication system via subscribers. + + + Understand contexts, naming, and how Resources are identified and called. + + + List, retrieve, and delete Resources programmatically. + + + Build conversational AI agents as Resources. + +