Skip to main content

Core Concepts

Understanding WiseAPI's core concepts is essential for building robust conference applications. These fundamental building blocks work together to provide a complete video conferencing solution with enterprise-grade features.

Architecture Overview​

WiseAPI follows a hierarchical structure where Organizations contain Rooms, Rooms host Sessions, and Sessions can be preserved on the Blockchain:

Organization
├── Organizational Units (Teams/Departments)
│   ├── Rooms (Persistent Conference Spaces)
│   │   ├── Sessions (Live Conference Instances)
│   │   │   ├── Participants
│   │   │   ├── Media Streams
│   │   │   └── Recordings
│   │   └── Configuration & Settings
│   └── Access Control & Permissions
└── Billing & Administration

Core Concepts​

🏢 Organization

The top-level entity representing your company with billing, administration, and organizational units for resource management and access control.

Key topics: Billing, OrgUnits, User Management, Global Settings

🏠 Room

A persistent conference space that serves as a container for multiple sessions over time, maintaining shared configuration and settings.

Key topics: Configuration, Access Policies, Session Management, Lifecycle

📹 Session

The atomic unit of a conference representing a single, active conference instance with real-time state, participants, and media streams.

Key topics: Status Flow, Participants, Real-time State, Recording

⛓️ Blockchain

Immutable storage of session manifests on blockchain for permanent audit trails, compliance, and tamper-proof conference records.

Key topics: Session Manifests, Hash Storage, Verification, Compliance

Understanding the Relationships​

Organization → Room → Session Flow​

  1. Start with Organization: Set up your company structure and billing
  2. Create Rooms: Define persistent conference spaces with specific configurations
  3. Launch Sessions: Start live conferences within rooms, inheriting room settings
  4. Store on Blockchain: Optionally preserve session data for permanent records

Key Relationships​

RelationshipDescriptionExample
Organization ↔ RoomsOrganization contains multiple rooms across org unitsCompany ABC has Meeting Room A, Training Room B
Room ↔ SessionsRooms host multiple sessions over timeDaily Standup Room hosts Monday, Tuesday, Wednesday sessions
Session ↔ ParticipantsSessions manage real-time participant interactions5 team members join Monday's standup session
Session ↔ BlockchainSessions can be permanently stored as manifestsMonday's session manifest stored with hash verification

Typical Workflows​

Basic Conference Flow​

graph LR
    A[Create Organization] --> B[Setup Rooms]
    B --> C[Configure Access]
    C --> D[Start Session]
    D --> E[Manage Participants]
    E --> F[End Session]
    F --> G[Access Recordings]

Advanced Compliance Flow​

graph LR
    A[Regular Conference] --> B[Session Ends]
    B --> C[Generate Manifest]
    C --> D[Store on Blockchain]
    D --> E[Verify Integrity]
    E --> F[Compliance Audit]

Getting Started Guide​

1. Understand the Hierarchy​

  • Organization: Your company and billing structure
  • Rooms: Persistent spaces for recurring meetings
  • Sessions: Live conference instances
  • Blockchain: Permanent audit trail storage

2. Plan Your Structure​

  • Identify organizational units (departments, teams)
  • Define room purposes (meetings, training, support)
  • Consider access policies and permissions
  • Plan for compliance and audit requirements

3. Implementation Order​

  1. Read Organization concepts - Understand billing and structure
  2. Read Room concepts - Learn about persistent spaces
  3. Read Session concepts - Understand live conferences
  4. Read Blockchain concepts - Learn about permanent storage

4. Advanced Features​

  • Access control and security policies
  • Recording and transcription capabilities
  • Blockchain integration for compliance
  • Multi-tenant organizational structures

Best Practices​

Room Design​

  • Purpose-specific rooms: Create rooms for specific meeting types
  • Consistent naming: Use clear, descriptive room names
  • Access control: Set appropriate join/open policies
  • Configuration inheritance: Let sessions inherit room settings

Session Management​

  • Monitor status: Track session lifecycle states
  • Participant management: Control access and permissions
  • Resource planning: Consider participant limits and duration
  • Recording strategy: Plan for storage and transcription needs

Security & Compliance​

  • Access policies: Use organization-level and room-level controls
  • Blockchain storage: Enable for compliance-critical sessions
  • Audit trails: Maintain records for regulatory requirements
  • Data retention: Plan for recording and manifest storage

Next Steps​

  1. Explore Concepts - Dive deep into each core concept
  2. Check API Endpoints - Learn how to implement these concepts
  3. Review Getting Started - Follow step-by-step integration guides
  4. Try Examples - Experiment with sample implementations

Need Help?​

  • Concepts Documentation - Detailed explanations of each concept
  • API Reference - Complete endpoint documentation
  • Getting Started Guide - Step-by-step tutorials
  • Support - Contact our technical team for assistance