OpenVox Document Center OpenVox Document Center
  • Home 
  • Products 
  • Solutions 
  • Resources 
    • Document Center 
    • Datasheets 
    • Firmwares 
    • Videos 
  • Partners 
  • Blog 
  • Company 
OpenVox Document Center OpenVox Document Center
OpenVox Document Center
  • Home 
  • Products 
  • Solutions 
  • Resources 
    • Document Center 
    • Datasheets 
    • Firmwares 
    • Videos 
  • Partners 
  • Blog 
  • Company 

UC Series IP PBX

  • folder icon closed folder iconRelease Notes
    • OpenVox IPPBX System Version 4.3.6
    • OpenVox IPPBX System Version 4.3.5
    • OpenVox IPPBX System Version 4.3.3
    • OpenVox IPPBX System Version 4.2.0
    • OpenVox IPPBX System Version 4.1.0
    • OpenVox IPPBX System Version 3.2.4
    • OpenVox IPPBX System Version 2.5.5
    • OpenVox IPPBX System Version 1.6.3
    • OpenVox IPPBX System Version 1.1.0
  • folder icon closed folder iconGetting Started Guide
    • Initial System Setup
      • Language
      • Set Date and Time
      • Change the System Prompt
    • Set up Extensions
      • Create Extensions in batch
      • Upload Extensions
    • Set up Your Phone
    • Set up VoIP Trunks
      • Create a VoIP Peer Trunk
      • Create a VoIP Register Trunk
    • Receive Inbound Calls
    • Make Outbound Calls
  • folder icon closed folder iconInstallation Guide
    • Hardware Overview
      • UC300 Overview
      • UC500 Overview
      • UC501 Overview
      • Module Accessories
    • Install PBX
      • Installation Warnings
      • Package Contents
      • Install OpenVox UC501
    • Connect Your IPPBX
  • folder icon closed folder iconAdmin Guide
    • Contacts
    • Extensions
      • Extension Overview
      • Extension Basic Setup
        • Create Extensions
          • Extension Creation Overview
          • Create a SIP Extension
          • Create an IAX Extension
          • Create an FXS Extension
          • Bulk Create Extensions
        • Register Extensions
          • Register a SIP Extension
          • Register an IAX Extension
          • Register a Remote Extension
        • Manage Extensions
          • Edit Extensions
          • Bulk Edit Extension Names and Emails
          • Delete Extensions
          • Import/Export Extensions
      • Extension Groups
        • Create an Ring Groups
      • Presence
      • Voicemail
        • Delete Voicemail Files
        • Mobility Extension
      • Call Monitoring
        • Call Monitoring Overview
        • Configure Call Monitoring
      • Call Permission
        • Set Call Permission of an Extension
      • Extension Settings
        • SIP Extension Settings
        • IAX Extension Settings
        • FXS Extension Settings
    • Trunks
      • Trunk Overview
      • VoIP Trunks
      • PSTN Trunks
        • PSTN Trunk Introduction
        • Create a PSTN Trunk
        • PSTN Trunk Settings
    • Call Recording
    • PBX Monitor
    • Network
      • Basic Network
        • Basic Network Overview
        • Configure Static IP Address
        • Obtain an IP Address from a DHCP Server
      • VLAN
        • VLAN Overview
        • Configure VLAN on UC-Series VoIP PBX
      • OpenVPN Client
        • OpenVPN Client Overview
        • Connect UC-Series VoIP PBX to OpenVPN Server
      • DDNS
        • DDNS Overview
        • Set up No-IP DDNS on UC-Series VoIP PBX
      • Port Forwarding
      • NAT
        • NAT Overview
        • Set NAT with External IP Address
        • Set NAT with External Host
        • Set NAT with STUN
      • Static Route
        • Static Route Overview
        • System Route Entries
        • Add a Static Route
        • Manage the Static Routes
        • Dedicated SIP Trunking on UC-Series VoIP PBX
    • Voice Prompts
      • System Prompt
        • Change System Prompt
        • Customize System Prompt
        • Change an Extension’s Prompt
      • Music on Hold (MoH)
        • Add a Custom MoH Playlist with Local Audio Files
      • Custom Prompt
        • Requirements of Custom Audio Files
        • Upload a Custom Prompt
        • Record a Custom Prompt
        • Play a Custom Prompt
        • Convert Audio Files Online
    • Call Control
      • Emergency Calling
      • Time Conditions
        • Time Conditions Overview
        • Set Time Conditions
        • Manage Time Conditions
        • Time Condition Examples
        • Time Condition Override
        • Monitor Time Condition State
      • Inbound Routes
        • Inbound Route Overview
        • Add an Inbound Route
        • Manage Inbound Routes
      • Outbound Routes
        • Outbound Route Overview
        • Dial Patterns of Outbound Route
        • Add an Outbound Route
        • Outbound Route Examples
      • Outbound Restriction
        • Outbound Restriction Overview
        • Add a Rule to Restrict Outbound Calls
        • Manage Outbound Restriction Rules
      • AutoCLIP Routes
        • AutoCLIP Overview
        • Calls to Original Extensions
        • Configure AutoCLIP to Route Inbound
    • System Management
      • System General Settings
        • System Preference
        • Feature Code
        • SIP Settings
        • IAX Settings
      • Security
      • User Permission
        • Configure User Permission
      • Date/Time
      • Email
      • Storage
        • Add a Windows Network Drive
      • Event Center
      • Hot Standby
      • Cloud Management
      • API
    • Call Feature
      • Queue
        • Add a Queue
      • Backup and Restore
        • Create a Backup File
        • Restore a Backup File
      • FAX
      • PIN Sets
      • Speed Dial
      • Conference
        • Join a Conference
        • Add a Conference
      • DISA
        • Set up DISA
      • IVR
        • Set up an IVR
        • Dial by Name
        • Change IVR Prompt Clip
        • Forward Incoming Calls to an External Number with IVR
      • Ring Group
        • Add a Ring Group
      • Callback
      • Intercom/Paging
        • Set up 1-Way Paging
        • Set up 2-Way Intercom
      • Call Transfer
        • Attended Transfer
        • Blind Transfer
      • Set up Callback
      • Call Parking
        • Configure Call Parking Caller ID
    • Maintenance
      • Upgrade Firmware
      • Backup and Restore
      • Reboot the PBX
      • Reset the PBX
      • Troubleshooting
        • Monitor Physical Port
        • Ping IP Address
        • Traceroute
        • Access the PBX via SSH
        • Capture Ethernet Packets
    • Resource Monitor and System Information
    • PBX Service Security
  • folder icon closed folder iconFunctions Guide
    • Auto Provision
      • Supported IP Phone Manufactures and Phone Models
      • Auto Provision Phones by PnP Method
      • Update Auto Provision Settings
      • Synchronize Phone Time with the PBX
      • Auto provision phones by Static Provisioning Server
    • Direct Inward Dialing (DID)
    • Conference Pannel
      • Manage Conference Contacts
      • Conference List
      • Dial-in Conferencing
      • Dial-out Conferencing
      • Control Online Conferences
    • Hotel
      • Hotel System Settings
        • Hotel General Settings
        • Call Rate Settings
        • Mini Bar Settings
        • Hotel Email Template
      • Room Management
        • Add Room Types
        • Add a Room
        • Add Bulk Rooms
        • Room Settings
      • Use Hotel App
        • Access Rooms Information
        • Book Rooms
        • Check In
        • Group Rooms
        • Change Room
        • Check Out
        • Billing Report
        • Guests Management
        • Wake up
        • Remote Action Control
    • LDAP Server
      • LDAP Overview
      • LDAP Server Configurations
        • Configure LDAP Server
      • LDAP Phonebook
        • Default LDAP Phonebook
        • Add an LDAP Phonebook
        • Manage an LDAP Phonebook
        • Export/Import an LDAP Phonebook
      • LDAP Client Configuration Examples
        • LDAP Configurations on Fanvil Phone
        • LDAP Configurations on Yealink Phone
        • LDAP Configurations on Htek Phone
        • LDAP Configurations on Cisco SPA Phone
        • LDAP Configurations on Grandstream Phone
        • LDAP Configurations on Snom Phone
        • LDAP Configurations on Zoiper Softphone
    • Billing
      • How to Configure A2billing with OpenVox UC Series IPPBX
    • VPN Client
      • OpenVPN
        • OpenVPN Certificates and Keys
          • Install OpenVPN on Windows
          • Generate OpenVPN Certificates and Keys
          • Check the Generated OpenVPN Certificates and Keys
        • OpenVPN Clients Configurations
          • Connect to OpenVox UC-Series VoIP PBX with Windows
            • Create a Client File for Windows Client
            • Connect Windows PC to OpenVox UC-Series VoIP PBX via OpenVPN
        • Check the Client Status
      • N2N
      • L2TP
        • Copy of Install on Windows and Initial Configurations
        • Connect Windows PC to OpenVox UC-Series VoIP PBX via L2TP
      • SSTP
        • Install on Windows and Initial Configurations
        • Connect Windows PC to OpenVox UC-Series VoIP PBX via SSTP
  • folder icon closed folder iconCompatible SIP Endpoints
    • Compatible SIP Endpoints
  • folder icon closed folder iconUser Manual
    • UC Series IP Phone System
      • UC Series User Manual(For Version 2.0)
      • UC Series User Manual(For Version 4.0)
  • folder icon closed folder iconAPI Documentation
    • API Authentication
      • Login
      • Heartbeat Packet
      • Logout
    • API interface example
      • Extension
        • Query Extension List
        • Query Extension Settings
        • Add an Extension
        • Modify an Extension
        • Delete an Extension
      • Trunk
        • Query Trunk List
        • Query SIP Trunk Settings
        • Add a SIP Trunk
        • Edit a SIP Trunk
        • Delete a SIP Trunk
      • Inbound Route
        • Query Inbound Route Settings
        • Add Inbound Route
        • Edit an Inboud Route
        • Delete an Inbound Route
      • Outbound Route
        • Query Outbound Route Settings
        • Add Outbound Route
        • Edit an Outbound Route
        • Delete an Outbound Route
      • Conference Room
        • Query Conference Room Settings
        • Query Ongoing Conference
        • Modify meeting room
        • Invite meeting room members
        • Kick out conference room member
        • Mute meeting room members
        • Unmute meeting room members
      • IVR (Interactive Voice Response)
        • Query IVR Settings
        • Edit an IVR
      • Queues
        • Query Queue Settings
        • Edit a Queue
        • Query Queue Status
        • Log in a Queue
        • Log out a Queue
        • Pause an Agent
        • Resume an Agent
      • Paging Group
        • Query Paging Group List
        • Query Paging Group Settings
        • Add a Paging Group
        • Edit a Paging Group
        • Delete a Paging Group
      • Query PBX Information
      • Audio Calls
        • Query Inbound Calls
        • Query Outbound Calls
        • Make an Internal Call
        • Make an Outbound Call
        • Disconnect an Extension’s Call
        • Disconnect an Inbound Call
        • Disconnect an Outbound Call
        • Hold a Call
        • Resume a Held Call
        • Mute an Extension
        • Unmute an Extension
        • Whisper Monitor
        • Barge-in Monitor
      • Play Prompts
        • Play Prompt to Extension
        • Play Prompt to External Number
      • Voicemails
        • Query Voicemail Files
        • Delete Voicemail Files
        • Download Voicemail Files
      • Download Recording Files
      • Download CDR Files
      • Hotel application
        • Add an Alarm
        • Query an Alarm
        • Edit an Alarm
        • Delete an Alarm
        • Hotel Check Out
    • API Reports Examples
      • ‘System Startup’ Report
      • ‘Changed Extension Status’ Report
      • ‘Ringing’ & ‘Ring Back’ Report
      • ‘Answer a Call’ Report
      • ‘Call Answered’ Report
      • ‘Call Released’ Report
      • ‘Call Transfer’ Report
      • ‘Call Failure’ Report
      • CDR Reports
  • folder icon closed folder iconSecurity Guide
    • PBX Service Security
    • Network Security
    • Web Access Security
    • Extension Security
    • Trunk Security
    • Firewall Rules
      • Examples of Firewall Rules
    • IP Auto Defense
    • Contingency Plan
  • folder icon closed folder iconFAQ
    • Troubleshooting of UC Series IPPBX Kit
  • folder icon closed folder iconSolution & Interoperability
  • folder icon closed folder iconReferences
    • Parameters of Import Files
      • Import Parameters – Extensions
      • Import Parameters – Trunks
      • Import Parameters – Inbound Routes
      • Import Parameters – Outbound Routes
      • Import Parameters – Firewall Rules
      • Import Parameters – Blocklist/Allowlist
      • Import Parameters – Speed Dial
      • Import Parameters – Hotel Customers
      • Import Parameters – Phonebook
