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
Original file line number Diff line number Diff line change
Expand Up @@ -598,7 +598,7 @@ Read on how to create a Maven project with Intellij [here](https://www.jetbrains

** How to get API Credentials **

The API also requires that you authenticate yourself using your Project ID, API Token, and Space URL. If you do not know where to find these values, check out our guide [here](/platform/dashboard/get-started/explore#api)!
The API also requires that you authenticate yourself using your Project ID, API Token, and Space URL. Find these values on the [API Credentials page](https://my.signalwire.com?page=credentials) of your SignalWire Space.

### How to Run Snippet?

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -571,7 +571,7 @@ Read on how to create a Maven project with Intellij [here](https://www.jetbrains

** How to get API Credentials **

The API also requires that you authenticate yourself using your Project ID, API Token, and Space URL. If you do not know where to find these values, check out our guide [here](/platform/dashboard/get-started/explore#api)!
The API also requires that you authenticate yourself using your Project ID, API Token, and Space URL. Find these values on the [API Credentials page](https://my.signalwire.com?page=credentials) of your SignalWire Space.

### How to Run Snippet?

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,9 +22,9 @@ Redacting Messages Immediately after Sending
This guide will use the [SignalWire Python SDK](/compatibility-api/sdks).
Specifically, we will be working with the [Update Message API](/rest/compatibility-api/endpoints/update-message) and the
[Delete Message API](/rest/compatibility-api/endpoints/delete-message).
You will also need your SignalWire API credentials.
You can get them by logging into your SignalWire Space and navigating to the API tab.
For more information, read our guide to [Navigating your SignalWire Space](/platform/dashboard/get-started/explore).
You will also need your SignalWire API credentials, found on the
[API Credentials page](https://my.signalwire.com?page=credentials)
page of your SignalWire Dashboard.

#### How to Run Application

Expand Down Expand Up @@ -85,7 +85,9 @@ We will need the following libraries (click their names to get instructions on h

- [SignalWire Rest Client](https://www.npmjs.com/package/@signalwire/compatibility-api)

You will also need your SignalWire API credentials. You can get them by logging into your SignalWire Space and navigating to the API tab. For more information on navigating your SignalWire Space check [here](/platform/dashboard/get-started/explore)
You will also need your SignalWire API credentials, found on the
[API Credentials page](https://my.signalwire.com?page=credentials)
page of your SignalWire Dashboard.

#### How to Run Application

Expand Down Expand Up @@ -187,8 +189,9 @@ Specifically we will be working with the [Update Message API](/rest/compatibilit
and the [Delete Message API](/rest/compatibility-api/endpoints/delete-message).
Additionally this project will use [Flask](https://flask.palletsprojects.com/en/2.0.x/installation/),
and of course you will need your SignalWire API credentials.
You can get them by logging into your SignalWire Space and navigating to the API tab.
For more information, read our guide to [Navigating your SignalWire Space](/platform/dashboard/get-started/explore).
Find this information on the
[API Credentials page](https://my.signalwire.com?page=credentials)
page of your SignalWire Dashboard.

#### Step by Step Code Walkthrough

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -102,7 +102,7 @@ This means your first column for your customer’s phone number is associated wi
### Securely save your SignalWire credentials

Whenever you’re using SignalWire’s API, you’ll need to provide your Project ID, Auth Token and Space URL.
You can access all 3 of these from the [API menu](/platform/dashboard/get-started/explore#api) on your SignalWire Dashboard.
You can access all 3 of these from the [API Credentials page](https://my.signalwire.com?page=credentials) on your SignalWire Dashboard.
In this guide we are sending SMS so we also need a SignalWire phone number that you can send SMS from.
If you don’t have a SignalWire phone number yet,
[please reference this guide on purchasing a number.](/platform/phone-numbers/getting-started/buying-a-phone-number)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -747,7 +747,7 @@ Read on how to create a Maven project with Intellij [here](https://www.jetbrains

** How to get API Credentials **

The API also requires that you authenticate yourself using your Project ID, API Token, and Space URL. If you do not know where to find these values, check out our guide [here](/platform/dashboard/get-started/explore#api)!
The API also requires that you authenticate yourself using your Project ID, API Token, and Space URL. Find these values on the [API Credentials page](https://my.signalwire.com?page=credentials) of your SignalWire Space.

### How to Run Snippet?

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -301,7 +301,7 @@ Read about the SignalWire Python SDK and how to install [here](/compatibility-ap

** How to get API Credentials **

The API also requires that you authenticate yourself using your Project ID, API Token, and Space URL. If you do not know where to find these values, check out our guide [here](/platform/dashboard/get-started/explore#api)!
The API also requires that you authenticate yourself using your Project ID, API Token, and Space URL. Find these values on the [API Credentials page](https://my.signalwire.com?page=credentials) of your SignalWire Space.

### How to Run Snippet?

Expand Down Expand Up @@ -379,7 +379,7 @@ You will also need to make sure that the vendor/autoload.php path points to the

** How to get API Credentials **

The API also requires that you authenticate yourself using your Project ID, API Token, and Space URL. If you do not know where to find these values, check out our guide [here](/platform/dashboard/get-started/explore#api)!
The API also requires that you authenticate yourself using your Project ID, API Token, and Space URL. Find these values on the [API Credentials page](https://my.signalwire.com?page=credentials) of your SignalWire Space.

### How to Run Snippet?

Expand Down Expand Up @@ -458,7 +458,7 @@ Read about CSV and how to install [here](https://rubygems.org/gems/csv/versions/

** How to get API Credentials **

The API also requires that you authenticate yourself using your Project ID, API Token, and Space URL. If you do not know where to find these values, check out our guide [here](/platform/dashboard/get-started/explore#api)!
The API also requires that you authenticate yourself using your Project ID, API Token, and Space URL. Find these values on the [API Credentials page](https://my.signalwire.com?page=credentials) of your SignalWire Space.

### How to Run Snippet?

Expand Down Expand Up @@ -518,7 +518,7 @@ In this case, we need to import `@signalwire/compatibility-api` and `fs`.

** How to get API Credentials **

The API also requires that you authenticate yourself using your Project ID, API Token, and Space URL. If you do not know where to find these values, check out our guide [here](/platform/dashboard/get-started/explore#api)!
The API also requires that you authenticate yourself using your Project ID, API Token, and Space URL. Find these values on the [API Credentials page](https://my.signalwire.com?page=credentials) of your SignalWire Space.

### How to Run Snippet?

Expand Down Expand Up @@ -576,7 +576,7 @@ For the following code to work, you will need to have a Maven project, The Java
Read about how to get started with the Java Wrapper API [here](https://github.com/signalwire-community/compatibility-api-java)

** How to get API Credentials **
The API also requires that you authenticate yourself using your Project ID, API Token, and Space URL. If you do not know where to find these values, check out our guide [here](/platform/dashboard/get-started/explore#api)!
The API also requires that you authenticate yourself using your Project ID, API Token, and Space URL. Find these values on the [API Credentials page](https://my.signalwire.com?page=credentials) of your SignalWire Space.

### How to Run Snippet?

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,10 @@ This guide will use the SignalWire Python SDK to get a list of owned DIDs, and c

## What do I need to run this?

You will only need the [SignalWire Python SDK](/compatibility-api/sdks), and your SignalWire API credentials. If you aren't sure where to find your credentials, check out [this](/platform/dashboard/get-started/explore) guide on naviating your Space.
You will only need the [SignalWire Python SDK](/compatibility-api/sdks), and your SignalWire API credentials.
Find this information on the
[API Credentials page](https://my.signalwire.com?page=credentials)
page of your SignalWire Dashboard.

## How do I run this code?

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,10 @@ What do I need to run this code?
--------------------------------


You will need the [SignalWire Python SDK](/compatibility-api/sdks) as well as your authentication variables which can easily be found in the **API** tab of your SignalWire Space.
View [here](/platform/dashboard/get-started/explore#api) to see more about navigating your Space and how to find authentication variables.
You will need the [SignalWire Python SDK](/compatibility-api/sdks) as well as your authentication variables
which can easily be found in the
[API Credentials page](https://my.signalwire.com?page=credentials)
page of your SignalWire Dashboard.

In order to store the message data and export to a CSV, you will need the [pandas](https://pandas.pydata.org/) library.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -23,9 +23,9 @@ Find the full code on Github [here](https://github.com/signalwire/signalwire-gui
You will need the [SignalWire Python SDK](/compatibility-api/sdks) as well as [Flask](https://flask.palletsprojects.com/en/2.0.x/installation/#install-flask) to handle the web framework.

Additionally, you will need a SignalWire account which you can create [here](https://m.signalwire.com/signups/new?s=1).
You will also need your SignalWire API credentials which you can find in the `API` tab of your SignalWire Dashboard.
For more information, read our guide to
[Navigating your SignalWire Space](/platform/dashboard/get-started/explore).
You will also need your SignalWire API credentials which you can find in the
[API Credentials page](https://my.signalwire.com?page=credentials)
page of your SignalWire Dashboard.

How to run
----------
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -38,8 +38,8 @@ Signing in with your SignalWire username and password will bring you to the Dash
:::info Additional Information

While bins can be created and updated [programmatically](/rest/compatibility-api/endpoints/create-application),
this guide will walk you through cXML scripts via the SignalWire Dashboard.
For more on the Dashboard, see our guide to [Navigating Your SignalWire Space](/platform/dashboard/get-started/explore).
this guide will walk you through cXML scripts via the
[SignalWire Dashboard](/platform/dashboard).

:::

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,9 +22,9 @@ This advanced example builds an application that implements a simple phone tree
Check out the full code on our Github Repository [here](https://github.com/signalwire/signalwire-guides/tree/master/code/node_ivr).

You will need the [SignalWire Node.JS SDK](/compatibility-api/sdks), and your SignalWire Credentials.
Find these by logging into your SignalWire Space and navigating to the API tab.
For more information, read our guide to
[Navigating your SignalWire Space](/platform/dashboard/get-started/explore).
Find this information on the
[API Credentials page](https://my.signalwire.com?page=credentials)
page of your SignalWire Dashboard.

The application also uses the [Express](https://expressjs.com/en/starter/installing.html) web framework and
[Mailgun](https://www.mailgun.com/) to send the emails, and you will need an API key from that service.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,9 @@ API_TOKEN=
SIGNALWIRE_URL=
```

If you need help finding this information, check out our guide to [Navigating Your SignalWire Space](/platform/dashboard/get-started/explore#api).
Find this information on the
[API Credentials page](https://my.signalwire.com?page=credentials)
of your SignalWire Dashboard.

The Compatibility SDK will pull these environmental variables from the `.env` file without any import statement as long as the `.env` file is in the same parent directory.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -295,7 +295,10 @@ Read about DateTime and how to [install using pip](https://pypi.org/project/Date

Read about the [SignalWire Python SDK and how to install it](/compatibility-api/sdks).

The API also requires that you authenticate yourself using your Project ID, API Token, and Space URL. If you do not know where to find these values, check out our guide to [Navigating your SignalWire Space](/platform/dashboard/get-started/explore).
The API also requires that you authenticate yourself using your Project ID, API Token, and Space URL.
Find this information on the
[API Credentials page](https://my.signalwire.com?page=credentials)
page of your SignalWire Dashboard.

### Step by Step Code Walkthrough

Expand Down Expand Up @@ -358,7 +361,10 @@ We will need the following libraries (click their names to get instructions on h
- [Gson](https://github.com/google/gson)
- [Unirest](https://github.com/Kong/unirest-java#installing)

The API also requires that you authenticate yourself using your Project ID, API Token, and Space URL. if you do not know where to find these values, check out our guide to [Navigate your SignalWire Space](/platform/dashboard/get-started/explore)
The API also requires that you authenticate yourself using your Project ID, API Token, and Space URL.
Find this information on the
[API Credentials page](https://my.signalwire.com?page=credentials)
page of your SignalWire Dashboard.

### Step by Step Code Walkthrough

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,11 @@ While this snippet will provide you with a lot of information, it can easily be

## What do I need to run this code?

As we will be using Python for this script, you will need to install the [SignalWire Python SDK](/compatibility-api/sdks). Once installed, you will also need your SignalWire API credentials, including an **API Token, SignalWire Space URL, and a Project ID**. All of this information can be found under the **API** tab of your SignalWire Space, however, you can find more information on where to look [here](/platform/dashboard/get-started/explore).
As we will be using Python for this script, you will need to install the [SignalWire Python SDK](/compatibility-api/sdks).
Once installed, you will also need your SignalWire API credentials, including an **API Token, SignalWire Space URL, and a Project ID**.
Find this information on the
[API Credentials page](https://my.signalwire.com?page=credentials)
page of your SignalWire Dashboard.

You will need to have a few different Python Packages installed as well to achieve this.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,9 +20,10 @@ You will need the [SignalWire Python SDK](/compatibility-api/sdks) as well as [F
[oauth2client](https://pypi.org/project/oauth2client/) are all a part of our google sheets integration.

Additionally you will need a SignalWire account, which you can create [here](https://m.signalwire.com/signups/new?s=1).
You will also need your SignalWire API credentials which you can find in the `API` tab of your SignalWire Dashboard.
For more information, read our guide to
[Navigating your SignalWire Space](/platform/dashboard/get-started/explore).
You will also need your SignalWire API credentials.
Find this information on the
[API Credentials page](https://my.signalwire.com?page=credentials)
page of your SignalWire Dashboard.

How to run this application
---------------------------
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,9 @@ API_TOKEN=
SIGNALWIRE_URL=
```

If you need help finding this information, check out our guide to [Navigating Your SignalWire Space](/platform/dashboard/get-started/explore#api).
Find this information on the
[API Credentials page](https://my.signalwire.com?page=credentials)
page of your SignalWire Dashboard.

The Compatibility SDK will pull these environmental variables from the `.env` file without any import statement as long as the `.env` file is in the same parent directory.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,9 +18,10 @@ What do I need to run this code?
Find the full code on Github [here](https://github.com/signalwire/snippets-voice-2-factor-auth)

You will need a signalwire account which you can create [here](https://m.signalwire.com/signups/new?s=1).
You will also need your SignalWire API credentials which you can find in the `API` tab of your SignalWire Dashboard.
For more information, read our guide to
[Navigating your SignalWire Space](/platform/dashboard/get-started/explore).
You will also need your SignalWire API credentials.
Find this information on the
[API Credentials page](https://my.signalwire.com?page=credentials)
page of your SignalWire Dashboard.

Additionally you will need the [SignalWire Python SDK](/compatibility-api/sdks), the [Requests](https://pypi.org/project/requests/) module, and [Flask](https://flask.palletsprojects.com/en/2.0.x/installation/#install-flask)

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,10 @@ There are two ways you could run this script easily. The first way is through us
- [Docker](https://www.docker.com/get-started)
- [Flask](https://flask.palletsprojects.com/en/2.0.x/)

As with all guides and snippets, you will need your API credentials **(SignalWire Space URL, API Token, and Project ID)**. These can be found under the **API** tab of your SignalWire Space. For more information around that, check [here](/platform/dashboard/get-started/explore).
As with all guides and snippets, you will need your API credentials **(SignalWire Space URL, API Token, and Project ID)**.
Find this information on the
[API Credentials page](https://my.signalwire.com?page=credentials)
page of your SignalWire Dashboard.

Code Breakdown
--------------
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,10 @@ You can view the full code on our GitHub [HERE](https://github.com/signalwire/gu

The [SignalWire Ruby SDK](/compatibility-api/sdks) will need to be installed.

Your SignalWire credentials (**API Token**, **Space URL**, and **Project ID**) can all be found in an easily copyable format within the **API** tab of your SignalWire portal. For more information on navigating your Space check out this [guide](/platform/dashboard/get-started/explore).
Your SignalWire credentials (**API Token**, **Space URL**, and **Project ID**) can all be found in an easily copyable format within the **API** tab of your SignalWire portal.
Find this information on the
[API Credentials page](https://my.signalwire.com?page=credentials)
page of your SignalWire Dashboard.

Lastly, you will need to install some additional Ruby packages:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,10 @@ You will also need some additional packages:
[Sinatra](https://github.com/sinatra/sinatra) for quickly creating web applications in Ruby
[Dotenv](https://github.com/bkeepers/dotenv) for managing our environment variables

As well as a SignalWire account which you can create [here](https://m.signalwire.com/signups/new?s=1), and your SignalWire Space credentials which can be found in the API tab of your SignalWire Space. For more information on navigating your Space check out this [guide](/platform/dashboard/get-started/explore).
As well as a SignalWire account which you can create [here](https://m.signalwire.com/signups/new?s=1), and your SignalWire API credentials.
Find this information on the
[API Credentials page](https://my.signalwire.com?page=credentials)
page of your SignalWire Dashboard.

Running the Application
-----------------------
Expand Down
2 changes: 1 addition & 1 deletion website/docs/main/home/calling/ai/get-started/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,7 @@ Add funds to your SignalWire Space in order to purchase a phone number and initi

</div>
<div className="col col--4">
![The left drop-down menu for your SignalWire Space.](@image/dashboard/left-menu/menu.png)
![The left drop-down menu for your SignalWire Space.](@image/dashboard/left-menu/menu.webp)
</div>
</div>

Expand Down
Loading