You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardexpand all lines: docs/interactions/structured-messages/quick-start.md
+15-15
Original file line number
Diff line number
Diff line change
@@ -7,13 +7,13 @@ Let's build a structured message! A structured message consists of elements that
7
7
8
8
In this Quick Start, we will walk you through creating a structured message within a matter of minutes. Let's get started.
9
9
10
-
## Create an Engage Messaging Channel
10
+
## Create a RingCX Messaging Channel
11
11
12
12
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.
13
13
14
14
### Configure a Community
15
15
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.
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.
28
28
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.
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.
46
46
47
47
!!! Note
48
48
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.
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.
57
57
58
-
## Create an Engage Chat Window on a Web Page
58
+
## Create a Chat Window on a Web Page
59
59
60
60
Now let's create an HTML web page with the JavaScript code to include. The code should look something like the following.
61
61
@@ -70,15 +70,15 @@ Now let's create an HTML web page with the JavaScript code to include. The code
70
70
</script>
71
71
```
72
72
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.
74
74
75
75
### Sample HTML
76
76
```html
77
77
<!DOCTYPE html>
78
78
<htmllang="en">
79
79
<head>
80
80
<metacharset="utf-8">
81
-
<title>Engage Messaging</title>
81
+
<title>RingCX Messaging</title>
82
82
83
83
<script>
84
84
//script from the source
@@ -109,11 +109,11 @@ Here's the point you've been building up to, sending a structured message using
109
109
110
110
### Obtain Access Token
111
111
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.
113
113
114
-
??? tip "How to generate an Engage API access token"
114
+
??? tip "How to generate a RingCX API access token"
115
115
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.
117
117
118
118
2. Select "Dev tools" towards the bottom of the left hand menu.
119
119
@@ -210,6 +210,6 @@ Having difficulty? Feeling frustrated? Receiving an error you don't understand?
210
210
211
211
## What's Next?
212
212
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.
214
214
215
215
<aclass="btn btn-success btn-lg"href="https://developers.ringcentral.com/engage/api-reference/">Explore the REST API »</a>
0 commit comments