List conference aliases, optionally scoped to one VMR.

Args: vmr: VMR id or exact name to filter by. Omit for all aliases. alias: Exact alias match. alias_contains: Case-insensitive substring match. limit: Max results. offset: Pagination offset.

List automatic participants, optionally scoped to one VMR.

Args: vmr: VMR id or name to filter by (pass the name directly — resolved internally, no need to list_vmrs first). Omit for all. alias_contains: Case-insensitive substring match on alias. limit: Max results. offset: Pagination offset.

List VMRs (Pexip conference objects with service_type=conference).

Args: name: Exact name match. name_contains: Case-insensitive substring match on name. tag: Filter by tag. limit: Max results (default 20). Use 0 to return all (avoid on large platforms). offset: Pagination offset.

Retrieve a VMR by integer id or by exact name.

List provisioned devices (registration records).

Args: alias_contains: Case-insensitive substring match on the device alias. owner_email: Filter by primary owner's email address (exact). tag: Filter by tag. limit: Max results. offset: Pagination offset.

Retrieve a device by integer id or by exact alias.

List endpoints currently registered to the platform (live Status API read).

This is the runtime counterpart to the device records: who is registered right now, on what node and protocol — not the configured allow-list.

Args: alias_contains: Case-insensitive substring match on the registered alias. protocol: "sip" / "h323" / "mssip" / "webrtc". limit, offset, fetch_all: Pagination controls (fetch_all walks all pages).

List directory end users.

Args: email_contains: Case-insensitive substring match on primary_email_address. name_contains: Case-insensitive substring match on display_name. sync_tag: Filter by LDAP sync tag. limit: Max results. offset: Pagination offset.

Retrieve an end user by integer id or by primary_email_address.

List dial plan gateway routing rules, ordered by priority ascending.

Args: name_contains: Case-insensitive substring match on rule name. enabled_only: If true, returns only enabled rules. limit: Max results. offset: Pagination offset.

Retrieve a gateway routing rule by integer id or exact name.

Retrieve the platform-wide global configuration singleton.

Includes things like default themes, default join PIN behavior, bandwidth caps, banner text, MSSIP domain, and call-create permissions.

List completed conference instances.

Args: start_time: Lower bound (inclusive) on conference start_time. ISO 8601 in UTC, e.g. "2026-05-07T00:00:00". end_time: Upper bound (exclusive) on conference start_time. UTC ISO 8601. name: Filter by exact instance name. service_type: "conference" / "lecture" / etc. tag: Filter by service tag. limit, offset, fetch_all: Pagination controls.

Retrieve one past conference instance by id.

List completed participant call legs (CDR-like records).

Time bounds apply to participant.start_time. All times are UTC ISO 8601.

Args: start_time: Lower bound (inclusive) on start_time. end_time: Upper bound (exclusive) on start_time. conference_name: Restrict to one conference name (string, not id). call_direction: "in" / "out". call_quality: "1_good" / "2_ok" / "3_bad" / "4_terrible". protocol: "sip" / "h323" / "mssip" / "webrtc" / "rtmp" / "teams" / etc. disconnect_reason: e.g. "Call disconnected", "Call failed", "Call rejected". location: system_location id or exact name. service_tag: Filter by tag carried from the parent conference. limit, offset, fetch_all: Pagination. fetch_all caps at 10,000.

Retrieve one past participant by id.

Returns full quality forensics: historic_call_quality (per-window timeline) and bucketed_call_quality ([unknown, good, ok, bad, terrible] counts). These deep fields are only populated on individual GET, not list responses.

Summarize / report on call history — grouped counts and totals over a window.

USE THIS for any "summarize", "report", "breakdown", "how many calls by X", "stats", or "totals" request. Returns aggregated counts + durations grouped by a field — NOT individual records. Prefer this over list_history_conferences / list_history_participants whenever the user wants aggregates rather than a raw list; it walks pagination internally and is far cheaper on context and tool calls than fetching individual records.

Args: start_time: Lower bound (inclusive) on start_time. UTC ISO 8601 required. end_time: Upper bound (exclusive) on start_time. UTC ISO 8601 required. group_by: One of "call_direction", "call_quality", "protocol", "service_tag", "system_location", "conference_name", "disconnect_reason", "vendor". conference_name: Restrict to one conference name. service_tag: Restrict to one tag. call_direction: "in" or "out" — useful when group_by is something else. location: system_location filter (name or id). max_records: Hard cap on participants fetched. Defaults to 10,000 (the platform retention limit).

