Query Call Skills Group Information Interface Description

1.Interface Introduction

This interface is mainly used to query information about all skillsets under the account, including agents in skillsets, skillset names, skillset numbers, etc.

2.Interface request

• HTTP request method：POST

• Request url：{HOST}/v20160818/queue/queryQueue/accountId?sig=SIG

• When requesting, please replace {HOST} with connection data queryDomain name,ACCOUNTID is replaced with the account number, SIG is generated according to the authentication rules, please see the authentication document to see the specific generation rules.

• Authentication method: Interface Authentication

3.The interface parameters are as follows:

Request parameters:

Field	Type	Is necessary	Remark
password	String	yes	The password used by the account administrator to log in to the User Center

Request body example

{
  “password”:”123456",
}

4.System returns

Field	Meaning
code	Response code
message	Response message
data	Return data, JSON format

data:

Field	Meaning
DisplayName	Name of the skillset
Strategy	Answering Strategies for Skill Groups rrmemory-turn, random-random, fewestcalls-least answer
SayExten	Whether to enable broadcast work ID
JoinEmpty	No idle agent flows immediately 1 Yes 0 No
BussinessTypeId	Incoming call screen id, if empty, the system default screen
WaitTime	Waiting time
Timeout	Ringing duration
ToPeerTypeWhenQueueEmpty	Skill Group Steering: system-system: node ivr_node_queue: skill group account_user: agent ivr_node_announcement :play voice node ivr_node_text_announcement :Play text speech node ivr_node_ivr :Button menu node ivr_node_encrypt_md5 :MD5 crypto node ivr_node_validation :Acquisition input node ivr_node_assignment :Assignment node ivr_node_route :Routing nodes by variable ivr_node_ivr_menu :Go to ivr menu node ivr_node_call_url calurl:node ivr_node_voice_mail :Message node ivr_node_room :Conference room node ivr_node_satisfaction :Custom satisfaction node ivr_node_superDialJobNum :Sampling the job number and dialing the node ivr_node_extension_peer :Custom node
ToPeerWhenQueueEmpty	Specific node operation IDs such as 0-on-hook, 1 satisfaction survey in system, 2-dial work number
ToPeerTypeWhenWait	Steering while waiting: same value as ToPeerTypeWhenQueueEmpty
ToPeerWhenWait	Specific node operation IDs such as 0-on-hook, 1 satisfaction survey in system, 2-dial work number
ToPeerTypeWhenWaitTimeout	Wait for timeout to turn: same value as ToPeerTypeWhenQueueEmpty
ToPeerWhenWaitTimeout	Specific node operation IDs such as 0-on-hook, 1 satisfaction survey in system, 2-dial work number
ToPeerTypeWhenHanguped	Steering after a call: Same value as ToPeerTypeWhenQueueEmpty
ToPeerWhenHanguped	Specific node operation IDs such as 0-on-hook, 1 satisfaction survey in system, 2-dial work number
Account	The account ID is the same as the AccountId passed by the calling interface
PBX	PBX
Exten	Skill group number
AssignMembers.agentID	Agent ID assigned
AssignMembers.penalty	Agent priority
AssignMembers.agentName	Agent name
AssignMembers.agentExten	Agent number
Members	ID string of assigned agent (don't return)
UpdateTime	Skill group information update time
AgentExtenPoint	Whether to enable the prompt tone after the report number
SayQueuePosition	Interval of broadcast queue position

code:

Code	Meaning
200	Request succeeded
400	Request body parameter error
403	Incorrect authentication parameters
500	服务器错误

Returns 200 examples:

{
"code": 200,
"message": "200 ok",
"data": [
    {
        "DisplayName": "ncn",
        "Strategy": "rrmemory",
        "SayExten": false,
        "JoinEmpty": "0",
        "BussinessTypeId": "",
        "WaitTime": "120",
        "Timeout": "30",
        "ToPeerTypeWhenQueueEmpty": "system",
        "ToPeerWhenQueueEmpty": "0",
        "ToPeerTypeWhenWait": "system",
        "ToPeerWhenWait": "0",
        "ToPeerTypeWhenWaitTimeout": "system",
        "ToPeerWhenWaitTimeout": "0",
        "ToPeerTypeWhenHanguped": "system",
        "ToPeerWhenHanguped": "0",
        "Account": "N00000000103",
        "PBX": "bj.ali.7.7",
        "Exten": "10011860",
        "AssignMembers": [
            {
                "agentID": "caaa9680-5e0a-11e6-a2c4-65eaf15cb8fd",
                "penalty": "0",
                "agentExten": "4567",
                "agentName": "4567"
            }
        ],
        "Members": "caaa9680-5e0a-11e6-a2c4-65eaf15cb8fd:0",
        "UpdateTime": "2016-08-09",
        "AgentExtenPoint": false,
        "SayQueuePosition": "0"
    }
]

}

Returns 210 examples:

{
    "code": 210,
    "message": "account or password incorrect"
}

Returns 400 examples:

{
    "code": 400,
    "message": "Please check your parameters"
}

Returns 403 examples:

{
    "code": 403,
    "message": "Forbidden"
}

Returns 500 examples:

{
    "code": 500,
    "message": "Internal Server Error"
}