loading
Popular Searches
  • VoIP
  • Gateway
  • IPPBX
  1. Home
  2. Docs
  3. UC Series IP PBX
  4. API Documentation
  5. API interface example
  6. Queues
  7. Query Queue Settings
Updated on March 15, 2022

UC Series IP PBX

  • folder icon closed folder iconRelease Notes
    • OpenVox IPPBX System Version 4.3.6
    • OpenVox IPPBX System Version 4.3.5
    • OpenVox IPPBX System Version 4.3.3
    • OpenVox IPPBX System Version 4.2.0
    • OpenVox IPPBX System Version 4.1.0
    • OpenVox IPPBX System Version 3.2.4
    • OpenVox IPPBX System Version 2.5.5
    • OpenVox IPPBX System Version 1.6.3
    • OpenVox IPPBX System Version 1.1.0
  • folder icon closed folder iconGetting Started Guide
    • Initial System Setup
      • Language
      • Set Date and Time
      • Change the System Prompt
    • Set up Extensions
      • Create Extensions in batch
      • Upload Extensions
    • Set up Your Phone
    • Set up VoIP Trunks
      • Create a VoIP Peer Trunk
      • Create a VoIP Register Trunk
    • Receive Inbound Calls
    • Make Outbound Calls
  • folder icon closed folder iconInstallation Guide
    • Hardware Overview
      • UC300 Overview
      • UC500 Overview
      • UC501 Overview
      • Module Accessories
    • Install PBX
      • Installation Warnings
      • Package Contents
      • Install OpenVox UC501
    • Connect Your IPPBX
  • folder icon closed folder iconAdmin Guide
    • Contacts
    • Extensions
      • Extension Overview
      • Extension Basic Setup
        • Create Extensions
          • Extension Creation Overview
          • Create a SIP Extension
          • Create an IAX Extension
          • Create an FXS Extension
          • Bulk Create Extensions
        • Register Extensions
          • Register a SIP Extension
          • Register an IAX Extension
          • Register a Remote Extension
        • Manage Extensions
          • Edit Extensions
          • Bulk Edit Extension Names and Emails
          • Delete Extensions
          • Import/Export Extensions
      • Extension Groups
        • Create an Ring Groups
      • Presence
      • Voicemail
        • Delete Voicemail Files
        • Mobility Extension
      • Call Monitoring
        • Call Monitoring Overview
        • Configure Call Monitoring
      • Call Permission
        • Set Call Permission of an Extension
      • Extension Settings
        • SIP Extension Settings
        • IAX Extension Settings
        • FXS Extension Settings
    • Trunks
      • Trunk Overview
      • VoIP Trunks
      • PSTN Trunks
        • PSTN Trunk Introduction
        • Create a PSTN Trunk
        • PSTN Trunk Settings
    • Call Recording
    • PBX Monitor
    • Network
      • Basic Network
        • Basic Network Overview
        • Configure Static IP Address
        • Obtain an IP Address from a DHCP Server
      • VLAN
        • VLAN Overview
        • Configure VLAN on UC-Series VoIP PBX
      • OpenVPN Client
        • OpenVPN Client Overview
        • Connect UC-Series VoIP PBX to OpenVPN Server
      • DDNS
        • DDNS Overview
        • Set up No-IP DDNS on UC-Series VoIP PBX
      • Port Forwarding
      • NAT
        • NAT Overview
        • Set NAT with External IP Address
        • Set NAT with External Host
        • Set NAT with STUN
      • Static Route
        • Static Route Overview
        • System Route Entries
        • Add a Static Route
        • Manage the Static Routes
        • Dedicated SIP Trunking on UC-Series VoIP PBX
    • Voice Prompts
      • System Prompt
        • Change System Prompt
        • Customize System Prompt
        • Change an Extension’s Prompt
      • Music on Hold (MoH)
        • Add a Custom MoH Playlist with Local Audio Files
      • Custom Prompt
        • Requirements of Custom Audio Files
        • Upload a Custom Prompt
        • Record a Custom Prompt
        • Play a Custom Prompt
        • Convert Audio Files Online
    • Call Control
      • Emergency Calling
      • Time Conditions
        • Time Conditions Overview
        • Set Time Conditions
        • Manage Time Conditions
        • Time Condition Examples
        • Time Condition Override
        • Monitor Time Condition State
      • Inbound Routes
        • Inbound Route Overview
        • Add an Inbound Route
        • Manage Inbound Routes
      • Outbound Routes
        • Outbound Route Overview
        • Dial Patterns of Outbound Route
        • Add an Outbound Route
        • Outbound Route Examples
      • Outbound Restriction
        • Outbound Restriction Overview
        • Add a Rule to Restrict Outbound Calls
        • Manage Outbound Restriction Rules
      • AutoCLIP Routes
        • AutoCLIP Overview
        • Calls to Original Extensions
        • Configure AutoCLIP to Route Inbound
    • System Management
      • System General Settings
        • System Preference
        • Feature Code
        • SIP Settings
        • IAX Settings
      • Security
      • User Permission
        • Configure User Permission
      • Date/Time
      • Email
      • Storage
        • Add a Windows Network Drive
      • Event Center
      • Hot Standby
      • Cloud Management
      • API
    • Call Feature
      • Queue
        • Add a Queue
      • Backup and Restore
        • Create a Backup File
        • Restore a Backup File
      • FAX
      • PIN Sets
      • Speed Dial
      • Conference
        • Join a Conference
        • Add a Conference
      • DISA
        • Set up DISA
      • IVR
        • Set up an IVR
        • Dial by Name
        • Change IVR Prompt Clip
        • Forward Incoming Calls to an External Number with IVR
      • Ring Group
        • Add a Ring Group
      • Callback
      • Intercom/Paging
        • Set up 1-Way Paging
        • Set up 2-Way Intercom
      • Call Transfer
        • Attended Transfer
        • Blind Transfer
      • Set up Callback
      • Call Parking
        • Configure Call Parking Caller ID
    • Maintenance
      • Upgrade Firmware
      • Backup and Restore
      • Reboot the PBX
      • Reset the PBX
      • Troubleshooting
        • Monitor Physical Port
        • Ping IP Address
        • Traceroute
        • Access the PBX via SSH
        • Capture Ethernet Packets
    • Resource Monitor and System Information
    • PBX Service Security
  • folder icon closed folder iconFunctions Guide
    • Auto Provision
      • Supported IP Phone Manufactures and Phone Models
      • Auto Provision Phones by PnP Method
      • Update Auto Provision Settings
      • Synchronize Phone Time with the PBX
      • Auto provision phones by Static Provisioning Server
    • Direct Inward Dialing (DID)
    • Conference Pannel
      • Manage Conference Contacts
      • Conference List
      • Dial-in Conferencing
      • Dial-out Conferencing
      • Control Online Conferences
    • Hotel
      • Hotel System Settings
        • Hotel General Settings
        • Call Rate Settings
        • Mini Bar Settings
        • Hotel Email Template
      • Room Management
        • Add Room Types
        • Add a Room
        • Add Bulk Rooms
        • Room Settings
      • Use Hotel App
        • Access Rooms Information
        • Book Rooms
        • Check In
        • Group Rooms
        • Change Room
        • Check Out
        • Billing Report
        • Guests Management
        • Wake up
        • Remote Action Control
    • LDAP Server
      • LDAP Overview
      • LDAP Server Configurations
        • Configure LDAP Server
      • LDAP Phonebook
        • Default LDAP Phonebook
        • Add an LDAP Phonebook
        • Manage an LDAP Phonebook
        • Export/Import an LDAP Phonebook
      • LDAP Client Configuration Examples
        • LDAP Configurations on Fanvil Phone
        • LDAP Configurations on Yealink Phone
        • LDAP Configurations on Htek Phone
        • LDAP Configurations on Cisco SPA Phone
        • LDAP Configurations on Grandstream Phone
        • LDAP Configurations on Snom Phone
        • LDAP Configurations on Zoiper Softphone
    • Billing
      • How to Configure A2billing with OpenVox UC Series IPPBX
    • VPN Client
      • OpenVPN
        • OpenVPN Certificates and Keys
          • Install OpenVPN on Windows
          • Generate OpenVPN Certificates and Keys
          • Check the Generated OpenVPN Certificates and Keys
        • OpenVPN Clients Configurations
          • Connect to OpenVox UC-Series VoIP PBX with Windows
            • Create a Client File for Windows Client
            • Connect Windows PC to OpenVox UC-Series VoIP PBX via OpenVPN
        • Check the Client Status
      • N2N
      • L2TP
        • Copy of Install on Windows and Initial Configurations
        • Connect Windows PC to OpenVox UC-Series VoIP PBX via L2TP
      • SSTP
        • Install on Windows and Initial Configurations
        • Connect Windows PC to OpenVox UC-Series VoIP PBX via SSTP
  • folder icon closed folder iconCompatible SIP Endpoints
    • Compatible SIP Endpoints
  • folder icon closed folder iconUser Manual
    • UC Series IP Phone System
      • UC Series User Manual(For Version 2.0)
      • UC Series User Manual(For Version 4.0)
  • folder icon closed folder iconAPI Documentation
    • API Authentication
      • Login
      • Heartbeat Packet
      • Logout
    • API interface example
      • Extension
        • Query Extension List
        • Query Extension Settings
        • Add an Extension
        • Modify an Extension
        • Delete an Extension
      • Trunk
        • Query Trunk List
        • Query SIP Trunk Settings
        • Add a SIP Trunk
        • Edit a SIP Trunk
        • Delete a SIP Trunk
      • Inbound Route
        • Query Inbound Route Settings
        • Add Inbound Route
        • Edit an Inboud Route
        • Delete an Inbound Route
      • Outbound Route
        • Query Outbound Route Settings
        • Add Outbound Route
        • Edit an Outbound Route
        • Delete an Outbound Route
      • Conference Room
        • Query Conference Room Settings
        • Query Ongoing Conference
        • Modify meeting room
        • Invite meeting room members
        • Kick out conference room member
        • Mute meeting room members
        • Unmute meeting room members
      • IVR (Interactive Voice Response)
        • Query IVR Settings
        • Edit an IVR
      • Queues
        • Query Queue Settings
        • Edit a Queue
        • Query Queue Status
        • Log in a Queue
        • Log out a Queue
        • Pause an Agent
        • Resume an Agent
      • Paging Group
        • Query Paging Group List
        • Query Paging Group Settings
        • Add a Paging Group
        • Edit a Paging Group
        • Delete a Paging Group
      • Query PBX Information
      • Audio Calls
        • Query Inbound Calls
        • Query Outbound Calls
        • Make an Internal Call
        • Make an Outbound Call
        • Disconnect an Extension’s Call
        • Disconnect an Inbound Call
        • Disconnect an Outbound Call
        • Hold a Call
        • Resume a Held Call
        • Mute an Extension
        • Unmute an Extension
        • Whisper Monitor
        • Barge-in Monitor
      • Play Prompts
        • Play Prompt to Extension
        • Play Prompt to External Number
      • Voicemails
        • Query Voicemail Files
        • Delete Voicemail Files
        • Download Voicemail Files
      • Download Recording Files
      • Download CDR Files
      • Hotel application
        • Add an Alarm
        • Query an Alarm
        • Edit an Alarm
        • Delete an Alarm
        • Hotel Check Out
    • API Reports Examples
      • ‘System Startup’ Report
      • ‘Changed Extension Status’ Report
      • ‘Ringing’ & ‘Ring Back’ Report
      • ‘Answer a Call’ Report
      • ‘Call Answered’ Report
      • ‘Call Released’ Report
      • ‘Call Transfer’ Report
      • ‘Call Failure’ Report
      • CDR Reports
  • folder icon closed folder iconSecurity Guide
    • PBX Service Security
    • Network Security
    • Web Access Security
    • Extension Security
    • Trunk Security
    • Firewall Rules
      • Examples of Firewall Rules
    • IP Auto Defense
    • Contingency Plan
  • folder icon closed folder iconFAQ
    • Troubleshooting of UC Series IPPBX Kit
  • folder icon closed folder iconSolution & Interoperability
  • folder icon closed folder iconReferences
    • Parameters of Import Files
      • Import Parameters – Extensions
      • Import Parameters – Trunks
      • Import Parameters – Inbound Routes
      • Import Parameters – Outbound Routes
      • Import Parameters – Firewall Rules
      • Import Parameters – Blocklist/Allowlist
      • Import Parameters – Speed Dial
      • Import Parameters – Hotel Customers
      • Import Parameters – Phonebook

