Privicore
  1. Websockets
Privicore
  • Privicore API
  • Utility
    • Utility
    • Check server health
      GET
    • Request command id status
      GET
  • Profile
    • Profile Model and Authentication Workflow
    • Register new profile
      POST
    • Authenticate
      POST
    • Retrieve profile id
      GET
    • Change password
      POST
    • Generate qr token for authorization
      POST
    • Reauthorize authorization token
      POST
    • Revoke authorization token
      POST
    • Retrieve token expiry
      POST
  • OAuth Application
    • OAuth Application Management
    • Register OAuth Application
      POST
    • Retrieve OAuth app configuration
      POST
    • Request OAuth app authorization code
      GET
    • Retrieve OAuth app authorization code
      POST
    • Obtain OAuth app access token
      POST
    • OAuth application list
      GET
    • Retrieve OAuth application scope
      GET
    • Refresh OAuth app access token
      POST
  • Public key
    • Public and Private Key Management
    • Generate your private and public keys
    • Register public key
    • Retrieve public key
    • Retrieve CAB public key
  • Data Token
    • Data Token Management
    • Reserve token space
    • Retrieve temporary data token
    • Exchange data for token
    • Upstream file via stream auth
    • Request data via token
    • Download data
    • Configure information security risk meta
    • Configure file meta
    • List data tokens
    • Update data token
    • Delete data
  • Device
    • Device Management
    • Request unique identifier (i.e. Register new device)
    • Retrieve unique identifier
    • Retrieve profile devices
    • Configure device meta
    • Approve device
    • Reject device
    • Retrieve device configuration
    • Remove device
  • Storage
    • Storage Device Management
    • Register storage device
    • List storage devices
    • Synchronize device
    • Remove storage
  • Verified authenticator
    • Authenticator and Voting Management
    • Register authenticator
    • List verified authenticators
    • Retrieve voting strategy
    • Set quorum size
    • Set quorum strategy
    • Set voting time limit
    • Set maximum voting attempts
    • Remove authenticator
    • Register voting configuration
    • Update voting configuration
    • List voting configurations
    • Retrieve voting configuration
  • Policy
    • Policy Management
    • List policy templates
    • Register policy
    • List active policies
    • List inactive policies
    • Activate policy
    • Deactivate policy
    • Delete policy
    • List registered policies
    • Retrieve registered policy
  • Voting
    • Voting Operations
    • Create voting
    • Check pool status
  • Websockets
    • WebSocket Integration
    • Establishing Connection
    • Join Channel
    • Leave Channel
    • Command Status Messages
    • Data Download Messages
  • Schemas
    • Response
      • CommandAccepted
      • Unauthorized
      • ValidationErrors
    • Schemas
    • profileId
    • deviceIdentifier
    • directoryId
    • directoryName
    • directoryShortName
    • givenName
    • familyName
    • createdAt
    • meta
  1. Websockets

Leave Channel

Overview#

Unsubscribe from your profile's message queue and stop receiving notifications.

Leave Channel#

Action: leaveChannel
Message Format: JSON

Request Parameters#

ParameterTypeRequiredDescription
authorizationTokenstringYesProfile authorization token obtained from authentication
correlationIdstringYesUnique identifier for tracking this request

Request Example#

Response#

{
  "correlationId": "unique-correlation-id",
  "status": 200,
  "data": {
    "channelId": "019735db-f8f7-6c08-c893-8f3a6f44a244",
    "message": "Successfully left profile channel."
  }
}

Use Case#

Use this operation to gracefully unsubscribe from your profile's message queue before closing the WebSocket connection. This ensures proper cleanup on the server side and prevents unnecessary message processing.
Leave channel when:
User logs out
Application is closing
Switching to a different profile
No longer need real-time notifications
After leaving the channel, no new messages will be received
The WebSocket connection remains open after leaving
You can rejoin the channel using the same connection
Always leave channel before closing connection for proper cleanup
Modified at 2026-01-05 14:08:11
Previous
Join Channel
Next
Command Status Messages
Built with