Query Queue Settings

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


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

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"

  • 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 number.
password String The password to join dynamic agent.
ringstrategy String The ring strategy.
  • Ring All
  • Least Recent
  • Fewest Calls
  • Random
  • Rrmemory
  • Linear
failoveraction String The failover destination.
agents String Static agents.
dynamicagents String Dynamic agents.
agenttimeout String The agent timeout.
agentannounce String The agent announcement.
wrapuptime Int The wrap-up time.
ringinuse String Ring the members whose device are known to be “in use”.
  • on: enable
  • off: disable
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
joinannounce String Announcement played to callers prior to joining the queue.
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.
userannounce String An periodic announcement.
userannouncefreq Int How often to play the periodic announcements.
breakoutkey String The breakout key.
breakoutaction String The breakout action.
breakoutdest String The breakout destination.
idannouncement String The file name of the prompt that announces the agent ID. It is "None" by default. Note: When querying one or more queues, this parameter is bound to return value(s).
satisfactionsurvey String The file name of the prompt for customer satisfaction survey. It is "None" by default. If it is not specified, the prompt will not be played.


Request Example

Query Queue 6701.

POST /api/v1.1.0/queue/query?token=1e3b3ebb6a974cb42ed31de5413df52d HTTP/1.1
Content-Type:application/json; charset=utf-8
Host: api.yeastarcloud.com
    "queueid": "6701"

Query all Queues.

POST /api/v1.1.0/queue/query?token=1e3b3ebb6a974cb42ed31de5413df52d HTTP/1.1
Content-Type:application/json; charset=utf-8
Host: api.yeastarcloud.com
Response Example
HTTP/1.1 200 OK
Access-control-allow-origin: *
Access-control-allow-methods: GET, POST, OPTIONS, PUT, DELETE
    "status": "Success",
    "queues": [
            "queuenumber": "6700",
            "password": "6700123",
            "queuename": "6700",
            "ringstrategy": "Ring All",
            "failoveraction": "Hang up",
            "agents": "103,102,",
      "ringinuse": "on",
            "retry": "10",
            "musiconhold": "[None]",
            "maxwaittime": "30",
            "joinempty": "on",
            "leavewhenempty": "on",
            "joinannounce": "[None]",
            "announcepos": "off",
            "announcefreq": "15",
            "announceholdtime": "on",
            "userannounce": "[None]",
            "userannouncefreq": "60",
            "breakoutkey": "0",
            "breakoutaction": "Hang up",
            "satisfactionsurvey": "None",
            "idannouncement": "Default"