Query Queue Settings

Estimated reading: 4 minutes 128 views

Query detailed information of one or more queues, like queue number, queue name, static agents, dynamic agents, etc.

Endpoint

POST /api/v1.1.0/queue/query?token={token}&type={type}

Request Parameters

Name Importance Type Description
queueid Optional String The Queue number.

  • Query a Queue: Set queueid to the Queue number.

Example: “queueid”:”6700″

  • Query multiple Queues: Set queueid to the Queue number. Separate multiple Queues with ,.

Example: “queueid”: “6700,6701,6702”

  • Query all Queues: Do not send queueid parameter.

Response Parameters

Name Type Description
queues Object Object.
queuenumber Int The queue number.
queuename String The queue name.
password String The password to join dynamic agent.
ringstrategy String The ring strategy.

  • Ring All
  • Least Recent
  • Fewest Calls
  • Random
  • Rrmemory
  • Linear
agents String Static agents.
dynamicagents String Dynamic agents.
agenttimeout String The agent timeout.
agentannounce String The agent announcement.
wrapuptime Int The wrap-up time.
retry Int The number of seconds to wait before trying all the phones again.
musiconhold String The on-hold music.
maxwaittime Int The caller max wait time.
joinempty String Allow callers to join a queue that has no agents.

  • on: enable
  • off: disable
