Skip to main content

Sessions

This section covers all the available endpoints for managing mentor sessions.

Available Endpoints​

Session Types​

  • SCHEDULED: A pre-scheduled session
  • INSTANT: An immediate/on-demand session

Session Statuses​

  • PENDING: Session is scheduled but not yet started
  • IN_PROGRESS: Session is currently active
  • COMPLETED: Session has ended successfully
  • CANCELLED: Session was cancelled
  • END-REQUEST-PENDING: A request to end the session is pending

Important Notes​

General Information​

  • All session times are in UTC
  • Session duration is specified in minutes
  • Free sessions are currently disabled
  • Video sessions use Agora for real-time communication
  • Session duration cannot exceed the appointment duration

Session Types and Booking​

  • Direct sessions require immediate coach availability
  • Scheduled sessions must be booked in advance
  • Sessions can only be cancelled before they start
  • Each session type has specific booking requirements
  • Instant sessions are subject to coach availability

Session Communication​

  • Session chats are available during and after the session
  • Chat messages can only be sent during active sessions
  • Media files (images/videos) in chat have size and format restrictions
  • Real-time communication uses secure video streaming
  • Chat history is preserved for future reference

Session Recording and Reports​

  • Session recordings are available for a limited time after completion
  • Recordings are stored in MP4 format
  • Access to recordings is controlled by user permissions
  • Session reports are only available for completed sessions
  • Reports include detailed session summary and recommendations

Session Logging and Monitoring​

  • Session logs track all important activities during the session
  • Logs are automatically created for certain actions
  • Logs cannot be created after a session has ended
  • Logs include timestamps and user information
  • Logs help track session progress and issues

Session Ratings and Feedback​

  • Ratings can only be submitted for completed sessions
  • Each session can only be rated once
  • Ratings include both numerical scores and detailed feedback
  • Rating criteria cover multiple aspects of the session
  • Ratings are subject to review and may be pending approval

Technical Requirements​

  • Stable internet connection required for video sessions
  • Supported browsers for video streaming
  • Minimum bandwidth requirements for optimal quality
  • Mobile devices supported for all session types
  • Automatic reconnection handling for network issues

Security and Privacy​

  • All communications are encrypted
  • Session recordings are securely stored
  • Access to recordings is time-limited
  • Personal information is protected
  • Compliance with data protection regulations

Important Notes​

  • Session Types:
    • DIRECT: Immediate session with coach
    • SCHEDULED: Pre-scheduled session
  • Session Statuses:
    • SCHEDULED: Session is booked but not started
    • IN_PROGRESS: Session is currently active
    • COMPLETED: Session has ended successfully
    • CANCELLED: Session was cancelled
  • Direct sessions require immediate coach availability
  • Scheduled sessions must be booked in advance
  • Session duration cannot exceed the appointment duration
  • Free sessions are currently disabled
  • Video sessions use Agora for real-time communication
  • Session chats are available during and after the session