Pexip Infinity
01README
Pexip Infinity v39 management and development — conference lifecycle, node deployment, platform administration, integrations, policy server development, event-driven automation, branding, client API, auth/RBAC, network infrastructure, licensing, recording, diagnostics, and Exchange calendar connectors.
02Release Notes
Add curated README and LICENSE to tarball (additionalFiles), bringing extension's Swamp Club quality grade from F/B to A-/B.
03Models
@dougschaefer/pexip-conferencev2026.03.26.1pexip/conference.ts
fn listVmrs(tag?: string)
List all Virtual Meeting Rooms.
| Argument | Type | Description |
|---|---|---|
| tag? | string | Filter by tag |
fn createVmr(name: string, alias: string, description?: string, hostPin?: string, guestPin?: string, tag?: string)
Create a new Virtual Meeting Room.
| Argument | Type | Description |
|---|---|---|
| name | string | VMR name / display name |
| alias | string | |
| description? | string | |
| hostPin? | string | Host PIN (digits) |
| guestPin? | string | Guest PIN (digits) |
| tag? | string | Tag for grouping/filtering |
fn deleteVmr(name: string)
Delete a Virtual Meeting Room.
| Argument | Type | Description |
|---|---|---|
| name | string | VMR name to delete |
fn updateVmr(name: string, pin?: string, allowGuests?: boolean, tag?: string, description?: string)
Update an existing VMR's properties (PIN, guest access, participant limit, service type, layout, etc.).
| Argument | Type | Description |
|---|---|---|
| name | string | VMR name to update |
| pin? | string | New host PIN |
| allowGuests? | boolean | Allow guest access |
| tag? | string | VMR tag for filtering |
| description? | string | VMR description |
fn listCallRoutingRules()
List all gateway routing rules (handles both incoming and outgoing call matching).
fn createCallRoutingRule(name: string, enabled?: boolean)
Create a gateway routing rule for call matching (incoming or outgoing).
| Argument | Type | Description |
|---|---|---|
| name | string | Rule name |
| enabled? | boolean |
fn listGatewayRules()
List all gateway routing rules (outbound/interop).
fn listActiveConferences()
List all currently active conferences and their participants.
fn disconnectParticipant(conferenceId: string, participantId: string)
Disconnect a participant from an active conference.
| Argument | Type | Description |
|---|---|---|
| conferenceId | string | Conference ID |
| participantId | string | Participant ID |
fn lockConference(conferenceId: string, locked: boolean)
Lock or unlock an active conference.
| Argument | Type | Description |
|---|---|---|
| conferenceId | string | Conference ID |
| locked | boolean | true to lock, false to unlock |
fn muteParticipant(participantId: string, muted: boolean)
Mute or unmute a participant in an active conference.
| Argument | Type | Description |
|---|---|---|
| participantId | string | Participant ID |
| muted | boolean | true to mute, false to unmute |
fn muteAllGuests(conferenceId: string, muted: boolean)
Mute or unmute all guest participants in a conference.
| Argument | Type | Description |
|---|---|---|
| conferenceId | string | Conference ID |
| muted | boolean | true to mute all guests, false to unmute |
fn transferParticipant(participantId: string)
Transfer a participant to a different conference.
| Argument | Type | Description |
|---|---|---|
| participantId | string | Participant ID to transfer |
fn changeParticipantRole(participantId: string, role: enum)
Change a participant's role (host/guest) in a conference.
| Argument | Type | Description |
|---|---|---|
| participantId | string | Participant ID |
| role | enum | New role |
fn changeLayout(conferenceId: string)
Change the video layout of an active conference. Layouts: 1:7, teams, ac, 1:21, 2:21, 2x2, 3x3, 4x4, 5x5, 1:0, 1:33.
| Argument | Type | Description |
|---|---|---|
| conferenceId | string | Conference ID |
fn getConferenceHistory()
Get conference history records. Optionally filter by time range.
fn listAliases(alias?: string)
List all conference aliases across all VMRs.
| Argument | Type | Description |
|---|---|---|
| alias? | string | Filter by alias string (substring match) |
fn addAlias(conferenceUri: string, alias: string, description?: string)
Add an alias to an existing conference/VMR.
| Argument | Type | Description |
|---|---|---|
| conferenceUri | string | Resource URI of the conference (from listVmrs) |
| alias | string | SIP/H.323/WebRTC alias string |
| description? | string |
fn deleteAlias(aliasId: string)
Remove an alias from a conference/VMR.
| Argument | Type | Description |
|---|---|---|
| aliasId | string | Alias ID (from listAliases) |
fn listAutoParticipants()
List all automatically dialed participants (RTMP streaming, recording, always-on rooms).
fn createAutoParticipant(conferenceUri: string, remoteAlias: string, protocol: enum, role?: enum, localAlias?: string, localDisplayName?: string, dtmfSequence?: string, streaming?: boolean)
Add an automatically dialed participant to a conference (e.g., RTMP stream, recording, always-on endpoint).
| Argument | Type | Description |
|---|---|---|
| conferenceUri | string | Resource URI of the conference |
| remoteAlias | string | Alias/URI to dial (e.g., rtmp://stream.example.com/live) |
| protocol | enum | |
| role? | enum | |
| localAlias? | string | Caller ID alias to present |
| localDisplayName? | string | |
| dtmfSequence? | string | DTMF digits to send after connect |
| streaming? | boolean | Mark as a streaming participant |
fn deleteAutoParticipant(participantId: string)
Remove an automatically dialed participant.
| Argument | Type | Description |
|---|---|---|
| participantId | string | Auto-participant ID |
fn getParticipantHistory(since?: string, conferenceId?: string, limit?: number)
Get participant-level call detail records (codec, quality, disconnect reason).
| Argument | Type | Description |
|---|---|---|
| since? | string | ISO timestamp — only records after this time |
| conferenceId? | string | Filter by conference ID |
| limit? | number |
fn getParticipantMediaHistory(participantId: string)
Get media stream history for a historical participant (bitrate, codec, packet loss, jitter).
| Argument | Type | Description |
|---|---|---|
| participantId | string | Participant history record ID |
fn listScheduledConferences()
List scheduled (time-bounded) conferences.
fn listRecurringConferences()
List recurring conference definitions.
Resources
vmr(infinite)— Virtual Meeting Room configuration
callRoutingRule(infinite)— Call routing rule (inbound call matching)
activeConference(1h)— Currently active conference with participants
conferenceHistory(7d)— Historical conference record
gatewayRule(infinite)— Gateway routing rule (outbound/interop)
@dougschaefer/pexip-deployv2026.03.26.1pexip/deploy.ts
fn getCapacity()
Show expected call capacity for a given Azure VM size based on Pexip v39 benchmarks.
fn validateNodeSpec(vcpu: number, ramGb: number, storageGb: number)
Validate a VM specification against Pexip v39 hardware requirements. Returns warnings for any spec violations.
| Argument | Type | Description |
|---|---|---|
| vcpu | number | Number of vCPUs |
| ramGb | number | RAM in GB |
| storageGb | number | Storage in GB |
fn downloadVhd(resourceGroup?: string)
Download Pexip Infinity VHD images from Pexip's Azure blob storage into your storage account. Source: https://pexipas.blob.core.windows.net/infinity/{version}/
| Argument | Type | Description |
|---|---|---|
| resourceGroup? | string | Storage account RG |
fn createImageFromVhd(resourceGroup?: string, location: string, osType: enum)
Create a managed disk image from a Pexip VHD in blob storage. Run this after uploading the VHD to the storage account.
| Argument | Type | Description |
|---|---|---|
| resourceGroup? | string | Resource group |
| location | string | Azure region |
| osType | enum |
fn listImages(resourceGroup?: string)
List all Pexip managed disk images in a resource group.
| Argument | Type | Description |
|---|---|---|
| resourceGroup? | string | Resource group |
fn deployNode(name: string, resourceGroup?: string, location: string, imageName: string)
Deploy a Pexip Infinity node VM from a managed image. Configures the VM per Pexip Azure deployment guide.
| Argument | Type | Description |
|---|---|---|
| name | string | VM name (e.g., PexipMgmt) |
| resourceGroup? | string | Resource group |
| location | string | Azure region |
| imageName | string | Managed image name to deploy from |
fn listNodes(resourceGroup?: string)
List all Pexip VMs in a resource group with their power state.
| Argument | Type | Description |
|---|---|---|
| resourceGroup? | string | Resource group |
fn startNode(name: string, resourceGroup?: string)
Start a deallocated Pexip node VM.
| Argument | Type | Description |
|---|---|---|
| name | string | VM name |
| resourceGroup? | string | Resource group |
fn stopNode(name: string, resourceGroup?: string)
Stop (deallocate) a Pexip node VM. This stops billing for compute.
| Argument | Type | Description |
|---|---|---|
| name | string | VM name |
| resourceGroup? | string | Resource group |
fn resizeNode(name: string, resourceGroup?: string)
Resize a Pexip node VM. VM must be deallocated first for most size changes.
| Argument | Type | Description |
|---|---|---|
| name | string | VM name |
| resourceGroup? | string | Resource group |
fn deleteNode(name: string, resourceGroup?: string)
Delete a Pexip node VM and its associated resources (NIC, OS disk, public IP).
| Argument | Type | Description |
|---|---|---|
| name | string | VM name |
| resourceGroup? | string | Resource group |
fn snapshotNode(name: string, resourceGroup?: string)
Create a disk snapshot of a Pexip node for backup/rollback.
| Argument | Type | Description |
|---|---|---|
| name | string | VM name to snapshot |
| resourceGroup? | string | Resource group |
Resources
vm(infinite)— Pexip Infinity VM deployed in Azure
image(infinite)— Pexip VHD managed disk image in Azure
@dougschaefer/pexip-integrationv2026.03.26.1pexip/integration.ts
fn listEventSinks()
List all configured event sinks.
fn createEventSink(name: string, url: string, verifyTls?: boolean)
Create an event sink to push conference/participant events to an external HTTP(S) endpoint.
| Argument | Type | Description |
|---|---|---|
| name | string | Event sink name |
| url | string | External server URL (HTTP/HTTPS) |
| verifyTls? | boolean | Verify TLS |
fn deleteEventSink(name: string)
Delete an event sink.
| Argument | Type | Description |
|---|---|---|
| name | string | Event sink name |
fn listCertificates()
List all TLS certificates on the platform.
fn uploadCertificate(name: string, certificate: string, privateKey: string)
Upload a TLS certificate (PEM format). Provide cert + key + optional intermediate chain.
| Argument | Type | Description |
|---|---|---|
| name | string | Certificate name |
| certificate | string | PEM-encoded certificate |
| privateKey | string | PEM-encoded private key |
fn listSipRegistrations()
List all SIP registrations (trunks to external SBC/proxy).
fn createSipRegistration(name: string, sipProxy: string, username: string, port?: number, enabled?: boolean)
Create a SIP registration (trunk to external SBC/proxy).
| Argument | Type | Description |
|---|---|---|
| name | string | Registration name |
| sipProxy | string | SIP proxy address |
| username | string | SIP username/alias to register |
| port? | number | SIP proxy port |
| enabled? | boolean |
fn listLdapSources()
List all LDAP/AD directory sources.
fn listTeamsConnectors()
List Microsoft Teams connector configurations.
fn syncLdap()
Trigger an immediate LDAP directory sync (normally runs daily at 01:00 UTC).
fn listIdentityProviders()
List configured identity providers (SAML/OIDC) for conference participant SSO.
fn createIdentityProvider(name: string, description?: string)
Configure an identity provider for conference participant authentication.
| Argument | Type | Description |
|---|---|---|
| name | string | IdP name |
| description? | string |
fn deleteIdentityProvider(name: string)
Remove an identity provider configuration.
| Argument | Type | Description |
|---|---|---|
| name | string |
fn listIdentityProviderGroups()
List identity provider groups (control which IdP users can access which services).
fn listUserGroups()
List user groups for access control.
fn listMediaLibrary()
List media library entries (prerecorded video/audio for hold music, IVR, playback service).
fn listPlaylists()
List media playlists.
fn createPlaylist(name: string, description?: string)
Create a media playlist for the playback service or IVR.
| Argument | Type | Description |
|---|---|---|
| name | string | Playlist name |
| description? | string |
fn listBrandingPackages()
List web app branding packages (per-client branded meeting experiences).
fn listWebAppPaths()
List web app path aliases (custom URLs for branded experiences).
fn createWebAppPath(path: string, brandingUri?: string)
Create a web app path alias (e.g., /meet/clientname).
| Argument | Type | Description |
|---|---|---|
| path | string | URL path (e.g., /meet/clientname) |
| brandingUri? | string | Resource URI of branding package |
fn listCsrs()
List certificate signing requests.
fn createCsr(name: string, commonName: string)
Generate a certificate signing request on the management node (keeps private key on-box).
| Argument | Type | Description |
|---|---|---|
| name | string | CSR name |
| commonName | string | Common name (FQDN) for the certificate |
fn listAzureTenants()
List Microsoft Azure/Entra tenant configurations for Teams CVI.
fn createAzureTenant(name: string, tenantId: string, description?: string)
Configure a Microsoft Azure/Entra tenant for Teams CVI integration.
| Argument | Type | Description |
|---|---|---|
| name | string | Tenant configuration name |
| tenantId | string | Azure AD / Entra tenant ID (Directory ID) |
| description? | string |
fn listTurnServers()
List TURN server configurations.
fn createTurnServer(name: string, address: string, port?: number, username?: string, password?: string, protocol?: enum)
Configure a TURN server for NAT traversal.
| Argument | Type | Description |
|---|---|---|
| name | string | TURN server name |
| address | string | TURN server address |
| port? | number | |
| username? | string | |
| password? | string | |
| protocol? | enum |
fn listRegisteredDevices()
List all registered device aliases.
fn listIvrThemes()
List all IVR themes (branding, hold music, prompts).
fn listCaCertificates()
List trusted CA certificates.
fn uploadCaCertificate(name: string, certificate: string)
Upload a trusted CA certificate (PEM format).
| Argument | Type | Description |
|---|---|---|
| name | string | CA certificate name |
| certificate | string | PEM-encoded CA certificate |
fn listPolicyServers()
List external policy server configurations.
fn createPolicyServer(name: string, url: string, username?: string, password?: string)
Configure an external policy server for dynamic call routing decisions.
| Argument | Type | Description |
|---|---|---|
| name | string | Policy server name |
| url | string | Policy server URL (HTTPS recommended) |
| username? | string | HTTP basic auth username |
| password? | string | HTTP basic auth password |
fn configureAutoBackup(enabled: boolean)
Configure automatic scheduled backups.
| Argument | Type | Description |
|---|---|---|
| enabled | boolean | Enable automatic backups |
fn configureSnmp(enabled?: boolean)
Configure SNMP monitoring on the platform.
| Argument | Type | Description |
|---|---|---|
| enabled? | boolean |
fn configureSyslog(serverAddress: string, port?: number, enabled?: boolean)
Configure remote syslog forwarding.
| Argument | Type | Description |
|---|---|---|
| serverAddress | string | Syslog server address |
| port? | number | Syslog port |
| enabled? | boolean |
Resources
eventSink(infinite)— Event sink for pushing conference events to external services
tlsCertificate(infinite)— TLS certificate for platform services
teamsConnector(infinite)— Microsoft Teams connector configuration
sipRegistration(infinite)— SIP registration (trunk to external SBC/proxy)
ldapSource(infinite)— LDAP/AD directory source for contact sync
@dougschaefer/pexip-otjv2026.03.26.1pexip/otj.ts
fn listEndpoints(groupName?: string)
List all OTJ endpoints (room systems with calendar integration).
| Argument | Type | Description |
|---|---|---|
| groupName? | string | Filter by endpoint group name |
fn createEndpoint(name: string, alias: string, endpointGroupUri: string, calendarId?: string, protocol?: enum, ipAddress?: string, enabled?: boolean)
Register a room system endpoint for OTJ (OBTP/OTD).
| Argument | Type | Description |
|---|---|---|
| name | string | Endpoint name (e.g., room display name) |
| alias | string | SIP/H.323 alias to dial the endpoint |
| endpointGroupUri | string | Resource URI of the endpoint group |
| calendarId? | string | Calendar resource email/ID |
| protocol? | enum | |
| ipAddress? | string | Direct IP for Cisco xAPI push |
| enabled? | boolean |
fn deleteEndpoint(name: string)
Remove an OTJ endpoint.
| Argument | Type | Description |
|---|---|---|
| name | string |
fn listEndpointGroups()
List OTJ endpoint groups.
fn createEndpointGroup(name: string, description?: string, integrationUri?: string)
Create an OTJ endpoint group.
| Argument | Type | Description |
|---|---|---|
| name | string | Group name (e.g., client code or building) |
| description? | string | |
| integrationUri? | string | Resource URI of the OTJ profile |
fn listProfiles()
List OTJ integration profiles.
fn createProfile(name: string, description?: string, systemLocationUri?: string, enabled?: boolean)
Create an OTJ integration profile.
| Argument | Type | Description |
|---|---|---|
| name | string | Profile name |
| description? | string | |
| systemLocationUri? | string | System location resource URI |
| enabled? | boolean |
fn listMeetingRules()
List OTJ meeting processing rules (URI pattern matching for dial strings).
fn createMeetingRule(name: string, priority?: number, matchString: string, replaceString?: string, enabled?: boolean)
Create an OTJ meeting processing rule.
| Argument | Type | Description |
|---|---|---|
| name | string | Rule name |
| priority? | number | |
| matchString | string | Regex to match meeting URI |
| replaceString? | string | Replacement for dial string |
| enabled? | boolean |
fn listCalendarDeployments()
List all calendar system deployments (Exchange, O365 Graph, Google).
fn configureGraphDeployment(name: string, description?: string, enabled?: boolean)
Configure a Microsoft 365 Graph API calendar deployment for OTJ.
| Argument | Type | Description |
|---|---|---|
| name | string | Deployment name |
| description? | string | |
| enabled? | boolean |
fn configureExchangeDeployment(name: string, description?: string, enabled?: boolean)
Configure an Exchange on-premises calendar deployment for OTJ.
| Argument | Type | Description |
|---|---|---|
| name | string | Deployment name |
| description? | string | |
| enabled? | boolean |
fn configureGoogleDeployment(name: string, description?: string, enabled?: boolean)
Configure a Google Workspace calendar deployment for OTJ.
| Argument | Type | Description |
|---|---|---|
| name | string | Deployment name |
| description? | string | |
| enabled? | boolean |
fn getEndpointStatus()
Get status of OTJ endpoints (last poll, errors).
fn listMeetings()
List active OTJ meetings (upcoming dial buttons pushed to endpoints).
fn inventory()
Full OTJ inventory — profiles, groups, endpoints, rules, calendar deployments.
Resources
endpoint(infinite)— OTJ endpoint (room system with calendar integration)
endpointGroup(infinite)— OTJ endpoint group (logical collection of rooms)
profile(infinite)— OTJ integration profile
meetingRule(infinite)— OTJ meeting processing rule (URI pattern matching)
calendarDeployment(infinite)— Calendar system deployment (Exchange, Graph, Google)
meeting(1h)— Active OTJ meeting status
@dougschaefer/pexip-platformv2026.03.26.1pexip/platform.ts
fn getConfig()
Get the global system configuration (DNS, NTP, SIP domain, protocols).
fn updateConfig(sipDomain?: string, enableSip?: boolean, enableH323?: boolean, enableWebrtc?: boolean)
Update global system configuration. Pass only fields to change.
| Argument | Type | Description |
|---|---|---|
| sipDomain? | string | Default SIP domain |
| enableSip? | boolean | Enable SIP protocol |
| enableH323? | boolean | Enable H.323 protocol |
| enableWebrtc? | boolean | Enable WebRTC |
fn listNodes()
List all conferencing and proxying nodes registered to this platform.
fn getNodeStatus()
Get runtime status of all worker nodes (load, calls, version).
fn setMaintenanceMode(nodeName: string)
Enable or disable maintenance mode on a conferencing node. Drains calls before maintenance.
| Argument | Type | Description |
|---|---|---|
| nodeName | string | Name of the worker node |
fn listDnsServers()
List configured DNS servers.
fn addDnsServer(address: string)
Add a DNS server.
| Argument | Type | Description |
|---|---|---|
| address | string | DNS server IP address |
fn listNtpServers()
List configured NTP servers.
fn addNtpServer(address: string)
Add an NTP server.
| Argument | Type | Description |
|---|---|---|
| address | string | NTP server address (IP or FQDN) |
fn getParticipantMedia(participantId: string)
Get media stream statistics for a participant (bitrate, codec, packet loss, jitter).
| Argument | Type | Description |
|---|---|---|
| participantId | string | Participant ID |
fn getNodeStatistics(nodeId: string)
Get detailed load statistics for a specific worker node.
| Argument | Type | Description |
|---|---|---|
| nodeId | string | Worker node ID |
fn listLocations()
List all system locations.
fn createLocation(name: string, description?: string)
Create a new system location.
| Argument | Type | Description |
|---|---|---|
| name | string | Location name |
| description? | string | Location description |
fn getLicenseStatus()
Get current license status and usage.
fn listAlarms()
List all active platform alarms.
fn createBackup()
Create an encrypted configuration backup on the management node.
fn restoreBackup()
Restore a configuration backup. WARNING: This overwrites all current configuration.
fn upgrade()
Initiate a platform upgrade. Upload the upgrade package first, then trigger.
fn takeSnapshot()
Take a diagnostic snapshot of the platform for Pexip support.
fn dialParticipant()
Dial out to a participant and add them to a conference.
fn disconnectConference(conferenceId: string)
Disconnect all participants and end a conference.
| Argument | Type | Description |
|---|---|---|
| conferenceId | string | Conference ID to disconnect |
fn startCloudNode()
Start a dynamic bursting cloud node in Azure.
fn listBackups()
List available configuration backups.
fn inventory()
Full platform inventory — system config, nodes, locations, licenses, and alarms.
Resources
systemConfig(infinite)— Pexip Infinity global system configuration
workerNode(infinite)— Conferencing or proxying node registered to the platform
systemLocation(infinite)— System location (logical grouping for nodes)
licenseStatus(1h)— Current license status and usage
alarm(1h)— Active platform alarm
backup(infinite)— Platform configuration backup
@dougschaefer/pexip-policyv2026.03.29.1pexip/policy.ts
fn listServers()
List all registered external policy servers on the platform.
fn getServer(name: string)
Get details of a specific policy server by name.
| Argument | Type | Description |
|---|---|---|
| name | string | Policy server name |
fn createServer(name: string)
Register an external policy server endpoint on the platform.
| Argument | Type | Description |
|---|---|---|
| name | string | Policy server name |
fn deleteServer(name: string)
Remove an external policy server registration.
| Argument | Type | Description |
|---|---|---|
| name | string | Policy server name to delete |
fn listProfiles()
List all policy profiles. Profiles bind policy servers and local scripts to system locations.
fn createProfile(name: string)
Create a policy profile that binds a policy server and/or local script to a system location.
| Argument | Type | Description |
|---|---|---|
| name | string | Profile name |
fn updateProfile(name: string)
Update a policy profile's server binding or local script.
| Argument | Type | Description |
|---|---|---|
| name | string | Profile name to update |
fn deleteProfile(name: string)
Delete a policy profile.
| Argument | Type | Description |
|---|---|---|
| name | string | Profile name to delete |
fn testServiceConfig()
Simulate a service configuration policy request. Sends the same query parameters a conferencing node would send to your policy server and returns the response. Use this to validate policy server behavior without placing a real call.
fn testParticipantProperties()
Simulate a participant properties policy request against your policy server.
fn validateResponse()
Validate a policy response JSON object against the Pexip policy response schema without making any network calls. Useful for testing policy server implementations offline.
fn inventory()
Full policy inventory: all policy servers, profiles, and their bindings in one call.
@dougschaefer/pexip-brandingv2026.03.29.1pexip/branding.ts
fn listPackages()
List all branding packages uploaded to the management node.
fn getPackage(name: string)
Get details of a specific branding package by name.
| Argument | Type | Description |
|---|---|---|
| name | string | Branding package name |
fn deletePackage(name: string)
Delete a branding package from the management node.
| Argument | Type | Description |
|---|---|---|
| name | string | Branding package name to delete |
fn listWebAppPaths()
List all webapp path aliases. Each path maps a URL to a branding package for custom join experiences.
fn createWebAppPath()
Create a webapp path alias that maps a URL path to a branding package (e.g., /meet/clientname).
fn deleteWebAppPath(path: string)
Delete a webapp path alias.
| Argument | Type | Description |
|---|---|---|
| path | string | Webapp path to delete |
fn listIvrThemes()
List all IVR themes. Themes control hold music, PIN entry prompts, and welcome screens for SIP/H.323 callers.
fn listMedia()
List all media library entries (hold music, IVR audio, playback content).
fn listPlaylists()
List all media playlists.
fn createPlaylist(name: string, description?: string)
Create a media playlist for IVR or playback service.
| Argument | Type | Description |
|---|---|---|
| name | string | Playlist name |
| description? | string | Playlist description |
fn inventory()
Full branding inventory: packages, webapp paths, IVR themes, media library, and playlists.
@dougschaefer/pexip-eventsinkv2026.03.29.1pexip/eventsink.ts
fn list()
List all configured event sinks with their target URLs, API versions, and delivery modes.
fn get(name: string)
Get details of a specific event sink by name.
| Argument | Type | Description |
|---|---|---|
| name | string | Event sink name |
fn create(name: string)
Create an event sink that POSTs conference and participant events to an HTTP(S) endpoint.
| Argument | Type | Description |
|---|---|---|
| name | string | Event sink name |
fn update(name: string, url?: string, username?: string, verifyCert?: boolean, apiVersion?: enum, bulkMode?: boolean)
Update an existing event sink configuration.
| Argument | Type | Description |
|---|---|---|
| name | string | Event sink name to update |
| url? | string | New target URL |
| username? | string | New auth username |
| verifyCert? | boolean | New TLS verify setting |
| apiVersion? | enum | New API version |
| bulkMode? | boolean | New bulk mode setting |
fn delete(name: string)
Delete an event sink.
| Argument | Type | Description |
|---|---|---|
| name | string | Event sink name to delete |
fn validateEvent()
Validate an event sink payload against the Pexip event schema. Use this to test event sink receiver implementations offline.
fn testDelivery()
Send a test event payload to a URL to verify your event sink receiver is working. Sends a synthetic conference_started event.
@dougschaefer/pexip-clientv2026.03.29.1pexip/client.ts
fn requestToken()
Request an authentication token for a conference. Returns the token, its expiry, and conference details including whether a PIN is required.
fn refreshToken(conferenceAlias: string)
Refresh an authentication token before it expires. Returns a new token with a fresh expiry.
| Argument | Type | Description |
|---|---|---|
| conferenceAlias | string | Conference alias |
fn releaseToken(conferenceAlias: string)
Release an authentication token and disconnect from the conference.
| Argument | Type | Description |
|---|---|---|
| conferenceAlias | string | Conference alias |
fn getParticipants(conferenceAlias: string)
List all participants in an active conference with role, protocol, mute state, and media info.
| Argument | Type | Description |
|---|---|---|
| conferenceAlias | string | Conference alias |
fn sendMessage(conferenceAlias: string, message: string)
Send a chat message to all participants in the conference.
| Argument | Type | Description |
|---|---|---|
| conferenceAlias | string | Conference alias |
| message | string | Message text to send |
fn lock(conferenceAlias: string, locked: boolean)
Lock or unlock a conference.
| Argument | Type | Description |
|---|---|---|
| conferenceAlias | string | Conference alias |
| locked | boolean | True to lock, false to unlock |
fn muteGuests(conferenceAlias: string, muted: boolean)
Mute or unmute all guest participants.
| Argument | Type | Description |
|---|---|---|
| conferenceAlias | string | Conference alias |
| muted | boolean | True to mute, false to unmute |
fn setLayout(conferenceAlias: string)
Change the video layout for all participants. Layouts: 1:0, 1:7, 1:21, 2:21, 1:33, teams, ac, 2x2, 3x3, 4x4, 5x5.
| Argument | Type | Description |
|---|---|---|
| conferenceAlias | string | Conference alias |
fn admitParticipant(conferenceAlias: string)
Admit a waiting participant into a locked conference.
| Argument | Type | Description |
|---|---|---|
| conferenceAlias | string | Conference alias |
fn spotlightParticipant(conferenceAlias: string)
Spotlight a participant, pinning them as the main speaker in the layout.
| Argument | Type | Description |
|---|---|---|
| conferenceAlias | string | Conference alias |
fn dial(conferenceAlias: string)
Dial out from the conference to a SIP/H.323/RTMP destination and add it as a participant. Use protocol 'rtmp' with an RTMP URI to start streaming.
| Argument | Type | Description |
|---|---|---|
| conferenceAlias | string | Conference alias |
fn disconnect(conferenceAlias: string)
Disconnect a participant or end the entire conference.
| Argument | Type | Description |
|---|---|---|
| conferenceAlias | string | Conference alias |
fn listBreakouts(conferenceAlias: string)
List active breakout rooms in a conference.
| Argument | Type | Description |
|---|---|---|
| conferenceAlias | string | Conference alias |
fn setOverlayText(conferenceAlias: string)
Set a text overlay banner visible to all participants in the conference.
| Argument | Type | Description |
|---|---|---|
| conferenceAlias | string | Conference alias |
@dougschaefer/pexip-authv2026.03.29.1pexip/auth.ts
fn getAuthConfig()
Get the platform authentication configuration (OIDC, LDAP, certificate settings).
fn updateAuthConfig()
Update platform authentication settings (OIDC provider, LDAP server, certificate auth).
fn listOAuth2Clients()
List all OAuth2 API clients registered on the platform.
fn createOAuth2Client(clientName: string, role: string)
Create an OAuth2 API client for machine-to-machine API access.
| Argument | Type | Description |
|---|---|---|
| clientName | string | Display name for the API client |
| role | string | Role to assign (determines API permissions) |
fn deleteOAuth2Client(clientName: string)
Delete an OAuth2 API client.
| Argument | Type | Description |
|---|---|---|
| clientName | string | Client name to delete |
fn listRoles()
List all platform roles with their permissions.
fn createRole(name: string)
Create a custom role with specific permissions.
| Argument | Type | Description |
|---|---|---|
| name | string | Role name |
fn deleteRole(name: string)
Delete a custom role.
| Argument | Type | Description |
|---|---|---|
| name | string | Role name to delete |
fn listRoleMappings()
List all role mappings (map OIDC/LDAP attributes to platform roles).
fn createRoleMapping(name: string)
Create a role mapping that assigns roles based on OIDC/LDAP attributes.
| Argument | Type | Description |
|---|---|---|
| name | string | Mapping name |
fn listEndUsers()
List all end users in the directory (personal VMR owners, LDAP-synced users).
fn createEndUser(email: string, firstName?: string, lastName?: string, displayName?: string)
Create an end user in the directory.
| Argument | Type | Description |
|---|---|---|
| string | Primary email address | |
| firstName? | string | First name |
| lastName? | string | Last name |
| displayName? | string | Display name |
fn listAllowlist()
List all break-in allowlist entries (trusted addresses that bypass security checks).
fn createAllowlistEntry(name: string, address: string)
Add an address to the break-in allowlist (trusted source that bypasses incorrect PIN/alias lockouts).
| Argument | Type | Description |
|---|---|---|
| name | string | Entry name |
| address | string | IP address or hostname |
fn inventory()
Full auth inventory: authentication config, OAuth2 clients, roles, role mappings, end users, and allowlist.
@dougschaefer/pexip-networkv2026.03.29.1pexip/network.ts
fn listSipProxies()
List all SIP proxy configurations.
fn createSipProxy(name: string, address: string, description?: string)
Create a SIP proxy (outbound SBC or SIP trunk endpoint).
| Argument | Type | Description |
|---|---|---|
| name | string | Proxy name |
| address | string | Proxy address (FQDN or IP) |
| description? | string |
fn deleteSipProxy(name: string)
Delete a SIP proxy configuration.
| Argument | Type | Description |
|---|---|---|
| name | string | SIP proxy name |
fn listSipCredentials()
List all SIP authentication credentials.
fn createSipCredential(realm: string, username: string, password: string)
Create a SIP authentication credential (realm + username + password).
| Argument | Type | Description |
|---|---|---|
| realm | string | SIP realm |
| username | string | SIP auth username |
| password | string | SIP auth password |
fn listMssipProxies()
List all MSSIP proxy configurations (Skype for Business / Lync).
fn createMssipProxy(name: string, address: string, transport: enum, description?: string)
Create an MSSIP proxy (Skype for Business / Lync edge server).
| Argument | Type | Description |
|---|---|---|
| name | string | Proxy name |
| address | string | Edge server address |
| transport | enum | |
| description? | string |
fn listTeamsProxies()
List all Teams proxy configurations (CVI media relay for Microsoft Teams).
fn createTeamsProxy(name: string, address: string, description?: string)
Create a Teams proxy for CVI media relay.
| Argument | Type | Description |
|---|---|---|
| name | string | Proxy name |
| address | string | Proxy address |
| description? | string |
fn listH323Gatekeepers()
List all H.323 gatekeeper registrations.
fn createH323Gatekeeper(name: string, address: string, port: number, description?: string)
Register with an H.323 gatekeeper.
| Argument | Type | Description |
|---|---|---|
| name | string | Gatekeeper name |
| address | string | Gatekeeper address |
| port | number | RAS port |
| description? | string |
fn listStunServers()
List all STUN server configurations.
fn createStunServer(name: string, address: string, description?: string)
Add a STUN server for WebRTC NAT traversal.
| Argument | Type | Description |
|---|---|---|
| name | string | Server name |
| address | string | STUN server address |
| description? | string |
fn listSmtpServers()
List all SMTP server configurations.
fn createSmtpServer(name: string, address: string, port: number, fromEmail: string, username?: string, description?: string)
Configure an SMTP server for email notifications.
| Argument | Type | Description |
|---|---|---|
| name | string | Server name |
| address | string | SMTP server address |
| port | number | SMTP port |
| fromEmail | string | From email address |
| username? | string | SMTP username |
| description? | string |
fn listStaticRoutes()
List all static network routes on the platform.
fn createStaticRoute(name: string, address: string, prefix: number, gateway: string)
Add a static network route.
| Argument | Type | Description |
|---|---|---|
| name | string | Route name |
| address | string | Destination network address |
| prefix | number | CIDR prefix length |
| gateway | string | Gateway address |
fn inventory()
Full network inventory: SIP proxies, SIP credentials, MSSIP proxies, Teams proxies, H.323 gatekeepers, STUN servers, SMTP servers, and static routes.
@dougschaefer/pexip-licensev2026.03.29.1pexip/license.ts
fn list()
List all installed licenses with entitlements, capacities, features, and expiration dates.
fn getStatus()
Get real-time license usage: current concurrent calls, activatable users, and capacity against limits.
fn listRequests()
List license activation requests (pending, completed, or failed).
fn checkCompliance()
Check license compliance: compares current usage against allocated capacity and flags any overages or approaching limits.
fn inventory()
Full license inventory: all licenses, current usage status, and compliance check.
@dougschaefer/pexip-recordingv2026.03.29.1pexip/recording.ts
fn listAutoRecording()
List all auto-participants configured for RTMP recording/streaming. These automatically dial an RTMP endpoint when the VMR activates.
fn createAutoRecording(vmrName: string, description?: string)
Configure automatic RTMP recording on a VMR. When the VMR activates, Pexip dials the RTMP URI as a participant.
| Argument | Type | Description |
|---|---|---|
| vmrName | string | VMR name to attach recording to |
| description? | string |
fn deleteAutoRecording(vmrName: string)
Remove an automatic RTMP recording configuration from a VMR.
| Argument | Type | Description |
|---|---|---|
| vmrName | string | VMR name |
fn listStreamingCredentials()
List streaming credentials (public keys used by Pexip's streaming service for authentication).
fn listRecordings()
List all media library entries (recordings, hold music, IVR audio, playback content stored on the management node).
fn deleteRecording(name: string)
Delete a media library entry by name.
| Argument | Type | Description |
|---|---|---|
| name | string | Media entry name to delete |
fn inventory()
Full recording inventory: auto-recording configurations, streaming credentials, and media library entries.
@dougschaefer/pexip-diagnosticsv2026.03.29.1pexip/diagnostics.ts
fn healthCheck()
Comprehensive platform health check: node status, active alarms, license usage, and current call load.
fn getNodeHealth()
Detailed health status for all worker nodes: media load, signaling load, current calls, version, uptime.
fn listAlarms()
List all active platform alarms with severity, node, and description.
fn getCallHistory()
Get conference call history for a time range. Returns CDR records with duration, participant count, and service type.
fn getParticipantHistory()
Get participant-level CDR records for a time range with codec, quality metrics, and disconnect reasons.
fn qualityReport()
Analyze call quality over a time range: disconnect reasons, packet loss, protocol distribution, and problem calls.
fn listLogLevels()
List all configurable log levels on the platform.
fn setLogLevel()
Set the log level for a specific component (for debugging).
fn listTuneables()
List all system tuneables (advanced configuration parameters).
fn setTuneable(name: string, setting: string)
Set a system tuneable value. Use with caution — these are advanced parameters.
| Argument | Type | Description |
|---|---|---|
| name | string | Tuneable name |
| setting | string | Value to set |
fn takeSnapshot()
Take a diagnostic snapshot for Pexip support. Captures logs, configuration, and runtime state.
@dougschaefer/pexip-exchangev2026.03.29.1pexip/exchange.ts
fn listConnectors()
List all Exchange/O365 calendar connectors with their configuration state.
fn getConnector(name: string)
Get full configuration details for a specific Exchange connector.
| Argument | Type | Description |
|---|---|---|
| name | string | Connector name |
fn createConnector(name: string, description?: string)
Create an Exchange/O365 calendar connector for One-Touch-Join integration.
| Argument | Type | Description |
|---|---|---|
| name | string | Connector name |
| description? | string |
fn updateConnector(name: string, roomMailboxEmail?: string, url?: string, enableDynamicVmrs?: boolean, enablePersonalVmrs?: boolean, meetingBufferBefore?: number, meetingBufferAfter?: number, oauthClientId?: string, oauthClientSecret?: string)
Update an Exchange connector's configuration.
| Argument | Type | Description |
|---|---|---|
| name | string | Connector name to update |
| roomMailboxEmail? | string | |
| url? | string | |
| enableDynamicVmrs? | boolean | |
| enablePersonalVmrs? | boolean | |
| meetingBufferBefore? | number | |
| meetingBufferAfter? | number | |
| oauthClientId? | string | |
| oauthClientSecret? | string |
fn deleteConnector(name: string)
Delete an Exchange connector.
| Argument | Type | Description |
|---|---|---|
| name | string | Connector name to delete |
fn listScheduledAliases()
List all scheduled aliases (dynamically generated VMR aliases from calendar events).
fn listScalingPolicies()
List all scheduled scaling policies for cloud bursting (automatically provisioning extra nodes during peak periods).
fn createScalingPolicy(policyName: string, enabled: boolean, timeTo: string, monday: boolean, tuesday: boolean, wednesday: boolean, thursday: boolean, friday: boolean, saturday: boolean, sunday: boolean)
Create a scheduled scaling policy for cloud bursting during predicted peak periods.
| Argument | Type | Description |
|---|---|---|
| policyName | string | Policy name |
| enabled | boolean | |
| timeTo | string | Daily end time (HH:MM) |
| monday | boolean | |
| tuesday | boolean | |
| wednesday | boolean | |
| thursday | boolean | |
| friday | boolean | |
| saturday | boolean | |
| sunday | boolean |
fn deleteScalingPolicy(policyName: string)
Delete a scheduled scaling policy.
| Argument | Type | Description |
|---|---|---|
| policyName | string | Policy name to delete |
fn inventory()
Full Exchange/scheduling inventory: connectors, scheduled aliases, and scaling policies.
04Previous Versions
2026.03.29.3Mar 29, 2026
Major expansion: 15 model types, 224 methods. New models for policy server development, branding/plugins, event sinks, client API, auth/RBAC, network infrastructure, licensing, recording, diagnostics, and Exchange connectors. Added updateVmr to conference model. All credentials marked sensitive. Security audit clean.
2026.03.29.1Mar 29, 2026
Pin zod to 4.3.6, remove ASEI-specific storage account default, fix example URL
2026.03.28.1Mar 28, 2026
Remove MSP-specific label from metadata
2026.03.27.3Mar 28, 2026
Fix repository URL: point to GitHub instead of ADO. Lint cleanup.
2026.03.27.2Mar 28, 2026
Lint cleanup: removed explicit any types, fixed require-await, prefixed unused vars. No functional changes.
2026.03.27.1Mar 28, 2026
Bug fixes, lint cleanup, and new methods. All delete operations now include --yes for non-interactive automation.
05Stats
A
100 / 100
Downloads
1
Archive size
93.6 KB
- Has README or module doc2/2earned
- README has a code example1/1earned
- README is substantive1/1earned
- Most symbols documented1/1earned
- No slow types1/1earned
- Has description1/1earned
- At least one platform tag (or universal)1/1earned
- Two or more platform tags (or universal)1/1earned
- License declared1/1earned
- Verified public repository2/2earned
06Platforms
07Labels