API Reference#

GET /healthz#

Healthz

Status Codes:
  • 200 OK – Successful Response

GET /#

Read Root

Status Codes:
  • 200 OK – Successful Response

GET /config#

Get Config

Status Codes:
  • 200 OK – Successful Response

GET /queue/state#

Get Queue State

Status Codes:
  • 200 OK – Successful Response

PATCH /queue/state#

Update Queue State

Status Codes:
GET /queue#

Get Queued Tasks

Query Parameters:
  • status ({'null', 'string'})

Status Codes:
POST /queue#

Add Tasks To Queue

Query Parameters:
  • position ({'null', 'integer'})

Status Codes:
POST /queue/move#

Move Task

Query Parameters:
  • task_id (string) – (Required)

  • new_position (integer) – (Required)

Status Codes:
DELETE /queue/tasks#

Cancel Tasks

Status Codes:
GET /queue/{position}#

Get Task By Position

Parameters:
  • position (integer)

Status Codes:
GET /tasks#

Get All Tasks

Query Parameters:
  • status ({'null', 'string'})

Status Codes:
GET /tasks/{task_id}#

Get Task By Id

Parameters:
  • task_id (string)

Status Codes:
GET /history#

Get Completed Tasks

Query Parameters:
  • status ({'null', 'string'})

Status Codes:
DELETE /history#

Clear History

Status Codes:
  • 200 OK – Successful Response

GET /call_queue#

Get Call Queue

Status Codes:
  • 200 OK – Successful Response

GET /call_history#

Get Call History

Status Codes:
  • 200 OK – Successful Response

GET /events#

Stream Events

Status Codes:
  • 200 OK – Successful Response