Stay organized with collections
Save and categorize content based on your preferences.
You can use the queue operation statuses endpoint to get availability status for
a queue before you deflect a session to it. This endpoint returns the following
boolean properties:
after_hours: true if the queue is unavailable because it's in an after
hours state
overcapacity: true if the queue is unavailable because it's in an
overcapacity state
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-25 UTC."],[[["\u003cp\u003eThis API endpoint provides the availability status of a queue, indicating whether it is available to receive sessions.\u003c/p\u003e\n"],["\u003cp\u003eThe endpoint returns boolean values for \u003ccode\u003eafter_hours\u003c/code\u003e and \u003ccode\u003eovercapacity\u003c/code\u003e to determine if the queue is unavailable due to either reason.\u003c/p\u003e\n"],["\u003cp\u003eA \u003ccode\u003eGET\u003c/code\u003e request to \u003ccode\u003ehttps://{subdomain}.{domain}/apps/api/v1/queue_operation_statuses\u003c/code\u003e is used to access this information.\u003c/p\u003e\n"],["\u003cp\u003eThe request requires the \u003ccode\u003emenu_id\u003c/code\u003e, \u003ccode\u003elang\u003c/code\u003e, and \u003ccode\u003echannel_type\u003c/code\u003e as query parameters, the \u003ccode\u003emenu_id\u003c/code\u003e being the target queue's ID, \u003ccode\u003elang\u003c/code\u003e being the language code, and \u003ccode\u003echannel_type\u003c/code\u003e being the type of communication.\u003c/p\u003e\n"]]],[],null,["# Queue operation statuses endpoint\n\nYou can use the queue operation statuses endpoint to get availability status for\na queue before you deflect a session to it. This endpoint returns the following\nboolean properties:\n\n- `after_hours`: `true` if the queue is unavailable because it's in an after\n hours state\n\n- `overcapacity`: `true` if the queue is unavailable because it's in an\n overcapacity state\n\n***Endpoint:***\n\nMethod: `GET`\n\nType: RAW\n\nURL: `https://{subdomain}.{domain}/apps/api/v1/queue_operation_statuses`\n\n***Query:***\n\n### Example request and response\n\nThis section provides an example request and response.\n\n#### Request\n\n https://{subdomain}.{domain}/apps/api/v1/queue_operation_statuses?menu_id=1&lang=en&channel_type=call\n\n#### Response\n\n {\n \"menu_id\": 1,\n \"lang\": \"en\",\n \"channel_type\": \"call\",\n \"after_hour\": false,\n \"overcapacity\": true\n }"]]
