diff --git a/website/blog/releases/realtime-api/3.0.0/index.mdx b/website/blog/releases/realtime-api/3.0.0/index.mdx index ce95bdaf3..296e8e740 100644 --- a/website/blog/releases/realtime-api/3.0.0/index.mdx +++ b/website/blog/releases/realtime-api/3.0.0/index.mdx @@ -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. diff --git a/website/blog/releases/realtime-api/4.0.0/index.mdx b/website/blog/releases/realtime-api/4.0.0/index.mdx index 6bc718607..32d7c7a9d 100644 --- a/website/blog/releases/realtime-api/4.0.0/index.mdx +++ b/website/blog/releases/realtime-api/4.0.0/index.mdx @@ -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/). @@ -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: @@ -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. @@ -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. diff --git a/website/blog/releases/realtime-api/4.1.1/index.mdx b/website/blog/releases/realtime-api/4.1.1/index.mdx index e4e497080..068245fda 100644 --- a/website/blog/releases/realtime-api/4.1.1/index.mdx +++ b/website/blog/releases/realtime-api/4.1.1/index.mdx @@ -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. diff --git a/website/browser-sdk_versioned_docs/version-v2/guides/v2-vs-v3.mdx b/website/browser-sdk_versioned_docs/version-v2/guides/v2-vs-v3.mdx index 1dfefcb52..70724d2c4 100644 --- a/website/browser-sdk_versioned_docs/version-v2/guides/v2-vs-v3.mdx +++ b/website/browser-sdk_versioned_docs/version-v2/guides/v2-vs-v3.mdx @@ -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 diff --git a/website/browser-sdk_versioned_docs/version-v2/index.mdx b/website/browser-sdk_versioned_docs/version-v2/index.mdx index 562e95637..e7f9498aa 100644 --- a/website/browser-sdk_versioned_docs/version-v2/index.mdx +++ b/website/browser-sdk_versioned_docs/version-v2/index.mdx @@ -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. @@ -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 @@ -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 @@ -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 \ @@ -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({ @@ -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 diff --git a/website/browser-sdk_versioned_docs/version-v2/tech-ref/call/index.mdx b/website/browser-sdk_versioned_docs/version-v2/tech-ref/call/index.mdx index 257044409..474898355 100644 --- a/website/browser-sdk_versioned_docs/version-v2/tech-ref/call/index.mdx +++ b/website/browser-sdk_versioned_docs/version-v2/tech-ref/call/index.mdx @@ -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** diff --git a/website/browser-sdk_versioned_docs/version-v2/tech-ref/relay-client.mdx b/website/browser-sdk_versioned_docs/version-v2/tech-ref/relay-client.mdx index 66df008af..7350d48c9 100644 --- a/website/browser-sdk_versioned_docs/version-v2/tech-ref/relay-client.mdx +++ b/website/browser-sdk_versioned_docs/version-v2/tech-ref/relay-client.mdx @@ -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** @@ -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({ @@ -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 @@ -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** @@ -154,7 +154,7 @@ await client.connect() ### disconnect -Disconnect the client from Relay. +Disconnect the client from RELAY. **Returns** diff --git a/website/docs/browser-sdk/_category_.yaml b/website/docs/browser-sdk/_category_.yaml index c930e498f..3c6c215c7 100644 --- a/website/docs/browser-sdk/_category_.yaml +++ b/website/docs/browser-sdk/_category_.yaml @@ -1,4 +1,4 @@ -label: Relay Browser SDK +label: RELAY Browser SDK position: 0 collapsed: true collapsible: false \ No newline at end of file diff --git a/website/docs/browser-sdk/guides/index.mdx b/website/docs/browser-sdk/guides/index.mdx index 10f44ef77..fdbdf51bd 100644 --- a/website/docs/browser-sdk/guides/index.mdx +++ b/website/docs/browser-sdk/guides/index.mdx @@ -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. diff --git a/website/docs/browser-sdk/guides/video/get-thumbnails-for-your-video-calls/index.mdx b/website/docs/browser-sdk/guides/video/get-thumbnails-for-your-video-calls/index.mdx index 8430b1ecc..8336b2bf2 100644 --- a/website/docs/browser-sdk/guides/video/get-thumbnails-for-your-video-calls/index.mdx +++ b/website/docs/browser-sdk/guides/video/get-thumbnails-for-your-video-calls/index.mdx @@ -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. diff --git a/website/docs/browser-sdk/guides/video/index.mdx b/website/docs/browser-sdk/guides/video/index.mdx index 5f5f10e7c..c7cddd84a 100644 --- a/website/docs/browser-sdk/guides/video/index.mdx +++ b/website/docs/browser-sdk/guides/video/index.mdx @@ -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. \ No newline at end of file diff --git a/website/docs/main/_common/context_topic.mdx b/website/docs/main/_common/context_topic.mdx index bd34f59a0..655e41695 100644 --- a/website/docs/main/_common/context_topic.mdx +++ b/website/docs/main/_common/context_topic.mdx @@ -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 ::: diff --git a/website/docs/main/_common/languageSwitcher.mdx b/website/docs/main/_common/languageSwitcher.mdx index ebebdc3ac..843d31773 100644 --- a/website/docs/main/_common/languageSwitcher.mdx +++ b/website/docs/main/_common/languageSwitcher.mdx @@ -1,16 +1,16 @@ -:::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: @@ -19,16 +19,16 @@ Relay V3 guide, please use the selection field below: -:::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. diff --git a/website/docs/main/compatibility-api/guides/general/phone-numbers/how-to-update-webhooks-in-bulk.mdx b/website/docs/main/compatibility-api/guides/general/phone-numbers/how-to-update-webhooks-in-bulk.mdx index 1fce8793e..1a3943481 100644 --- a/website/docs/main/compatibility-api/guides/general/phone-numbers/how-to-update-webhooks-in-bulk.mdx +++ b/website/docs/main/compatibility-api/guides/general/phone-numbers/how-to-update-webhooks-in-bulk.mdx @@ -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 ------------ diff --git a/website/docs/main/compatibility-api/guides/general/phone-numbers/remove-all-landlines-from-your-recipient-list-and-find-out-more-about-who-you-are-sending-to/index.mdx b/website/docs/main/compatibility-api/guides/general/phone-numbers/remove-all-landlines-from-your-recipient-list-and-find-out-more-about-who-you-are-sending-to/index.mdx index d0ca2b2ec..2e6a4f0fd 100644 --- a/website/docs/main/compatibility-api/guides/general/phone-numbers/remove-all-landlines-from-your-recipient-list-and-find-out-more-about-who-you-are-sending-to/index.mdx +++ b/website/docs/main/compatibility-api/guides/general/phone-numbers/remove-all-landlines-from-your-recipient-list-and-find-out-more-about-who-you-are-sending-to/index.mdx @@ -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", @@ -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", diff --git a/website/docs/main/events/hackathons/cluecon-2024/index.mdx b/website/docs/main/events/hackathons/cluecon-2024/index.mdx index c7ac84fb5..71316751f 100644 --- a/website/docs/main/events/hackathons/cluecon-2024/index.mdx +++ b/website/docs/main/events/hackathons/cluecon-2024/index.mdx @@ -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. diff --git a/website/docs/main/events/livewire/smart-biz-ai/index.mdx b/website/docs/main/events/livewire/smart-biz-ai/index.mdx index f0681e1c2..1de03fec8 100644 --- a/website/docs/main/events/livewire/smart-biz-ai/index.mdx +++ b/website/docs/main/events/livewire/smart-biz-ai/index.mdx @@ -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. diff --git a/website/docs/main/home/calling/ai/get-started/_ai-swml-get-started.mdx b/website/docs/main/home/calling/ai/get-started/_ai-swml-get-started.mdx index 5193c75da..0e2b146b1 100644 --- a/website/docs/main/home/calling/ai/get-started/_ai-swml-get-started.mdx +++ b/website/docs/main/home/calling/ai/get-started/_ai-swml-get-started.mdx @@ -22,7 +22,7 @@ Register your SignalWire account
- 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 Save. This simple YAML/JSON document is a complete calling application! diff --git a/website/docs/main/home/calling/fax/_usecases/_usecases.mdx b/website/docs/main/home/calling/fax/_usecases/_usecases.mdx index fcd8abce5..d06faddb6 100644 --- a/website/docs/main/home/calling/fax/_usecases/_usecases.mdx +++ b/website/docs/main/home/calling/fax/_usecases/_usecases.mdx @@ -13,7 +13,7 @@ import SendFaxRest from "./_sendFax/Rest.mdx" }, "Reject a Fax": { "CXML": , - "Relay Realtime SDK (Server)": + "RELAY Realtime SDK (Server)": }, "Send a Fax": { "REST API": diff --git a/website/docs/main/home/calling/fax/getting-started/first-steps-with-fax/index.mdx b/website/docs/main/home/calling/fax/getting-started/first-steps-with-fax/index.mdx index 43180b994..dac8bea56 100644 --- a/website/docs/main/home/calling/fax/getting-started/first-steps-with-fax/index.mdx +++ b/website/docs/main/home/calling/fax/getting-started/first-steps-with-fax/index.mdx @@ -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** diff --git a/website/docs/main/home/calling/voice/_usecases/_useCases.mdx b/website/docs/main/home/calling/voice/_usecases/_useCases.mdx index 1f562ec14..944b5d45a 100644 --- a/website/docs/main/home/calling/voice/_usecases/_useCases.mdx +++ b/website/docs/main/home/calling/voice/_usecases/_useCases.mdx @@ -17,24 +17,24 @@ import RecordCallCallFlowBuilder from "./_Recording/_CallFlowBuilder.mdx" , - "Relay Realtime SDK (Server)": , + "RELAY Realtime SDK (Server)": , "Call Flow Builder": , "cXML": , }, "Answering machine detection (AMD)": { - "Relay Realtime SDK (Server)": , + "RELAY Realtime SDK (Server)": , "REST": , }, "Interactive Voice Response (IVR)": { "SWML": , "cXML": , - "Relay Realtime SDK (Server)": , + "RELAY Realtime SDK (Server)": , "Call Flow Builder": , }, "Call Recording": { "SWML": , "cXML": , - "Relay Realtime SDK (Server)": , + "RELAY Realtime SDK (Server)": , "Call Flow Builder": , } }}/> \ No newline at end of file diff --git a/website/docs/main/home/calling/voice/guides/_category_.yaml b/website/docs/main/home/calling/voice/guides/_category_.yaml index 0f45264c1..a322f2375 100644 --- a/website/docs/main/home/calling/voice/guides/_category_.yaml +++ b/website/docs/main/home/calling/voice/guides/_category_.yaml @@ -14,6 +14,6 @@ customProps: - label: SWML Guides type: link - description: SignalWire Markup Language (SWML) lets you write Relay applications using simple statements in a YAML or a JSON document. + description: SignalWire Markup Language (SWML) lets you write RELAY applications using simple statements in a YAML or a JSON document. href: /swml/guides/ className: external-link diff --git a/website/docs/main/home/calling/voice/sip/byoc/index.mdx b/website/docs/main/home/calling/voice/sip/byoc/index.mdx index 8b7c52b82..7da3539f8 100644 --- a/website/docs/main/home/calling/voice/sip/byoc/index.mdx +++ b/website/docs/main/home/calling/voice/sip/byoc/index.mdx @@ -29,7 +29,7 @@ If you would like to do inbound BYOC (i.e. send your carrier traffic to SignalWi A screenshot of the New Domain App page, showing fields in which the user can set the app name, app URL, and toggle an IP whitelist. The Settings section in this example is configured to handle using a Relay Application, with optional encryption and a selection of supported codecs and ciphers. @@ -119,15 +119,15 @@ In the below example, we have a Call Flow that answers the call and plays a TTS --- -#### Using Relay +#### Using RELAY -To handle incoming calls using a Relay Application, you will need to: +To handle incoming calls using a RELAY Application, you will need to: 1. Go to the settings page for the newly created Domain App, by clicking on the app name in the Domain Apps list. - 2. Set the **HANDLE USING** field to **Relay Application** + 2. Set the **HANDLE USING** field to **RELAY Application** 3. Set a context (think of it as a traffic label) in the **WHEN A CALL COMES IN** field. Let's use an `office` context as an example; 4. Run code listening for calls on that `office` context and then do something with them. @@ -135,7 +135,7 @@ To handle incoming calls using a Relay Application, you will need to: 1. Go to the settings page for the newly created Domain App, by clicking on the app name in the Domain Apps list. - 2. Set the **HANDLE USING** field to **Relay Application** + 2. Set the **HANDLE USING** field to **RELAY Application** 3. Set a topic (think of it as a traffic label) in the **WHEN A CALL COMES IN** field. Let's use an `office` topic as an example; 4. Run code listening for calls on that `office` topic and then do something with them. @@ -143,9 +143,9 @@ To handle incoming calls using a Relay Application, you will need to: - + - ##### Relay V3 Example + ##### RELAY V3 Example ```javascript import { Voice } from "@signalwire/realtime-api"; @@ -175,9 +175,9 @@ Then, we tell it to listen for `call.received` events, and when a new call comes in we answer it and say "Hello! This is a test call." to the caller. - + - ##### Relay V4 Example + ##### RELAY V4 Example ```javascript import { SignalWire } from "@signalwire/realtime-api"; @@ -214,7 +214,7 @@ in we answer it and say "Hello! This is a test call." to the caller. -To learn more about what you can do with Relay, have a look at our [Relay Realtime SDK documentation](/sdks/realtime-sdk/). +To learn more about what you can do with RELAY, have a look at our [RELAY Realtime SDK documentation](/sdks/realtime-sdk/). ## Outbound BYOC @@ -309,14 +309,14 @@ curl https://.signalwire.com/api/laml/2010-04-01/Accounts/ - + ```javascript import { Voice } from "@signalwire/realtime-api"; @@ -341,7 +341,7 @@ try { ``` - + ```javascript import { SignalWire } from "@signalwire/realtime-api"; diff --git a/website/docs/main/home/calling/voice/sip/sip-domain-apps/index.mdx b/website/docs/main/home/calling/voice/sip/sip-domain-apps/index.mdx index 1456027c4..006336c81 100644 --- a/website/docs/main/home/calling/voice/sip/sip-domain-apps/index.mdx +++ b/website/docs/main/home/calling/voice/sip/sip-domain-apps/index.mdx @@ -27,31 +27,31 @@ A Domain Application is a SignalWire feature that allows you to send SIP traffic -## Relay Application +## RELAY Application -If you are handling incoming SIP traffic with a **Relay Application**, you are defining -your logic in a separate Relay application on your own server. Relay applications run +If you are handling incoming SIP traffic with a **RELAY Application**, you are defining +your logic in a separate RELAY application on your own server. RELAY applications run different logic based on the context attached to incoming calls, so you will need to choose -a context to label your incoming SIP traffic. The following example shows a Relay client +a context to label your incoming SIP traffic. The following example shows a RELAY client listening for the "office" context then runs the logic inside the event listener callback. -If you are handling incoming SIP traffic with a **Relay Application**, you are defining -your logic in a separate Relay application on your own server. Relay applications run +If you are handling incoming SIP traffic with a **RELAY Application**, you are defining +your logic in a separate RELAY application on your own server. RELAY applications run different logic based on the topic attached to incoming calls, so you will need to choose -a topic to label your incoming SIP traffic. The following example shows a Relay client +a topic to label your incoming SIP traffic. The following example shows a RELAY client listening for the "office" topic then runs the logic inside the event listener callback. - + ```js import { SignalWire } from "@signalwire/realtime-api"; @@ -83,7 +83,7 @@ await voiceClient.listen({ - + ```js import { Voice } from "@signalwire/realtime-api"; @@ -112,7 +112,7 @@ client.on("call.received", async (call) => { -Find the many options for what you can do with Relay in our [Relay Realtime SDK reference](/sdks/realtime-sdk/) or [another SDK](pathname:///sdks/) of your choice. +Find the many options for what you can do with RELAY in our [RELAY Realtime SDK reference](/sdks/realtime-sdk/) or [another SDK](pathname:///sdks/) of your choice. ## cXML Webhooks diff --git a/website/docs/main/home/calling/voice/sip/sip-endpoints/index.mdx b/website/docs/main/home/calling/voice/sip/sip-endpoints/index.mdx index c26fa8414..e111d7071 100644 --- a/website/docs/main/home/calling/voice/sip/sip-endpoints/index.mdx +++ b/website/docs/main/home/calling/voice/sip/sip-endpoints/index.mdx @@ -94,9 +94,9 @@ for creating SignalWire applications. - Use the [`connect` method](/swml/methods/connect) to connect a call to a sip endpoint - [**Call Flow Builder**](/call-flow-builder) - A visual tool for creating SignalWire Call applications. - Use the [`Forward to Phone`](/call-flow-builder/forward-to-phone#forward-to-sip) node to connect a call to a SIP endpoint -- [**Relay Browser Applications**](/sdks/browser-sdk/) - A JavaScript SDK for creating SignalWire applications in the browser utilizing SignalWires WebSocket APIs. +- [**RELAY Browser Applications**](/sdks/browser-sdk/) - A JavaScript SDK for creating SignalWire applications in the browser utilizing SignalWires WebSocket APIs. - Use the [`dial` method](/sdks/browser-sdk/signalwire-client/client#dial) to dial a resource address that's linked to a SIP endpoint. -- [**Relay Server Applications**](/sdks/realtime-sdk) - A Node.js SDK for creating SignalWire applications on the server utilizing SignalWires WebSocket APIs. +- [**RELAY Server Applications**](/sdks/realtime-sdk) - A Node.js SDK for creating SignalWire applications on the server utilizing SignalWires WebSocket APIs. - Use the [`connectSip` method](/sdks/realtime-sdk/voice/call#connectsip) to connect an existing call to a sip endpoint. - Use the [`dialSip` method](/sdks/realtime-sdk/voice/client#dialsip) to create a new call to a sip endpoint. - [**cXML Scripts/Applications**](/compatibility-api/guides/general/creating-and-using-cxml-scripts) - Compatible cXML scripts for creating SignalWire applications. diff --git a/website/docs/main/home/calling/voice/voice-faq.mdx b/website/docs/main/home/calling/voice/voice-faq.mdx index 72210a6c3..e09ea95bf 100644 --- a/website/docs/main/home/calling/voice/voice-faq.mdx +++ b/website/docs/main/home/calling/voice/voice-faq.mdx @@ -28,7 +28,7 @@ Please reach out to [Support@signalwire.com](mailto:Support@signalwire.com) to g -Yes, SignalWire has all the components to build a very powerful IVR! You could use the [Compatibility API](/compatibility-api), [Relay SDK](/sdks), or even build a video/voice solution using our [Javascript SDKs](/sdks/browser-sdk). +Yes, SignalWire has all the components to build a very powerful IVR! You could use the [Compatibility API](/compatibility-api), [RELAY SDK](/sdks), or even build a video/voice solution using our [Javascript SDKs](/sdks/browser-sdk). Check out some working IVR demos built with SignalWire such as [Dynamic IVR using JSON Menus](/compatibility-api/guides/voice/python/dynamic-ivr-using-json-menus), [IVR with Voicemails Forwarded to Email](/compatibility-api/guides/voice/nodejs/ivr-with-voicemail-to-email), and @@ -84,11 +84,11 @@ Yes - transcription is possible using by turning it on when creating a [recordin -Yes - text to speech is simple with either the [Relay Realtime SDK](/sdks/realtime-sdk/v3/voice/call#playtts) or [Compatibility API](/compatibility-api/cxml/voice/say/). +Yes - text to speech is simple with either the [RELAY Realtime SDK](/sdks/realtime-sdk/v3/voice/call#playtts) or [Compatibility API](/compatibility-api/cxml/voice/say/). -Speech to text is available with the `` verb in our [Compatibility API](/compatibility-api/cxml/voice/gather/) or you can collect speech and transcribe with Node.js using the [Relay Realtime SDK](/sdks/realtime-sdk/v3/voice/call#collect). +Speech to text is available with the `` verb in our [Compatibility API](/compatibility-api/cxml/voice/gather/) or you can collect speech and transcribe with Node.js using the [RELAY Realtime SDK](/sdks/realtime-sdk/v3/voice/call#collect). diff --git a/website/docs/main/home/messaging/sms/_usecases/_usecases.mdx b/website/docs/main/home/messaging/sms/_usecases/_usecases.mdx index becb26879..560d80e6f 100644 --- a/website/docs/main/home/messaging/sms/_usecases/_usecases.mdx +++ b/website/docs/main/home/messaging/sms/_usecases/_usecases.mdx @@ -15,22 +15,22 @@ import SmsCxmlForward from "./_Sms/_Forward/_Cxml.mdx" , - "Relay Realtime SDK (Server)": , + "RELAY Realtime SDK (Server)": , "CXML": , "REST API": }, "Send an MMS message": { "SWML": , - "Relay Realtime SDK (Server)": , + "RELAY Realtime SDK (Server)": , "CXML": , "REST API": }, "Respond to an incoming message": { - "Relay Realtime SDK (Server)": , + "RELAY Realtime SDK (Server)": , "CXML": }, "Forward an incoming message": { - "Relay Realtime SDK (Server)": , + "RELAY Realtime SDK (Server)": , "CXML": } }}/> \ No newline at end of file diff --git a/website/docs/main/home/overview/_usecases/_useCases.mdx b/website/docs/main/home/overview/_usecases/_useCases.mdx index a94ca3ec7..64a807cba 100644 --- a/website/docs/main/home/overview/_usecases/_useCases.mdx +++ b/website/docs/main/home/overview/_usecases/_useCases.mdx @@ -26,12 +26,12 @@ import VideoBrowser from "./_Video/_RelayBrowser.mdx" "Speak a TTS message": { "SWML": , "Call Flow Builder": , - "Relay Realtime SDK (Server)": , + "RELAY Realtime SDK (Server)": , "CXML": }, "Send an SMS message": { "SWML": , - "Relay Realtime SDK (Server)": , + "RELAY Realtime SDK (Server)": , "CXML": , "REST API": }, @@ -40,15 +40,15 @@ import VideoBrowser from "./_Video/_RelayBrowser.mdx" "CXML": }, "Send a chat message": { - "Relay Realtime SDK (Server)": , - "Relay Browser SDK": + "RELAY Realtime SDK (Server)": , + "RELAY Browser SDK": }, "Send a PubSub message": { - "Relay Realtime SDK (Server)": , - "Relay Browser SDK": + "RELAY Realtime SDK (Server)": , + "RELAY Browser SDK": }, "Stream a video room": { - "Relay Realtime SDK (Server)": , - "Relay Browser SDK": + "RELAY Realtime SDK (Server)": , + "RELAY Browser SDK": } }}/> \ No newline at end of file diff --git a/website/docs/main/home/platform/basics/general/stun-vs-turn-vs-ice.mdx b/website/docs/main/home/platform/basics/general/stun-vs-turn-vs-ice.mdx index 460bbc768..6aee4715e 100644 --- a/website/docs/main/home/platform/basics/general/stun-vs-turn-vs-ice.mdx +++ b/website/docs/main/home/platform/basics/general/stun-vs-turn-vs-ice.mdx @@ -12,7 +12,7 @@ STUN, TURN, and ICE are IETF standard protocols developed to address the Network ### Definitions - **Session Travel Utilities for NAT (STUN)** - provides a tool for clients to find out their public address and the type of NAT they are behind. It enables users that are behind a NAT to connect to a single peer. -- **Traversal Using Relay around NAT (TURN)** - is a protocol that helps in the traversal of NATs or firewalls for multimedia applications. It also supports a connection of a client behind a NAT to a single peer. However, it is used when STUN is not effective. +- **Traversal Using RELAY around NAT (TURN)** - is a protocol that helps in the traversal of NATs or firewalls for multimedia applications. It also supports a connection of a client behind a NAT to a single peer. However, it is used when STUN is not effective. - **Interactive Connectivity Establishment (ICE)** - is a standard that illustrates how to coordinate STUN and TURN to make a connection between clients. ### How Do They Work? @@ -33,6 +33,6 @@ After the SDPs have been sent, a series of connectivity checks are executed. The Once the checks have been completed, the two browsers decide which valid candidate to use. After it has been selected, the call will begin. This entire process usually takes milliseconds. -If the two browsers cannot find a valid ICE candidate, a STUN request will be made to the TURN server. This will result in a media relay address, which is a public address and port that will forward packets received to and from the browser that set up the relay address. The relay address will be added to the list of candidates and exchanged through some signaling channel. +If the two browsers cannot find a valid ICE candidate, a STUN request will be made to the TURN server. This will result in a media RELAY address, which is a public address and port that will forward packets received to and from the browser that set up the RELAY address. The RELAY address will be added to the list of candidates and exchanged through some signaling channel. If you are building a WebRTC application, the WebRTC stack includes an ICE Agent that takes care of most of what was described for you. You will need to implement a signaling mechanism to exchange SDPs and send them along with new ICE candidates whenever they are discovered. diff --git a/website/docs/main/home/platform/call-fabric/index.mdx b/website/docs/main/home/platform/call-fabric/index.mdx index 730530449..2361ba0ec 100644 --- a/website/docs/main/home/platform/call-fabric/index.mdx +++ b/website/docs/main/home/platform/call-fabric/index.mdx @@ -58,7 +58,7 @@ For example, all of the following are Resources: - [Subscribers](#subscribers) - [SWML Scripts](/swml) - [Compatibility XML Webhooks/Applications](/compatibility-api/cxml) -- [Relay apps](/sdks/#what-is-relay) +- [RELAY apps](/sdks/#what-is-relay) - [SignalWire AI Agents](/swml/methods/ai) - Video Conferences: - [Programmable API Video Conferences](/video/getting-started/managing-rooms-with-apis) @@ -157,7 +157,7 @@ In particular, this API maintains parity with Twilio's API for near-instant migr **[RELAY Realtime](/sdks/overview/what-is-relay/)** -- Relay Realtime is a WebSocket-based API offering real-time, +- RELAY Realtime is a WebSocket-based API offering real-time, two-way communication and advanced event-driven interactions with vastly improved performance over traditional REST APIs. diff --git a/website/docs/main/home/platform/call-fabric/resources/relay-applications.mdx b/website/docs/main/home/platform/call-fabric/resources/relay-applications.mdx index 4e43b4b56..468283630 100644 --- a/website/docs/main/home/platform/call-fabric/resources/relay-applications.mdx +++ b/website/docs/main/home/platform/call-fabric/resources/relay-applications.mdx @@ -1,33 +1,33 @@ --- -title: Relay Applications +title: RELAY Applications description: Learn about the Subscriber Resource on the SignalWire platform - what they are, how they work, and how to manage them in the Dashboard. slug: /platform/call-fabric/resources/relay-applications --- -# Relay Applications +# RELAY Applications Resources on the Call Fabric platform ## About -Relay Applications are powerful applications running on your own server or a client such as a browser or mobile application, -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. +RELAY Applications are powerful applications running on your own server or a client such as a browser or mobile application, +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. ## Details -A Relay Application Resource will have the following details: +A RELAY Application Resource will have the following details: | Detail | Value | |:----------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| Name | The name of the Relay application. | -| Reference | The reference (previously known as Context) of the Relay application.
A given phone number can be configured with the desired Reference (E.g., "office").
That then assigns incoming calls to that number to be forwarded to the matching Relay application. | +| Name | The name of the RELAY application. | +| Reference | The reference (previously known as Context) of the RELAY application.
A given phone number can be configured with the desired Reference (E.g., "office").
That then assigns incoming calls to that number to be forwarded to the matching RELAY application. | - ![Details of a Relay App on the SignalWire Dashboard.](@image/dashboard/resources/relay-app.webp) + ![Details of a RELAY App on the SignalWire Dashboard.](@image/dashboard/resources/relay-app.webp) ## Learn more -For more information on Relay, please refer to the -[Relay documentation](/sdks/#what-is-relay). \ No newline at end of file +For more information on RELAY, please refer to the +[RELAY documentation](/sdks/#what-is-relay). diff --git a/website/docs/main/home/platform/call-fabric/resources/swml-scripts.mdx b/website/docs/main/home/platform/call-fabric/resources/swml-scripts.mdx index 687f87e97..8605a1693 100644 --- a/website/docs/main/home/platform/call-fabric/resources/swml-scripts.mdx +++ b/website/docs/main/home/platform/call-fabric/resources/swml-scripts.mdx @@ -11,7 +11,7 @@ slug: /platform/call-fabric/resources/swml-scripts ## About The SWML Resource type is used to create and manage SWML scripts. -SWML allows you to write Relay applications using simple statements in a YAML or JSON document. +SWML allows you to write RELAY applications using simple statements in a YAML or JSON document. ## Details diff --git a/website/docs/main/home/platform/phone-numbers/guides/how-to-configure-your-webhook/index.mdx b/website/docs/main/home/platform/phone-numbers/guides/how-to-configure-your-webhook/index.mdx index 64ad59754..a2cfbefe0 100644 --- a/website/docs/main/home/platform/phone-numbers/guides/how-to-configure-your-webhook/index.mdx +++ b/website/docs/main/home/platform/phone-numbers/guides/how-to-configure-your-webhook/index.mdx @@ -117,7 +117,7 @@ If you set your phone number to handle incoming calls using Fax, you will **NOT* ::: -If you use the [SignalWire Compatibility APIs](/compatibility-api), select **LaML Webhooks** for **When a Call Comes In**. If you are using the [RELAY Realtime API](/sdks/realtime-sdk), select **Relay** for **When a Call Comes In**. The other options are all third-party integrations you can choose to use for different use cases! +If you use the [SignalWire Compatibility APIs](/compatibility-api), select **LaML Webhooks** for **When a Call Comes In**. If you are using the [RELAY Realtime API](/sdks/realtime-sdk), select **RELAY** for **When a Call Comes In**. The other options are all third-party integrations you can choose to use for different use cases! GET and POST are two different types of HTTP methods. GET is used for requesting something from a resource, whereas POST is used to send data to a server. If you were using a webhook that pointed towards your web application for handling inbound calls, you would use a POST request. If you were using an XML Bin to `` (text to speech) a quick message for your customers to listen to when calling your number, you would use GET. diff --git a/website/docs/main/swml/get-started/quickstart.mdx b/website/docs/main/swml/get-started/quickstart.mdx index 24075c7a8..612398779 100644 --- a/website/docs/main/swml/get-started/quickstart.mdx +++ b/website/docs/main/swml/get-started/quickstart.mdx @@ -73,7 +73,7 @@ Call your assigned phone number to test your SWML application. description="Follow these instructions if your SignalWire Space is on the Legacy Dashboard" > -You can write and save new SWML scripts from the "Relay/SWML" section of your Dashboard. +You can write and save new SWML scripts from the "RELAY/SWML" section of your Dashboard. In that section, switch to the tab named [SWML Scripts](https://my.signalwire.com/relay-bins). Once there, you can create a new SWML script: diff --git a/website/docs/main/swml/guides/AI/holiday-special-santa-ai/index.mdx b/website/docs/main/swml/guides/AI/holiday-special-santa-ai/index.mdx index f0bd4f3e6..d7d72b96d 100644 --- a/website/docs/main/swml/guides/AI/holiday-special-santa-ai/index.mdx +++ b/website/docs/main/swml/guides/AI/holiday-special-santa-ai/index.mdx @@ -38,8 +38,8 @@ idea of what their child wants for Christmas, and then purchase the gift directl To get our AI Santa set up, we will take the following steps: 1. Sign into your SignalWire Space and navigate to your Dashboard. -2. Create a new Relay (SWML) Script using the sample script and provided instructions. -3. Assign a phone number to the Relay (SWML) Script. +2. Create a new RELAY (SWML) Script using the sample script and provided instructions. +3. Assign a phone number to the RELAY (SWML) Script. We'll explain each of these steps in detail throughout the article. Follow along, and don't hesitate to reach out if you have questions or run into issues! @@ -617,7 +617,7 @@ has messaging services enabled, as the Santa AI will send you an SMS with a link **Hosting your own Santa AI** -To host your own Santa AI, simply copy and paste the `SWML` script [above](#final-swml-script) into a new relay script then assign it in your phone number settings, located +To host your own Santa AI, simply copy and paste the `SWML` script [above](#final-swml-script) into a new RELAY script then assign it in your phone number settings, located on your [SignalWire Dashboard](https://my.signalwire.com). Don't forget to replace the sample values with your active `post prompt webhook URL`, `Rapid API token`, `webhook host`, and `From number`, as described above the sample script. diff --git a/website/docs/main/swml/guides/deployment.mdx b/website/docs/main/swml/guides/deployment.mdx index 171e6e174..f615501c3 100644 --- a/website/docs/main/swml/guides/deployment.mdx +++ b/website/docs/main/swml/guides/deployment.mdx @@ -6,7 +6,7 @@ x-custom: tags: - sdk:swml - product:voice -description: Learn how to serve SWML scripts from web servers and Relay applications. +description: Learn how to serve SWML scripts from web servers and RELAY applications. --- @@ -14,7 +14,7 @@ description: Learn how to serve SWML scripts from web servers and Relay applicat Deploy SWML scripts from web servers and applications -SWML scripts can be served in multiple ways beyond the SignalWire Dashboard. This guide covers serving SWML from web servers and Relay applications. +SWML scripts can be served in multiple ways beyond the SignalWire Dashboard. This guide covers serving SWML from web servers and RELAY applications. :::info @@ -91,9 +91,9 @@ sections: file: https://cdn.signalwire.com/swml/audio.mp3 ``` -## From a Relay application +## From a RELAY application -You can also execute SWML from a Relay application. +You can also execute SWML from a RELAY application. The following is a snippet using the [RealTime API](/sdks/realtime-sdk). ```javascript diff --git a/website/docs/main/swml/reference/methods/join_room.mdx b/website/docs/main/swml/reference/methods/join_room.mdx index ec3e65f45..4efb82040 100644 --- a/website/docs/main/swml/reference/methods/join_room.mdx +++ b/website/docs/main/swml/reference/methods/join_room.mdx @@ -1,7 +1,7 @@ --- title: join_room slug: /swml/methods/join_room -description: Join a Relay Room Session. +description: Join a RELAY Room Session. tags: ['swml'] --- diff --git a/website/docs/main/swml/reference/methods/transfer.mdx b/website/docs/main/swml/reference/methods/transfer.mdx index 94830da23..31d84be8a 100644 --- a/website/docs/main/swml/reference/methods/transfer.mdx +++ b/website/docs/main/swml/reference/methods/transfer.mdx @@ -1,13 +1,13 @@ --- title: transfer slug: /swml/methods/transfer -description: Transfer the execution of the script to a different `SWML section`, `URL`, or `Relay application`. +description: Transfer the execution of the script to a different `SWML section`, `URL`, or `RELAY application`. tags: ['swml'] --- import APIField from "@site/src/components/APIField"; -Transfer the execution of the script to a different `SWML section`, `URL`, or `Relay application`. Once +Transfer the execution of the script to a different `SWML section`, `URL`, or `RELAY application`. Once the transfer is complete, the script will continue executing SWML from the new location. @@ -54,10 +54,10 @@ Scroll down until you reach "Messaging Settings", as shown in the next figure, a :::info Topic -In Relay V4, a topic is a named scope that allows you to organize and categorize -your resources. When you configure a phone number to handle messages with a Relay -application and specify a topic, all messages to that number will be delivered -to Relay clients listening on that topic. +In RELAY V4, a topic is a named scope that allows you to organize and categorize +your resources. When you configure a phone number to handle messages with a RELAY +application and specify a topic, all messages to that number will be delivered +to RELAY clients listening on that topic. ::: :::info Ensuring message delivery diff --git a/website/docs/realtime-sdk/guides/messaging/forwarding-texts-to-email-nodejs/index.mdx b/website/docs/realtime-sdk/guides/messaging/forwarding-texts-to-email-nodejs/index.mdx index 28e096b64..bc920d01e 100644 --- a/website/docs/realtime-sdk/guides/messaging/forwarding-texts-to-email-nodejs/index.mdx +++ b/website/docs/realtime-sdk/guides/messaging/forwarding-texts-to-email-nodejs/index.mdx @@ -40,12 +40,12 @@ We will write a simple server that listens for a message event from SignalWire w ### Configuring the phone number -First, we need to create a new Relay Application resource. -To do so, go to the "Resources" section from your sidebar, and create a new Relay ApplicationResource. +First, we need to create a new RELAY Application resource. +To do so, go to the "Resources" section from your sidebar, and create a new RELAY ApplicationResource. -![Relay Application resource selector with cXML highlighted.](@image/dashboard/resources/add-new-relay-application.png) +![RELAY Application resource selector with cXML highlighted.](@image/dashboard/resources/add-new-relay-application.png) -When configuring the Relay Application, set the topic to "office" (to match what we have in the code). +When configuring the RELAY Application, set the topic to "office" (to match what we have in the code). @@ -54,7 +54,7 @@ number yet, make sure to [buy one][buy-one]. You will need at least one number to receive messages. You can do that from the "Phone Numbers" section in the Sidebar. Go to the Settings page of the number you -want to configure. In the `Inbound Message Settings` section, assign your relay application. +want to configure. In the `Inbound Message Settings` section, assign your RELAY application. ![Assign Resource](@image/dashboard/phone-numbers/assign-resource-full.png) @@ -66,9 +66,9 @@ want to configure. In the `Inbound Message Settings` section, assign your relay You don't need to create a new resource for your call. Simply open the settings for the number you want to configure, and under "**Inbound Message Settings**", -choose to handle incoming messages using "Relay Application", and set the topic to "office" to match the code. +choose to handle incoming messages using "RELAY Application", and set the topic to "office" to match the code. -![legacy UI relay application configuration](@image/dashboard/legacy/number-message-config-relay.png) +![legacy UI RELAY application configuration](@image/dashboard/legacy/number-message-config-relay.png) diff --git a/website/docs/realtime-sdk/guides/voice/first-steps-with-voice/index.mdx b/website/docs/realtime-sdk/guides/voice/first-steps-with-voice/index.mdx index abedf7c71..70503f943 100644 --- a/website/docs/realtime-sdk/guides/voice/first-steps-with-voice/index.mdx +++ b/website/docs/realtime-sdk/guides/voice/first-steps-with-voice/index.mdx @@ -25,8 +25,8 @@ This introductory guide will show you how to make and receive calls from your ow [Log in][log-in] to your SignalWire Space. From the Phone Numbers section, you can [buy a new phone number][buy-a-new-phone-number]. You will need at least one number to make and receive calls. After you have acquired a number, open its settings by clicking on "Edit Settings". Scroll down until you reach "Voice and Fax Settings", as shown in the next figure, and configure it to: -- handle incoming calls using a Relay application, -- forward the call to the "office" Relay topic +- handle incoming calls using a RELAY application, +- forward the call to the "office" RELAY topic @@ -35,10 +35,10 @@ This introductory guide will show you how to make and receive calls from your ow :::info Topic -In Relay V4, a topic is a named scope that allows you to organize and categorize -your resources. When you configure a phone number to handle calls with a Relay -application and specify a topic, all calls to that number will be delivered -to Relay clients listening on that topic. +In RELAY V4, a topic is a named scope that allows you to organize and categorize +your resources. When you configure a phone number to handle calls with a RELAY +application and specify a topic, all calls to that number will be delivered +to RELAY clients listening on that topic. ::: ## Installation of the SDK diff --git a/website/docs/realtime-sdk/guides/voice/setting-up-voicemail/index.mdx b/website/docs/realtime-sdk/guides/voice/setting-up-voicemail/index.mdx index c5d4809f3..87b79acef 100644 --- a/website/docs/realtime-sdk/guides/voice/setting-up-voicemail/index.mdx +++ b/website/docs/realtime-sdk/guides/voice/setting-up-voicemail/index.mdx @@ -21,14 +21,14 @@ A popular and important use case is recording a voicemail from your callers when In this guide we will see how to implement a voicemail using Node.js. This allows you the most flexibility in case you want to integrate voicemails with complex workflows. -## Assigning a Phone Number to a Relay Topic +## Assigning a Phone Number to a RELAY Topic -To handle calls using Node.js, you should first set up a phone number to handle incoming calls using a Relay application. +To handle calls using Node.js, you should first set up a phone number to handle incoming calls using a RELAY application. Click the **Phone Numbers** tab on your lefthand side nav within your SignalWire Space, and click the specific number you would like to set up call forwarding on. If you don't have a number yet, now is the time to [buy one][buy-one]! - + ![the Voice and Fax Settings pane.](@image/dashboard/relay/app-voice-handler.webP) @@ -83,7 +83,7 @@ await voiceClient.listen({ }); ``` -Right after playing the introduction message, we need to start recording. In Relay V4, we can set up event listeners directly in the recording call: +Right after playing the introduction message, we need to start recording. In RELAY V4, we can set up event listeners directly in the recording call: ```js // inside the "call.received" event handler diff --git a/website/docs/realtime-sdk/guides/voice/stop-robocalls-with-signalwires-communication-api.mdx b/website/docs/realtime-sdk/guides/voice/stop-robocalls-with-signalwires-communication-api.mdx index 8c377d5bf..a52436fde 100644 --- a/website/docs/realtime-sdk/guides/voice/stop-robocalls-with-signalwires-communication-api.mdx +++ b/website/docs/realtime-sdk/guides/voice/stop-robocalls-with-signalwires-communication-api.mdx @@ -30,7 +30,7 @@ sidebar_custom_props: [signalwire-relay-sdk]: /sdks/realtime-sdk/ [the-getting-started-with-relay]: https://github.com/signalwire/signalwire-guides/blob/master/intros/getting_started_relay.md -# Stopping Robocalls with a CAPTCHA - Node.js (Relay v4) +# Stopping Robocalls with a CAPTCHA - Node.js (RELAY v4) Robocalling and spam calls have been increasing in number over the past few years. Only in the US, there were 165.1 million robocalls placed in 2020, an average of 14.1 per person, including children and people who do not have a phone! SignalWire can help with its communication technology, which allows us to easily create a robocall protection service. @@ -59,7 +59,7 @@ As with all SignalWire scripts, you will need your API credentials (**SignalWire The application uses [node-persist][node-persist], a simple file-based database, to keep track of flagged numbers and automatically reject calls. In a production application, you would maybe use a different database such as PostgreSQL. Every phone number is saved and remembered, so any callers who you want to receive calls from will automatically get through the second time they dial-in. Spammers, on the other hand, will just be sent to have a chat with Lenny! -Lastly, you will also need to have the [SignalWire Relay SDK][signalwire-relay-sdk] installed. +Lastly, you will also need to have the [SignalWire RELAY SDK][signalwire-relay-sdk] installed. :::caution Remember @@ -77,7 +77,7 @@ The application needs a SignalWire API token. You can sign up [here][here], then You also need to configure a phone number where legitimate calls will be forwarded. This can be any number (i.e., your personal number), and you can set it up in the `.env` file as `MY_NUMBER`. -Finally, you need a DID (phone number) that people will call instead of dialing your own number directly. For this, buy a phone number from your SignalWire Dashboard, then configure it to handle incoming calls using `Relay Application`, with the same Relay context name that you configure in `.env` as `SIGNALWIRE_CONTEXT`. By default, the example config file uses `captcha` as context name. +Finally, you need a DID (phone number) that people will call instead of dialing your own number directly. For this, buy a phone number from your SignalWire Dashboard, then configure it to handle incoming calls using `RELAY Application`, with the same RELAY context name that you configure in `.env` as `SIGNALWIRE_CONTEXT`. By default, the example config file uses `captcha` as context name. ## Running the Application @@ -114,7 +114,7 @@ The possible paths that a call can take are defined in index.js in the form of a +---> LENNY ----+ (lenny.js) ``` -Right after the application is started, we create a Relay Client to connect with SignalWire: +Right after the application is started, we create a RELAY Client to connect with SignalWire: ```js const client = await SignalWire({ @@ -130,7 +130,7 @@ await voiceClient.listen({ }); ``` -Whenever someone calls a number which we have associated to the same topic specified in `SIGNALWIRE_CONTEXT`, the Relay Consumer will call our `onIncomingCallHandler` function. In there, we first answer the call: +Whenever someone calls a number which we have associated to the same topic specified in `SIGNALWIRE_CONTEXT`, the RELAY Consumer will call our `onIncomingCallHandler` function. In there, we first answer the call: ```js await call.answer(); @@ -297,6 +297,6 @@ Now you have a powerful and persistent way to prevent robocalls from hitting you You can sign up for a new SignalWire Space [here][here-1]! If you sign up for the first time, your account will start in trial mode, which you can exit by making a manual top up of $5.00. You can find more information [on the Trial Mode resource page][on-the-trial-mode-resource-page]. -You can find more information, including where to get your credentials and how to set up the phone number, in [the Getting Started with Relay][the-getting-started-with-relay] guide. +You can find more information, including where to get your credentials and how to set up the phone number, in [the Getting Started with RELAY][the-getting-started-with-relay] guide. diff --git a/website/docs/realtime-sdk/guides/voice/weather-phone-with-signalwire-realtime-api/index.mdx b/website/docs/realtime-sdk/guides/voice/weather-phone-with-signalwire-realtime-api/index.mdx index c216b0952..765a00c9e 100644 --- a/website/docs/realtime-sdk/guides/voice/weather-phone-with-signalwire-realtime-api/index.mdx +++ b/website/docs/realtime-sdk/guides/voice/weather-phone-with-signalwire-realtime-api/index.mdx @@ -73,9 +73,9 @@ You can follow the README.md instructions to download and run the sample. ## How to Run the Application -1. Edit the settings of your phone number so that our code can handle it. The Relay Topic you specify here needs to match the one you specify in the code later. In this case, we have used 'office'. +1. Edit the settings of your phone number so that our code can handle it. The RELAY Topic you specify here needs to match the one you specify in the code later. In this case, we have used 'office'. - + ![the Edit Settings page of a phone number in SignalWire.](@image/dashboard/relay/app-voice-handler.webP) @@ -295,7 +295,7 @@ const { SignalWire } = require("@signalwire/realtime-api"); Using your [Project ID and API token][project-id-and-api-token], you can instantiate both Voice and Messaging Client. -`topics` parameter: Relay topics allows you to treat a bunch of phone numbers as one, so that you can subscribe to and receive events (calls, messages etc) from your group of numbers at once. You can pick which numbers are in which Relay topic from the SignalWire Dashboard. For this example, I've already set up my number to be in the `office` topic (read [Buying a Phone Number][buying-a-phone-number-2] if you're unfamiliar with the process). +`topics` parameter: RELAY topics allows you to treat a bunch of phone numbers as one, so that you can subscribe to and receive events (calls, messages etc) from your group of numbers at once. You can pick which numbers are in which RELAY topic from the SignalWire Dashboard. For this example, I've already set up my number to be in the `office` topic (read [Buying a Phone Number][buying-a-phone-number-2] if you're unfamiliar with the process). ```javascript const client = await SignalWire({ diff --git a/website/docs/realtime-sdk/index.mdx b/website/docs/realtime-sdk/index.mdx index 9bf953a87..46413c1e8 100644 --- a/website/docs/realtime-sdk/index.mdx +++ b/website/docs/realtime-sdk/index.mdx @@ -41,9 +41,9 @@ The SDK operates through a bidirectional WebSocket connection. When you call met npm install @signalwire/realtime-api ``` -### Create a Relay Application +### Create a RELAY Application -For Voice, Messaging, and Task namespaces, create a [Relay Application resource](/platform/call-fabric/resources/relay-applications) in your dashboard: +For Voice, Messaging, and Task namespaces, create a [RELAY Application resource](/platform/call-fabric/resources/relay-applications) in your dashboard: 1. Set a name for your application 2. Choose a reference (e.g., "support", "sales") that matches your client's topics @@ -81,7 +81,7 @@ const voiceClient = client.voice; // Answer incoming calls and play a greeting await voiceClient.listen({ - topics: ["support"], // Must match your Relay Application reference + topics: ["support"], // Must match your RELAY Application reference onCallReceived: async (call) => { console.log("Incoming call from:", call.from); @@ -93,7 +93,7 @@ await voiceClient.listen({ console.log("Waiting for calls..."); ``` -Now call the SignalWire phone number or SIP address you assigned to your Relay Application in step 2. Your application will answer and play the greeting! +Now call the SignalWire phone number or SIP address you assigned to your RELAY Application in step 2. Your application will answer and play the greeting! diff --git a/website/docs/realtime-sdk/tech-ref/index.mdx b/website/docs/realtime-sdk/tech-ref/index.mdx index bdb13c09b..a34aa1c5d 100644 --- a/website/docs/realtime-sdk/tech-ref/index.mdx +++ b/website/docs/realtime-sdk/tech-ref/index.mdx @@ -49,9 +49,9 @@ await voiceClient.listen({ Your `project` ID and `token` are available in the [SignalWire Dashboard](/platform/dashboard/getting-started/your-signalwire-api-space). These authenticate your WebSocket connection and establish your access permissions. -Topics (formerly contexts) work with [Relay Application resources](/platform/call-fabric/resources/relay-applications) to route events. When you assign a phone number or a SIP address to a Relay Application with reference "support", SignalWire routes all calls from that number or SIP address to SDK clients authenticated with the "support" topic. This creates strict access control - a client subscribed to "support" cannot receive events intended for "sales". +Topics (formerly contexts) work with [RELAY Application resources](/platform/call-fabric/resources/relay-applications) to route events. When you assign a phone number or a SIP address to a RELAY Application with reference "support", SignalWire routes all calls from that number or SIP address to SDK clients authenticated with the "support" topic. This creates strict access control - a client subscribed to "support" cannot receive events intended for "sales". -The routing process is straightforward: incoming calls hit a phone number or a SIP address, SignalWire checks the Relay Application's reference, then delivers the event only to clients with matching topics. This happens automatically based on your authentication. +The routing process is straightforward: incoming calls hit a phone number or a SIP address, SignalWire checks the RELAY Application's reference, then delivers the event only to clients with matching topics. This happens automatically based on your authentication. ```javascript // Topic-based client (receives events only for subscribed topics) diff --git a/website/docs/realtime-sdk/tech-ref/messaging/messaging-messagecontract.md b/website/docs/realtime-sdk/tech-ref/messaging/messaging-messagecontract.md index 0a2e439b1..1ae588118 100644 --- a/website/docs/realtime-sdk/tech-ref/messaging/messaging-messagecontract.md +++ b/website/docs/realtime-sdk/tech-ref/messaging/messaging-messagecontract.md @@ -63,9 +63,9 @@ An object representing an SMS or MMS message. The state a message can be in. -- `queued`: The message has been queued in Relay. -- `initiated`: Relay has initiated the process of sending the message. -- `sent`: Relay has sent the message. +- `queued`: The message has been queued in RELAY. +- `initiated`: RELAY has initiated the process of sending the message. +- `sent`: RELAY has sent the message. - `delivered`: The message has been successfully delivered. Due to the nature of SMS and MMS, receiving a `delivered` event is not guaranteed, even if the message is delivered successfully. - `undelivered`: The message has not been delivered. Due to the nature of SMS and MMS, receiving a `undelivered` event is not guaranteed, even if the message fails to be delivered. - `failed`: The request has failed. diff --git a/website/docs/realtime-sdk/tech-ref/voice/callstate.mdx b/website/docs/realtime-sdk/tech-ref/voice/callstate.mdx index f77a04dee..43b2966f9 100644 --- a/website/docs/realtime-sdk/tech-ref/voice/callstate.mdx +++ b/website/docs/realtime-sdk/tech-ref/voice/callstate.mdx @@ -12,7 +12,7 @@ sidebar_label: CallState # CallState -Payload for call state events that are triggered by the change in state of an active Relay-controlled call. +Payload for call state events that are triggered by the change in state of an active RELAY-controlled call. Obtain instances of this state Callback request by including a `call_state_url` parameter when starting a call with one of the following methods: diff --git a/website/realtime-sdk_versioned_docs/version-v2/guides/voice/stop-robocalls-with-signalwires-communication-api.mdx b/website/realtime-sdk_versioned_docs/version-v2/guides/voice/stop-robocalls-with-signalwires-communication-api.mdx index 878b9c2de..bc37b9487 100644 --- a/website/realtime-sdk_versioned_docs/version-v2/guides/voice/stop-robocalls-with-signalwires-communication-api.mdx +++ b/website/realtime-sdk_versioned_docs/version-v2/guides/voice/stop-robocalls-with-signalwires-communication-api.mdx @@ -54,7 +54,7 @@ As with all SignalWire scripts, you will need your API credentials (**SignalWire The application uses [node-persist][node-persist], a simple file-based database, to keep track of flagged numbers and automatically reject calls. In a production application, you would maybe use a different database such as PostgreSQL. Every phone number is saved and remembered, so any callers who you want to receive calls from will automatically get through the second time they dial-in. Spammers, on the other hand, will just be sent to have a chat with Lenny! -Lastly, you will also need to have the [SignalWire Relay SDK][signalwire-relay-sdk] installed. +Lastly, you will also need to have the [SignalWire RELAY SDK][signalwire-relay-sdk] installed. :::caution Remember @@ -109,7 +109,7 @@ The possible paths that a call can take are defined in index.js in the form of a +---> LENNY ----+ (lenny.js) ``` -Right after the application is started, we create a Relay Consumer to connect with SignalWire: +Right after the application is started, we create a RELAY Consumer to connect with SignalWire: ```js const { RelayConsumer } = require('@signalwire/node'); @@ -124,7 +124,7 @@ const consumer = new RelayConsumer({ consumer.run(); ``` -Whenever someone calls a number which we have associated to the same topic specified in `SIGNALWIRE_CONTEXT`, the Relay Consumer will call our `onIncomingCallHandler` function. In there, we first answer the call: +Whenever someone calls a number which we have associated to the same topic specified in `SIGNALWIRE_CONTEXT`, the RELAY Consumer will call our `onIncomingCallHandler` function. In there, we first answer the call: ```js await call.answer(); @@ -296,11 +296,11 @@ Now you have a powerful and persistent way to prevent robocalls from hitting you You can sign up for a new SignalWire Space [here][here-1]! If you sign up for the first time, your account will start in trial mode, which you can exit by making a manual top up of $5.00. You can find more information [on the Trial Mode resource page][on-the-trial-mode-resource-page]. -You can find more information, including where to get your credentials and how to set up the phone number, in [the Getting Started with Relay][the-getting-started-with-relay] guide. +You can find more information, including where to get your credentials and how to set up the phone number, in [the Getting Started with RELAY][the-getting-started-with-relay] guide. Here are some other resources that may be helpful for you: - [**Full Application on GitHub**][full-application-on-github] -- [Relay Documentation][relay-documentation] -- [Getting Started with Relay][getting-started-with-relay] +- [RELAY Documentation][relay-documentation] +- [Getting Started with RELAY][getting-started-with-relay] - [SignalWire 101][signalwire-101] \ No newline at end of file diff --git a/website/realtime-sdk_versioned_docs/version-v2/index.mdx b/website/realtime-sdk_versioned_docs/version-v2/index.mdx index c3b8b49ab..9d7db9c1d 100644 --- a/website/realtime-sdk_versioned_docs/version-v2/index.mdx +++ b/website/realtime-sdk_versioned_docs/version-v2/index.mdx @@ -1,12 +1,12 @@ --- -title: Relay Realtime SDK +title: RELAY Realtime SDK sidebar_position: 0 --- import { Card, CardGroup } from '@site/src/components/Extras/Card'; import { SiNodedotjs, SiGo, SiPhp, SiPython, SiRuby, SiDotnet } from 'react-icons/si'; -# Relay Realtime SDK v2 +# RELAY Realtime SDK v2 Welcome to the SignalWire Realtime SDK v2 documentation. This version provides multi-language support for building real-time communication applications with persistent WebSocket connections. diff --git a/website/realtime-sdk_versioned_docs/version-v2/language/dotnet/consumer.mdx b/website/realtime-sdk_versioned_docs/version-v2/language/dotnet/consumer.mdx index 1f68b3230..9979a7e38 100644 --- a/website/realtime-sdk_versioned_docs/version-v2/language/dotnet/consumer.mdx +++ b/website/realtime-sdk_versioned_docs/version-v2/language/dotnet/consumer.mdx @@ -11,13 +11,13 @@ sidebar_position: 2 # SignalWire.Relay.Consumer -A Relay Consumer is a simple application framework that provides a shell for creating independent consumers of the Relay SDK. Relay Consumers abstract all the setup of connecting to Relay and automatically dispatch workers to handle requests. Consumers will receive requests and delegate them to their own worker thread, allowing you to focus on your business logic without having to worry about multi-threading or blocking, everything just works. Think of Relay Consumers like a background worker system for all your calling and messaging needs. +A RELAY Consumer is a simple application framework that provides a shell for creating independent consumers of the RELAY SDK. RELAY Consumers abstract all the setup of connecting to RELAY and automatically dispatch workers to handle requests. Consumers will receive requests and delegate them to their own worker thread, allowing you to focus on your business logic without having to worry about multi-threading or blocking, everything just works. Think of RELAY Consumers like a background worker system for all your calling and messaging needs. ## Creating Consumers -A Relay Consumer is a simple application framework, customized by specifying [contexts][index] and event handlers to respond to incoming events. +A RELAY Consumer is a simple application framework, customized by specifying [contexts][index] and event handlers to respond to incoming events. -A consumer has 2 required properties: `project`, `token`, and usually requires at least one `contexts` for incoming events. Project and Token are used to authenticate your Consumer to your SignalWire account. Contexts are a list of contexts you want this Consumer to listen for. [Learn more about Contexts][index]. +A consumer has 2 required properties: `project`, `token`, and usually requires at least one `contexts` for incoming events. Project and Token are used to authenticate your Consumer to your SignalWire account. Contexts are a list of contexts you want this Consumer to listen for. [Learn more about RELAY Contexts][index]. A consumer is created by inheriting the `Consumer` type, and then overriding the available methods. It is then executed by initializing and calling the `Run` method on it. @@ -105,7 +105,7 @@ namespace Example ### Ready -Executed when the Consumer has connected and is ready to make Relay requests. +Executed when the Consumer has connected and is ready to make RELAY requests. ```csharp using SignalWire.Relay; @@ -267,7 +267,7 @@ namespace Example ## Cleaning Up on Exit -When a Relay Consumer shuts down, you have the opportunity to clean up any resources held by the consumer. For example, you could close any open files, network connections, or send a notification to your monitoring service. +When a RELAY Consumer shuts down, you have the opportunity to clean up any resources held by the consumer. For example, you could close any open files, network connections, or send a notification to your monitoring service. Just implement a `Teardown` method in your consumer and it will be called during the shutdown procedure. diff --git a/website/realtime-sdk_versioned_docs/version-v2/language/dotnet/index.mdx b/website/realtime-sdk_versioned_docs/version-v2/language/dotnet/index.mdx index 37a6b71a3..d5cd9b2db 100644 --- a/website/realtime-sdk_versioned_docs/version-v2/language/dotnet/index.mdx +++ b/website/realtime-sdk_versioned_docs/version-v2/language/dotnet/index.mdx @@ -1,5 +1,5 @@ --- -title: Relay SDK for .NET +title: RELAY SDK for .NET sidebar_label: Overview sidebar_position: 0 --- @@ -13,13 +13,13 @@ sidebar_position: 0 [task]: ./task/ [signalwire-signalwire-dotnet]: https://github.com/signalwire/signalwire-dotnet -# Relay SDK for .NET +# RELAY SDK for .NET ## Getting Started -The Relay SDK for .NET enables .NET developers to connect and use SignalWire's Relay APIs within their own .NET code. Our Relay SDK allows developers to build or add robust and innovative communication services to their applications. +The RELAY SDK for .NET enables .NET developers to connect and use SignalWire's RELAY APIs within their own .NET code. Our RELAY SDK allows developers to build or add robust and innovative communication services to their applications. -The Relay SDK for .NET is easy to use and only takes a few minute to setup and get running. +The RELAY SDK for .NET is easy to use and only takes a few minute to setup and get running. ### Installation @@ -38,15 +38,15 @@ The .NET SDK may be used with [.NET Framework 4.6.1][net-framework-4-6-1] or gre ## Using the SDK -The .NET SDK can be used to get up and running with Relay quickly and easily. In order to use the .NET client, you must get your **project** and **token** from your SignalWire dashboard. +The .NET SDK can be used to get up and running with RELAY quickly and easily. In order to use the .NET client, you must get your **project** and **token** from your SignalWire dashboard. There are a few ways to get started, depending on your needs: **`SignalWire.Relay.Consumer`**, **`SignalWire.Relay.Task`**, and **`SignalWire.Relay.Client`**. -## Relay Consumer +## RELAY Consumer -A [`SignalWire.Relay.Consumer`][relay-consumer] creates a long running process, allowing you to respond to incoming requests and events in realtime. Relay Consumers abstract all the setup of connecting to Relay and automatically dispatches workers to handle requests; so you can concentrate on writing your code without having to worry about multi-threading or blocking, everything just works. Think of Relay Consumers like a background worker system for all your calling and messaging needs. +A [`SignalWire.Relay.Consumer`][relay-consumer] creates a long running process, allowing you to respond to incoming requests and events in realtime. RELAY Consumers abstract all the setup of connecting to RELAY and automatically dispatches workers to handle requests; so you can concentrate on writing your code without having to worry about multi-threading or blocking, everything just works. Think of RELAY Consumers like a background worker system for all your calling and messaging needs. -Relay Consumers can scale easily, simply by running multiple instances of your `SignalWire.Relay.Consumer` process. Each event will only be delivered to a single consumer, so as your volume increases, just scale up! This process works well whether you are using Docker Swarm, a Procfile on Heroku, your own webserver, and most other environments. +RELAY Consumers can scale easily, simply by running multiple instances of your `SignalWire.Relay.Consumer` process. Each event will only be delivered to a single consumer, so as your volume increases, just scale up! This process works well whether you are using Docker Swarm, a Procfile on Heroku, your own webserver, and most other environments. > Setting up a new consumer is the easiest way to get up and running. @@ -88,13 +88,13 @@ namespace Example } ``` -[Learn more about Relay Consumers][relay-consumer] +[Learn more about RELAY Consumers][relay-consumer] -## Relay Task +## RELAY Task -A [`SignalWire.Relay.RelayTask`][task] is simple way to send jobs to your [`SignalWire.Relay.Consumer`][relay-consumer] from a short lived process, like a web framework. Relay Tasks allow you to pass commands down to your Consumers without blocking your short lived request. Think of a Relay Task as a way to queue a job for your background workers to processes asynchronously. +A [`SignalWire.Relay.RelayTask`][task] is simple way to send jobs to your [`SignalWire.Relay.Consumer`][relay-consumer] from a short lived process, like a web framework. RELAY Tasks allow you to pass commands down to your Consumers without blocking your short lived request. Think of a RELAY Task as a way to queue a job for your background workers to processes asynchronously. -For example, if you wanted to make an outbound call and play a message when your user clicks a button on your web application, since Relay is a realtime protocol and relies on you to tell it what to do in realtime, if you did this within your web application, your web server would block until the call was finished... this may take a long time! Instead, simply create a new Relay Task. This task will be handled by a running Relay Consumer process and your web application can respond back to your user immediately. +For example, if you wanted to make an outbound call and play a message when your user clicks a button on your web application, since RELAY is a realtime protocol and relies on you to tell it what to do in realtime, if you did this within your web application, your web server would block until the call was finished... this may take a long time! Instead, simply create a new RELAY Task. This task will be handled by a running RELAY Consumer process and your web application can respond back to your user immediately. ```csharp RelayTask.Deliver(validHost, validProjectID, validToken, validContext, new JObject { @@ -103,11 +103,11 @@ RelayTask.Deliver(validHost, validProjectID, validToken, validContext, new JObje }); ``` -[Learn more about Relay Tasks][task] +[Learn more about RELAY Tasks][task] -## Relay Client +## RELAY Client -[`SignalWire.Relay.Client`][relay-client] is a lower level object, giving you a basic connection to Relay but that is all. It is best used when you are creating a script only concerned with sending outbound requests or you want complete control over the Relay connection yourself. +[`SignalWire.Relay.Client`][relay-client] is a lower level object, giving you a basic connection to RELAY but that is all. It is best used when you are creating a script only concerned with sending outbound requests or you want complete control over the RELAY connection yourself. > Setting up a new client and make an outbound call. @@ -152,11 +152,11 @@ namespace Example } ``` -[Learn more about Relay Clients][relay-client] +[Learn more about RELAY Clients][relay-client] ### Contexts -Relay uses **Contexts** as a simple way to separate events to specific consumers, allowing you to write consumers for specific types of calls or messages or scale them independently. A Context is simply a named string, that allows you to categorize requests. When creating outbound requests, or configuring phone numbers for inbound requests, you can specify the **context**; Relay will then deliver that call or event to Consumers that are configured to listen for that context. +RELAY uses **Contexts** as a simple way to separate events to specific consumers, allowing you to write consumers for specific types of calls or messages or scale them independently. A Context is simply a named string, that allows you to categorize requests. When creating outbound requests, or configuring phone numbers for inbound requests, you can specify the **context**; RELAY will then deliver that call or event to Consumers that are configured to listen for that context. -For example, you could have a customer support phone number configured to send to Relay with the `support` context, and a personal number configured with `personal` context. Relay would deliver these events to any Consumer listening for those contexts. This gives you a lot of control in how messages are delivered to your Consumers, allowing you to write Consumer classes specific to the context, scale them independently, or separate traffic based on your own business rules. +For example, you could have a customer support phone number configured to send to RELAY with the `support` context, and a personal number configured with `personal` context. RELAY would deliver these events to any Consumer listening for those contexts. This gives you a lot of control in how messages are delivered to your Consumers, allowing you to write Consumer classes specific to the context, scale them independently, or separate traffic based on your own business rules. diff --git a/website/realtime-sdk_versioned_docs/version-v2/language/dotnet/relay-client.mdx b/website/realtime-sdk_versioned_docs/version-v2/language/dotnet/relay-client.mdx index 4255fa33a..06058df1e 100644 --- a/website/realtime-sdk_versioned_docs/version-v2/language/dotnet/relay-client.mdx +++ b/website/realtime-sdk_versioned_docs/version-v2/language/dotnet/relay-client.mdx @@ -11,11 +11,11 @@ sidebar_position: 1 # SignalWire.Relay.Client -`SignalWire.Relay.Client` is the basic connection to Relay, allowing you send commands to Relay and set up handlers for inbound events. +`SignalWire.Relay.Client` is the basic connection to RELAY, allowing you send commands to RELAY and set up handlers for inbound events. ## Constructor -Constructs a client object to interact with Relay. +Constructs a client object to interact with RELAY. **Parameters** @@ -26,7 +26,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. ```csharp Client client = new Client("my-project-id", "my-project-token"); @@ -43,7 +43,7 @@ Client client = new Client("my-project-id", "my-project-token"); ### Connect -Activates the connection to the Relay API. The connection to Relay does not happen automatically so that you can setup handlers to events that might occur before the connection is successfully established. +Activates the connection to the RELAY API. The connection to RELAY does not happen automatically so that you can setup handlers to events that might occur before the connection is successfully established. **Returns** @@ -58,7 +58,7 @@ client.Connect() ### Disconnect -Disconnect the client from Relay. +Disconnect the client from RELAY. **Returns** diff --git a/website/realtime-sdk_versioned_docs/version-v2/language/dotnet/task/index.mdx b/website/realtime-sdk_versioned_docs/version-v2/language/dotnet/task/index.mdx index 0a0c14d36..89a5ab642 100644 --- a/website/realtime-sdk_versioned_docs/version-v2/language/dotnet/task/index.mdx +++ b/website/realtime-sdk_versioned_docs/version-v2/language/dotnet/task/index.mdx @@ -6,9 +6,9 @@ title: Task API # SignalWire.Relay.TaskingAPI -This represents the API interface for the Tasking Relay Service. A [`SignalWire.Relay.RelayTask`] is simple way to send jobs to your [`SignalWire.Relay.Consumer`][consumer] from a short lived process, like a web framework. Relay Tasks allow you to pass commands down to your Consumers without blocking your short lived request. Think of a Relay Task as a way to queue a job for your background workers to processes asynchronously. +This represents the API interface for the Tasking RELAY Service. A [`SignalWire.Relay.RelayTask`] is simple way to send jobs to your [`SignalWire.Relay.Consumer`][consumer] from a short lived process, like a web framework. RELAY Tasks allow you to pass commands down to your Consumers without blocking your short lived request. Think of a RELAY Task as a way to queue a job for your background workers to processes asynchronously. -For example, if you wanted to make an outbound call and play a message when your user clicks a button on your web application, since Relay is a realtime protocol and relies on you to tell it what to do in realtime, if you did this within your web application, your web server would block until the call was finished... this may take a long time! Instead, simply create a new Relay Task. This task will be handled by a running Relay Consumer process and your web application can respond back to your user immediately. +For example, if you wanted to make an outbound call and play a message when your user clicks a button on your web application, since RELAY is a realtime protocol and relies on you to tell it what to do in realtime, if you did this within your web application, your web server would block until the call was finished... this may take a long time! Instead, simply create a new RELAY Task. This task will be handled by a running RELAY Consumer process and your web application can respond back to your user immediately. ## Methods @@ -57,9 +57,9 @@ All these events can be used to track a task. # SignalWire.Relay.RelayTask -A `SignalWire.Relay.RelayTask` is a simple way to send jobs to your [`SignalWire.Relay.Consumer`][consumer] from a short lived process, like a web framework. Relay Tasks allow you to pass commands down to your Consumers without blocking your short lived request. Think of a Relay Task as a way to queue a job for your background workers to processes asynchronously. +A `SignalWire.Relay.RelayTask` is a simple way to send jobs to your [`SignalWire.Relay.Consumer`][consumer] from a short lived process, like a web framework. RELAY Tasks allow you to pass commands down to your Consumers without blocking your short lived request. Think of a RELAY Task as a way to queue a job for your background workers to processes asynchronously. -For example, if you wanted to make an outbound call and play a message when your user clicks a button on your web application, since Relay is a realtime protocol and relies on you to tell it what to do in realtime, if you did this within your web application, your web server would block until the call was finished... this may take a long time! Instead, simply create a new Relay Task. This task will be handled by a running Relay Consumer process and your web application can respond back to your user immediately. +For example, if you wanted to make an outbound call and play a message when your user clicks a button on your web application, since RELAY is a realtime protocol and relies on you to tell it what to do in realtime, if you did this within your web application, your web server would block until the call was finished... this may take a long time! Instead, simply create a new RELAY Task. This task will be handled by a running RELAY Consumer process and your web application can respond back to your user immediately. ## Constructor diff --git a/website/realtime-sdk_versioned_docs/version-v2/language/golang/consumer.mdx b/website/realtime-sdk_versioned_docs/version-v2/language/golang/consumer.mdx index b255a10f6..baca6c582 100644 --- a/website/realtime-sdk_versioned_docs/version-v2/language/golang/consumer.mdx +++ b/website/realtime-sdk_versioned_docs/version-v2/language/golang/consumer.mdx @@ -11,13 +11,13 @@ sidebar_position: 2 ## Relay.Consumer -A Relay Consumer is a Go object that runs Go routines in the background along side your application to handle calling and messaging events in realtime. Relay Consumers abstract all the setup of connecting to Relay and automatically dispatch workers to handle requests. Consumers will receive requests and delegate them to their own worker thread, allowing you to focus on your business logic without having to worry about multi-threading or blocking, everything just works. Think of Relay Consumers like a background worker system for all your calling and messaging needs. +A RELAY Consumer is a Go object that runs Go routines in the background along side your application to handle calling and messaging events in realtime. RELAY Consumers abstract all the setup of connecting to RELAY and automatically dispatch workers to handle requests. Consumers will receive requests and delegate them to their own worker thread, allowing you to focus on your business logic without having to worry about multi-threading or blocking, everything just works. Think of RELAY Consumers like a background worker system for all your calling and messaging needs. ## Creating Consumers -A Relay Consumer is an object, customized by specifying [contexts][link] and event handlers to respond to incoming events. +A RELAY Consumer is an object, customized by specifying [contexts][link] and event handlers to respond to incoming events. -A consumer has 2 required properties: `project`, `token`, and usually requires at least one `contexts` for incoming events. Project and Token are used to authenticate your Consumer to your SignalWire account. Contexts are a list of contexts you want this Consumer to listen for. [Learn more about Contexts][link]. +A consumer has 2 required properties: `project`, `token`, and usually requires at least one `contexts` for incoming events. Project and Token are used to authenticate your Consumer to your SignalWire account. Contexts are a list of contexts you want this Consumer to listen for. [Learn more about RELAY Contexts][link]. ```go Contexts = append(Contexts, PContext) @@ -89,7 +89,7 @@ consumer.OnTask = MyOnTask ### onReady -Executed once your Consumer is connected to Relay and the session has been established. +Executed once your Consumer is connected to RELAY and the session has been established. ```go @@ -153,7 +153,7 @@ func MyOnIncomingCall(consumer *signalwire.Consumer, call *signalwire.CallObj) { ## Cleaning Up on Exit -When a Relay Consumer shuts down, you have the opportunity to clean up any resources held by the consumer. For example, you could close any open files, network connections, or send a notification to your monitoring service. +When a RELAY Consumer shuts down, you have the opportunity to clean up any resources held by the consumer. For example, you could close any open files, network connections, or send a notification to your monitoring service. Implement an `Teardown` method in your consumer and it will be called during the shutdown procedure. diff --git a/website/realtime-sdk_versioned_docs/version-v2/language/golang/index.mdx b/website/realtime-sdk_versioned_docs/version-v2/language/golang/index.mdx index 21ebeeb80..104544cb2 100644 --- a/website/realtime-sdk_versioned_docs/version-v2/language/golang/index.mdx +++ b/website/realtime-sdk_versioned_docs/version-v2/language/golang/index.mdx @@ -5,13 +5,13 @@ sidebar_label: Overview [link]: ./consumer.mdx -# Relay SDK for Go Lang +# RELAY SDK for Go Lang ## Getting Started -The Relay SDK for Go enables Go developers to connect and use SignalWire's Relay APIs within their own Go code. Our Relay SDK allows developers to build or add robust and innovative communication services to their applications. +The RELAY SDK for Go enables Go developers to connect and use SignalWire's RELAY APIs within their own Go code. Our RELAY SDK allows developers to build or add robust and innovative communication services to their applications. -The Relay SDK for Go is easy to use and only takes a few minute to setup and get running. +The RELAY SDK for Go is easy to use and only takes a few minute to setup and get running. @@ -29,15 +29,15 @@ The Go SDK requires **`Go 1.11`** or greater installed on your system. ## Using the SDK -The Go SDK can be used to get up and running with Relay quickly and easily. In order to use the Go client, you must get your **project** and **token** from your SignalWire dashboard. +The Go SDK can be used to get up and running with RELAY quickly and easily. In order to use the Go client, you must get your **project** and **token** from your SignalWire dashboard. There are a few ways to get started, depending on your needs: **`Relay.Consumer`**, **`Relay.Task`**, and **`Relay.Client`**. -### Relay Consumer +### RELAY Consumer -A [`Relay.Consumer`][link] creates a long running process, allowing you to respond to incoming requests and events in realtime. Relay Consumers abstract all the setup of connecting to Relay and automatically dispatches workers to handle requests; so you can concentrate on writing your code without having to worry about multi-threading or blocking, everything just works. Think of Relay Consumers like a background worker system for all your calling and messaging needs. +A [`Relay.Consumer`][link] creates a long running process, allowing you to respond to incoming requests and events in realtime. RELAY Consumers abstract all the setup of connecting to RELAY and automatically dispatches workers to handle requests; so you can concentrate on writing your code without having to worry about multi-threading or blocking, everything just works. Think of RELAY Consumers like a background worker system for all your calling and messaging needs. -Relay Consumers can scale easily, simply by running multiple instances of your `Relay.Consumer` process. Each event will only be delivered to a single consumer, so as your volume increases, just scale up! This process works well whether you are using Docker Swarm, a Procfile on Heroku, your own webserver, and most other environments. +RELAY Consumers can scale easily, simply by running multiple instances of your `Relay.Consumer` process. Each event will only be delivered to a single consumer, so as your volume increases, just scale up! This process works well whether you are using Docker Swarm, a Procfile on Heroku, your own webserver, and most other environments. > Setting up a new consumer is the easiest way to get up and running. @@ -53,12 +53,12 @@ if err := consumer.Run(); err != nil { } ``` -[Learn more about Relay Consumers][link] +[Learn more about RELAY Consumers][link] ## Contexts -Relay uses **Contexts** as a simple way to separate events to specific consumers, allowing you to write consumers for specific types of calls or messages or scale them independently. A Context is simply a named string, that allows you to categorize requests. When creating outbound requests, or configuring phone numbers for inbound requests, you can specify the **context**; Relay will then deliver that call or event to Consumers that are configured to listen for that context. +RELAY uses **Contexts** as a simple way to separate events to specific consumers, allowing you to write consumers for specific types of calls or messages or scale them independently. A Context is simply a named string, that allows you to categorize requests. When creating outbound requests, or configuring phone numbers for inbound requests, you can specify the **context**; RELAY will then deliver that call or event to Consumers that are configured to listen for that context. -For example, you could have a customer support phone number configured to send to Relay with the `support` context, and a personal number configured with `personal` context. Relay would deliver these events to any Consumer listening for those contexts. This gives you a lot of control in how messages are delivered to your Consumers, allowing you to write Consumer classes specific to the context, scale them independently, or separate traffic based on your own business rules. \ No newline at end of file +For example, you could have a customer support phone number configured to send to RELAY with the `support` context, and a personal number configured with `personal` context. RELAY would deliver these events to any Consumer listening for those contexts. This gives you a lot of control in how messages are delivered to your Consumers, allowing you to write Consumer classes specific to the context, scale them independently, or separate traffic based on your own business rules. \ No newline at end of file diff --git a/website/realtime-sdk_versioned_docs/version-v2/language/golang/relay-client.mdx b/website/realtime-sdk_versioned_docs/version-v2/language/golang/relay-client.mdx index 8158d9756..c84d09112 100644 --- a/website/realtime-sdk_versioned_docs/version-v2/language/golang/relay-client.mdx +++ b/website/realtime-sdk_versioned_docs/version-v2/language/golang/relay-client.mdx @@ -10,11 +10,11 @@ sidebar_position: 1 # 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** @@ -27,7 +27,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. ```go signalwireContexts := []string{DefaultContext} @@ -47,7 +47,7 @@ client := signalwire.Client(PProjectID, PTokenID, "" /*host, empty for default*/ ### Connect() -Activates the connection to the Relay API. The connection to Relay does not happen automatically so that you can setup handlers to events that might occur before the connection is successfully established. +Activates the connection to the RELAY API. The connection to RELAY does not happen automatically so that you can setup handlers to events that might occur before the connection is successfully established. **Returns** @@ -73,7 +73,7 @@ if err != nil { ### Disconnect() -Disconnect the client from Relay. +Disconnect the client from RELAY. **Returns** diff --git a/website/realtime-sdk_versioned_docs/version-v2/language/golang/task/index.mdx b/website/realtime-sdk_versioned_docs/version-v2/language/golang/task/index.mdx index 79f50e4ba..3f343d4fe 100644 --- a/website/realtime-sdk_versioned_docs/version-v2/language/golang/task/index.mdx +++ b/website/realtime-sdk_versioned_docs/version-v2/language/golang/task/index.mdx @@ -9,7 +9,7 @@ sidebar_position: 1 ## Relay.Task -A `Relay.Task` is simple way to send jobs to your [`Relay.Consumers`][link] from a short lived process, like a web framework. Relay Tasks allow you to pass commands down to your Consumers without blocking your short lived request. Think of a Relay Task as a way to queue a job for your background workers to processes asynchronously. +A `Relay.Task` is simple way to send jobs to your [`Relay.Consumers`][link] from a short lived process, like a web framework. RELAY Tasks allow you to pass commands down to your Consumers without blocking your short lived request. Think of a RELAY Task as a way to queue a job for your background workers to processes asynchronously. ### Methods-submenu diff --git a/website/realtime-sdk_versioned_docs/version-v2/language/nodejs/consumer.mdx b/website/realtime-sdk_versioned_docs/version-v2/language/nodejs/consumer.mdx index 96afaad15..801c75ad7 100644 --- a/website/realtime-sdk_versioned_docs/version-v2/language/nodejs/consumer.mdx +++ b/website/realtime-sdk_versioned_docs/version-v2/language/nodejs/consumer.mdx @@ -11,11 +11,11 @@ sidebar_position: 1 # Relay.Consumer -A Relay Consumer is a simple Node object that runs in its own process along side your application to handle calling and messaging events in realtime. Relay Consumers abstract all the setup of connecting to Relay and automatically dispatch workers to handle requests. Consumers will receive requests and delegate them to their own worker thread, allowing you to focus on your business logic without having to worry about multi-threading or blocking, everything just works. Think of Relay Consumers like a background worker system for all your calling and messaging needs. +A RELAY Consumer is a simple Node object that runs in its own process along side your application to handle calling and messaging events in realtime. RELAY Consumers abstract all the setup of connecting to RELAY and automatically dispatch workers to handle requests. Consumers will receive requests and delegate them to their own worker thread, allowing you to focus on your business logic without having to worry about multi-threading or blocking, everything just works. Think of RELAY Consumers like a background worker system for all your calling and messaging needs. ## Creating Consumers -A Relay Consumer is a simple object, customized by specifying contexts and event handlers to respond to incoming events. +A RELAY Consumer is a simple object, customized by specifying contexts and event handlers to respond to incoming events. A consumer has 2 required properties: `project`, `token`, and usually requires at least one `contexts` for incoming events. Project and Token are used to authenticate your Consumer to your SignalWire account. Contexts are a list of contexts you want this Consumer to listen for. @@ -75,7 +75,7 @@ Event handlers are where you will write most of your code. They are executed whe ### ready -Executed once your Consumer is connected to Relay and the session has been established. It passes in the Consumer object itself. +Executed once your Consumer is connected to RELAY and the session has been established. It passes in the Consumer object itself. ```javascript const { RelayConsumer } = require('@signalwire/node') @@ -198,7 +198,7 @@ consumer.run() ## Cleaning Up on Exit -When a Relay Consumer shuts down, you have the opportunity to clean up any resources held by the consumer. For example, you could close any open files, network connections, or send a notification to your monitoring service. +When a RELAY Consumer shuts down, you have the opportunity to clean up any resources held by the consumer. For example, you could close any open files, network connections, or send a notification to your monitoring service. Just implement a `teardown` method in your consumer and it will be called during the shutdown procedure. @@ -227,4 +227,4 @@ Running a consumer is just like running any Node.js script, simply execute the s ## Shutting Down Consumers -In order to gracefully shut down a Relay consumer process, send it the `SIGTERM` signal. Most process supervisors such as Runit, Docker and Kubernetes send this signal when shutting down a process, so using those systems will make things easier. \ No newline at end of file +In order to gracefully shut down a RELAY consumer process, send it the `SIGTERM` signal. Most process supervisors such as Runit, Docker and Kubernetes send this signal when shutting down a process, so using those systems will make things easier. \ No newline at end of file diff --git a/website/realtime-sdk_versioned_docs/version-v2/language/nodejs/index.mdx b/website/realtime-sdk_versioned_docs/version-v2/language/nodejs/index.mdx index 37ec5813a..331ed571e 100644 --- a/website/realtime-sdk_versioned_docs/version-v2/language/nodejs/index.mdx +++ b/website/realtime-sdk_versioned_docs/version-v2/language/nodejs/index.mdx @@ -1,5 +1,5 @@ --- -title: Relay SDK for Node.js +title: RELAY SDK for Node.js sidebar_label: Overview --- @@ -16,11 +16,11 @@ sidebar_label: Overview [task]: ./task/ [voice]: ./calling/ -# Relay SDK for Node.js +# RELAY SDK for Node.js ## Getting Started -The Relay SDK for Node.js enables Node.js developers to connect and use SignalWire's Relay APIs within their own Node.js code. Our Relay SDK allows developers to build or add robust and innovative communication services to their applications. +The RELAY SDK for Node.js enables Node.js developers to connect and use SignalWire's RELAY APIs within their own Node.js code. Our RELAY SDK allows developers to build or add robust and innovative communication services to their applications. ## Installation @@ -36,15 +36,15 @@ The Node.js SDK may be used with Node.js 8.0 or greater. ## Using the SDK -The Node.js SDK can be used to get up and running with Relay quickly and easily. In order to use the Node.js client, you must get your **project** and **token** from your SignalWire dashboard. +The Node.js SDK can be used to get up and running with RELAY quickly and easily. In order to use the Node.js client, you must get your **project** and **token** from your SignalWire dashboard. There are a few ways to get started, depending on your needs: **`Relay.Consumer`**, **`Relay.Task`**, and **`Relay.Client`**. -### Relay Consumer +### RELAY Consumer -A [`Relay.Consumer`][relay-consumer] creates a long running process, allowing you to respond to incoming requests and events in realtime. Relay Consumers abstract all the setup of connecting to Relay and automatically dispatches workers to handle requests; so you can concentrate on writing your code without having to worry about multi-threading or blocking, everything just works. Think of Relay Consumers like a background worker system for all your calling and messaging needs. +A [`Relay.Consumer`][relay-consumer] creates a long running process, allowing you to respond to incoming requests and events in realtime. RELAY Consumers abstract all the setup of connecting to RELAY and automatically dispatches workers to handle requests; so you can concentrate on writing your code without having to worry about multi-threading or blocking, everything just works. Think of RELAY Consumers like a background worker system for all your calling and messaging needs. -Relay Consumers can scale easily, simply by running multiple instances of your `Relay.Consumer` process. Each event will only be delivered to a single consumer, so as your volume increases, just scale up! This process works well whether you are using Docker Swarm, a Procfile on Heroku, your own webserver, and most other environments. +RELAY Consumers can scale easily, simply by running multiple instances of your `Relay.Consumer` process. Each event will only be delivered to a single consumer, so as your volume increases, just scale up! This process works well whether you are using Docker Swarm, a Procfile on Heroku, your own webserver, and most other environments. > Setting up a new consumer is the easiest way to get up and running. @@ -70,13 +70,13 @@ const consumer = new RelayConsumer({ consumer.run() ``` -[Learn more about Relay Consumers][relay-consumer] +[Learn more about RELAY Consumers][relay-consumer] -### Relay Task +### RELAY Task -A `Relay.Task` is simple way to send jobs to your [`Relay.Consumers`][relay-consumers] from a short lived process, like a web framework. Relay Tasks allow you to pass commands down to your Consumers without blocking your short lived request. Think of a Relay Task as a way to queue a job for your background workers to processes asynchronously. +A `Relay.Task` is simple way to send jobs to your [`Relay.Consumers`][relay-consumers] from a short lived process, like a web framework. RELAY Tasks allow you to pass commands down to your Consumers without blocking your short lived request. Think of a RELAY Task as a way to queue a job for your background workers to processes asynchronously. -For example, if you wanted to make an outbound call and play a message when your user clicks a button on your web application, since Relay is a realtime protocol and relies on you to tell it what to do in realtime, if you did this within your web application, your web server would block until the call was finished... this may take a long time! Instead, simply create a new Relay Task. This task will be handled by a running Relay Consumer process and your web application can respond back to your user immediately. +For example, if you wanted to make an outbound call and play a message when your user clicks a button on your web application, since RELAY is a realtime protocol and relies on you to tell it what to do in realtime, if you did this within your web application, your web server would block until the call was finished... this may take a long time! Instead, simply create a new RELAY Task. This task will be handled by a running RELAY Consumer process and your web application can respond back to your user immediately. > Send a task in the `office` context with custom data. @@ -121,11 +121,11 @@ const consumer = new RelayConsumer({ consumer.run() ``` -[Learn more about Relay Tasks][relay-task] +[Learn more about RELAY Tasks][relay-task] -### Relay Client +### RELAY Client -[`Relay.Client`][relay-client] is a lower level object, giving you a basic connection to Relay but that is all. It is best used when you are creating a script only concerned with sending outbound requests or you want complete control over the Relay connection yourself. +[`Relay.Client`][relay-client] is a lower level object, giving you a basic connection to RELAY but that is all. It is best used when you are creating a script only concerned with sending outbound requests or you want complete control over the RELAY connection yourself. > Setting up a new client and make an outbound call. @@ -153,13 +153,13 @@ client.on('signalwire.ready', async (client) => { client.connect() ``` -[Learn more about Relay Clients][relay-client] +[Learn more about RELAY Clients][relay-client] ## Contexts -Relay uses **Contexts** as a simple way to separate events to specific consumers, allowing you to write consumers for specific types of calls or messages or scale them independently. A Context is simply a named string, that allows you to categorize requests. When creating outbound requests, or configuring phone numbers for inbound requests, you can specify the **context**; Relay will then deliver that call or event to Consumers that are configured to listen for that context. +RELAY uses **Contexts** as a simple way to separate events to specific consumers, allowing you to write consumers for specific types of calls or messages or scale them independently. A Context is simply a named string, that allows you to categorize requests. When creating outbound requests, or configuring phone numbers for inbound requests, you can specify the **context**; RELAY will then deliver that call or event to Consumers that are configured to listen for that context. -For example, you could have a customer support phone number configured to send to Relay with the `support` context, and a personal number configured with `personal` context. Relay would deliver these events to any Consumer listening for those contexts. This gives you a lot of control in how messages are delivered to your Consumers, allowing you to write Consumer classes specific to the context, scale them independently, or separate traffic based on your own business rules. +For example, you could have a customer support phone number configured to send to RELAY with the `support` context, and a personal number configured with `personal` context. RELAY would deliver these events to any Consumer listening for those contexts. This gives you a lot of control in how messages are delivered to your Consumers, allowing you to write Consumer classes specific to the context, scale them independently, or separate traffic based on your own business rules. # API Reference \ No newline at end of file diff --git a/website/realtime-sdk_versioned_docs/version-v2/language/nodejs/relay-client.mdx b/website/realtime-sdk_versioned_docs/version-v2/language/nodejs/relay-client.mdx index d77a926f9..655781486 100644 --- a/website/realtime-sdk_versioned_docs/version-v2/language/nodejs/relay-client.mdx +++ b/website/realtime-sdk_versioned_docs/version-v2/language/nodejs/relay-client.mdx @@ -1,6 +1,6 @@ --- title: Relay.Client -sidebar_label: Relay Client +sidebar_label: RELAY Client sidebar_position: 0 --- @@ -11,11 +11,11 @@ sidebar_position: 0 # 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 @@ -26,7 +26,7 @@ Constructs a client object to interact with Relay. ### Example -Create a Client to interact with the Relay API. +Create a Client to interact with the RELAY API. ```javascript const client = new RelayClient({ @@ -47,7 +47,7 @@ const client = new RelayClient({ ### connect -Activates the connection to the Relay API. The connection to Relay does not happen automatically so that you can setup handlers to events that might occur before the connection is successfully established. +Activates the connection to the RELAY API. The connection to RELAY does not happen automatically so that you can setup handlers to events that might occur before the connection is successfully established. #### Returns @@ -62,7 +62,7 @@ await client.connect() ### disconnect -Disconnect the client from Relay. +Disconnect the client from RELAY. #### Returns diff --git a/website/realtime-sdk_versioned_docs/version-v2/language/nodejs/task/index.mdx b/website/realtime-sdk_versioned_docs/version-v2/language/nodejs/task/index.mdx index fb8258a18..7f470b4e8 100644 --- a/website/realtime-sdk_versioned_docs/version-v2/language/nodejs/task/index.mdx +++ b/website/realtime-sdk_versioned_docs/version-v2/language/nodejs/task/index.mdx @@ -6,7 +6,7 @@ title: Relay.Task # Relay.Task -A `Relay.Task` is simple way to send jobs to your [`Relay.Consumers`][relay-consumers] from a short lived process, like a web framework. Relay Tasks allow you to pass commands down to your Consumers without blocking your short lived request. Think of a Relay Task as a way to queue a job for your background workers to processes asynchronously. +A `Relay.Task` is simple way to send jobs to your [`Relay.Consumers`][relay-consumers] from a short lived process, like a web framework. RELAY Tasks allow you to pass commands down to your Consumers without blocking your short lived request. Think of a RELAY Task as a way to queue a job for your background workers to processes asynchronously. ## Creating Tasks diff --git a/website/realtime-sdk_versioned_docs/version-v2/language/php/consumer.mdx b/website/realtime-sdk_versioned_docs/version-v2/language/php/consumer.mdx index 3edd271d3..9bc3a7daf 100644 --- a/website/realtime-sdk_versioned_docs/version-v2/language/php/consumer.mdx +++ b/website/realtime-sdk_versioned_docs/version-v2/language/php/consumer.mdx @@ -14,11 +14,11 @@ sidebar_position: 1 [index]: ./index.mdx#contexts -A Relay Consumer is a simple PHP class that runs in its own process along side your application to handle calling and messaging events in realtime. Relay Consumers abstract all the setup of connecting to Relay and automatically dispatch workers to handle requests. Consumers will receive requests and delegate them to their own worker thread, allowing you to focus on your business logic without having to worry about multi-threading or blocking, everything just works. Think of Relay Consumers like a background worker system for all your calling and messaging needs. +A RELAY Consumer is a simple PHP class that runs in its own process along side your application to handle calling and messaging events in realtime. RELAY Consumers abstract all the setup of connecting to RELAY and automatically dispatch workers to handle requests. Consumers will receive requests and delegate them to their own worker thread, allowing you to focus on your business logic without having to worry about multi-threading or blocking, everything just works. Think of RELAY Consumers like a background worker system for all your calling and messaging needs. ## Creating Consumers -A Relay Consumer is a simple object, customized by specifying [contexts][index] and event handlers to respond to incoming events. +A RELAY Consumer is a simple object, customized by specifying [contexts][index] and event handlers to respond to incoming events. A consumer has 2 required properties: `project`, `token`, and usually requires at least one `contexts` for incoming events. Project and Token are used to authenticate your Consumer to your SignalWire account. Contexts are a list of contexts you want this Consumer to listen for. @@ -134,7 +134,7 @@ Event handlers are where you will write most of your code. They are executed whe ### ready -Executed once your Consumer is connected to Relay and the session has been established. +Executed once your Consumer is connected to RELAY and the session has been established. ```php run(); ## Cleaning Up on Exit -When a Relay Consumer shuts down, you have the opportunity to clean up any resources held by the consumer. For example, you could close any open files, network connections, or send a notification to your monitoring service. +When a RELAY Consumer shuts down, you have the opportunity to clean up any resources held by the consumer. For example, you could close any open files, network connections, or send a notification to your monitoring service. Just implement a `teardown` method in your consumer and it will be called during the shutdown procedure. @@ -321,4 +321,4 @@ Running a consumer is just like running any other PHP script, simply execute the ## Shutting Down Consumers -In order to gracefully shut down a Relay consumer process, send it the `SIGTERM` signal. Most process supervisors such as Runit, Docker and Kubernetes send this signal when shutting down a process, so using those systems will make things easier. \ No newline at end of file +In order to gracefully shut down a RELAY consumer process, send it the `SIGTERM` signal. Most process supervisors such as Runit, Docker and Kubernetes send this signal when shutting down a process, so using those systems will make things easier. \ No newline at end of file diff --git a/website/realtime-sdk_versioned_docs/version-v2/language/php/index.mdx b/website/realtime-sdk_versioned_docs/version-v2/language/php/index.mdx index 8c374ddda..048dcad26 100644 --- a/website/realtime-sdk_versioned_docs/version-v2/language/php/index.mdx +++ b/website/realtime-sdk_versioned_docs/version-v2/language/php/index.mdx @@ -1,5 +1,5 @@ --- -title: Relay SDK for PHP +title: RELAY SDK for PHP sidebar_label: Overview --- @@ -14,9 +14,9 @@ sidebar_label: Overview [relay-task]: ./task -The Relay SDK for PHP enables PHP developers to connect and use SignalWire's Relay APIs within their own PHP code. Our Relay SDK allows developers to build or add robust and innovative communication services to their applications. +The RELAY SDK for PHP enables PHP developers to connect and use SignalWire's RELAY APIs within their own PHP code. Our RELAY SDK allows developers to build or add robust and innovative communication services to their applications. -The Relay SDK for PHP is easy to use and only takes a few minute to setup and get running. +The RELAY SDK for PHP is easy to use and only takes a few minute to setup and get running. :::warning Package Maintenance Status **THIS PACKAGE IS NOT ACTIVELY MAINTAINED ANYMORE** @@ -39,15 +39,15 @@ The PHP SDK requires **`PHP 7.1`** or greater installed on your system. ## Using the SDK -The PHP SDK can be used to get up and running with Relay quickly and easily. In order to use the PHP client, you must get your **project** and **token** from your SignalWire dashboard. +The PHP SDK can be used to get up and running with RELAY quickly and easily. In order to use the PHP client, you must get your **project** and **token** from your SignalWire dashboard. There are a few ways to get started, depending on your needs: **`Relay.Consumer`**, **`Relay.Task`**, and **`Relay.Client`**. -### Relay Consumer +### RELAY Consumer -A [`Relay.Consumer`][relay-consumer] creates a long running process, allowing you to respond to incoming requests and events in realtime. Relay Consumers abstract all the setup of connecting to Relay and automatically dispatches workers to handle requests; so you can concentrate on writing your code without having to worry about multi-threading or blocking, everything just works. Think of Relay Consumers like a background worker system for all your calling and messaging needs. +A [`Relay.Consumer`][relay-consumer] creates a long running process, allowing you to respond to incoming requests and events in realtime. RELAY Consumers abstract all the setup of connecting to RELAY and automatically dispatches workers to handle requests; so you can concentrate on writing your code without having to worry about multi-threading or blocking, everything just works. Think of RELAY Consumers like a background worker system for all your calling and messaging needs. -Relay Consumers can scale easily, simply by running multiple instances of your `Relay.Consumer` process. Each event will only be delivered to a single consumer, so as your volume increases, just scale up! This process works well whether you are using Docker Swarm, a Procfile on Heroku, your own webserver, and most other environments. +RELAY Consumers can scale easily, simply by running multiple instances of your `Relay.Consumer` process. Each event will only be delivered to a single consumer, so as your volume increases, just scale up! This process works well whether you are using Docker Swarm, a Procfile on Heroku, your own webserver, and most other environments. :::tip Getting Started Setting up a new consumer is the easiest way to get up and running. @@ -84,13 +84,13 @@ $consumer = new CustomConsumer(); $consumer->run(); ``` -[Learn more about Relay Consumers][learn-more-about-relay-consumers] +[Learn more about RELAY Consumers][learn-more-about-relay-consumers] -### Relay Task +### RELAY Task -A [`Relay.Task`][relay-task] is simple way to send jobs to your [`Relay.Consumers`][relay-consumers] from a short lived process, like a web framework. Relay Tasks allow you to pass commands down to your Consumers without blocking your short lived request. Think of a Relay Task as a way to queue a job for your background workers to processes asynchronously. +A [`Relay.Task`][relay-task] is simple way to send jobs to your [`Relay.Consumers`][relay-consumers] from a short lived process, like a web framework. RELAY Tasks allow you to pass commands down to your Consumers without blocking your short lived request. Think of a RELAY Task as a way to queue a job for your background workers to processes asynchronously. -For example, if you wanted to make an outbound call and play a message when your user clicks a button on your web application, since Relay is a realtime protocol and relies on you to tell it what to do in realtime, if you did this within your web application, your web server would block until the call was finished... this may take a long time! Instead, simply create a new Relay Task. This task will be handled by a running Relay Consumer process and your web application can respond back to your user immediately. +For example, if you wanted to make an outbound call and play a message when your user clicks a button on your web application, since RELAY is a realtime protocol and relies on you to tell it what to do in realtime, if you did this within your web application, your web server would block until the call was finished... this may take a long time! Instead, simply create a new RELAY Task. This task will be handled by a running RELAY Consumer process and your web application can respond back to your user immediately. @@ -144,11 +144,11 @@ $consumer->run(); -[Learn more about Relay Tasks][learn-more-about-relay-tasks] +[Learn more about RELAY Tasks][learn-more-about-relay-tasks] -### Relay Client +### RELAY Client -[`Relay.Client`][relay-client] is a lower level object, giving you a basic connection to Relay but that is all. It is best used when you are creating a script only concerned with sending outbound requests or you want complete control over the Relay connection yourself. +[`Relay.Client`][relay-client] is a lower level object, giving you a basic connection to RELAY but that is all. It is best used when you are creating a script only concerned with sending outbound requests or you want complete control over the RELAY connection yourself. Setting up a new client and make an outbound call. @@ -175,10 +175,10 @@ $client->on('signalwire.ready', function($client) { $client->connect(); ``` -[Learn more about Relay Clients][learn-more-about-relay-clients] +[Learn more about RELAY Clients][learn-more-about-relay-clients] ## Contexts -Relay uses **Contexts** as a simple way to separate events to specific consumers, allowing you to write consumers for specific types of calls or messages or scale them independently. A Context is simply a named string, that allows you to categorize requests. When creating outbound requests, or configuring phone numbers for inbound requests, you can specify the **context**; Relay will then deliver that call or event to Consumers that are configured to listen for that context. +RELAY uses **Contexts** as a simple way to separate events to specific consumers, allowing you to write consumers for specific types of calls or messages or scale them independently. A Context is simply a named string, that allows you to categorize requests. When creating outbound requests, or configuring phone numbers for inbound requests, you can specify the **context**; RELAY will then deliver that call or event to Consumers that are configured to listen for that context. -For example, you could have a customer support phone number configured to send to Relay with the `support` context, and a personal number configured with `personal` context. Relay would deliver these events to any Consumer listening for those contexts. This gives you a lot of control in how messages are delivered to your Consumers, allowing you to write Consumer classes specific to the context, scale them independently, or separate traffic based on your own business rules. \ No newline at end of file +For example, you could have a customer support phone number configured to send to RELAY with the `support` context, and a personal number configured with `personal` context. RELAY would deliver these events to any Consumer listening for those contexts. This gives you a lot of control in how messages are delivered to your Consumers, allowing you to write Consumer classes specific to the context, scale them independently, or separate traffic based on your own business rules. \ No newline at end of file diff --git a/website/realtime-sdk_versioned_docs/version-v2/language/php/relay-client.mdx b/website/realtime-sdk_versioned_docs/version-v2/language/php/relay-client.mdx index c1880b915..557cfee63 100644 --- a/website/realtime-sdk_versioned_docs/version-v2/language/php/relay-client.mdx +++ b/website/realtime-sdk_versioned_docs/version-v2/language/php/relay-client.mdx @@ -1,6 +1,6 @@ --- title: Relay.Client -sidebar_label: Relay Client +sidebar_label: RELAY Client sidebar_position: 0 --- @@ -9,11 +9,11 @@ sidebar_position: 0 [relay-calling]: ./calling/ [link]: #events -`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** @@ -24,7 +24,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. ```php connect(); ### disconnect -Disconnect the client from Relay. +Disconnect the client from RELAY. **Returns** diff --git a/website/realtime-sdk_versioned_docs/version-v2/language/php/task/index.mdx b/website/realtime-sdk_versioned_docs/version-v2/language/php/task/index.mdx index 136f46325..97c4102bb 100644 --- a/website/realtime-sdk_versioned_docs/version-v2/language/php/task/index.mdx +++ b/website/realtime-sdk_versioned_docs/version-v2/language/php/task/index.mdx @@ -6,7 +6,7 @@ sidebar_label: Task [relay-consumers]: ../consumer [consumer]: ../consumer#ontask -A `Relay.Task` is simple way to send jobs to your [`Relay.Consumers`][relay-consumers] from a short lived process, like a web framework. Relay Tasks allow you to pass commands down to your Consumers without blocking your short lived request. Think of a Relay Task as a way to queue a job for your background workers to processes asynchronously. +A `Relay.Task` is simple way to send jobs to your [`Relay.Consumers`][relay-consumers] from a short lived process, like a web framework. RELAY Tasks allow you to pass commands down to your Consumers without blocking your short lived request. Think of a RELAY Task as a way to queue a job for your background workers to processes asynchronously. ## Creating Tasks diff --git a/website/realtime-sdk_versioned_docs/version-v2/language/python/consumer.mdx b/website/realtime-sdk_versioned_docs/version-v2/language/python/consumer.mdx index 70f42dd05..aad50604a 100644 --- a/website/realtime-sdk_versioned_docs/version-v2/language/python/consumer.mdx +++ b/website/realtime-sdk_versioned_docs/version-v2/language/python/consumer.mdx @@ -12,11 +12,11 @@ sidebar_position: 2 ## Relay.Consumer -A [`Relay.Consumer`][relay-consumer] is a simple object that runs in its own process along side your application to handle calling and messaging events in realtime. Relay Consumers abstract all the setup of connecting to Relay and automatically dispatch workers to handle requests. Consumers will receive requests and delegate them to their own worker thread, allowing you to focus on your business logic without having to worry about multi-threading or blocking, everything just works. Think of Relay Consumers like a background worker system for all your calling and messaging needs. +A [`Relay.Consumer`][relay-consumer] is a simple object that runs in its own process along side your application to handle calling and messaging events in realtime. RELAY Consumers abstract all the setup of connecting to RELAY and automatically dispatch workers to handle requests. Consumers will receive requests and delegate them to their own worker thread, allowing you to focus on your business logic without having to worry about multi-threading or blocking, everything just works. Think of RELAY Consumers like a background worker system for all your calling and messaging needs. ### Creating Consumers -A Relay Consumer is a simple object, customized by specifying contexts and event handlers to respond to incoming events. +A RELAY Consumer is a simple object, customized by specifying contexts and event handlers to respond to incoming events. A consumer has 2 required properties: `project`, `token`, and usually requires at least one `contexts` for incoming events. Project and Token are used to authenticate your Consumer to your SignalWire account. Contexts are a list of contexts you want this Consumer to listen for. @@ -75,7 +75,7 @@ Event handlers are where you will write most of your code. They are executed whe ### ready -Executed once your Consumer is connected to Relay and the session has been established. +Executed once your Consumer is connected to RELAY and the session has been established. ```python from signalwire.relay.consumer import Consumer @@ -185,7 +185,7 @@ consumer.run() ### Cleaning Up on Exit -When a Relay Consumer shuts down, you have the opportunity to clean up any resources held by the consumer. For example, you could close any open files, network connections, or send a notification to your monitoring service. +When a RELAY Consumer shuts down, you have the opportunity to clean up any resources held by the consumer. For example, you could close any open files, network connections, or send a notification to your monitoring service. Just implement a `teardown` method in your consumer and it will be called during the shutdown procedure. @@ -217,4 +217,4 @@ Running a consumer is just like running any Python script, simply execute the sc ### Shutting Down Consumers -In order to gracefully shut down a Relay consumer process, send it the `SIGTERM` signal. Most process supervisors such as Runit, Docker and Kubernetes send this signal when shutting down a process, so using those systems will make things easier. \ No newline at end of file +In order to gracefully shut down a RELAY consumer process, send it the `SIGTERM` signal. Most process supervisors such as Runit, Docker and Kubernetes send this signal when shutting down a process, so using those systems will make things easier. \ No newline at end of file diff --git a/website/realtime-sdk_versioned_docs/version-v2/language/python/index.mdx b/website/realtime-sdk_versioned_docs/version-v2/language/python/index.mdx index daccda977..83a2365e0 100644 --- a/website/realtime-sdk_versioned_docs/version-v2/language/python/index.mdx +++ b/website/realtime-sdk_versioned_docs/version-v2/language/python/index.mdx @@ -1,5 +1,5 @@ --- -title: Relay SDK for Python +title: RELAY SDK for Python sidebar_label: Python --- @@ -8,13 +8,13 @@ sidebar_label: Python [relay-client]: /sdks/realtime-sdk/v2/language/python/relay-client [relay-task]: /sdks/realtime-sdk/v2/language/python/task -# Relay SDK for Python +# RELAY SDK for Python ## Getting Started -The Relay SDK for Python enables developers to connect and use SignalWire's Relay APIs within their own Python code. Our Relay SDK allows developers to build or add robust and innovative communication services to their applications. +The RELAY SDK for Python enables developers to connect and use SignalWire's RELAY APIs within their own Python code. Our RELAY SDK allows developers to build or add robust and innovative communication services to their applications. -The Relay SDK for Python is easy to use and only takes a few minute to setup and get running. +The RELAY SDK for Python is easy to use and only takes a few minute to setup and get running. ## Installation @@ -39,15 +39,15 @@ We suggest to use Python 3.7 or above. ## Using the SDK -The Python SDK can be used to get up and running with Relay quickly and easily. In order to use the SDK, you must get your **project** and **token** from your SignalWire dashboard. +The Python SDK can be used to get up and running with RELAY quickly and easily. In order to use the SDK, you must get your **project** and **token** from your SignalWire dashboard. There are a few ways to get started, depending on your needs: **`Relay.Consumer`**, **`Relay.Task`** and **`Relay.Client`**. -### Relay Consumer +### RELAY Consumer -A [`Relay.Consumer`][relay-consumer] creates a long running process, allowing you to respond to incoming requests and events in realtime. Relay Consumers abstract all the setup of connecting to Relay and automatically dispatches workers to handle requests; so you can concentrate on writing your code without having to worry about multi-threading or blocking, everything just works. Think of Relay Consumers like a background worker system for all your calling and messaging needs. +A [`Relay.Consumer`][relay-consumer] creates a long running process, allowing you to respond to incoming requests and events in realtime. RELAY Consumers abstract all the setup of connecting to RELAY and automatically dispatches workers to handle requests; so you can concentrate on writing your code without having to worry about multi-threading or blocking, everything just works. Think of RELAY Consumers like a background worker system for all your calling and messaging needs. -Relay Consumers can scale easily, simply by running multiple instances of your `Relay.Consumer` process. Each event will only be delivered to a single consumer, so as your volume increases, just scale up! This process works well whether you are using Docker Swarm, a Procfile on Heroku, your own webserver, and most other environments. +RELAY Consumers can scale easily, simply by running multiple instances of your `Relay.Consumer` process. Each event will only be delivered to a single consumer, so as your volume increases, just scale up! This process works well whether you are using Docker Swarm, a Procfile on Heroku, your own webserver, and most other environments. Setting up a new consumer is the easiest way to get up and running: @@ -74,13 +74,13 @@ consumer = CustomConsumer() consumer.run() ``` -[Learn more about Relay Consumers][relay-consumer] +[Learn more about RELAY Consumers][relay-consumer] -### Relay Task +### RELAY Task -A `Relay.Task` is simple way to send jobs to your [`Relay.Consumers`][relay-consumer] from a short lived process, like a web framework. Relay Tasks allow you to pass commands down to your Consumers without blocking your short lived request. Think of a Relay Task as a way to queue a job for your background workers to processes asynchronously. +A `Relay.Task` is simple way to send jobs to your [`Relay.Consumers`][relay-consumer] from a short lived process, like a web framework. RELAY Tasks allow you to pass commands down to your Consumers without blocking your short lived request. Think of a RELAY Task as a way to queue a job for your background workers to processes asynchronously. -For example, if you wanted to make an outbound call and play a message when your user clicks a button on your web application, since Relay is a realtime protocol and relies on you to tell it what to do in realtime, if you did this within your web application, your web server would block until the call was finished... this may take a long time! Instead, simply create a new Relay Task. This task will be handled by a running Relay Consumer process and your web application can respond back to your user immediately. +For example, if you wanted to make an outbound call and play a message when your user clicks a button on your web application, since RELAY is a realtime protocol and relies on you to tell it what to do in realtime, if you did this within your web application, your web server would block until the call was finished... this may take a long time! Instead, simply create a new RELAY Task. This task will be handled by a running RELAY Consumer process and your web application can respond back to your user immediately. Send a task in the `office` context with custom data: @@ -122,11 +122,11 @@ consumer = CustomConsumer() consumer.run() ``` -[Learn more about Relay Tasks][relay-task] +[Learn more about RELAY Tasks][relay-task] -### Relay Client +### RELAY Client -[`Relay.Client`][relay-client] is a lower level object, giving you a basic connection to Relay but that is all. It is best used when you are creating a script only concerned with sending outbound requests or you want complete control over the Relay connection yourself. +[`Relay.Client`][relay-client] is a lower level object, giving you a basic connection to RELAY but that is all. It is best used when you are creating a script only concerned with sending outbound requests or you want complete control over the RELAY connection yourself. Setting up a new client and make an outbound call: @@ -146,10 +146,10 @@ client.on('ready', ready) client.connect() ``` -[Learn more about Relay Clients][relay-client] +[Learn more about RELAY Clients][relay-client] ## Contexts -Relay uses **Contexts** as a simple way to separate events to specific consumers, allowing you to write consumers for specific types of calls or messages or scale them independently. A Context is simply a named string, that allows you to categorize requests. When creating outbound requests, or configuring phone numbers for inbound requests, you can specify the **context**; Relay will then deliver that call or event to Consumers that are configured to listen for that context. +RELAY uses **Contexts** as a simple way to separate events to specific consumers, allowing you to write consumers for specific types of calls or messages or scale them independently. A Context is simply a named string, that allows you to categorize requests. When creating outbound requests, or configuring phone numbers for inbound requests, you can specify the **context**; RELAY will then deliver that call or event to Consumers that are configured to listen for that context. -For example, you could have a customer support phone number configured to send to Relay with the `support` context, and a personal number configured with `personal` context. Relay would deliver these events to any Consumer listening for those contexts. This gives you a lot of control in how messages are delivered to your Consumers, allowing you to write Consumer classes specific to the context, scale them independently, or separate traffic based on your own business rules. \ No newline at end of file +For example, you could have a customer support phone number configured to send to RELAY with the `support` context, and a personal number configured with `personal` context. RELAY would deliver these events to any Consumer listening for those contexts. This gives you a lot of control in how messages are delivered to your Consumers, allowing you to write Consumer classes specific to the context, scale them independently, or separate traffic based on your own business rules. \ No newline at end of file diff --git a/website/realtime-sdk_versioned_docs/version-v2/language/python/relay-client.mdx b/website/realtime-sdk_versioned_docs/version-v2/language/python/relay-client.mdx index 3b99c5d61..94cdfa45b 100644 --- a/website/realtime-sdk_versioned_docs/version-v2/language/python/relay-client.mdx +++ b/website/realtime-sdk_versioned_docs/version-v2/language/python/relay-client.mdx @@ -13,14 +13,14 @@ sidebar_position: 1 ## 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`][relay-client] is the basic connection to RELAY, allowing you send commands to RELAY and setup handlers for inbound events. [relay-client]: /sdks/realtime-sdk/v2/language/python/relay-client [link]: #events ### Constructor -Constructs a client object to interact with Relay. +Constructs a client object to interact with RELAY. **Parameters** @@ -31,7 +31,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: ```python from signalwire.relay.client import Client @@ -43,7 +43,7 @@ client = Client(project='', token='') | Property | Type | Description | | -------- | ---- | ----------- | -| `connected` | `boolean` | Returns _true_ if the client is connected to Relay. | +| `connected` | `boolean` | Returns _true_ if the client is connected to RELAY. | | `calling` | [`Relay.Calling`][relay-calling] | Returns a [`Relay.Calling`][relay-calling] instance associated with the client. | | `tasking` | [`Relay.Tasking`][relay-tasking] | Returns a [`Relay.Tasking`][relay-tasking] instance associated with the client. | | `messaging` | [`Relay.Messaging`][relay-messaging] | Returns a [`Relay.Messaging`][relay-messaging] instance associated with the client. | @@ -52,7 +52,7 @@ client = Client(project='', token='') ### connect -Activates the connection to the Relay API. The connection to Relay does not happen automatically so that you can setup handlers to events that might occur before the connection is successfully established. +Activates the connection to the RELAY API. The connection to RELAY does not happen automatically so that you can setup handlers to events that might occur before the connection is successfully established. **Returns** @@ -67,7 +67,7 @@ client.connect() ### disconnect -Coroutine that close the Relay connection, cancel the pending tasks and stop the event loop. +Coroutine that close the RELAY connection, cancel the pending tasks and stop the event loop. **Returns** diff --git a/website/realtime-sdk_versioned_docs/version-v2/language/python/task/index.mdx b/website/realtime-sdk_versioned_docs/version-v2/language/python/task/index.mdx index d43e1867a..f43b0afdd 100644 --- a/website/realtime-sdk_versioned_docs/version-v2/language/python/task/index.mdx +++ b/website/realtime-sdk_versioned_docs/version-v2/language/python/task/index.mdx @@ -9,7 +9,7 @@ sidebar_position: 1 ## Relay.Task -A [`Relay.Task`][relay-task] is simple way to send jobs to your [`Relay.Consumers`][relay-consumer] from a short lived process, like a web framework. Relay Tasks allow you to pass commands down to your Consumers without blocking your short lived request. Think of a Relay Task as a way to queue a job for your background workers to processes asynchronously. +A [`Relay.Task`][relay-task] is simple way to send jobs to your [`Relay.Consumers`][relay-consumer] from a short lived process, like a web framework. RELAY Tasks allow you to pass commands down to your Consumers without blocking your short lived request. Think of a RELAY Task as a way to queue a job for your background workers to processes asynchronously. ### Creating Tasks diff --git a/website/realtime-sdk_versioned_docs/version-v2/language/ruby/consumer.mdx b/website/realtime-sdk_versioned_docs/version-v2/language/ruby/consumer.mdx index bc05b9f01..0af270ecb 100644 --- a/website/realtime-sdk_versioned_docs/version-v2/language/ruby/consumer.mdx +++ b/website/realtime-sdk_versioned_docs/version-v2/language/ruby/consumer.mdx @@ -1,5 +1,5 @@ --- -title: Relay Consumer +title: RELAY Consumer sidebar_label: Consumer sidebar_position: 1 --- @@ -10,7 +10,7 @@ sidebar_position: 1 [relay-task]: ./task [index]: ./index.mdx#contexts -A Relay Consumer is a simple object that runs in its own process along side your application to handle calling and messaging events in realtime. Relay Consumers abstract all the setup of connecting to Relay and automatically dispatch workers to handle requests. Consumers will receive requests and delegate them to their own worker thread, allowing you to focus on your business logic without having to worry about multi-threading or blocking, everything just works. Think of Relay Consumers like a background worker system for all your calling and messaging needs. +A RELAY Consumer is a simple object that runs in its own process along side your application to handle calling and messaging events in realtime. RELAY Consumers abstract all the setup of connecting to RELAY and automatically dispatch workers to handle requests. Consumers will receive requests and delegate them to their own worker thread, allowing you to focus on your business logic without having to worry about multi-threading or blocking, everything just works. Think of RELAY Consumers like a background worker system for all your calling and messaging needs. ## Authenticating a consumer @@ -37,7 +37,7 @@ MyConsumer.new(project: 'your-project-key', token: 'your-project-token').run ## Consumer Contexts -A Relay Consumer is a simple object, customized by specifying contexts and event handlers to respond to incoming events. +A RELAY Consumer is a simple object, customized by specifying contexts and event handlers to respond to incoming events. A consumer usually requires at least one `contexts` for incoming events. Contexts are a list of contexts you want this Consumer to listen for. [Learn more about Contexts][index]. @@ -104,7 +104,7 @@ MyConsumer.new.run ### ready -This method is executed when the Consumer has connected and is ready to make Relay requests. +This method is executed when the Consumer has connected and is ready to make RELAY requests. ```ruby require 'signalwire' @@ -171,7 +171,7 @@ MessageSendConsumer.new.run ## Cleaning Up on Exit -When a Relay Consumer shuts down, you have the opportunity to clean up any resources held by the consumer. For example, you could close any open files, network connections, or send a notification to your monitoring service. +When a RELAY Consumer shuts down, you have the opportunity to clean up any resources held by the consumer. For example, you could close any open files, network connections, or send a notification to your monitoring service. Just implement a `teardown` method in your consumer and it will be called during the shutdown procedure. @@ -200,4 +200,4 @@ Running a consumer is just like running any Ruby script, simply execute the scri ## Shutting Down Consumers -In order to gracefully shut down a Relay consumer process, send it the `SIGTERM` signal. Most process supervisors such as Runit, Docker and Kubernetes send this signal when shutting down a process. \ No newline at end of file +In order to gracefully shut down a RELAY consumer process, send it the `SIGTERM` signal. Most process supervisors such as Runit, Docker and Kubernetes send this signal when shutting down a process. \ No newline at end of file diff --git a/website/realtime-sdk_versioned_docs/version-v2/language/ruby/index.mdx b/website/realtime-sdk_versioned_docs/version-v2/language/ruby/index.mdx index 31026aa3a..f7144d267 100644 --- a/website/realtime-sdk_versioned_docs/version-v2/language/ruby/index.mdx +++ b/website/realtime-sdk_versioned_docs/version-v2/language/ruby/index.mdx @@ -1,5 +1,5 @@ --- -title: Relay SDK for Ruby +title: RELAY SDK for Ruby --- [learn-more-about-relay-clients]: ./relay-client @@ -13,9 +13,9 @@ title: Relay SDK for Ruby ## Getting Started -The Relay SDK for Ruby enables Ruby developers to connect and use SignalWire's Relay APIs within their own Ruby code. Our Relay SDK allows developers to build or add robust and innovative communication services to their applications. +The RELAY SDK for Ruby enables Ruby developers to connect and use SignalWire's RELAY APIs within their own Ruby code. Our RELAY SDK allows developers to build or add robust and innovative communication services to their applications. -The Relay SDK for Ruby is easy to use and only takes a few minutes to setup and get running. +The RELAY SDK for Ruby is easy to use and only takes a few minutes to setup and get running. ## Installation @@ -48,11 +48,11 @@ The Ruby SDK requires your **project** and **token** from your SignalWire dashbo The recommended starting point is the **`Relay.Consumer`** class, and **`Relay.Client`** provides lower-level access. -### Relay Consumer +### RELAY Consumer -A [`Relay.Consumer`][relay-consumer-1] creates a long running process, allowing you to respond to incoming requests and events in realtime. Relay Consumers abstract all the setup of connecting to Relay and automatically dispatches workers to handle requests; so you can concentrate on writing your code without having to worry about multi-threading or blocking, everything just works. Think of Relay Consumers like a background worker system for all your calling and messaging needs. +A [`Relay.Consumer`][relay-consumer-1] creates a long running process, allowing you to respond to incoming requests and events in realtime. RELAY Consumers abstract all the setup of connecting to RELAY and automatically dispatches workers to handle requests; so you can concentrate on writing your code without having to worry about multi-threading or blocking, everything just works. Think of RELAY Consumers like a background worker system for all your calling and messaging needs. -Relay Consumers can scale easily, simply by running multiple instances of your `Relay.Consumer` process. Each event will only be delivered to a single consumer, so as your volume increases, just scale up! This process works well whether you are using Docker Swarm, a Procfile on Heroku, your own webserver, and most other environments. +RELAY Consumers can scale easily, simply by running multiple instances of your `Relay.Consumer` process. Each event will only be delivered to a single consumer, so as your volume increases, just scale up! This process works well whether you are using Docker Swarm, a Procfile on Heroku, your own webserver, and most other environments. > Setting up a new consumer is the easiest way to get up and running. @@ -72,13 +72,13 @@ end MyConsumer.new.run ``` -[Learn more about Relay Consumers][learn-more-about-relay-consumers] +[Learn more about RELAY Consumers][learn-more-about-relay-consumers] -### Relay Task +### RELAY Task -A `SignalWire::Relay::Task` is a simple way to send jobs to your [`Relay.Consumer`][relay-consumer-1] from a short lived process, like a web framework. Relay Tasks allow you to pass commands down to your Consumers without blocking your short lived request. Think of a Relay Task as a way to queue a job for your background workers to processes asynchronously. +A `SignalWire::Relay::Task` is a simple way to send jobs to your [`Relay.Consumer`][relay-consumer-1] from a short lived process, like a web framework. RELAY Tasks allow you to pass commands down to your Consumers without blocking your short lived request. Think of a RELAY Task as a way to queue a job for your background workers to processes asynchronously. -For example, if you wanted to make an outbound call and play a message when your user clicks a button on your web application, since Relay is a realtime protocol and relies on you to tell it what to do in realtime, if you did this within your web application, your web server would block until the call was finished... this may take a long time! Instead, simply create a new Relay Task. This task will be handled by a running Relay Consumer process and your web application can respond back to your user immediately. +For example, if you wanted to make an outbound call and play a message when your user clicks a button on your web application, since RELAY is a realtime protocol and relies on you to tell it what to do in realtime, if you did this within your web application, your web server would block until the call was finished... this may take a long time! Instead, simply create a new RELAY Task. This task will be handled by a running RELAY Consumer process and your web application can respond back to your user immediately. ```ruby require 'signalwire/relay/task' @@ -87,9 +87,9 @@ task = Signalwire::Relay::Task.new(project: "your-project-id", token: "your-proj task.deliver(context: 'incoming', message: { number_to_call: '+1555XXXXXXX', message_to_play: 'We have a message for you' }) ``` -[Learn more about Relay Tasks][learn-more-about-relay-tasks] +[Learn more about RELAY Tasks][learn-more-about-relay-tasks] -### Relay Client +### RELAY Client [`Relay.Client`][relay-client] is the underlying Relay connection Consumers use. It offers an alternative API for cases that require more specialized functionality. @@ -110,10 +110,10 @@ end client.connect! ``` -[Learn more about Relay Clients][learn-more-about-relay-clients] +[Learn more about RELAY Clients][learn-more-about-relay-clients] ## Contexts -Relay uses **Contexts** as a simple way to separate events to specific consumers, allowing you to write consumers for specific types of calls or messages or scale them independently. A Context is simply a named string, that allows you to categorize requests. When creating outbound requests, or configuring phone numbers for inbound requests, you can specify the **context**; Relay will then deliver that call or event to Consumers that are configured to listen for that context. +RELAY uses **Contexts** as a simple way to separate events to specific consumers, allowing you to write consumers for specific types of calls or messages or scale them independently. A Context is simply a named string, that allows you to categorize requests. When creating outbound requests, or configuring phone numbers for inbound requests, you can specify the **context**; RELAY will then deliver that call or event to Consumers that are configured to listen for that context. -For example, you could have a customer support phone number configured to send to Relay with the `support` context, and a personal number configured with `personal` context. Relay would deliver these events to any Consumer listening for those contexts. This gives you a lot of control in how messages are delivered to your Consumers, allowing you to write Consumer classes specific to the context, scale them independently, or separate traffic based on your own business rules. \ No newline at end of file +For example, you could have a customer support phone number configured to send to RELAY with the `support` context, and a personal number configured with `personal` context. RELAY would deliver these events to any Consumer listening for those contexts. This gives you a lot of control in how messages are delivered to your Consumers, allowing you to write Consumer classes specific to the context, scale them independently, or separate traffic based on your own business rules. \ No newline at end of file diff --git a/website/realtime-sdk_versioned_docs/version-v2/language/ruby/relay-client.mdx b/website/realtime-sdk_versioned_docs/version-v2/language/ruby/relay-client.mdx index 01290ecb7..88dc4a999 100644 --- a/website/realtime-sdk_versioned_docs/version-v2/language/ruby/relay-client.mdx +++ b/website/realtime-sdk_versioned_docs/version-v2/language/ruby/relay-client.mdx @@ -1,6 +1,6 @@ --- -title: Relay Client -sidebar_label: Relay Client +title: RELAY Client +sidebar_label: RELAY Client sidebar_position: 0 --- @@ -8,11 +8,11 @@ sidebar_position: 0 [relay-messaging]: ./messaging/ [link]: #events -`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** @@ -23,7 +23,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. ```ruby Signalwire::Relay::Client.new(project: "your-project-id", token: "your-project-token") @@ -33,7 +33,7 @@ Signalwire::Relay::Client.new(project: "your-project-id", token: "your-project-t | Property | Type | Description | | -------- | ---- | ----------- | -| `connected` | Boolean | Returns `true` if the client has connected to Relay. | +| `connected` | Boolean | Returns `true` if the client has connected to RELAY. | | `calling` | [`Relay::Calling`][relay-calling-1] | Returns a [`Relay::Calling`][relay-calling-1] instance associated with the client. | | `messaging` | [`Relay::Messaging`][relay-messaging] | Returns a `Relay::Messaging` instance associated with the client. | @@ -41,7 +41,7 @@ Signalwire::Relay::Client.new(project: "your-project-id", token: "your-project-t ### connect! -Starts the connection to the Relay API. The connection to Relay does not happen automatically so that you can setup handlers to events that might occur before the connection is successfully established. +Starts the connection to the RELAY API. The connection to RELAY does not happen automatically so that you can setup handlers to events that might occur before the connection is successfully established. **Returns** @@ -56,7 +56,7 @@ client.connect! ### disconnect! -Disconnect the client from Relay. +Disconnect the client from RELAY. **Returns** @@ -76,7 +76,7 @@ Attach an event handler for a specific type of event. | Parameter | Type | Required | Description | | --------- | ---- | -------- | ----------- | -| `event` | Symbol | Yes | Event name. Full list of events [Relay Client Events][link] | +| `event` | Symbol | Yes | Event name. Full list of events [RELAY Client Events][link] | | `guards` | Array | No | Guard clauses for the event. | | `handler` | Block | No | Block to call when the event is received. It will be passed in as an argument. | diff --git a/website/realtime-sdk_versioned_docs/version-v2/language/ruby/task/index.mdx b/website/realtime-sdk_versioned_docs/version-v2/language/ruby/task/index.mdx index 42937e0f9..d7178f1c6 100644 --- a/website/realtime-sdk_versioned_docs/version-v2/language/ruby/task/index.mdx +++ b/website/realtime-sdk_versioned_docs/version-v2/language/ruby/task/index.mdx @@ -1,12 +1,12 @@ --- -title: Relay Task +title: RELAY Task sidebar_label: Task --- [relay-consumers]: ../consumer [consumer]: ../consumer#on_task -A `Relay::Task` is simple way to send jobs to your [`Relay.Consumers`][relay-consumers] from a short lived process, like a web framework. Relay Tasks allow you to pass commands down to your Consumers without blocking your short lived request. Think of a Relay Task as a way to queue a job for your background workers to processes asynchronously. +A `Relay::Task` is simple way to send jobs to your [`Relay.Consumers`][relay-consumers] from a short lived process, like a web framework. RELAY Tasks allow you to pass commands down to your Consumers without blocking your short lived request. Think of a RELAY Task as a way to queue a job for your background workers to processes asynchronously. ## Creating Tasks diff --git a/website/realtime-sdk_versioned_docs/version-v3/guides/messaging/first-steps-with-messaging.mdx b/website/realtime-sdk_versioned_docs/version-v3/guides/messaging/first-steps-with-messaging.mdx index d180b9dba..f555c745e 100644 --- a/website/realtime-sdk_versioned_docs/version-v3/guides/messaging/first-steps-with-messaging.mdx +++ b/website/realtime-sdk_versioned_docs/version-v3/guides/messaging/first-steps-with-messaging.mdx @@ -39,8 +39,8 @@ You will need at least one number to send and receive messages. After you have acquired a number, open its settings by clicking on "Edit Settings". Scroll down until you reach "Messaging Settings", as shown in the next figure, and configure it to: -- handle messages using a Relay application, -- forward the call to the "office" Relay context +- handle messages using a RELAY application, +- forward the call to the "office" RELAY context @@ -49,9 +49,9 @@ Scroll down until you reach "Messaging Settings", as shown in the next figure, a :::info Context -In Relay V3, a context is a named scope that allows you to group resources together. -When you configure a phone number to handle messages with a Relay application -and specify a context, all messages to that number will be delivered to Relay +In RELAY V3, a context is a named scope that allows you to group resources together. +When you configure a phone number to handle messages with a RELAY application +and specify a context, all messages to that number will be delivered to RELAY clients listening on that context. ::: diff --git a/website/realtime-sdk_versioned_docs/version-v3/guides/messaging/forwarding-texts-to-email-nodejs/index.mdx b/website/realtime-sdk_versioned_docs/version-v3/guides/messaging/forwarding-texts-to-email-nodejs/index.mdx index f57a1ddcf..91707adda 100644 --- a/website/realtime-sdk_versioned_docs/version-v3/guides/messaging/forwarding-texts-to-email-nodejs/index.mdx +++ b/website/realtime-sdk_versioned_docs/version-v3/guides/messaging/forwarding-texts-to-email-nodejs/index.mdx @@ -37,12 +37,12 @@ We will write a simple server that listens for a message event from SignalWire w ### Configuring the phone number -First, we need to create a new Relay Application resource. -To do so, go to the "Resources" section from your sidebar, and create a new Relay ApplicationResource. +First, we need to create a new RELAY Application resource. +To do so, go to the "Resources" section from your sidebar, and create a new RELAY ApplicationResource. -![Relay Application resource selector with cXML highlighted.](@image/dashboard/resources/add-new-relay-application.png) +![RELAY Application resource selector with cXML highlighted.](@image/dashboard/resources/add-new-relay-application.png) -When configuring the Relay Application, set the context to "office" (to match what we have in the code). +When configuring the RELAY Application, set the context to "office" (to match what we have in the code). @@ -51,7 +51,7 @@ number yet, make sure to [buy one][buy-one]. You will need at least one number to receive messages. You can do that from the "Phone Numbers" section in the Sidebar. Go to the Settings page of the number you -want to configure. In the `Inbound Message Settings` section, assign your relay application. +want to configure. In the `Inbound Message Settings` section, assign your RELAY application. ![Assign Resource](@image/dashboard/phone-numbers/assign-resource-full.png) @@ -63,9 +63,9 @@ want to configure. In the `Inbound Message Settings` section, assign your relay You don't need to create a new resource for your call. Simply open the settings for the number you want to configure, and under "**Inbound Message Settings**", -choose to handle incoming messages using "Relay Application", and set the context to "office" to match the code. +choose to handle incoming messages using "RELAY Application", and set the context to "office" to match the code. -![legacy UI relay application configuration](@image/dashboard/legacy/number-message-config-relay.png) +![legacy UI RELAY application configuration](@image/dashboard/legacy/number-message-config-relay.png) diff --git a/website/realtime-sdk_versioned_docs/version-v3/guides/realtime-relay-v4-vs-v3.mdx b/website/realtime-sdk_versioned_docs/version-v3/guides/realtime-relay-v4-vs-v3.mdx index 1d91a0efa..ae69761f4 100644 --- a/website/realtime-sdk_versioned_docs/version-v3/guides/realtime-relay-v4-vs-v3.mdx +++ b/website/realtime-sdk_versioned_docs/version-v3/guides/realtime-relay-v4-vs-v3.mdx @@ -1,5 +1,5 @@ --- -title: Upgrading to Relay v4 +title: Upgrading to RELAY v4 description: Easily upgrade to the version 4 of the Realtime SDK. --- diff --git a/website/realtime-sdk_versioned_docs/version-v3/guides/voice/first-steps-with-voice/index.mdx b/website/realtime-sdk_versioned_docs/version-v3/guides/voice/first-steps-with-voice/index.mdx index 4dea4d7de..8e213bbf1 100644 --- a/website/realtime-sdk_versioned_docs/version-v3/guides/voice/first-steps-with-voice/index.mdx +++ b/website/realtime-sdk_versioned_docs/version-v3/guides/voice/first-steps-with-voice/index.mdx @@ -21,8 +21,8 @@ This introductory guide will show you how to make and receive calls from your ow [Log in][log-in] to your SignalWire Space. From the Phone Numbers section, you can [buy a new phone number][buy-a-new-phone-number]. You will need at least one number to make and receive calls. After you have acquired a number, open its settings by clicking on "Edit Settings". Scroll down until you reach "Voice and Fax Settings", as shown in the next figure, and configure it to: -- handle incoming calls using a Relay application, -- forward the call to the "office" Relay context +- handle incoming calls using a RELAY application, +- forward the call to the "office" RELAY context @@ -31,9 +31,9 @@ This introductory guide will show you how to make and receive calls from your ow :::info Context -In Relay V3, a context is a named scope that allows you to group resources together. -When you configure a phone number to handle calls with a Relay application -and specify a context, all calls to that number will be delivered to Relay +In RELAY V3, a context is a named scope that allows you to group resources together. +When you configure a phone number to handle calls with a RELAY application +and specify a context, all calls to that number will be delivered to RELAY clients listening on that context. ::: diff --git a/website/realtime-sdk_versioned_docs/version-v3/guides/voice/setting-up-voicemail/index.mdx b/website/realtime-sdk_versioned_docs/version-v3/guides/voice/setting-up-voicemail/index.mdx index 4df20502e..82a892aec 100644 --- a/website/realtime-sdk_versioned_docs/version-v3/guides/voice/setting-up-voicemail/index.mdx +++ b/website/realtime-sdk_versioned_docs/version-v3/guides/voice/setting-up-voicemail/index.mdx @@ -16,14 +16,14 @@ A popular and important use case is recording a voicemail from your callers when In this guide we will see how to implement a voicemail using Node.js. This allows you the most flexibility in case you want to integrate voicemails with complex workflows. -## Assigning a Phone Number to a Relay Context +## Assigning a Phone Number to a RELAY Context -To handle calls using Node.js, you should first set up a phone number to handle incoming calls using a Relay application. +To handle calls using Node.js, you should first set up a phone number to handle incoming calls using a RELAY application. Click the **Phone Numbers** tab on your lefthand side nav within your SignalWire Space, and click the specific number you would like to set up call forwarding on. If you don't have a number yet, now is the time to [buy one][buy-one]! - + ![the Voice and Fax Settings pane.](@image/dashboard/relay/app-voice-handler.webP) diff --git a/website/realtime-sdk_versioned_docs/version-v3/guides/voice/weather-phone-with-signalwire-realtime-api/index.mdx b/website/realtime-sdk_versioned_docs/version-v3/guides/voice/weather-phone-with-signalwire-realtime-api/index.mdx index 79ef8e3f9..096120e7d 100644 --- a/website/realtime-sdk_versioned_docs/version-v3/guides/voice/weather-phone-with-signalwire-realtime-api/index.mdx +++ b/website/realtime-sdk_versioned_docs/version-v3/guides/voice/weather-phone-with-signalwire-realtime-api/index.mdx @@ -64,9 +64,9 @@ You can follow the README.md instructions to download and run the sample. ## How to Run the Application -1. Edit the settings of your phone number so that our code can handle it. The Relay Context you specify here needs to match the one you specify in the code later. In this case, we have used 'office'. +1. Edit the settings of your phone number so that our code can handle it. The RELAY Context you specify here needs to match the one you specify in the code later. In this case, we have used 'office'. - + ![the Edit Settings page of a phone number in SignalWire.](@image/dashboard/relay/app-voice-handler.webP) diff --git a/website/realtime-sdk_versioned_docs/version-v3/index.mdx b/website/realtime-sdk_versioned_docs/version-v3/index.mdx index f844b141a..dbe3012c9 100644 --- a/website/realtime-sdk_versioned_docs/version-v3/index.mdx +++ b/website/realtime-sdk_versioned_docs/version-v3/index.mdx @@ -1,5 +1,5 @@ --- -title: "Relay Realtime SDK" +title: "RELAY Realtime SDK" sidebar_position: 0 --- @@ -9,8 +9,8 @@ import { MdCode, MdLibraryBooks } from "react-icons/md"; # Overview :::caution -The [RELAY v4](/sdks/realtime-sdk) is the most up-to-date version of the Realtime Relay SDK. -Consider reading the [Upgrading to Relay v4](/sdks/realtime-sdk/v3/guides/realtime-relay-v4-vs-v3) page to understand the benefits of +The [RELAY v4](/sdks/realtime-sdk) is the most up-to-date version of the Realtime RELAY SDK. +Consider reading the [Upgrading to RELAY v4](/sdks/realtime-sdk/v3/guides/realtime-relay-v4-vs-v3) page to understand the benefits of [RELAY v4](/sdks/realtime-sdk) and how to upgrade. ::: @@ -45,9 +45,9 @@ The SDK operates through a bidirectional WebSocket connection. When you call met npm install @signalwire/realtime-api@~3 ``` -### Create a Relay Application +### Create a RELAY Application -For Voice, Messaging, and Task namespaces, create a [Relay Application resource](/platform/call-fabric/resources/relay-applications) in your dashboard: +For Voice, Messaging, and Task namespaces, create a [RELAY Application resource](/platform/call-fabric/resources/relay-applications) in your dashboard: 1. Set a name for your application 2. Choose a reference (e.g., "support", "sales") that matches your client's topics @@ -63,7 +63,7 @@ import { Voice } from "@signalwire/realtime-api"; const client = new Voice.Client({ project: "your-project-id", token: "your-api-token", - topics: ["support"] // Must match your Relay Application reference + topics: ["support"] // Must match your RELAY Application reference }); ``` @@ -77,7 +77,7 @@ import { Voice } from "@signalwire/realtime-api"; const client = new Voice.Client({ project: "your-project-id", token: "your-api-token", - topics: ["support"] // Must match your Relay Application reference + topics: ["support"] // Must match your RELAY Application reference }); // Answer incoming calls and play a greeting @@ -91,7 +91,7 @@ client.on("call.received", async (call) => { console.log("Waiting for calls..."); ``` -Now call the SignalWire phone number or SIP address you assigned to your Relay Application in step 2. Your application will answer and play the greeting! +Now call the SignalWire phone number or SIP address you assigned to your RELAY Application in step 2. Your application will answer and play the greeting! diff --git a/website/realtime-sdk_versioned_docs/version-v3/tech-ref/index.mdx b/website/realtime-sdk_versioned_docs/version-v3/tech-ref/index.mdx index 9b822f622..d6c694343 100644 --- a/website/realtime-sdk_versioned_docs/version-v3/tech-ref/index.mdx +++ b/website/realtime-sdk_versioned_docs/version-v3/tech-ref/index.mdx @@ -41,11 +41,11 @@ const client = new Voice.Client({ Your `project` ID and `token` are available in the [SignalWire Dashboard](/platform/dashboard/getting-started/your-signalwire-api-space). These authenticate your WebSocket connection and establish your access permissions. -Topics (formerly contexts) work with [Relay Application resources](/platform/call-fabric/resources/relay-applications) to route events. -When you assign a phone number or a SIP address to a Relay Application with reference "support", SignalWire routes all calls from that number or SIP address +Topics (formerly contexts) work with [RELAY Application resources](/platform/call-fabric/resources/relay-applications) to route events. +When you assign a phone number or a SIP address to a RELAY Application with reference "support", SignalWire routes all calls from that number or SIP address to SDK clients authenticated with the "support" topic. This creates strict access control - a client subscribed to "support" cannot receive events intended for "sales". -The routing process is straightforward: incoming calls hit a phone number or a SIP address, SignalWire checks the Relay Application's reference, then delivers the event only to +The routing process is straightforward: incoming calls hit a phone number or a SIP address, SignalWire checks the RELAY Application's reference, then delivers the event only to clients with matching topics. This happens automatically based on your authentication. ```javascript diff --git a/website/realtime-sdk_versioned_docs/version-v3/tech-ref/messaging/messaging-messagecontract.md b/website/realtime-sdk_versioned_docs/version-v3/tech-ref/messaging/messaging-messagecontract.md index 936ef4e20..0a1d8a531 100644 --- a/website/realtime-sdk_versioned_docs/version-v3/tech-ref/messaging/messaging-messagecontract.md +++ b/website/realtime-sdk_versioned_docs/version-v3/tech-ref/messaging/messaging-messagecontract.md @@ -103,9 +103,9 @@ The destination number of the message. The state a message can be in. -- `queued`: The message has been queued in Relay. -- `initiated`: Relay has initiated the process of sending the message. -- `sent`: Relay has sent the message. +- `queued`: The message has been queued in RELAY. +- `initiated`: RELAY has initiated the process of sending the message. +- `sent`: RELAY has sent the message. - `delivered`: The message has been successfully delivered. Due to the nature of SMS and MMS, receiving a `delivered` event is not guaranteed, even if the message is delivered successfully. - `undelivered`: The message has not been delivered. Due to the nature of SMS and MMS, receiving a `undelivered` event is not guaranteed, even if the message fails to be delivered. - `failed`: The request has failed. diff --git a/website/realtime-sdk_versioned_docs/version-v3/tech-ref/voice/callstate.mdx b/website/realtime-sdk_versioned_docs/version-v3/tech-ref/voice/callstate.mdx index ad0232019..fb4948bc7 100644 --- a/website/realtime-sdk_versioned_docs/version-v3/tech-ref/voice/callstate.mdx +++ b/website/realtime-sdk_versioned_docs/version-v3/tech-ref/voice/callstate.mdx @@ -10,7 +10,7 @@ slug: /voice/call-state [voice-client]: ./voice-client.mdx#dialphone [voice-client-1]: ./voice-client.mdx#dialsip -Payload for call state events that are triggered by the change in state of an active Relay-controlled call. You can obtain instances of this state callback request by including a `call_state_url` parameter when starting a call with one of the following methods: +Payload for call state events that are triggered by the change in state of an active RELAY-controlled call. You can obtain instances of this state callback request by including a `call_state_url` parameter when starting a call with one of the following methods: - [`Call.connect`][voice-call] - [`Call.connectPhone`][voice-call-1] diff --git a/website/src/pages/page/tadhack-2024/index.mdx b/website/src/pages/page/tadhack-2024/index.mdx index cf924f18f..d611501b4 100644 --- a/website/src/pages/page/tadhack-2024/index.mdx +++ b/website/src/pages/page/tadhack-2024/index.mdx @@ -187,7 +187,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.