Skip to content
Merged
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
10 changes: 10 additions & 0 deletions fern/products/apis/pages/core/authorization.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -44,10 +44,20 @@ Authorization: Basic YTFiMmMzZDQtZTVmNi03ODkwLWFiY2QtZWYxMjM0NTY3ODkwOjR0akNHbm1
Your Project ID and API Tokens are available in the
[SignalWire Dashboard](/docs/platform/your-signalwire-api-space).

<llms-ignore>

<Frame>
<img src="/assets/images/dashboard/credentials/api-credentials.webp" alt="API credentials in the Dashboard." />
</Frame>

</llms-ignore>

<llms-only>

In the Dashboard, open **API Credentials**. Copy the **Project ID**, then reveal and copy an existing API token or select **+ New** to create one.

</llms-only>

### API token scopes

Tokens can be scoped to limit API access.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -76,6 +76,14 @@ incoming webhook requests.
The final step is to configure one of your SignalWire phone numbers to answer calls using the cXML Script we just created.
You can do that from the "Phone Numbers" section:

<llms-ignore>

![Assign Resource.](/assets/images/dashboard/phone-numbers/assign-resource-voice.webp)

</llms-ignore>

<llms-only>

In the Dashboard, open **Phone Numbers** > **Purchased**, select the number, and open its edit page. Under **Inbound Call Settings**, select **+ Assign Resource**, choose the cXML script, and save.

</llms-only>
Original file line number Diff line number Diff line change
Expand Up @@ -57,10 +57,20 @@ which allows you to generate scripts dynamically.
Navigate to the "Resources" tab from the sidebar and create a new Resource.
There, select the resource type of "Script", and pick "cXML script".

<llms-ignore>

<Frame>
![Create a new cXML script.](/assets/images/dashboard/resources/new-cxml-bin.webp)
</Frame>

</llms-ignore>

<llms-only>

In **My Resources**, select **+ Add New** > **Script** > **cXML Script**.

</llms-only>

<Markdown src="/snippets/common/dashboard/_resource-admonition.mdx" />

### Paste the script
Expand Down Expand Up @@ -102,10 +112,20 @@ You will need at least one number to receive messages.
Navigate to the "Phone Numbers" section of your Dashboard and open the settings for the number you want to configure.
There, assign the cXML script you just created to handle messages.

<llms-ignore>

<Frame>
![Open the settings for the number.](/assets/images/dashboard/phone-numbers/assign-resource-full.webp)
</Frame>

</llms-ignore>

<llms-only>

On the phone number's edit page, select **+ Assign Resource** under **Inbound Message Settings**, choose the cXML script, and save.

</llms-only>

### Send a test SMS

Try sending a message to the configured phone number.
Expand Down Expand Up @@ -149,10 +169,20 @@ Follow the above guide, with the following changes:

Navigate to the "LaML/cXML" section of your Dashboard and create a new cXML bin with the content above.

<llms-ignore>

<Frame>
![Create a new cXML script.](/assets/images/dashboard/legacy/xml-bins.webp)
</Frame>

</llms-ignore>

<llms-only>

In the legacy Dashboard, open **cXML/LaML** > **Bins** and select **+ New** to create a cXML bin.

</llms-only>

**Assign a phone number**

Open the settings for the number you want to configure.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -24,10 +24,20 @@ How To Run the Application

In order to achieve this via XML, you will have to navigate to the **cXML/LaML** section on the left side of your SignalWire Dashboard and under **Bins** select **+ New** to create a new LaML Bin.

<llms-ignore>

<Frame caption="Creating a new cXML bin">
![The new cXML bin creation dialog](/assets/images/dashboard/legacy/xml-bins.webp)
</Frame>

</llms-ignore>

<llms-only>

In the legacy Dashboard, open **cXML/LaML** > **Bins**, select **+ New**, and create the cXML bin used to receive the fax.

</llms-only>

