Skip to content

Commit ad93fd3

Browse files
authored
chore: add detail steps about ivr menu key press (#3)
1 parent 1d34c20 commit ad93fd3

11 files changed

+132
-1
lines changed

.gitignore

+2
Original file line numberDiff line numberDiff line change
@@ -159,4 +159,6 @@ cython_debug/
159159
# option (not recommended) you can uncomment the following to ignore the entire idea folder.
160160
#.idea/
161161

162+
.DS_Store
163+
162164
*~
303 KB
Loading

docs/img/automator-ivr-menu-b.png

287 KB
Loading
456 KB
Loading

docs/img/ivr-menu-a-keys.png

181 KB
Loading

docs/img/ivr-menu-a-prompt.png

167 KB
Loading

docs/img/ivr-menu-b-prompt.png

163 KB
Loading

docs/img/ivr-menus.png

227 KB
Loading

docs/recipes/ivr-menu-key-press.json

+90
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,90 @@
1+
{
2+
"name": "SMS sent when call received",
3+
"nodes": [
4+
{
5+
"id": "trigger",
6+
"position": {
7+
"x": 250,
8+
"y": 80
9+
},
10+
"type": "trigger",
11+
"data": {
12+
"description": "",
13+
"rules": [],
14+
"label": "Call received",
15+
"type": "callReceived",
16+
"nextNodes": [
17+
"action-1717500598278"
18+
],
19+
"matchType": "and"
20+
}
21+
},
22+
{
23+
"id": "action-1717500598278",
24+
"position": {
25+
"x": 250,
26+
"y": 280
27+
},
28+
"type": "action",
29+
"data": {
30+
"paramValues": "{\"toPhoneNumbers\":[{\"phoneNumber\":\"{trigger.caller.phoneNumber}\"}],\"fromPhoneNumber\":\"$$PARAM$$\",\"messageText\":\"$$PARAM$$\"}",
31+
"parentNodeId": "trigger",
32+
"label": "Send SMS",
33+
"type": "sendSMS",
34+
"parentNodeBranch": "default",
35+
"nextNodes": [
36+
"action-exit-1717500488442"
37+
]
38+
}
39+
},
40+
{
41+
"id": "action-exit-1717500488442",
42+
"position": {
43+
"x": 250,
44+
"y": 480
45+
},
46+
"type": "action",
47+
"data": {
48+
"paramValues": "{}",
49+
"parentNodeId": "action-1717500598278",
50+
"label": "Exit",
51+
"type": "exit",
52+
"parentNodeBranch": "default",
53+
"nextNodes": []
54+
}
55+
}
56+
],
57+
"params": [
58+
{
59+
"id": "action-params-action-1717500598278-fromPhoneNumber",
60+
"name": "Select the phone number your SMS will be sent from",
61+
"type": "option",
62+
"options": [],
63+
"remote": true,
64+
"remoteOptionKey": "fromPhoneNumbers",
65+
"validator": "^\\+[1-9]\\d{1,14}$",
66+
"noOptionsMessage": "noSMSPermission",
67+
"supportedVariables": [
68+
"trigger.recipient.phoneNumber"
69+
],
70+
"supportedVariablesForTrigger": "newSMS",
71+
"nodeId": "action-1717500598278",
72+
"nodeLabel": "Send SMS",
73+
"paramId": "fromPhoneNumber",
74+
"forAction": "sendSMS"
75+
},
76+
{
77+
"id": "action-params-action-1717500598278-messageText",
78+
"name": "Enter your SMS message text",
79+
"type": "text",
80+
"limitLength": 500,
81+
"helperText": "Tip: type \"#\" to see a list of variables you can insert into the message",
82+
"nodeId": "action-1717500598278",
83+
"nodeLabel": "Send SMS",
84+
"paramId": "messageText",
85+
"forAction": "sendSMS",
86+
"requiredActionOutputs": []
87+
}
88+
],
89+
"version": 1
90+
}

docs/recipes/ivr-menus.md

+39
Original file line numberDiff line numberDiff line change
@@ -20,3 +20,42 @@ One can use the "Call end reason" variable to determine if a caller ended the ca
2020

2121
For now, there is no way to detect specific key a user pressed in an IVR menu, but we can make some reasonable inferrences depending upon what extensions an IVR menu might direct a user to. For example, if an IVR menu directs someone to a extension 203, and if the IVR menu is the only way a user could navigate to that extension, then one could place a "Call received" trigger on extension 203 - thereby detecting that someone previously selected it via an IVR menu.
2222

23+
### Step 1: Setup IVR menus in RingCentral admin portal
24+
25+
We will have two IVR menus.
26+
27+
![ivr-menus](../img/ivr-menus.png)
28+
29+
First menu is the IVR menu that you want caller to press keys to trigger automation. Let's call the first extension "IVR Menu 1".
30+
31+
Let's set prompt to say "Press 1 get to a link by SMS":
32+
33+
![ivr-menu-a-prompt](../img/ivr-menu-a-prompt.png)
34+
35+
In Key presses, let's make Key 1 connect to IVR Menu B.
36+
37+
![ivr-menu-a-keys](../img/ivr-menu-a-keys.png)
38+
39+
In IVR Menu B, let's set prompt to say "A SMS is sent to you with link":
40+
41+
![ivr-menu-b-prompt](../img/ivr-menu-b-prompt.png)
42+
43+
### Step 2: Setup automation in Automator
44+
45+
Login into RingCentral Automator with admin account. Then **go to IVR Menu B's page**:
46+
47+
![automator-ivr-menu-b](../img/automator-ivr-menu-b.png)
48+
49+
Import following automation template file n for IVR Menu B:
50+
51+
![automator-ivr-menu-b-import](../img/automator-ivr-menu-b-import.png)
52+
53+
[:fontawesome-solid-download: Download automation](ivr-menu-key-press.json){: download .md-button }
54+
55+
After imported, You can also update the automation to setup other actions and logics for call received trigger.
56+
57+
**Enable** the automation, then all DONE. When call to IVR Menu A, then caller press 1. Caller will be redirect to IVR Menu B. Then a SMS will be sent.
58+
59+
### Step 3: Other key presses
60+
61+
To setup other key press, you need to create a new IVR Menu C. Then setup key 2 connect to IVR Menu C in IVR Menu A. Then import other automation for IVR Menu C in Automator.

docs/recipes/missed-call.json

+1-1
Original file line numberDiff line numberDiff line change
@@ -142,7 +142,7 @@
142142
},
143143
{
144144
"id": "action-params-action-sms-messageText",
145-
"name": "Enter your auto-reply's message test",
145+
"name": "Enter your auto-reply's message text",
146146
"type": "text",
147147
"limitLength": 500,
148148
"helperText": "Tip: type \"#\" to see a list of variables you can insert into the message",

0 commit comments

Comments
 (0)