XAPI - Queues

[telis]

What can I put in the expand argument in the query string for the 3CX XAPI Configuration API. I figured out by guesswork that I have to use "agents" to get the members of the queues but I cannot figure out how to get the DD for the queue or what else might be available.

/xapi/v1/Queues?expand=agents

Is this documented anywhere or does anyone have any knowledge?

 

[paulodagraca]

Hello


The full detail should be: (*see below)
If any detail is missing in your result, you can expand... like Agents, Groups, Managers,..

{
  "@odata.count": "<long>",
  "value": [
    {
      "AgentAvailabilityMode": "<boolean>",
      "Agents": [
      ],
      "AnnouncementInterval": "<integer>",
      "AnnounceQueuePosition": "<boolean>",
      "BreakRoute": {
        "IsPromptEnabled": "<boolean>",
        "Prompt": "<string>",
        "Route": {
          "External": "<string>",
          "Name": "<string>",
          "Number": "<string>",
          "PeerType": "IVR",
          "To": "None"
        }
      },
      "CallbackEnableTime": "<integer>",
      "CallbackPrefix": "<string>",
      "CallUsEnableChat": "<boolean>",
      "CallUsEnablePhone": "<boolean>",
      "CallUsEnableVideo": "<boolean>",
      "CallUsRequirement": "Email",
      "ClickToCallId": "<string>",
      "EnableIntro": "<boolean>",
      "ForwardNoAnswer": {
        "External": "<string>",
        "Name": "<string>",
        "Number": "<string>",
        "PeerType": "Parking",
        "To": "IVR"
      },
      "Groups": [
      ],
      "MasterTimeout": "<integer>",
      "MaxCallersInQueue": "<integer>",
      "Name": "<string>",
      "NotifyCodes": [
      ],
      "Number": "<string>",
      "OfficeRoute": {
        "IsPromptEnabled": "<boolean>",
        "Prompt": "<string>",
        "Route": {
          "External": "<string>",
          "Name": "<string>",
          "Number": "<string>",
          "PeerType": "RoutePoint",
          "To": "None"
        }
      },
      "OnHoldFile": "<string>",
      "OutOfOfficeRoute": {
        "IsPromptEnabled": "<boolean>",
        "Prompt": "<string>",
        "Route": {
          "External": "<string>",
          "Name": "<string>",
          "Number": "<string>",
          "PeerType": "ExternalLine",
          "To": "VoiceMail"
        }
      },
      "PlayFullPrompt": "<boolean>",
      "PollingStrategy": "SkillBasedRouting_RingAll",
      "PriorityQueue": "<boolean>",
      "PromptSet": "<string>",
      "Recording": "AllowToOptOut",
      "ResetQueueStatisticsSchedule": {
        "Day": "Monday",
        "Frequency": "Weekly",
        "Time": "13:29:59.3"
      },
      "ResetStatisticsScheduleEnabled": "<boolean>",
      "RingTimeout": "<integer>",
      "SLATime": "<integer>",
      "TypeOfChatOwnershipType": "TakeManually",
      "WrapUpTime": "<integer>"
    },
    {
      "AgentAvailabilityMode": "<boolean>",
      "Agents": [
      ],
      "AnnouncementInterval": "<integer>",
      "AnnounceQueuePosition": "<boolean>",
      "BreakRoute": {
        "IsPromptEnabled": "<boolean>",
        "Prompt": "<string>",
        "Route": {
          "External": "<string>",
          "Name": "<string>",
          "Number": "<string>",
          "PeerType": "IVR",
          "To": "VoiceMailOfDestination"
        }
      },
      "CallbackEnableTime": "<integer>",
      "CallbackPrefix": "<string>",
      "CallUsEnableChat": "<boolean>",
      "CallUsEnablePhone": "<boolean>",
      "CallUsEnableVideo": "<boolean>",
      "CallUsRequirement": "Email",
      "ClickToCallId": "<string>",
      "EnableIntro": "<boolean>",
      "ForwardNoAnswer": {
        "External": "<string>",
        "Name": "<string>",
        "Number": "<string>",
        "PeerType": "SpecialMenu",
        "To": "None"
      },
      "Groups": [
      ],
      "HolidaysRoute": {
        "IsPromptEnabled": "<boolean>",
        "Prompt": "<string>",
        "Route": {
          "External": "<string>",
          "Name": "<string>",
          "Number": "<string>",
          "PeerType": "SpecialMenu",
          "To": "Boomerang"
        }
      },
      "Id": "<integer>",
      "IntroFile": "<string>",
      "IsRegistered": "<boolean>",
      "Managers": [
      ],
      "MasterTimeout": "<integer>",
      "MaxCallersInQueue": "<integer>",
      "Name": "<string>",
      "NotifyCodes": [
      ],
      "Number": "<string>",
      "OfficeRoute": {
        "IsPromptEnabled": "<boolean>",
        "Prompt": "<string>",
        "Route": {
          "External": "<string>",
          "Name": "<string>",
          "Number": "<string>",
          "PeerType": "ExternalLine",
          "To": "Deflect"
        }
      },
      "OnHoldFile": "<string>",
      "OutOfOfficeRoute": {
        "IsPromptEnabled": "<boolean>",
        "Prompt": "<string>",
        "Route": {
          "External": "<string>",
          "Name": "<string>",
          "Number": "<string>",
          "PeerType": "Group",
          "To": "Boomerang"
        }
      },
      "PlayFullPrompt": "<boolean>",
      "PollingStrategy": "First3Available",
      "PriorityQueue": "<boolean>",
      "PromptSet": "<string>",
      "Recording": "Disabled",
      "ResetQueueStatisticsSchedule": {
        "Day": "Wednesday",
        "Frequency": "Weekly",
        "Time": "21:49:43"
      },
      "ResetStatisticsScheduleEnabled": "<boolean>",
      "RingTimeout": "<integer>",
      "SLATime": "<integer>",
      "TypeOfChatOwnershipType": "TakeManually",
      "WrapUpTime": "<integer>"
    }
  ]
}

Hope this helps.

Paulo

 

[fxbastler]

... but I cannot figure out how to get the DD for the queue or what else might be available.

The DID of a queue cannot be obtained with the XAPI query of the queue alone. It can only be determined by combining it with a query of the inbound rules and their assignment to the queue’s ID.

 

[paulodagraca]

Hello telis,

If you want the Queue DID, you could be doing something like this in your programm/script:

GET
.../xapi/v1/ReportInboundRules/Pbx.GetInboundRulesData()?%24top=100&%24skip=0

Find match of Queue number
"value" [ ] "InOfficeRouting" "Number"

If found, grab DID
"value" [ ] "DID"

Paulo

 

[telis]

Many thanks both.

@paulodagraca where did you get this json from? When I called the endpoint without expand specified I do not see an empty Agents, Groups node etc. so I didn't know what the full list of options for the expand argument was. And I still don't know what it is for the other calls that have an expand property.

@fxbastler I have used now used the inbound rules call to get the data I needed after typing several things into the expand property of the queues call and not getting anywhere.

 

[paulodagraca]

Hello telis,

I was looking into Postman with the 3CX workspace.



Paulo

 

[telis]

@paulodagraca where did you get the workspace from? Did you import this from here - https://raw.githubusercontent.com/3cx/xapi-tutorial/refs/heads/master/swagger.yaml.

I was trying to get the openapi doc from the 3CX instance URL and concluded there was no open api.

I'm using bruno not postman.