We then need to enter in the XML language for receiving a fax into our LaML Bin.
The below code is taken from the [Receive a Fax in Compatibility XML example](/docs/compatibility-api/cxml/reference/fax/receive#examples).

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -26,12 +26,22 @@ you need API credentials. Find these in your [SignalWire Space](https://signalwi
If this is the first time you are using API credentials, you will need to create
an API token.

<llms-ignore>

<Frame caption="You can find your Project ID, Space URL, and API Token from the API tab in your SignalWire Space. Make sure your token has the necessary scopes enabled.">

![The API page.](/assets/images/dashboard/credentials/api-credentials.webp)

</Frame>

</llms-ignore>

<llms-only>

Open **API Credentials** in the Dashboard and copy the **Project ID**, **Space URL**, and an API token with the scopes required to send messages. If necessary, select **+ New** to create a token.

</llms-only>


In the "API" section you will find all the information you'll need. In particular:

Expand Down Expand Up @@ -150,4 +160,4 @@ Make sure to replace all placeholders with your own values.

This example used the [Compatibility API](/docs/compatibility-api), and in
particular the [Compatibility REST API](/docs/compatibility-api/rest), to
send a message.
send a message.
Original file line number Diff line number Diff line change
Expand Up @@ -92,12 +92,22 @@ Some carriers may send delayed DLRs, and others may not send DLRs at all. Provid

To access the number settings and configure the webhooks in the SignalWire Space, click on **Phone Numbers** and find the number to set up.

<llms-ignore>

<Frame caption="Purchased Phone Number List page in SignalWire Dashboard">

![The Phone Numbers tab of a SignalWire Space showing a list of phone numbers](/assets/images/dashboard/phone-numbers/purchased-phone-numbers.webp)

</Frame>

</llms-ignore>

<llms-only>

Open **Phone Numbers** > **Purchased**, search for the number if necessary, and select its name to open its settings.

</llms-only>

Click on the phone number to be set up and then click to **Edit Settings**.

In the Edit Settings page, the number can be given a name and set up **Voice/Fax & Messaging** settings.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,12 +17,22 @@ If your application exposes sensitive data or makes changes to your data, then y

You can find your personalized signing key in the [API Credentials Space](https://my.signalwire.com?page=credentials) of your Dashboard. Click "Show" to display the key and a copy icon to easily copy the signature into your code. Each project in your Dashboard will have its own signing key for verification. You can reset the signing key by clicking the reset button. Please note that it takes about a minute for the new key to be active. You will also be able to see the new key before finalizing the reset request so that you can copy it to wherever it needs to be updated.

<llms-ignore>

<Frame caption="the API Credentials page">

![The SignalWire Space showing API credentials, including Signing Key](/assets/images/dashboard/credentials/api-credentials-with-signing-key.webp)

</Frame>

</llms-ignore>

<llms-only>

In the Dashboard, open **API Credentials**, find **Signing Key**, and select **Show**. Copy the key for the project whose webhook requests you are verifying.

</llms-only>

## Verifying the webhook signature

### NodeJs
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -44,10 +44,20 @@ Authorization: Basic YTFiMmMzZDQtZTVmNi03ODkwLWFiY2QtZWYxMjM0NTY3ODkwOjR0akNHbm1
Your Project ID and API Tokens are available in the
[SignalWire Dashboard](/docs/platform/your-signalwire-api-space).

<llms-ignore>

<Frame>
<img src="/assets/images/dashboard/credentials/api-credentials.webp" alt="API credentials in the Dashboard." />
</Frame>

</llms-ignore>

<llms-only>

In the Dashboard, open **API Credentials**. Copy the **Project ID**, then reveal and copy an existing API token or select **+ New** to create one.

</llms-only>

### API token scopes

Tokens can be scoped to limit API access.
Expand Down
30 changes: 30 additions & 0 deletions fern/products/platform/pages/calling/fax/overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -51,11 +51,21 @@ If you don't have a number yet, navigate to the Phone Numbers section and [buy a

From your [SignalWire Dashboard](https://my.signalwire.com/dashboard), create a new Resource by navigating to the resources tab, then select the "New Script" option and choose "New SWML application".

<llms-ignore>

<Frame caption="Navigating to and creating a new SWML resource for handling faxes.">
![The new resource dialog showing SWML script
creation.](/assets/images/dashboard/resources/swml-resource-vid.webp)
</Frame>

</llms-ignore>

<llms-only>

In the Dashboard, open **My Resources**, select **+ Add New** > **Script** > **SWML Application**, then create a hosted script for the fax-handling SWML.

</llms-only>

Paste the following code into your script:

```yaml
Expand Down Expand Up @@ -97,11 +107,21 @@ Navigate to the "Phone Numbers" tab on the left sidebar.
From this tab, click on your newly purchased phone number, then on the "edit settings" option.
In the settings page that appears, select "Assign Resource" for "Inbound Call Settings".

<llms-ignore>

<Frame caption="Assign the script to your phone number's inbound call settings.">
![Phone number settings page showing the Assign Resource button for inbound
calls.](/assets/images/dashboard/phone-numbers/assign-resource-full.webp)
</Frame>

</llms-ignore>

<llms-only>

On the phone number's edit page, select **+ Assign Resource** under **Inbound Call Settings**, choose the fax script, and save.

</llms-only>


Select the newly created script, then click "Save" to apply the configuration.

Expand All @@ -112,10 +132,20 @@ Send a test fax to your configured phone number and then open the respective cal

Copy the link found in the **Document** parameter and paste it into your browser to view your fax.

<llms-ignore>

<Frame caption="View your received faxes in the dashboard logs.">
![The logs page showing voice logs where inbound faxes will be received.](/assets/images/dashboard/sidebar/voice-logs.webp)
</Frame>

</llms-ignore>

<llms-only>

Open **Logs** > **Calling**, select the fax call's log entry, and copy the URL in its **Document** field to view the received fax.

</llms-only>

</Steps>

<Info>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -57,8 +57,18 @@ See [Buying a Phone Number](/docs/platform/phone-numbers) for step-by-step instr

In the number's setting, click on the "Assign Resource" button and select your SIP endpoint resource.

<llms-ignore>

![Assign SIP Endpoint.](/assets/images/dashboard/phone-numbers/assign-resource-voice.webp)

</llms-ignore>

<llms-only>

In the Dashboard, open **Phone Numbers** > **Purchased**, select the number, and open its edit page. Under **Inbound Call Settings**, select **+ Assign Resource**, choose the SIP Endpoint Resource, and save.

</llms-only>

<Markdown src="/snippets/common/dashboard/_resource-admonition.mdx" />

If you prefer to use API calls, you will need the [Search for Available Phone Numbers](/docs/apis/rest/phone-numbers/search-available-phone-numbers),
Expand Down Expand Up @@ -133,6 +143,8 @@ that you would like to register, and then click `Edit Settings` button. From her
`Handle Incoming Calls` section, select `SIP Endpoint`, then input the SIP address you created.


<llms-ignore>

<img
class="img-1080"
src="/assets/images/dashboard/legacy/sip/sip-config.webp"
Expand All @@ -142,6 +154,14 @@ that you would like to register, and then click `Edit Settings` button. From her
Register SIP Endpoint to a SignalWire Phone Number
</figcaption>

</llms-ignore>

<llms-only>

In the legacy Dashboard, edit the phone number, set **Accept Incoming Calls as** to **Voice Calls**, set **Handle Calls Using** to **a SIP Endpoint**, and select the SIP address under **When a Call Comes In, Forward the Call to**.

</llms-only>


</Accordion>

Expand Down
4 changes: 1 addition & 3 deletions fern/products/platform/pages/calling/voice/TTS/fish.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -133,9 +133,7 @@ Navigate to the **Phone Numbers** section of the Dashboard's left sidebar menu.

Purchase a phone number and assign it to the desired SWML script.

<Frame caption="Assigning a phone number to the SWML Script">
![A purchased phone number showing assignment to a specified Resource.](/assets/images/dashboard/phone-numbers/assign-resource-voice.webp)
</Frame>
<Markdown src="/snippets/common/dashboard/_assign-resource-voice.mdx" />

### Give it a call!

Expand Down
4 changes: 1 addition & 3 deletions fern/products/platform/pages/calling/voice/TTS/grok.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -96,9 +96,7 @@ Navigate to the **Phone Numbers** section of the Dashboard's left sidebar menu.

Purchase a phone number and assign it to the desired SWML script.

<Frame caption="Assigning a phone number to the SWML Script">
![A purchased phone number showing assignment to a specified Resource.](/assets/images/dashboard/phone-numbers/assign-resource-voice.webp)
</Frame>
<Markdown src="/snippets/common/dashboard/_assign-resource-voice.mdx" />

### Give it a call!

Expand Down
4 changes: 1 addition & 3 deletions fern/products/platform/pages/calling/voice/TTS/groq-tts.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -153,9 +153,7 @@ Navigate to the **Phone Numbers** section of the Dashboard's left sidebar menu.

Purchase a phone number and assign it to the desired SWML script.

<Frame caption="Assigning a phone number to the SWML Script">
![A purchased phone number showing assignment to a specified Resource.](/assets/images/dashboard/phone-numbers/assign-resource-voice.webp)
</Frame>
<Markdown src="/snippets/common/dashboard/_assign-resource-voice.mdx" />

### Give it a call!

Expand Down
4 changes: 1 addition & 3 deletions fern/products/platform/pages/calling/voice/TTS/inworld.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -155,9 +155,7 @@ Navigate to the **Phone Numbers** section of the Dashboard's left sidebar menu.

Purchase a phone number and assign it to the desired SWML script.

<Frame caption="Assigning a phone number to the SWML Script">
![A purchased phone number showing assignment to a specified Resource.](/assets/images/dashboard/phone-numbers/assign-resource-voice.webp)
</Frame>
<Markdown src="/snippets/common/dashboard/_assign-resource-voice.mdx" />

### Give it a call!

Expand Down
4 changes: 1 addition & 3 deletions fern/products/platform/pages/calling/voice/TTS/minimax.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -145,9 +145,7 @@ Navigate to the **Phone Numbers** section of the Dashboard's left sidebar menu.

Purchase a phone number and assign it to the desired SWML script.

<Frame caption="Assigning a phone number to the SWML Script">
![A purchased phone number showing assignment to a specified Resource.](/assets/images/dashboard/phone-numbers/assign-resource-voice.webp)
</Frame>
<Markdown src="/snippets/common/dashboard/_assign-resource-voice.mdx" />

### Give it a call!

Expand Down
4 changes: 1 addition & 3 deletions fern/products/platform/pages/calling/voice/TTS/mistral.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -136,9 +136,7 @@ Navigate to the **Phone Numbers** section of the Dashboard's left sidebar menu.

Purchase a phone number and assign it to the desired SWML script.

<Frame caption="Assigning a phone number to the SWML Script">
![A purchased phone number showing assignment to a specified Resource.](/assets/images/dashboard/phone-numbers/assign-resource-voice.webp)
</Frame>
<Markdown src="/snippets/common/dashboard/_assign-resource-voice.mdx" />

### Give it a call!

Expand Down
Loading
Loading