Suggestions

close search

Get online users

URL: https://api.stringee.com/v1/users

HTTP method: GET

Custom HTTP GET header: Name: X-STRINGEE-AUTH Value: JSON web token (JWT), see https://developer.stringee.com/docs/call-rest-api/call-rest-api-authentication

GET params:

Field	Type	Require	Description
page	Int	No	Default page=1
limit	Int	No	Default limit=100; max=100
attribute	String	No	User attribute
userId	String	No	userId

Sample request

a) Get users with default

GET https://api.stringee.com/v1/users
X-STRINGEE-AUTH: json_web_token

b) Get users with params

GET https://api.stringee.com/v1/users?agentStatus=available&page=1&limit=10
X-STRINGEE-AUTH: json_web_token

Sample response

{
    "count": 1,
    "pageSize": 1,
    "users": [{
        "loginTime": 1534736250475,
        "attributes": [{
            "attribute": "agentStatus",
            "value": "available"
        }, {
            "attribute": "call"
        }],
        "userId": "tient"
    }]
}