diff --git a/docs/Queue Management API Documentation.md b/docs/Queue Management API Documentation.md new file mode 100644 index 000000000..a91daf800 --- /dev/null +++ b/docs/Queue Management API Documentation.md @@ -0,0 +1,32 @@ + +# Queue Management API Documentation + +**Description:** This document provides a detailed guide for managing call queues using the Queue Management API. It covers essential operations such as enqueueing, dequeueing, and handling queue events. This API is critical for building robust call center applications. + +**Target Audience:** Developers, Call Center Solution Architects + +## Queue Concepts + +A queue is a data structure that holds calls waiting to be processed by available agents. The Queue Management API allows you to programmatically control the flow of calls in and out of these queues. Key concepts include: + +* **Call SID (Session ID):** A unique identifier for each call. Used to track and manage individual calls within the queue. +* **Queue Name:** A unique identifier for each queue. Used to target specific queues for enqueueing and dequeueing operations. +* **Queue Position:** The position of a call within the queue. The first call in the queue has position 1. +* **Agent Availability:** The status of agents (available, busy, offline). The API does not directly manage agent availability, but it's a crucial factor in determining when to dequeue calls. +* **Priority:** A value assigned to a call that determines its order in the queue. Higher priority calls are typically dequeued before lower priority calls. + +## Queue Operations + +This section details the core operations available through the Queue Management API. + +### Enqueueing a Call + +Enqueueing a call adds it to the specified queue. + +**Endpoint:** `/v1/enqueue/{callSid}` + +**Method:** POST + +**Parameters:** + +| Parameter | Type | Description \ No newline at end of file