leavewhenempty String Callers already on hold will be forced out of a queue when no agents are available.

  • on: enable
  • off: disable
announcepos String Announce position of caller in the queue.

  • on: enable
  • off: disable
announcefreq String How often to announce queue position and estimated hold time.
announceholdtime Int Announce the hold time to the caller periodically.

Examples

Request Example

Query Queue 9999, 9998.

POST /api/v0.0.1/queue/query?token=813b621cfe8eecf445a2ce1f4a079ffe&type=json HTTP/1.1

Content-Type:application/json; charset=utf-8

Host: 172.16.6.150

{

“queueid”: “9999,9998”

}

POST /api/v0.0.1/queue/query?token=813b621cfe8eecf445a2ce1f4a079ffe&type=xml HTTP/1.1

Content-Type:application/json; charset=utf-8

Host: 172.16.6.150

<?xml version=”1.0″ encoding=”UTF-8″ ?>

<xml>

<queueid>9999,9998</queueid>

</xml>

Query all Queues.

POST /api/v0.0.1/queue/query?token=813b621cfe8eecf445a2ce1f4a079ffe HTTP/1.1

Content-Type:application/json; charset=utf-8

Host: 172.16.6.150

Response Example

HTTP/1.1 200 OK

Access-control-allow-origin: *

