Retrieve list of all online users
Learn how to retrieve the list of all online users in the chat on your website using iFlyChat REST API
postGet list of all online users in the chat
post
https://api.iflychat.com/api/1.1/users/list
You can use iFlyChat API to programmatically get the list of all online users in the chat on your website
Request
Response
Request
Body Parameters
api_key
required
string
The private API key of your website
Response
200: OK
The response will contain
user_id, user_role, user_name, user_status, user_avatar_url and user_profile_url of all online users on your website. It also contains the total number of users online.{"users": [{"user_id": "1","user_role": "admin","user_name": "shashwat","user_status": "1","user_avatar_url": "/sites/default/files/styles/thumbnail/public/pictures/picture-1-1427288050.jpg?itok=glXtBjnp","user_profile_url": "javascript:void(0)"},{"user_id": "2","user_role": "admin","user_name": "shubham","user_status": "1","user_avatar_url": "/sites/all/modules/drupalchat/themes/light/images/default_avatar.png","user_profile_url": "javascript:void(0)"},],"length": 2}
This the sample curl command required to make HTTP request:
curl -H "Content-Type: application/json" -X POST https://api.iflychat.com/api/1.1/users/list -d "{\"api_key\":\"Wr4vpoJ_ET3lpBdX9E9TutUic4Dgb-gc7RGzuZvKqZgW5\"}"