Skip to content
2 changes: 1 addition & 1 deletion website/blog/releases/realtime-api/3.0.0/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ tags: [sdk, release]
date: 2022-05-19T00:01
---

We are happy to announce the release for the **Relay Realtime-API SDK 3.0.0**!
We are happy to announce the release for the **RELAY Realtime-API SDK 3.0.0**!

:::danger This Is A Major Release
When upgrading to this version from a previous version, please be aware that there may be breaking changes.
Expand Down
12 changes: 6 additions & 6 deletions website/blog/releases/realtime-api/4.0.0/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,11 @@ tags: [sdk, release]
date: 2024-04-17
---

We are happy to announce the release for the **Relay Realtime-API SDK 4.0.0**!
We are happy to announce the release for the **RELAY Realtime-API SDK 4.0.0**!

:::danger This Is A Major Release
When upgrading to this version from a previous version, please be aware that there may be breaking changes.
Please check out our [Upgrading to Relay v4 Guide](/sdks/realtime-sdk/v3/guides/realtime-relay-v4-vs-v3) for more information.
Please check out our [Upgrading to RELAY v4 Guide](/sdks/realtime-sdk/v3/guides/realtime-relay-v4-vs-v3) for more information.
:::

Future updates will adhere to [Semantic Versioning](https://semver.org/).
Expand All @@ -23,7 +23,7 @@ This means you can upgrade with confidence knowing that new versions will not br
{/* truncate */}


This marks the release of SignalWires new Relay Realtime-api v4 SDK.
This marks the release of SignalWires new RELAY Realtime-api v4 SDK.
This SDK strives to model the SDK after the concept of PUC (Programmable Unified Communications.)
The v4 SDK will include all the namespaces that were originally included in the v3 SDK:

Expand All @@ -35,7 +35,7 @@ The v4 SDK will include all the namespaces that were originally included in the
- `Task`

## Setting Up a Single Client in v4
- In Relay v4, a single client instance provides access to all namespaces, simplifying the development process and reducing code complexity. This unified client architecture makes the system more maintainable and efficient, offering a streamlined approach to accessing different functionalities within the Relay ecosystem.
- In RELAY v4, a single client instance provides access to all namespaces, simplifying the development process and reducing code complexity. This unified client architecture makes the system more maintainable and efficient, offering a streamlined approach to accessing different functionalities within the RELAY ecosystem.
This shift in architecture reflects a more modern and developer-friendly approach, focusing on ease of integration and simplicity, which are key in today's fast-paced development environments.


Expand All @@ -51,9 +51,9 @@ const messagingClient = client.messaging;
```
---

## Advanced Event Listening in Relay v4
## Advanced Event Listening in RELAY v4

Relay v4 introduces a new approach, offering more granular control over applications by allowing
RELAY v4 introduces a new approach, offering more granular control over applications by allowing
listening to events not only on the `Call` and `RoomSession` but also on particular sessions through a new method/parameter called `listen`.
Examples of some sessions that can be directly listened to are: `Collects`, `Recordings`, `Playback`, `Detects`, etc.

Expand Down
2 changes: 1 addition & 1 deletion website/blog/releases/realtime-api/4.1.1/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ tags: [sdk, release]
date: 2025-03-05
---

We are happy to announce the release for the **Relay Realtime-API SDK 4.1.1**!
We are happy to announce the release for the **RELAY Realtime-API SDK 4.1.1**!

Future updates will adhere to [Semantic Versioning](https://semver.org/).
This means you can upgrade with confidence knowing that new versions will not break your code from minor updates.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,7 @@ Here are several use-cases, classified according to the SDK that is most indicat
| Remote work | Call center |
| Remote conferencing | Patient consultation |

[relay_sdk]: https://www.npmjs.com/package/@signalwire/js/v/1.2.7
[RELAY_sdk]: https://www.npmjs.com/package/@signalwire/js/v/1.2.7
[javascript_sdk]: https://www.npmjs.com/package/@signalwire/js
[sec_relay_sdk]: #i-am-building-a-one-to-one-communication-app-which-should-dial-other-browsers-or-phones
[sec_RELAY_sdk]: #i-am-building-a-one-to-one-communication-app-which-should-dial-other-browsers-or-phones
[sec_javascript_sdk]: #i-am-building-an-audiovideo-conferencing-application
26 changes: 13 additions & 13 deletions website/browser-sdk_versioned_docs/version-v2/index.mdx
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
---
title: Relay SDK for JavaScript
title: RELAY SDK for JavaScript
sidebar_label: Overview
---

# Relay SDK for JavaScript
# RELAY SDK for JavaScript

The Relay JavaScript SDK transforms your standard browser into a realtime media engine, enabling developers to directly make audio and video calls to phone numbers, SIP endpoints, and other browsers. Using the JavaScript SDK you can add immersive, scalable communication - from video conferences and softphones to click-to-call and mobile gaming - all available right in your own web pages and applications.
The RELAY JavaScript SDK transforms your standard browser into a realtime media engine, enabling developers to directly make audio and video calls to phone numbers, SIP endpoints, and other browsers. Using the JavaScript SDK you can add immersive, scalable communication - from video conferences and softphones to click-to-call and mobile gaming - all available right in your own web pages and applications.

SignalWire's simple and powerful authentication system, using JWT, allows you to set granular permissions, enabling some of your users to only join conference calls, while others could list on-going calls and jump in to assist from a support dashboard... the possibilities are endless.

Expand All @@ -15,7 +15,7 @@ SignalWire's simple and powerful authentication system, using JWT, allows you to

## Installation

The Relay SDK for JavaScript is easy to use and only takes a few minute to setup and get running.
The RELAY SDK for JavaScript is easy to use and only takes a few minute to setup and get running.

### CDN

Expand Down Expand Up @@ -59,23 +59,23 @@ SignalWire uses [JSON Web Tokens (JWT)](https://en.wikipedia.org/wiki/JSON_Web_T

### How Does It Work?

You start by creating a token on your server and specify what capabilities and permissions you'd like your endpoint to have. You can then connect to Relay within the SDKs using your `Project ID` and `JWT`.
You start by creating a token on your server and specify what capabilities and permissions you'd like your endpoint to have. You can then connect to RELAY within the SDKs using your `Project ID` and `JWT`.

Think of it as if you are generating a long, temporary password for each endpoint you want to connect. There is no limit to the number of JWTs you can generate.

### Security

Security is one of the basic principles of SignalWire and Relay, and we use JSON Web Tokens for client-side authorization because they are an open, industry standard method of securely representing authorization between two parties.
Security is one of the basic principles of SignalWire and RELAY, and we use JSON Web Tokens for client-side authorization because they are an open, industry standard method of securely representing authorization between two parties.

Relay JWT allows you to specify find-grained permissions, or _scopes_, to determine what access rights are granted, as well as expiration and identification. These settings are determined by you and signed by SignalWire when the JWT is created and cannot be altered or tampered with on the client-side.
RELAY JWT allows you to specify find-grained permissions, or _scopes_, to determine what access rights are granted, as well as expiration and identification. These settings are determined by you and signed by SignalWire when the JWT is created and cannot be altered or tampered with on the client-side.

### Expiration

All Relay JWT have an expiration time, to protect from abuse. When a token's expiration is up, the client will be disconnected from Relay automatically.
All RELAY JWT have an expiration time, to protect from abuse. When a token's expiration is up, the client will be disconnected from RELAY automatically.

By default, all Relay JWT have an expiration time of 15 minutes, but you should create tokens with the shortest possible expiration that makes sense for your application.
By default, all RELAY JWT have an expiration time of 15 minutes, but you should create tokens with the shortest possible expiration that makes sense for your application.

Relay JWT can also easily be _refreshed_, updating an existing token with a new expiration time. This allows you to create tokens with short expirations that can be frequently extended as required by your application.
RELAY JWT can also easily be _refreshed_, updating an existing token with a new expiration time. This allows you to create tokens with short expirations that can be frequently extended as required by your application.

### Resource

Expand Down Expand Up @@ -142,7 +142,7 @@ curl https://your-space.signalwire.com/api/relay/rest/jwt \

### Generate a JWT

To generate a JWT, make a server-side `POST` request to the JWT endpoint on the Relay REST API.
To generate a JWT, make a server-side `POST` request to the JWT endpoint on the RELAY REST API.

```shell
curl https://your-space.signalwire.com/api/relay/rest/jwt \
Expand All @@ -164,7 +164,7 @@ For more information and examples on generating JSON Web Tokens, see [Authentica

### Connect using JWT

Using the JWT you received in the previous step, you can connect to Relay using your **Project ID** and the **JWT**.
Using the JWT you received in the previous step, you can connect to RELAY using your **Project ID** and the **JWT**.

```javascript
const client = new Relay({
Expand All @@ -173,7 +173,7 @@ const client = new Relay({
});
```

You can then use `client` to make Relay requests.
You can then use `client` to make RELAY requests.

### Refresh JWT Token

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@ call.deaf()

### dtmf

Send a Dual Tone Multi Frequency (DTMF) string to Relay.
Send a Dual Tone Multi Frequency (DTMF) string to RELAY.

**Parameters**

Expand Down
Original file line number Diff line number Diff line change
@@ -1,16 +1,16 @@
---
title: Relay Client
sidebar_label: Relay Client
title: RELAY Client
sidebar_label: RELAY Client
slug: /client
---

# Relay Client
# RELAY Client

`Relay` client is the basic connection to Relay, allowing you send commands to Relay and setup handlers for inbound events.
`Relay` client is the basic connection to RELAY, allowing you send commands to RELAY and setup handlers for inbound events.

## Constructor

Constructs a client object to interact with Relay.
Constructs a client object to interact with RELAY.

**Parameters**

Expand All @@ -21,7 +21,7 @@ Constructs a client object to interact with Relay.

**Examples**

> Create a Client to interact with the Relay API.
> Create a Client to interact with the RELAY API.

```javascript
const client = new Relay({
Expand All @@ -40,7 +40,7 @@ client.connect()

| Name | Type | Description |
| - | - | - |
| `connected` | `boolean` | `true` if the client has connected to Relay. |
| `connected` | `boolean` | `true` if the client has connected to RELAY. |
| `expired` | `boolean` | `true` if the JWT has expired. |

## Devices and Media Constraints
Expand Down Expand Up @@ -140,7 +140,7 @@ if (success) {

### connect

Activates the connection to Relay. Make sure you have attached the listeners you need before connecting the client, or you might miss some events.
Activates the connection to RELAY. Make sure you have attached the listeners you need before connecting the client, or you might miss some events.

**Returns**

Expand All @@ -154,7 +154,7 @@ await client.connect()

### disconnect

Disconnect the client from Relay.
Disconnect the client from RELAY.

**Returns**

Expand Down
2 changes: 1 addition & 1 deletion website/docs/browser-sdk/_category_.yaml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
label: Relay Browser SDK
label: RELAY Browser SDK
position: 0
collapsed: true
collapsible: false
2 changes: 1 addition & 1 deletion website/docs/browser-sdk/guides/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ sidebar_custom_props:
hideFromIndex: true
---

This section contains guides for using the Relay browser SDK v3.
This section contains guides for using the RELAY browser SDK v3.

<DocCardList />

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -64,13 +64,13 @@ The URL for the preview image will be in the attribute, `preview_url` for the ro

#### RELAY v3

For Realtime API (Relay v3), you can add an event listener for
For Realtime API (RELAY v3), you can add an event listener for
[`room.started`](/sdks/realtime-sdk/video/client#onroomstarted)
event to get new room sessions as they are created.

#### RELAY v4

For Realtime API (Relay v4), you can add an event listener for
For Realtime API (RELAY v4), you can add an event listener for
[`onRoomStarted`](/sdks/realtime-sdk/video/client#onroomstarted)
event to get new room sessions as they are created.

Expand Down
2 changes: 1 addition & 1 deletion website/docs/browser-sdk/guides/video/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,6 @@ title: Video Guides
slug: /guides/video
---

This section contains video guides for using the Relay browser SDK v3.
This section contains video guides for using the RELAY browser SDK v3.

<DocCardList />
2 changes: 1 addition & 1 deletion website/docs/main/_common/context_topic.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@
incoming calls or messages) only for the numbers in A, only for the numbers in B, or
for both. We are going to use "office" in this guide, but you can pick any name.

:::info Topic was called "Context" in the older Relay versions
:::info Topic was called "Context" in the older RELAY versions

:::

Expand Down
20 changes: 10 additions & 10 deletions website/docs/main/_common/languageSwitcher.mdx
Original file line number Diff line number Diff line change
@@ -1,16 +1,16 @@
<Language groupId="relay_version">
<LangItem value="relayv4">

:::info This guide is using Relay V4
:::info This guide is using RELAY V4

This guide is available for Relay V3 and for Relay V4. You are currently viewing the guide for **Relay V4**. To switch to the older
Relay V3 guide, please use the selection field below:
This guide is available for RELAY V3 and for RELAY V4. You are currently viewing the guide for **RELAY V4**. To switch to the older
RELAY V3 guide, please use the selection field below:

<LangSwitch
groupId="relay_version"
groupIds={[
{ label: "Relay V4", value: "relayv4" },
{ label: "Relay V3", value: "relayv3" },
{ label: "RELAY V4", value: "relayv4" },
{ label: "RELAY V3", value: "relayv3" },
]}
/>

Expand All @@ -19,16 +19,16 @@ Relay V3 guide, please use the selection field below:
</LangItem>
<LangItem value="relayv3">

:::warning This guide is using the older Relay V3
:::warning This guide is using the older RELAY V3

This guide is available for Relay V3 and for Relay V4. You are currently viewing the guide for **Relay V3**.
Unless you have strong reason for using Relay V3, please switch to the latest version.
This guide is available for RELAY V3 and for RELAY V4. You are currently viewing the guide for **RELAY V3**.
Unless you have strong reason for using RELAY V3, please switch to the latest version.

<LangSwitch
groupId="relay_version"
groupIds={[
{ label: "Relay V4", value: "relayv4" },
{ label: "Relay V3", value: "relayv3" },
{ label: "RELAY V4", value: "relayv4" },
{ label: "RELAY V3", value: "relayv3" },
]}
/>

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -331,7 +331,7 @@ client.incomingPhoneNumbers
Wrap Up
-------

This script uses both the REST API and Relay REST API n order to query all numbers in your project, compare with a CSV containing the numbers you want to update, and then update all webhooks for those numbers with your intended webhook. You can expand on it by adding specific webhooks for each number in the CSV, and updating the webhook based on that instead of the webhook string!
This script uses both the REST API and RELAY REST API n order to query all numbers in your project, compare with a CSV containing the numbers you want to update, and then update all webhooks for those numbers with your intended webhook. You can expand on it by adding specific webhooks for each number in the CSV, and updating the webhook based on that instead of the webhook string!

Sign Up Here
------------
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -39,13 +39,13 @@ line_city_list =[]
sms_enabled_number_list=[]
line_carrier_list =[]

# For our Relay-Rest APIs we will use a base64 encoded string of your projectID and API Token
# For our RELAY-Rest APIs we will use a base64 encoded string of your projectID and API Token
base_64_token = Project_ID + ':' + API_Token
message_bytes = base_64_token.encode('ascii')
base64_bytes = base64.b64encode(message_bytes)
base_64_token = base64_bytes.decode('ascii')

# The Number Lookup APIs are Relay-Rest so we must make an http request to the end points
# The Number Lookup APIs are RELAY-Rest so we must make an http request to the end points
# and declare what content to accept. We must also declare the content type and our Authorization Token which is base64 encoded
headers = {
"Accept": "application/json",
Expand Down Expand Up @@ -175,13 +175,13 @@ line_carrier_list =[]
#### Prepare authentication to use when connecting to the API endpoint

```python
# For our Relay-Rest APIs we will use a base64 encoded string of your projectID and API Token
# For our RELAY-Rest APIs we will use a base64 encoded string of your projectID and API Token
base_64_token = Project_ID + ':' + API_Token
message_bytes = base_64_token.encode('ascii')
base64_bytes = base64.b64encode(message_bytes)
base_64_token = base64_bytes.decode('ascii')

# The Number Lookup APIs are Relay-Rest so we must make an http request to the end points
# The Number Lookup APIs are RELAY-Rest so we must make an http request to the end points
# and declare what content to accept. We must also declare the content type and our Authorization Token which is base64 encoded
headers = {
"Accept": "application/json",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -117,7 +117,7 @@ Consider the following potential applications, and then go create something even
### Serverless

Try out the following serverless examples in the Dashboard of your SignalWire Space.
Navigate to the Relay/SWML sidebar item and the SWML Scripts tab, and
Navigate to the RELAY/SWML sidebar item and the SWML Scripts tab, and
follow [these instructions](https://github.com/signalwire/digital_employees/tree/main/serverless)
to link your preferred SignalWire number to the demo.

Expand Down
2 changes: 1 addition & 1 deletion website/docs/main/events/livewire/smart-biz-ai/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -161,7 +161,7 @@ The call flow will be handled by a
[SWML (SignalWire Markup Language)](/swml) Script,
which itself seeks logic from the websocket we will host locally using Flask.

To create a SWML Script, navigate to the **Relay / SWML** page of your SignalWire Dashboard.
To create a SWML Script, navigate to the **RELAY / SWML** page of your SignalWire Dashboard.

On that page, select the **SWML Scripts** tab as shown in the below screenshot.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ Register your SignalWire account

<div class="row">
<div class="col col--6">
Open the [Relay / SWML](https://my.signalwire.com?page=relay) tab in your SignalWire Dashboard,
Open the [RELAY / SWML](https://my.signalwire.com?page=relay) tab in your SignalWire Dashboard,
paste the following script, and hit <kbd>Save</kbd>.

<Admonition type="info" title="Fun fact">This simple YAML/JSON document is a complete calling application!</Admonition>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ import SendFaxRest from "./_sendFax/Rest.mdx"
},
"Reject a Fax": {
"CXML": <RejectFaxCxml/>,
"Relay Realtime SDK (Server)": <RejectFaxRelay/>
"RELAY Realtime SDK (Server)": <RejectFaxRelay/>
},
"Send a Fax": {
"REST API": <SendFaxRest/>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,7 @@ Follow the above guide with these changes:

**Create a SWML Script**

Navigate to the "Relay/SWML" section of your Dashboard and create a new SWML Script.
Navigate to the "RELAY/SWML" section of your Dashboard and create a new SWML Script.

**Assign a phone number**

Expand Down
Loading