GetSQState

POST

https://api.voximplant.com/platform_api/GetSQState

POST

/platform_api/GetSQState

curl -X POST "https://api.voximplant.com/platform_api/GetSQState?application_id=1&sq_queue_id=1" \
     -H "Authorization: Bearer <token>"

200SmartQueue state

{
  "result": [
    {
      "sq_queue_id": 1,
      "sq_queue_name": "queue_name_1",
      "sq_agents": [
        {
          "user_id": 1,
          "user_name": "user-1",
          "user_display_name": "Sylvester Stallone",
          "sq_skills": [
            {
              "sq_skill_id": 1,
              "sq_skill_name": "skill_1",
              "sq_skill_level": 5
            }
          ],
          "sq_statuses": {
            "CALL": {
              "from_date": "2021-05-25 12:24:44",
              "sq_status_name": "ONLINE"
            },
            "IM": {
              "from_date": "2021-05-25 12:24:44",
              "sq_status_name": "ONLINE"
            }
          }
        },
        {
          "user_id": 2,
          "user_name": "user-2",
          "user_display_name": "Chuck Norris",
          "sq_skills": [
            {
              "sq_skill_id": 3,
              "sq_skill_name": "skill_3",
              "sq_skill_level": 2
            }
          ],
          "sq_statuses": {
            "CALL": {
              "from_date": "2021-05-25 12:35:58",
              "sq_status_name": "DND"
            },
            "IM": {
              "from_date": "2021-05-25 12:35:58",
              "sq_status_name": "DND"
            }
          }
        },
        {
          "user_id": 3,
          "user_name": "user-3",
          "user_display_name": "Sylvester Norris",
          "sq_skills": [],
          "sq_statuses": {
            "CALL": {
              "from_date": "2021-05-25 12:32:43",
              "sq_status_name": "DND"
            },
            "IM": {
              "from_date": "2021-05-25 12:32:43",
              "sq_status_name": "DND"
            }
          }
        }
      ],
      "tasks": []
    }
  ]
}

Gets the current state of the specified SmartQueue.

Example request: Get the current state of the SmartQueue with id = 1.

Authentication

AuthorizationBearer

Voximplant Management API uses signed JWT tokens generated from your service-account private key. Pass the token in the Authorization header as a Bearer value:

Authorization: Bearer $VOXIMPLANT_TOKEN

See Authorization for ready-to-copy snippets in bash, Python, Node.js and Go that turn your credentials.json into a token.

Query parameters

application_idintegerRequired

The application ID to search by

application_namestringOptional

The application name to search by. Can be used instead of the application_id parameter

sq_queue_idlist of integersRequired

The SmartQueue ID list separated by semicolons (;). Use the 'all' value to select all SmartQueues

sq_queue_namelist of stringsOptional

The SmartQueue name list separated by semicolons (;). Can be used instead of sq_queue_id

timezonestringOptionalDefaults to UTC

The selected timezone or the 'auto' value (the account location)

Response

Successful response

resultlist of objectsOptional