forked from ringcentral/ringcentral-api-docs
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathmkdocs.yml
229 lines (212 loc) · 10.7 KB
/
mkdocs.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
site_name: Developing with RingCentral
site_url: https://github.com/ringcentral/ringcentral-api-docs
site_favicon: favicon.ico
repo_url: https://github.com/ringcentral/ringcentral-api-docs
edit_uri: tree/master/docs
docs_dir: docs
plugins:
- git-committers:
repository: ringcentral/ringcentral-api-docs
branch: master
- bootstrap-tables
- ringcentral-api-index:
outfile: basics/api-index.md
theme:
name: ringcentral
fluid_layout: True
suppress_nextprev: true
shortcuts:
- foo
markdown_extensions:
- markdown.extensions.admonition
- pymdownx.details
- pymdownx.keys
- pymdownx.tabbed
- pymdownx.superfences
- codehilite:
linenums: "None"
- mdx_include
extra_css:
- extra.css
- css/mega-menu.css
copyright: "1999-2020 RingCentral, Inc. All rights reserved."
google_analytics: ['UA-57519112-1', 'developers.ringcentral.com']
pages:
# ---- CORE APIs ----
- 'Primary':
- 'Voice':
- 'Overview': 'voice/index.md'
- 'Getting Started': 'voice/quick-start.md'
- 'Placing Calls':
- 'RingOut': 'voice/ringout.md'
- 'WebRTC': 'voice/webrtc.md'
- 'URI Scheme': 'voice/uri-scheme.md'
- 'Call Routing':
- 'Overview': 'voice/call-routing/index.md'
- 'Get Started': 'voice/call-routing/get-started.md'
- 'Answering Rules Overview': 'voice/call-routing/manual/answering-rules.md'
- 'User Answering Rules': 'voice/call-routing/manual/user-answering-rules.md'
- 'Company Answering Rules': 'voice/call-routing/manual/company-answering-rules.md'
- 'Call Queues': 'voice/call-routing/manual/call-queues.md'
- 'Call Forwarding/Flipping': 'voice/call-routing/manual/call-forwarding.md'
- 'Call Control':
- 'Overview': 'voice/call-control.md'
- 'Finding active calls': 'voice/finding-active-calls.md'
- 'Detecting state changes': 'voice/call-control-sessions.md'
- 'Pre-call Control': 'voice/pre-call-control.md'
- 'Active-call Control': 'voice/active-call-control.md'
- 'Call Monitoring': 'voice/supervision.md'
- 'Conference call': 'voice/conference.md'
- 'Telephony Session Notifications': 'voice/telephony-session-notifications.md'
- 'Call Control SDK': 'https://github.com/ringcentral/ringcentral-call-control-js'
- 'Call Logs':
- 'Reading Call Log Data': 'voice/call-log/reading-call-log.md'
- 'Data Types': 'voice/call-log/api.md'
- 'Detailed Call Log Data': 'voice/call-log/details.md'
- 'Data Archival': 'voice/call-log/archival.md'
- 'Call Recordings': 'voice/call-log/recordings.md'
- 'Synchronization': 'voice/call-log/sync.md'
- 'Best Practices': 'voice/call-log/best-practices.md'
- 'Access Control': 'voice/call-log/access.md'
- 'Call Analytics':
- 'Calculating Call Metrics': 'voice/calculating-call-time-metrics.md'
- 'Sample Applications':
- 'Building a Web Phone with WebRTC': 'https://ringcentral-tutorials.github.io/getting-started-with-webrtc-js-demo/'
- 'Call Log Analytics for iOS': 'https://ringcentral-tutorials.github.io/calllog-analytics-swift-demo/'
- 'Call Log Visualizations': 'https://ringcentral-tutorials.github.io/calllog-visualization-nodejs-demo/'
- 'Call Recording Push Notification': 'https://ringcentral-tutorials.github.io/callrecording-notification-node/'
- 'SMS and Fax':
- 'Overview': 'messaging/index.md'
- 'Getting Started': 'messaging/quick-start.md'
- 'SMS':
- 'Best Practices': 'messaging/sms/best-practices.md'
- 'Sending an SMS': 'messaging/sms/sending-sms.md'
- 'Sending an MMS': 'messaging/sms/sending-images.md'
- 'Valid SMS Numbers': 'messaging/sms/valid-sms-numbers.md'
- 'High Volume SMS':
- 'Overview': 'messaging/sms/high-volume/index.md'
- 'Sending High Volume SMS': 'messaging/sms/high-volume/sending-highvolume-sms.md'
- 'Reading High Volume Message Store': 'messaging/sms/high-volume/message-store.md'
- 'Toll-Free vs. Local Numbers': 'messaging/sms/high-volume/toll-free-sms-vs-local-numbers.md'
- 'Opt-in / Opt-out': 'messaging/sms/high-volume/opt-out.md'
- 'Event Notifications': 'messaging/sms/high-volume/events.md'
- 'Errors Handling': 'messaging/sms/high-volume/handling-errors.md'
- 'Fax':
- 'Sending Faxes': 'messaging/fax/sending-faxes.md'
- 'Multipart Formats': 'messaging/fax/fax-multipart-formats.md'
- 'Receiving Faxes': 'messaging/fax/receiving-faxes.md'
- 'Forwarding and Resending Faxes': 'messaging/fax/resending-faxes.md'
- 'Pager Messages':
- 'Sending Pager Messages': 'messaging/pager/sending-pager-messages.md'
- 'Message Store':
- 'Sending Messages': 'messaging/message-store/messaging.md'
- 'Working with Message Store': 'messaging/message-store/working-with-message-store.md'
- 'Message Synchronization': 'messaging/message-store/message-sync.md'
- 'Modifying Message Histories': 'messaging/message-store/message-histories.md'
- 'Message Store Export': 'messaging/message-store/message-exports-report.md'
- 'Sample Applications':
- 'SMS Sample App Walkthrough': 'https://ringcentral-tutorials.github.io/sms-api-nodejs-demo/'
- 'A2P SMS Messaging': 'https://ringcentral-tutorials.github.io/a2p-sms-messaging-nodejs-demo/'
- 'Two-factor Authentication': 'https://ringcentral-tutorials.github.io/sms-2fa-nodejs-demo/'
- 'Custom Fax Cover Pages': 'https://ringcentral-tutorials.github.io/fax-cover-page-nodejs-demo/'
- 'Team Messaging':
- 'Overview': 'team-messaging/index.md'
- 'Getting Started': 'team-messaging/quick-start.md'
- 'Posting Messages':
- 'Simple text messages': 'team-messaging/manual/posting.md'
- 'Posting Cards': 'team-messaging/manual/posting-cards.md'
- 'Posting Images': 'team-messaging/manual/posting-images.md'
- 'Uploading and posting files': 'team-messaging/manual/attaching-files.md'
- 'Chats, Groups, Teams':
- 'Chats': 'team-messaging/manual/chats.md'
- 'Conversations': 'team-messaging/manual/conversations.md'
- 'Teams': 'team-messaging/manual/teams.md'
- 'Pagination': 'team-messaging/manual/pagination.md'
- 'Incoming Webhooks':
- 'Webhook Creation': 'team-messaging/manual/webhook-creation.md'
- 'Webhook Posting (v2)': 'team-messaging/manual/webhook-posting.md'
- 'Webhook Posting (v1)': 'team-messaging/manual/formatting.md'
- 'Testing using cURL': 'team-messaging/manual/testing-webhooks.md'
- 'Compliance Export':
- 'Compliance Export': 'team-messaging/manual/compliance-export.md'
- 'Export File Structure': 'team-messaging/manual/compliance-export-structure.md'
- 'Bots':
- 'Building a Bot Locally': 'team-messaging/manual/local-bots.md'
- 'Build a Bot in Node': 'team-messaging/manual/node.md'
- 'Bot Frameworks': 'team-messaging/manual/frameworks.md'
- 'Outgoing Events and Webhooks':
- 'Subscribing to Webhooks': 'team-messaging/manual/outgoing-webhooks.md'
- 'Post Events': 'team-messaging/manual/events-posts.md'
- 'Chat Events': 'team-messaging/manual/events-groups.md'
- 'Incoming Webhook Events': 'team-messaging/manual/events-incoming-webhooks.md'
- 'Deep links': 'team-messaging/manual/links.md'
- 'Sample Applications':
- 'Bot using IBM Watson and Botkit': 'https://ringcentral-tutorials.github.io/botkit-watson-bot-nodejs-demo/'
- 'Voicemail Transcription Bot': 'https://ringcentral-tutorials.github.io/ringcentral-ai-bot/'
- 'Meetings':
- 'Overview': 'meetings/index.md'
- 'Getting Started': 'meetings/quick-start.md'
- 'RingCentral Video API': 'meetings/video.md'
- 'Embeddable': 'meetings/embeddable.md'
# ---- SECONDARY APIs ----
- 'Secondary':
- 'Using the API':
- 'Methods, endpoints and parameters': 'basics/uris.md'
- 'Exploring the API': 'basics/explorer.md'
- 'Using phones in sandbox': 'basics/your-rc-phone.md'
- 'Media content': 'basics/media.md'
- 'App permissions': 'basics/permissions.md'
- 'URI schemes': 'basics/uri-schemes.md'
- 'Rate limits': 'basics/rate-limits.md'
- 'API Reference Index': 'basics/api-index.md'
- 'Applications':
- 'Development Lifecycle':
- 'Tips for your first app': 'basics/your-first-steps.md'
- 'Create an application': 'basics/create-app.md'
- 'Develop in sandbox': 'basics/sandbox.md'
- 'Graduate to production': 'basics/production.md'
- 'App Promotion':
- 'Submit to the App Gallery': 'basics/app-gallery.md'
- 'Update a Profile': 'basics/update-profile.md'
- 'Checklist and Best Practices': 'basics/app-gallery-checklist.md'
- 'Partner compatibility': 'basics/partner-compatibility.md'
- 'Partner Brand Guidelines':
- 'AT&T Office@Hand': 'basics/partners/att.md'
- 'Avaya Cloud Office': 'basics/partners/aco.md'
- 'BT Cloud Work': 'basics/partners/bt.md'
- 'TELUS Business Connect': 'basics/partners/telus.md'
- 'Unify Office': 'basics/partners/atos.md'
- 'Application Management':
- 'Using Lead Forms': 'basics/lead-forms.md'
- 'Install App Buttons': 'basics/install-app-button.md'
- 'Account':
- 'Overview': 'account/index.md'
- 'Users and Extensions': 'account/extensions.md'
- 'Phone Numbers': 'account/phone-numbers.md'
- 'Call Forwarding/Flipping': 'account/call-forwarding-flipping.md'
- 'User Feature Flags': 'account/feature-flags.md'
- 'Custom Fields': 'account/custom-fields.md'
- 'Presence': 'account/presence.md'
- 'Authentication':
- 'Overview': 'authentication/index.md'
- 'Getting Started': 'authentication/quick-start.md'
- 'Developer Manual':
- '3-legged OAuth Flow': 'authentication/auth-code-flow.md'
- 'Password Flow': 'authentication/password-flow.md'
- 'Implicit Grant Flow': 'authentication/implicit-grant-flow.md'
- 'Using Auth Tokens': 'authentication/tokens.md'
- 'Notifications and Events':
- 'Overview': 'notifications/index.md'
- 'Push Notifications':
- 'Getting Started': 'notifications/push-notifications/quick-start.md'
- 'Using PubNub': 'notifications/push-notifications/pubnub.md'
- 'WebHooks':
- 'Getting Started': 'notifications/webhooks/quick-start.md'
- 'Creating Webhooks': 'notifications/webhooks/creating-webhooks.md'
- 'Receiving Webhooks': 'notifications/webhooks/receiving.md'
- 'Configuring TLS/SSL': 'notifications/webhooks/configuring-tls-ssl.md'
- 'Sample Applications':
- 'Create SMS Push Notification': 'https://ringcentral-tutorials.github.io/sms-api-nodejs-quickstart/'
- 'A2P SMS Messaging': 'https://ringcentral-tutorials.github.io/a2p-sms-messaging-nodejs-demo/'
- 'Downloads and SDKs': sdks.md
- 'RingCentral Labs': labs.md