Access-control-allow-methods: GET, POST, OPTIONS, PUT, DELETE

{

“status”: “Success”,

“queues”: [

{

“queuenumber”: “9998”,

“queuename”: “queue_xiaoshao”,

“password”: “666666”,

“agents”: “101”,

“announcefreq”: “300”,

“announceholdtime”: “off”,

“announcepos”: “off”,

“joinempty”: “on”,

“leavewhenempty”: “off”,

“retry”: “10”,

“ringstrategy”: “Ring All”,

“agenttimeout”: “20”,

“wrapuptime”: “10”,

“dynamicagents”: “6000”,

“agentannounce”: “”,

“musiconhold”: “Inherit”,

“maxwaittime”: “600”

},

{

“queuenumber”: “9999”,

“queuename”: “queue_test”,

“password”: “123456”,

“agents”: “101,103,104”,

“announcefreq”: “0”,

“announceholdtime”: “off”,

“announcepos”: “off”,

“joinempty”: “on”,

“leavewhenempty”: “off”,

“retry”: “5”,

“ringstrategy”: “Ring All”,

“agenttimeout”: “15”,

“wrapuptime”: “60”,

“dynamicagents”: “”,

“agentannounce”: “”,

“musiconhold”: “Inherit”,

“maxwaittime”: “5”

}

]

}

