engage-voice-api-docs/mkdocs.yml at master · DaKingKong/engage-voice-api-docs · GitHub

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
site_name: RingCentral Engage Voice Developer Guide
site_url: https://engage-voice-api-docs.rtfd.org
site_favicon: favicon.ico
repo_url: https://github.com/ringcentral/engage-voice-api-docs
docs_dir: docs
theme:
  name: ringcentral
  product_section: engage
  fluid_layout: True
  suppress_nextprev: true
  shortcuts:
    - foo

plugins:
  - git-committers:
      repository: ringcentral/engage-voice-api-docs
      branch: master
  - bootstrap-tables

markdown_extensions:
  - markdown.extensions.admonition
  - pymdownx.details
  - pymdownx.keys
  - pymdownx.tabbed
  - pymdownx.superfences:
       disable_indented_code_blocks: true
  - pymdownx.highlight
  - markdown_include.include:
       base_path: docs

#extra_css: [extra.css]
#extra_javascript: [fonts.js]
pages:
- 'Primary':
  - 'Analytics':
    - 'Overview': analytics/index.md
    - 'Cloud Reports':
      - 'Call Detail': analytics/reports/call-detail-report.md
    - 'Realtime Reports':
      - 'Agent Segment Metadata': analytics/reports/agent-segment-metadata-report.md
      - 'Agent Session': analytics/reports/agent-session-report.md
      - 'Call Details and Recordings': analytics/reports/global-call-type-detail-report.md
      - 'Dialer Result Download': analytics/reports/dialer-result-download-report.md
  - 'Routing':
    - 'Overview': routing/index.md
    - 'Getting Started':
      - 'Node JS': routing/quick-start/node.md
      - 'Python': routing/quick-start/python.md
      - 'PHP': routing/quick-start/php.md
    - 'Queues':
      - 'Queues': routing/queues/queues.md
      - 'Queue Events': routing/queues/queue-events.md
      - 'Queue Groups': routing/queues/queue-groups.md
      - 'Group Skills': routing/queues/group-skills.md
    - 'IVR':
      - 'Overview': routing/ivr/index.md
      - 'WWW Node': routing/ivr/www-node.md
      - 'Scripting Node': routing/ivr/scripting-node.md
    - 'Tutorials':
      - 'IVR DNC List': https://ringcentral-tutorials.github.io/dnc-via-ivr-rest-demo
  - 'Dialing':
    - 'Overview': dialing/index.md
    - 'Getting Started':
      - 'Node JS': dialing/quick-start/node.md
      - 'Python': dialing/quick-start/python.md
      - 'PHP': dialing/quick-start/php.md
    - 'Campaigns':
      - 'Dial Groups': dialing/campaigns/dial-groups.md
      - 'Campaigns': dialing/campaigns/campaigns.md
      - 'DNC': dialing/dnc/dnc-list.md
    - 'Leads':
      - 'Bulk Import Leads': dialing/leads/bulk-import.md
      - 'Searching Leads': dialing/leads/search.md
      - 'Lead Actions': dialing/leads/actions.md
      - 'Web2Campaign': dialing/leads/web2campaign.md
    - 'Active Calls':
      - 'Active Calls': dialing/active-calls/index.md
      - 'Getting Started':
        - 'Node JS': dialing/active-calls/quick-start/node.md
        - 'PHP': dialing/active-calls/quick-start/php.md
        - 'Python': dialing/active-calls/quick-start/python.md
      #- 'List Active Calls': dialing/activecalls/list-activecalls.md
  - 'Users':
    - 'Overview': users/agents/index.md
    - 'Agents':
      - 'Agents': users/agents/agents.md
      - 'Agent Groups': users/agents/agent-groups.md
      - 'Skill Profiles': users/agents/skill-profile.md
      - 'Agent Scripting': users/agents/agent-script.md
  - 'Workforce':
    - 'Overview': workforce/index.md
    - 'Workforce Management':
      - 'Creating an Event': notifications/wfm/configure-wfm.md
      - 'Event Payload': notifications/wfm/payload-wfm.md
    - 'Quality Management': workforce/qm/index.md
    - 'Call Recordings': workforce/call-recording/index.md
- 'Secondary':
  - 'Using the API':
    - 'Fundamentals':
      - 'Methods, endpoints and parameters': 'basics/uris.md'
      #- 'App permissions': 'basics/permissions.md'
      #- 'Rate limits': 'basics/rate-limits.md'
    #- 'Obtaining a Token': basics/auth-ringcentral.md
    #- 'Legacy Tokens': basics/auth-legacy.md
  - 'Authentication':
    - 'Overview': authentication/index.md
    - 'Engage with RingCentral Token': authentication/auth-ringcentral.md
    - 'Engage Access Token': authentication/auth-engage.md
    - 'Legacy': authentication/auth-legacy.md
  - 'Events and Notifications':
    - 'Overview': notifications/index.md
    - 'Workforce Management':
      - 'Creating an Event': notifications/wfm/configure-wfm.md
      - 'Event Payload': notifications/wfm/payload-wfm.md
    - 'Web Services': notifications/web-service/index.md
  - 'SDKs': sdks/index.md
  - 'Embeddable': embeddable/get-started.md
  - 'Postman': postman.md
  - 'Database Access': redshift-db.md