Skip to content

Commit 9f559dd

Browse files
edumanskyedumansky
committed
Update docs site with latest included CLI APIs
1 parent 9af1f21 commit 9f559dd

9 files changed

Lines changed: 471 additions & 42 deletions

File tree

‎site/astro.config.mjs‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,8 +16,12 @@ export default defineConfig({
1616
{ label: 'Quick Start', slug: 'getting-started' },
1717
]},
1818
{ label: 'API Reference', items: [
19+
{ label: 'Admin Commands', slug: 'admin' },
1920
{ label: 'Calling Commands', slug: 'calling' },
2021
{ label: 'Contact Center Commands', slug: 'cc' },
22+
{ label: 'Device Commands', slug: 'device' },
23+
{ label: 'Meetings Commands', slug: 'meetings' },
24+
{ label: 'Messaging Commands', slug: 'messaging' },
2125
]},
2226
{ label: 'Integrations', items: [
2327
{ label: 'Claude Code Skill', slug: 'claude-skill' },

‎site/src/content/docs/admin.mdx‎

Lines changed: 97 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,97 @@
1+
---
2+
title: Admin Commands
3+
description: Webex Admin API commands reference.
4+
---
5+
6+
The `webex admin` subcommand provides access to the Webex Admin APIs for managing organizations, users, licenses, roles, and platform-level configuration.
7+
8+
## Resource Groups
9+
10+
| Resource | Description |
11+
|----------|-------------|
12+
| `admin-audit` | Admin audit event logs |
13+
| `analytics` | Analytics data |
14+
| `archive-users` | Archived user management |
15+
| `authorizations` | Authorization management |
16+
| `classifications` | Data classification management |
17+
| `data-sources` | Data source configuration |
18+
| `domain-management` | Domain management |
19+
| `events` | Event management |
20+
| `groups` | Group management |
21+
| `guest-management` | Guest user management |
22+
| `hybrid-clusters` | Hybrid cluster management |
23+
| `hybrid-connectors` | Hybrid connector management |
24+
| `identity-org` | Identity and organization management |
25+
| `licenses` | License management |
26+
| `live-monitoring` | Live monitoring |
27+
| `meeting-qualities` | Meeting quality reports |
28+
| `org-contacts` | Organizational contact management |
29+
| `organizations` | Organization management |
30+
| `partner-administrators` | Partner administrator management |
31+
| `partner-reports-templates` | Partner report templates |
32+
| `partner-tags` | Partner tag management |
33+
| `people` | People management |
34+
| `recording-report` | Recording reports |
35+
| `recordings` | Recording management |
36+
| `report-templates` | Report templates |
37+
| `reports` | General reports |
38+
| `resource-groups` | Resource group management |
39+
| `resource-memberships` | Resource membership management |
40+
| `roles` | Role management |
41+
| `scim-2-bulk` | SCIM 2.0 bulk operations |
42+
| `scim-2-groups` | SCIM 2.0 group provisioning |
43+
| `scim-2-schemas` | SCIM 2.0 schema discovery |
44+
| `scim-2-users` | SCIM 2.0 user provisioning |
45+
| `security-audit` | Security audit event logs |
46+
| `send-activation-email` | Send activation emails |
47+
| `service-apps` | Service app management |
48+
| `settings` | Organization settings |
49+
| `workspace-locations` | Workspace location management |
50+
| `workspace-metrics` | Workspace metrics |
51+
52+
## Common Patterns
53+
54+
```bash
55+
# List resources
56+
webex admin <resource> list
57+
58+
# Get by ID
59+
webex admin <resource> get --id "..."
60+
61+
# Create
62+
webex admin <resource> create --body-file config.json
63+
64+
# Update
65+
webex admin <resource> update --id "..." --body-file updated.json
66+
67+
# Delete
68+
webex admin <resource> delete --id "..."
69+
```
70+
71+
## Examples
72+
73+
```bash
74+
# List people in the organization
75+
webex admin people list --paginate
76+
77+
# List licenses
78+
webex admin licenses list
79+
80+
# List roles
81+
webex admin roles list
82+
83+
# List groups
84+
webex admin groups list
85+
86+
# Get organization details
87+
webex admin organizations list
88+
89+
# View admin audit events
90+
webex admin admin-audit list
91+
92+
# List hybrid clusters
93+
webex admin hybrid-clusters list
94+
95+
# SCIM user provisioning
96+
webex admin scim-2-users list
97+
```

‎site/src/content/docs/calling.mdx‎

Lines changed: 46 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -9,30 +9,51 @@ The `webex calling` subcommand provides access to the Webex Calling API. No `--o
99

1010
| Resource | Description |
1111
|----------|-------------|
12-
| `people` | Users and their calling settings |
13-
| `locations` | Location management |
14-
| `devices` | Device provisioning and management |
15-
| `numbers` | Phone number inventory |
16-
| `call-queue` | Call queue configuration |
17-
| `hunt-group` | Hunt group configuration |
18-
| `auto-attendant` | Auto attendant / IVR |
12+
| `announcement-playlist` | Announcement playlist management |
13+
| `announcement-repository` | Announcement repository management |
14+
| `auto-attendant` | Auto attendant / IVR configuration |
15+
| `call-controls` | Active call control operations |
1916
| `call-park` | Call park settings |
2017
| `call-pickup` | Call pickup groups |
21-
| `paging-group` | Paging groups |
22-
| `call-controls` | Active call control operations |
18+
| `call-queue` | Call queue configuration |
2319
| `call-recording` | Call recording settings |
24-
| `user-call` | Per-user call settings |
25-
| `workspace-call` | Per-workspace call settings |
26-
| `device-call` | Per-device call settings |
27-
| `location-call` | Per-location call settings |
20+
| `call-routing` | Call routing configuration |
21+
| `call-settings-for-me` | Personal call settings |
22+
| `caller-reputation-provider` | Caller reputation / spam management |
23+
| `calling-service` | Calling service configuration |
24+
| `client-call` | Client call management |
25+
| `conference-controls` | Conference call controls |
26+
| `converged-recordings` | Recording access and management |
27+
| `customer-experience-essentials` | Customer experience essentials |
2828
| `dect-devices` | DECT handset and base station management |
29-
| `pstn` | PSTN connection and trunk settings |
29+
| `device-call` | Per-device call settings |
30+
| `devices` | Device provisioning and management |
3031
| `emergency-services` | E911 and emergency callback |
32+
| `external-voicemail` | External voicemail settings |
33+
| `hot-desk` | Hot desk configuration |
34+
| `hot-desking-sign-in-via-voice-portal` | Hot desking voice portal sign-in |
35+
| `hunt-group` | Hunt group configuration |
36+
| `location-call` | Per-location call settings |
37+
| `location-call-handling` | Location call handling rules |
38+
| `location-schedules` | Location schedule management |
39+
| `location-voicemail` | Location voicemail settings |
40+
| `locations` | Location management |
41+
| `numbers` | Phone number inventory |
3142
| `operating-modes` | Operating mode schedules |
43+
| `paging-group` | Paging group configuration |
44+
| `partner-reports-templates` | Partner report templates |
45+
| `people` | Users and their calling settings |
46+
| `pstn` | PSTN connection and trunk settings |
47+
| `recording-report` | Recording reports |
48+
| `reports` | CDR and call history reports |
49+
| `reports-detailed-call-history` | Detailed call history reports |
50+
| `send-activation-email` | Send activation emails |
3251
| `single-number-reach` | Single number reach / simultaneous ring |
52+
| `user-call` | Per-user call settings |
3353
| `virtual-extensions` | Virtual extension configuration |
34-
| `converged-recordings` | Recording access and management |
35-
| `reports` | CDR and call history reports |
54+
| `virtual-line-call` | Virtual line call settings |
55+
| `workspace-call` | Per-workspace call settings |
56+
| `workspaces` | Workspace management |
3657

3758
## Common Patterns
3859

@@ -59,6 +80,12 @@ webex calling <resource> delete --id "..."
5980
# List all people
6081
webex calling people list --paginate
6182

83+
# Get your own details
84+
webex calling people get-my-own
85+
86+
# List locations
87+
webex calling locations list
88+
6289
# Get call settings for a person
6390
webex calling user-call get-voicemail --person-id "PERSON_ID"
6491

@@ -67,4 +94,7 @@ webex calling call-queue list --location-id "LOCATION_ID"
6794

6895
# Get detailed call history
6996
webex calling reports-detailed-call-history list --start-time "2024-01-01T00:00:00Z"
97+
98+
# List devices
99+
webex calling devices list --paginate
70100
```

‎site/src/content/docs/cc.mdx‎

Lines changed: 48 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -9,30 +9,60 @@ The `webex cc` subcommand provides access to the Webex Contact Center API. The `
99

1010
| Resource | Description |
1111
|----------|-------------|
12-
| `site` | Contact center sites |
13-
| `team` | Agent teams |
14-
| `users` | CC-enabled users |
15-
| `entry-point` | Inbound entry points (voice, chat, email, social) |
12+
| `address-book` | Address books |
13+
| `agent-personal-greeting-files` | Agent personal greeting file management |
14+
| `agent-summaries` | Agent summary reports |
15+
| `agent-wellbeing` | Agent wellbeing configuration |
16+
| `agents` | Agent state operations (login, logout, state change) |
17+
| `ai-assistant` | AI assistant configuration |
18+
| `ai-feature` | AI feature management |
19+
| `audio-files` | IVR prompts and audio files |
20+
| `auto-csat` | Automated CSAT configuration |
21+
| `auxiliary-code` | Idle and wrap-up reason codes |
22+
| `business-hour` | Business hours schedules |
23+
| `call-monitoring` | Call monitoring configuration |
24+
| `callbacks` | Callback management |
25+
| `campaign-manager` | Outbound campaign management |
26+
| `captures` | Capture management |
27+
| `contact-list-management` | Contact list management |
28+
| `contact-number` | Contact number management |
1629
| `contact-service-queue` | Contact service queues |
17-
| `skill` | Skill definitions |
18-
| `skill-profile` | Skill profile assignments |
19-
| `user-profiles` | User profile (access control) |
20-
| `desktop-profile` | Agent desktop profiles |
30+
| `data-sources` | Data source configuration |
2131
| `desktop-layout` | Agent desktop layouts |
22-
| `multimedia-profile` | Channel blending profiles |
23-
| `auxiliary-code` | Idle and wrap-up reason codes |
32+
| `desktop-profile` | Agent desktop profiles |
33+
| `dial-number` | DN-to-entry-point mappings |
34+
| `dial-plan` | Outdial plans |
35+
| `dnc-management` | Do-not-call list management |
36+
| `entry-point` | Inbound entry points (voice, chat, email, social) |
37+
| `estimated-wait-time` | Estimated wait time configuration |
38+
| `flow` | Flow export/import/publish |
39+
| `generated-summaries` | AI-generated summary management |
2440
| `global-variables` | Flow global variables |
25-
| `business-hour` | Business hours schedules |
2641
| `holiday-list` | Holiday lists |
27-
| `dial-plan` | Outdial plans |
28-
| `dial-number` | DN-to-entry-point mappings |
42+
| `journey` | Customer journey management |
43+
| `journey-customer-identification` | Journey customer identification |
44+
| `journey-data-ingestion` | Journey data ingestion |
45+
| `journey-profile-creation-insights` | Journey profile creation insights |
46+
| `journey-subscription` | Journey subscription management |
47+
| `journey-trigger-actions` | Journey trigger actions |
48+
| `journey-workspace-management` | Journey workspace management |
49+
| `multimedia-profile` | Channel blending profiles |
50+
| `notification` | Notification management |
2951
| `outdial-ani` | Outdial ANI lists |
30-
| `audio-files` | IVR prompts and audio |
31-
| `flow` | Flow export/import/publish |
32-
| `agents` | Agent state operations |
33-
| `address-book` | Address books |
34-
| `work-types` | Work type definitions |
3552
| `overrides` | Schedule overrides |
53+
| `queues` | Queue statistics and management |
54+
| `realtime` | Realtime data and statistics |
55+
| `resource-collection` | Resource collection management |
56+
| `search` | Search operations |
57+
| `site` | Contact center sites |
58+
| `skill` | Skill definitions |
59+
| `skill-profile` | Skill profile assignments |
60+
| `subscriptions` | Subscription management |
61+
| `tasks` | Task management |
62+
| `team` | Agent teams |
63+
| `user-profiles` | User profile (access control) |
64+
| `users` | CC-enabled users |
65+
| `work-types` | Work type definitions |
3666

3767
## Common Patterns
3868

‎site/src/content/docs/device.mdx‎

Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
1+
---
2+
title: Device Commands
3+
description: Webex Device API commands reference.
4+
---
5+
6+
The `webex device` subcommand provides access to the Webex Device APIs for managing devices, workspaces, and device configurations.
7+
8+
## Resource Groups
9+
10+
| Resource | Description |
11+
|----------|-------------|
12+
| `device-call` | Device call settings |
13+
| `device-configurations` | Device configuration management |
14+
| `devices` | Device provisioning and management |
15+
| `hot-desk` | Hot desk configuration |
16+
| `workspace-locations` | Workspace location management |
17+
| `workspace-metrics` | Workspace usage metrics |
18+
| `workspace-personalization` | Workspace personalization settings |
19+
| `workspaces` | Workspace management |
20+
| `xapi` | xAPI commands for device control |
21+
22+
## Common Patterns
23+
24+
```bash
25+
# List resources
26+
webex device <resource> list
27+
28+
# Get by ID
29+
webex device <resource> get --id "..."
30+
31+
# Create
32+
webex device <resource> create --body-file config.json
33+
34+
# Update
35+
webex device <resource> update --id "..." --body-file updated.json
36+
37+
# Delete
38+
webex device <resource> delete --id "..."
39+
```
40+
41+
## Examples
42+
43+
```bash
44+
# List all devices
45+
webex device devices list --paginate
46+
47+
# List workspaces
48+
webex device workspaces list
49+
50+
# Get device configurations
51+
webex device device-configurations list
52+
53+
# List workspace locations
54+
webex device workspace-locations list
55+
56+
# Execute xAPI command
57+
webex device xapi list
58+
```

0 commit comments

Comments
 (0)