HTTP/1.1 200 OK

Access-control-allow-origin: *

Access-control-allow-methods: GET, POST, OPTIONS, PUT, DELETE

<?xml version=”1.0″ encoding=”utf-8″?>

<xml>

<status>Success</status>

<queues>

<item id=”0″>

<queuenumber>9998</queuenumber>

<queuename>queue_xiaoshao</queuename>

<password>666666</password>

<agents>101</agents>

<announcefreq>300</announcefreq>

<announceholdtime>off</announceholdtime>

<announcepos>off</announcepos>

<joinempty>on</joinempty>

<leavewhenempty>off</leavewhenempty>

<retry>10</retry>

<ringstrategy>Ring All</ringstrategy>

<agenttimeout>20</agenttimeout>

<wrapuptime>10</wrapuptime>

<dynamicagents>6000</dynamicagents>

<agentannounce></agentannounce>

<musiconhold>Inherit</musiconhold>

<maxwaittime>600</maxwaittime>

</item>

<item id=”1″>

<queuenumber>9999</queuenumber>

<queuename>queue_test</queuename>

<password>123456</password>

<agents>101,103,104</agents>

<announcefreq>0</announcefreq>

<announceholdtime>off</announceholdtime>

<announcepos>off</announcepos>

<joinempty>on</joinempty>

<leavewhenempty>off</leavewhenempty>

<retry>5</retry>

<ringstrategy>Ring All</ringstrategy>

<agenttimeout>15</agenttimeout>

<wrapuptime>60</wrapuptime>

<dynamicagents></dynamicagents>

<agentannounce></agentannounce>

<musiconhold>Inherit</musiconhold>

<maxwaittime>5</maxwaittime>

</item>

</queues>

</xml>

Still stuck? How can we help?

Was this page helpful? Yes No

How can we help?

A premium WordPress theme with integrated Knowledge Base,
providing 24/7 community based support.

Leave a Comment Cancel reply

CONTENTS

Copyright © 2002-2022 OpenVox all rights reserved.