Suggestions

close search

Agent Management

Realtime agent

URL: https://api.stringeex.com/v1/agent/list

HTTP method: GET

Content-Type: application/json

Custom HTTP header: Name: X-STRINGEE-AUTH Value: JSON web token (JWT), see StringeeX API REST Authentication

GET params:

Field	Type	Required	Description
limit	Number	No	Default: 15
page	Number	No	Default: 1
online	Number	No	1 = Online, 0 = Not online
manual_status	Text	No	AVAIABLED | LUNCH BREAK | SHORT BREAK| NOT AVAILABLE| ACW

Sample request:

GET /v1/agent/list?page=1&limit=20 HTTP/1.1
Host: https://api.stringeex.com
X-STRINGEE-AUTH: json_web_token
Accept: application/json

Response:

{
    "r": "response_code",
    "msg": "response_message"
}

Field	Type	Required	Description
r	Number	Yes	r = 0 is success, other value is not success
msg	Text	Yes	The message of the response
data	Array	No	The data of the response

Sample response:

{
    "r": 0,
    "message": "Load agent(s) success",
    "data": {
        "totalCount": "3",
        "totalPages": 1,
        "currentPage": 1,
        "limit": 50,
        "accounts": [
            {
                "id": "ac_g3wwkjog1xjrxknz",
                "name": "Dau Ngoc Huy",
                "email": "[email protected]",
                "role": "admin",
                "manual_status": "AVAILABLE",
                "system_status": 1,
                "routing_type": 1
            }
        ]
    }
}

Get list agent online

URL: https://api.stringeex.com/v1/agent/listonline

HTTP method: GET

Content-Type: application/json

Custom HTTP header: Name: X-STRINGEE-AUTH Value: JSON web token (JWT), see StringeeX API REST Authentication

Sample response:

{
    "r": 0,
    "data": [
        {
            "id": "ac_v307fmglbbsd3u6r",
            "name": "Le Van Thang",
            "email": "[email protected]"
        },
        {
            "id": "ac_blxmbplvkxarvqjp",
            "name": "Dau Huy",
            "email": "[email protected]"
        }
    ],
    "message": "Load agent(s) success"
}