fn list(product?: string, connectionStatus?: string, tag?: string, type?: string)
List all devices in the Webex org. Optionally filter by product type, connection status, or tag.
| Argument | Type | Required | Description |
|---|
| product? | string | no | Filter by product name (e.g., 'Cisco Codec Pro', 'Cisco Room Kit Pro') |
| connectionStatus? | string | no | Filter by connection status: connected, disconnected, connected_with_issues |
| tag? | string | no | Filter by device tag |
| type? | string | no | Filter by device type: roomdesk, phone, accessory, camera |
fn get(deviceId: string)
Get detailed information about a specific device by ID.
| Argument | Type | Required | Description |
|---|
| deviceId | string | yes | Webex device ID |
fn getStatus(deviceId: string, statusPaths: array)
Query xAPI status values from a device. Use specific paths (e.g., 'SystemUnit.Software.Version') rather than broad wildcards for MTR devices.
| Argument | Type | Required | Description |
|---|
| deviceId | string | yes | Webex device ID |
| statusPaths | array | yes | Status paths to query (max 10). Examples: SystemUnit.Software.Version, SystemUnit.Uptime, Standby.State |
fn enableMacros(deviceId: string)
Enable the macro runtime on a device by setting Macros.Mode=On and Macros.AutoStart=On.
| Argument | Type | Required | Description |
|---|
| deviceId | string | yes | Webex device ID |
fn healthCheck(deviceId: string)
Run a health check on a device — queries connection status, firmware version, uptime, standby state, and network address. Uses specific status paths safe for both native and MTR mode devices.
| Argument | Type | Required | Description |
|---|
| deviceId | string | yes | Webex device ID |
fn setConfiguration(deviceId: string, patches: array)
Set one or more device configurations via JSON Patch. Use the path format 'Config.Path/sources/configured/value'. On MTR devices, only configs tagged with include_for_extension='mtr' are available.
| Argument | Type | Required | Description |
|---|
| deviceId | string | yes | Webex device ID |
| patches | array | yes | Array of configuration patches to apply |
fn executeCommand(deviceId: string, command: string, commandArgs?: string, body?: string)
Execute an arbitrary xAPI command on a device via the Webex cloud API. Commands work in all device modes (native, MTR, Zoom). For macro-specific commands, prefer the @dougschaefer/cisco-collaboration-endpoints-macro model methods.
| Argument | Type | Required | Description |
|---|
| deviceId | string | yes | Webex device ID |
| command | string | yes | xAPI command name (e.g., 'Audio.Volume.Set', 'Standby.Activate', 'SystemUnit.Boot') |
| commandArgs? | string | no | Command arguments as JSON string (e.g., '{\ |
| body? | string | no | Command body content (used by commands like Macros.Macro.Save) |
fn updateTags(deviceId: string, tags: array)
Update tags on a device. Tags are used for organizing and filtering devices in Control Hub and can be used to target fleet operations.
| Argument | Type | Required | Description |
|---|
| deviceId | string | yes | Webex device ID |
| tags | array | yes | Complete list of tags to set on the device (replaces existing tags) |
fn listWorkspaces(displayName?: string, workspaceLocationId?: string, calling?: string)
List Webex workspaces (rooms/spaces) in the org. Workspaces represent physical locations with assigned devices, calendar integration, and calling configuration.
| Argument | Type | Required | Description |
|---|
| displayName? | string | no | Filter by workspace display name (partial match) |
| workspaceLocationId? | string | no | Filter by workspace location ID |
| calling? | string | no | Filter by calling type: freeCalling, hybridCalling, webexCalling, thirdPartySipCalling |
fn getWorkspace(workspaceId: string)
Get detailed information about a specific workspace by ID.
| Argument | Type | Required | Description |
|---|
| workspaceId | string | yes | Webex workspace ID |
Resources
device(infinite)— Cisco RoomOS device registered to Webex Control Hub — codecs, boards, desk devices, and room navigators
workspace(infinite)— Webex workspace (room/space) with assigned devices, calendar integration, and calling configuration