Skip to content

Commit d5af48f

Browse files
authored
Merge pull request #196 from kerireki/patch-20
Update quick-start.md Changed 'Engage' product name to 'RingCX', eliminated where possible
2 parents 74a34ff + ea6af71 commit d5af48f

File tree

1 file changed

+15
-15
lines changed

1 file changed

+15
-15
lines changed

docs/interactions/structured-messages/quick-start.md

+15-15
Original file line numberDiff line numberDiff line change
@@ -7,13 +7,13 @@ Let's build a structured message! A structured message consists of elements that
77

88
In this Quick Start, we will walk you through creating a structured message within a matter of minutes. Let's get started.
99

10-
## Create an Engage Messaging Channel
10+
## Create a RingCX Messaging Channel
1111

1212
For this Quick Start, we need to create a channel and then assign an agent to that channel. There are several steps in this process starting with the community.
1313

1414
### Configure a Community
1515

16-
Communities are databases of identities associated with each source. There must be a community in order to create a source. You can create a community per type of source (Facebook, Twitter, Engage Messaging, etc.), which can then be used when creating several sources of the same type. Follow the instructions to [create a community](https://support.ringcentral.com/engagedigital/admin/create-communities.html). In this Quick Start, we'll create an Engage Messaging community profile.
16+
Communities are databases of identities associated with each source. There must be a community in order to create a source. You can create a community per type of source (Facebook, Twitter, RingCX Messaging, etc.), which can then be used when creating several sources of the same type. Follow the instructions to [create a community](https://support.ringcentral.com/engagedigital/admin/create-communities.html). In this Quick Start, we'll create a RingCX Messaging community profile.
1717

1818
<img class="img-fluid" width="238" src="../../../img/structured-messages-community-add.png">
1919

@@ -22,11 +22,11 @@ Simply give this community a name and click **Save**
2222
<img class="img-fluid" width="467" src="../../../img/structured-messages-community-create.png">
2323

2424

25-
### Configure an Engage Messaging Channel
25+
### Configure a RingCX Messaging Channel
2626

27-
In this quick start, we begin with the Engage Messaging channel. Follow the instructions to navigate to and [create a channel](https://support.ringcentral.com/engagedigital/admin/configure-entry-points.html) for Engage Messaging.
27+
In this quick start, we begin with the RingCX Messaging channel. Follow the instructions to navigate to and [create a channel](https://support.ringcentral.com/engagedigital/admin/configure-entry-points.html) for RingCX Messaging.
2828

29-
Give this channel a name. For our example here, we'll call it "Engage Messaging Example". Make sure to select the community you just created. While here, let's enable web messaging by checking the "Enable Web Messaging" box.
29+
Give this channel a name. For our example here, we'll call it "RingCX Messaging Example". Make sure to select the community you just created. While here, let's enable web messaging by checking the "Enable Web Messaging" box.
3030

3131
<img class="img-fluid" width="800" src="../../../img/structured-messages-create-channel.png">
3232

@@ -42,20 +42,20 @@ There are three types of channel modes: asynchronus, real time, and triage. For
4242

4343
<img class="img-fluid" width="540" src="../../../img/structured-messages-channel-mode.png">
4444

45-
Now let's add our Engage Messaging Example to the real time channel. First click the pencil icon to edit the real time channel.
45+
Now let's add our RingCX Messaging Example to the real time channel. First click the pencil icon to edit the real time channel.
4646

4747
!!! Note
4848
These channel modes can be renamed to a custom name and may not be the name used for the real time mode. For our Quick Start, we are using the default channel mode name.
4949

5050
<img class="img-fluid" width="800" src="../../../img/structured-messages-channel-modes-edit.png">
5151

52-
Then add our Engage Messaging Example in the Channels field by selecting it from the dropdown.
52+
Then add our RingCX Messaging Example in the Channels field by selecting it from the dropdown.
5353

5454
<img class="img-fluid" width="800" src="../../../img/structured-messages-channel-modes-realtime.png">
5555

56-
Now let's go back to our Engage Messaging Example channel listed in the channels section. Click the pencil icon to edit this channel and look for the JavaScript code under "Chat connection", in the "Code to include" field. We will use this code in the next section to embed a messaging window on a web page.
56+
Now let's go back to our RingCX Messaging Example listed in the Channels section. Click the pencil icon to edit this channel and look for the JavaScript code under "Chat connection", in the "Code to include" field. We will use this code in the next section to embed a messaging window on a web page.
5757

58-
## Create an Engage Chat Window on a Web Page
58+
## Create a Chat Window on a Web Page
5959

6060
Now let's create an HTML web page with the JavaScript code to include. The code should look something like the following.
6161

@@ -70,15 +70,15 @@ Now let's create an HTML web page with the JavaScript code to include. The code
7070
</script>
7171
```
7272

73-
We'll want to embed this code segment into an HTML page so we can start a Engage Messaging chat window. Here's some sample code to create your own web page with.
73+
We'll want to embed this code segment into an HTML page so we can start a RingCX Messaging chat window. Here's some sample code to create your own web page with.
7474

7575
### Sample HTML
7676
```html
7777
<!DOCTYPE html>
7878
<html lang="en">
7979
<head>
8080
<meta charset="utf-8">
81-
<title>Engage Messaging</title>
81+
<title>RingCX Messaging</title>
8282

8383
<script>
8484
//script from the source
@@ -109,11 +109,11 @@ Here's the point you've been building up to, sending a structured message using
109109

110110
### Obtain Access Token
111111

112-
The first thing you need to do is obtain an API Access Token if you do not already have one. Access tokens can be created and/or accessed via the "API access token" area in the "Dev tools" area of your Engage portal under the "Admin" tab.
112+
The first thing you need to do is obtain an API Access Token if you do not already have one. Access tokens can be created and/or accessed via the "API access token" area in the "Dev tools" area of your RingCX portal under the "Admin" tab.
113113

114-
??? tip "How to generate an Engage API access token"
114+
??? tip "How to generate a RingCX API access token"
115115

116-
1. Login to your Engage portal and click on the "Admin" menu located in the top, horizontal menu.
116+
1. Login to your RingCX portal and click on the "Admin" menu located in the top, horizontal menu.
117117

118118
2. Select "Dev tools" towards the bottom of the left hand menu.
119119

@@ -210,6 +210,6 @@ Having difficulty? Feeling frustrated? Receiving an error you don't understand?
210210

211211
## What's Next?
212212

213-
When you have successfully made your first Structured Message API call, it is time to take your next step towards building a more robust Engage application.
213+
When you have successfully made your first Structured Message API call, it is time to take your next step towards building a more robust application.
214214

215215
<a class="btn btn-success btn-lg" href="https://developers.ringcentral.com/engage/api-reference/">Explore the REST API &raquo;</a>

0 commit comments

Comments
 (0)