Skip to main content

CheckAvailability checks if organization is available.

POST 
/api/v1/voice/availability/check

Evaluates all scheduling rules to determine current availability.

Parameters​

  • channel: Required, channel to check (voice, chat, email)
  • check_time: Optional, time to check (default: now)

Response​

  • is_available: Whether organization is open
  • reason: Availability reason (OPEN, CLOSED, HOLIDAY, OOO_OVERRIDE)
  • unavailable_until: When organization reopens (if closed)
  • message_text: Custom message for unavailability
  • sound_file_id: Audio file for unavailability message

Evaluation Order​

  1. Check for active OOO override → returns OOO_OVERRIDE
  2. Check for active holiday → returns HOLIDAY
  3. Check business hours → returns OPEN or CLOSED

Errors​

  • INVALID_ARGUMENT: Missing channel
  • PERMISSION_DENIED: Caller lacks voice:schedule:read permission

Request​

Responses​

A successful response.