Returns: { "total_calls": int, "total_duration_seconds": int, "average_duration_seconds": float, "time_range": {"start": ..., "end": ...}, "group_by": str, "groups": {: {"count": int, "duration_seconds": int}, ...}, "truncated": bool # true if max_records was hit before exhausting results }

List historical alarms.

Args: start_time: Lower bound (inclusive) on time_raised. UTC ISO 8601. end_time: Upper bound (exclusive) on time_raised. UTC ISO 8601. level: "error" / "warning" / "info". limit, offset, fetch_all: Pagination controls.

Retrieve one historical alarm by id.

List historical backplane connections.

Retrieve one historical backplane connection by id.

Get media stream statistics for a historical backplane connection.

Args: backplane_id: Backplane id from list_backplane_history.

List historical registration events.

Args: alias_contains: Case-insensitive substring match on the alias. limit, offset, fetch_all: Pagination controls.

Retrieve one historical registration entry by id.

List Conferencing Node status event history.

Args: start_time: Lower bound (inclusive). UTC ISO 8601. end_time: Upper bound (exclusive). UTC ISO 8601. limit, offset, fetch_all: Pagination controls.

Retrieve one Conferencing Node status event by id.

List system locations (logical groupings of Conferencing Nodes, typically per datacenter / region).

Retrieve a system location by integer id or by exact name.

List Conferencing Nodes (the worker_vm resource).

Args: location: System location id or exact name to filter by. name_contains: Case-insensitive substring match on node name. node_type: "CONFERENCING" or "PROXYING". limit: Max results. offset: Pagination offset.

Retrieve a Conferencing Node by integer id or by exact name.

List IVR themes (branding bundles assignable to VMRs).

Retrieve an IVR theme by id or exact name.

List configured LDAP / Active Directory sync sources.

Retrieve an ldap_sync_source by id or exact name.

Includes last sync status / errors when available — useful for answering 'is LDAP sync working?'.

List any Pexip configuration resource that has no dedicated tool.

This is the catch-all listing tool. Supported resources by area:

• Admin auth & roles: authentication, role, ldap_role, permission, adfs_auth_server, adfs_auth_server_domain, identity_provider, identity_provider_group, user_group, user_group_entity_mapping.

• Integrations & signaling: teams_proxy (Microsoft Teams Connectors), azure_tenant (Teams CVI tenant), gms_access_token, gms_gateway_token (Google Meet), ms_exchange_connector, exchange_domain, sip_proxy, sip_credential, mssip_proxy, h323_gatekeeper, turn_server, stun_server, policy_server, policy_profile, break_in_allow_list_address, telehealth_profile.

• Scheduling & sync: registration, conference_sync_template, ldap_sync_field, scheduled_conference, scheduled_alias, recurring_conference.

• Media library: media_library_entry, media_library_playlist, media_library_playlist_entry.

• Platform & certificates: management_vm, licence, licence_request, media_processing_server, diagnostic_graphs, ca_certificate, tls_certificate, certificate_signing_request.

• MJX / One-Touch Join: mjx_integration, mjx_endpoint, mjx_endpoint_group, mjx_meeting_processing_rule, mjx_exchange_deployment, mjx_exchange_autodiscover_url, mjx_graph_deployment, mjx_google_deployment.

• System infrastructure: dns_server, ntp_server, http_proxy, syslog_server, snmp_network_management_system, smtp_server, static_route, ssh_authorized_key.

• Backups & upgrades: system_backup (existing system backups), autobackup (backup schedule), upgrade, software_bundle, software_bundle_revision, scheduled_scaling.

• Web app: webapp_alias, webapp_branding, external_webapp_host.

Call get_resource_schema(resource) to discover filterable fields.

Args: resource: API resource name from the list above (e.g. "sip_proxy", "system_backup", "teams_proxy", "dns_server"). name_contains: Case-insensitive substring match on the name field. filters: Additional query filters as key-value pairs (e.g. {"enable": true}). Keys must match the resource's field names. limit: Max results per page (default 20). offset: Pagination offset.

Get a single configuration resource by integer id or by name.

Args: resource: API resource name (see list_resources for the full list). id: Integer id, numeric string, or the resource's name — names are resolved automatically, so there is no need to list first.

Fetch the live JSON schema for a Pexip configuration resource.

Use this to discover available fields, types, required vs optional (nullable: false = required), allowed enum values, filtering options, and help text for any resource. Pass the resource name as it appears in the URL path, e.g. "conference", "conference_alias", "end_user", "system_location", "worker_vm", "gateway_routing_rule", "automatic_participant".

List currently-running conference instances.

Empty objects list = nothing is in progress right now.

Args: name: Filter by exact instance name (the dialed alias). service_type: "conference" / "lecture" / "two_stage_dialing" / "gateway" / "test_call". tag: Filter by service tag. limit: Per-page limit (ignored if fetch_all). offset: Pagination offset (ignored if fetch_all). fetch_all: Walk all pages and return up to 5,000 records combined.

List currently-connected participants (active call legs).

Args: conference_name: Restrict to one running conference instance. role: "chair" or "guest". protocol: "api" / "sip" / "h323" / "mssip" / "webrtc" / "rtmp" / "teams" / "gms". is_muted: Filter by mute state. limit, offset, fetch_all: Pagination controls.

Retrieve a single active participant.

Args: participant_id: UUID, or the participant's display name (e.g. "Bob") — names are resolved against currently connected participants automatically, so there is no need to call list_active_participants first. conference: Optional conference name to scope a display-name lookup when the name might not be unique across meetings.

List active platform alarms.

Args: level: "error" / "warning" / "info". node_name: Restrict to one Conferencing Node by name. limit, offset, fetch_all: Pagination controls.

Live status (load, sync, version, boot time) for each Conferencing Node.

Args: location: Filter to one system_location by name or id. name_contains: Case-insensitive substring match on node name. limit, offset, fetch_all: Pagination controls.

Get live status for one Conferencing Node by integer id or exact name.

Current concurrent port usage vs entitlement (audio + video ports, per location).

Live call quality for one active participant.

Combines two Status API endpoints into one response:

• the participant record (call_quality, connect_time, conference, role, protocol, remote_address, location, current packet loss summary)

• all media streams for the participant (per-stream rx/tx bitrate, packet loss, jitter, codec, resolution).

For "is Alice's call OK right now?" use cases — pass the name directly. For post-call quality forensics, use get_history_participant which exposes bucketed_call_quality.

Args: participant_id: UUID, or the participant's display name (e.g. "Bob") — names are resolved against currently connected participants automatically, so there is no need to call list_active_participants first. conference: Optional conference name to scope a display-name lookup when the name might not be unique across meetings.

List conference instances broken out per Conferencing Node (shards).

Args: conference_name: Filter by conference name. limit, offset, fetch_all: Pagination controls.

Retrieve a single conference shard by id.

List currently registered aliases on the platform.

Args: alias_contains: Case-insensitive substring match on the alias. limit, offset, fetch_all: Pagination controls.

Retrieve a single registered alias by id.

List live status for system locations.

Args: name_contains: Case-insensitive substring match on location name. limit, offset, fetch_all: Pagination controls.

Get live status for one system location by id or exact name.

Get load statistics for one system location (call counts, port usage).

Args: location: Location id or exact name.

Get load statistics for one Conferencing Node (CPU, media load, call counts).

Args: node: Node id or exact name.

List backplane status (inter-node media connections).

Retrieve a single backplane by id.

Get media stream statistics for a backplane connection.

Args: backplane_id: Backplane id from list_backplanes.

List Management Node live status.

Retrieve live status for a specific Management Node.

List conference synchronization status.

Retrieve a single conference sync entry by id.

List all cloud overflow Conferencing Nodes (dynamic bursting).

Retrieve a single cloud overflow node by id.

List all locations monitored for dynamic bursting.

Retrieve a single cloud monitored location by id.

List all locations containing Conferencing Nodes for dynamic bursting.

Retrieve a single cloud overflow location by id.

List Secure Scheduler for Exchange integration status.

Retrieve a single Exchange scheduler entry by id.

List One-Touch Join endpoint live status.

Args: name_contains: Case-insensitive substring match on endpoint name. limit, offset, fetch_all: Pagination controls.

Retrieve live status for a single MJX endpoint by id.

List One-Touch Join meeting status (upcoming meetings detected by MJX).

Retrieve status for a single MJX meeting by id.

List Teams Connector node status.

Retrieve status for a single Teams Connector node by id.

List Teams Connector call status.

Retrieve status for a single Teams Connector call by id.