Search Specific Queues

Request URL

GET {base_url}/{api_path}/queue/search?access_token={access_token}

Request parameters

Response parameters

Queue_List

Parameter	Type	Description
id	Integer	The unique ID of the queue.
number	String	Queue number.
name	String	Queue name.
ring_strategy	String	The ring strategy of the queue. ring_all: Ring all available agents simultaneously until someone answers. least_recent: Ring the available agent that was least recently called. fewest_calls: Ring the available agent with the fewest completed calls. random: Ring the agents randomly. rrmemory: Round robin with memory. linear: Ring the available agent in specific order based on the type of agents in the queue.
client_unique_ringtone	String	The distinctive ringtone that will be played on agents' Linkus clients when they receive calls from this queue. Empty string: The system will use the ringtone set on the Linkus clients. Other value: The filename of the ringtone.
dynamic_agent_list	Array <Dynamic_Agent_List>	Information of dynamic agents.
static_agent_list	Array <Static_Agent_List>	Information of static agents.
manager_list	Array <Manager_List>	Information of queue managers.
enable_time_condition	Integer	Whether the time condition is enabled. 0: Disabled 1: Enabled
enb_play_holiday_prompt_global	Integer	Whether a prompt is played to callers before routing the inbound calls to the holiday destination. 0: Disabled 1: Enabled
holiday_dest	String	Holiday destination. end_call: Hang Up. extension: Extension. ext_vm: Extension Voicemail. group_vm: Group Voicemail. ivr: IVR. call_flow: Call Flow ring_group: Ring Group. queue: Queue. external_num: External Number. play_greeting: Play Prompt and Exit.
holiday_dest_prefix	String	This parameter returns different values depending on the destination type (holiday_dest). When the destination type is external_num, the parameter returns the dial-out prefix of the external number. When the destination type is play_greeting, the parameter returns the play count of the prompt.
holiday_dest_value	String	The destination value. This parameter returns different values depending on the destination type (holiday_dest). When the destination type is play_greeting, this parameter returns the custom prompt file name. E.g. demo.wav. When the destination type is extension, ext_vm, group_vm, ivr, call_flow, ring_group, or queue, this parameter returns the unique ID of the destination. For example, the destination is the extension 2002, then this parameter returns the extension ID 2. When the destination type is external_num, the parameter returns the external number.
ignore_holiday_dest	Integer	Whether the holiday destination is ignored.
outoffice_dest	String	Outside business hours destination. end_call: Hang Up. extension: Extension. ext_vm: Extension Voicemail. group_vm: Group Voicemail. ivr: IVR. call_flow: Call Flow ring_group: Ring Group. queue: Queue. external_num: External Number. play_greeting: Play Prompt and Exit.
outoffice_dest_prefix	String	This parameter returns different values depending on the destination type (outoffice_dest). When the destination type is external_num, the parameter returns the dial-out prefix of the external number. When the destination type is play_greeting, the parameter returns the play count of the prompt.
outoffice_dest_value	String	The destination value. This parameter returns different values depending on the destination type (outoffice_dest_prefix). When the destination type is play_greeting, this parameter returns the custom prompt file name. E.g. demo.wav. When the destination type is extension, ext_vm, group_vm, ivr, call_flow, ring_group, or queue, this parameter returns the unique ID of the destination. For example, the destination is the extension 2002, then this parameter returns the extension ID 2. When the destination type is external_num, the parameter returns the external number.
timezone_id	Integer	The ID of time zone.

Examples

Request example

Search for the queue with the number "6402".

GET /openapi/v1.0/queue/search?access_token=6lqF0qYlAOjWxa64DalBZwJ7mynMRKeD&search_value=6402 HTTP/1.1

Host: yeastardocs.example.yeastarcloud.com

HTTP/1.1 200 OK
{
    "errcode": 0,
    "errmsg": "SUCCESS",
    "total_number": 1,
    "queue_list": [
        {
            "id": 3,
            "number": "6402",
            "name": "Tech-support",
            "ring_strategy": "ring_all",
            "client_unique_ringtone": "example.wav",
            "dynamic_agent_list": [
                {
                    "text": "Leo Ball",
                    "text2": "1000",
                    "value": "73",
                    "type": "extension"
                },
                {
                    "text": "Phillip Huff",
                    "text2": "1001",
                    "value": "85",
                    "type": "extension"
                }
            ],
            "static_agent_list": [
                {
                    "text": "Madison Cooper",
                    "text2": "1004",
                    "value": "96",
                    "type": "extension"
                },
                {
                    "text": "Kevin Connor",
                    "text2": "1005",
                    "value": "97",
                    "type": "extension"
                },
                {
                    "text": "Kristin Hale",
                    "text2": "1006",
                    "value": "92",
                    "type": "extension"
                }
            ],
            "manager_list": [
                {
                    "text": "Leo Ball",
                    "text2": "1000",
                    "value": "73",
                    "type": "extension"
                }
            ]
        }
    ]
}