Query Agent Status Interface Description

1.Interface Introduction

Query the call status, login status and custom status of a specified agent

2.Interface request

• HTTP request method：POST

• Request url：{HOST}/v20160818/user/queryUserState/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 document: Interface Authentication

• Frequency limit: 100 times / minute

3.The interface parameters are as follows

Field	Type	Is necessary	Remark
exten	String	yes	Seat number, generally 8000, 8001, 8002, etc.

Request body example

{
    "exten":"8000"
}

4.System returns

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

data:

flag	Status tag value signout：Check out Reserve：Answer offline signoutcalling：On call and agent is checked out 0：idle 1：busy 2：Short break 99：Calling 3-9：Custom status
state	status

code：

Code	meaning
200	Request succeeded
210	Agent does not exist
400	Request body parameter error
403	Incorrect authentication parameters
500	Server Error

Returns 200 examples:

{
    "code": 200,
    "data": {
        "flag": "signout",
        "state": "Check out"
    }
}

Returns 210 examples:

{
    "code": 210,
    "message": "user not exist"
}

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"
}