iFlyChat
  • Documentation
  • Installation
    • WordPress Chat Plugin
    • Drupal Chat Module
    • PHP Chat Client
  • WordPress
    • Embed Chatroom in WordPress Post
    • Disable Popup Chat
    • Hide Popup Chat from a Page
    • Embed Inbox View
    • View Chat Logs
    • Guest User Access
    • Show/Hide Popup Chat On Specific Pages
    • WordPress Filters and Hooks
  • API Reference
    • Create a new chat room
    • Retrieve list of all chat rooms
    • Edit a chat room
    • Retrieve list of all online users
    • Kick a user from the chat
    • Retrieve list of all users online in a chat room
    • Delete a chat room
    • Retrieve Thread History
  • JavaScript SDK
    • Quickstart
    • Custom Label In Chat Window
    • User Chat Button Widget
    • Reference
      • message receive
      • message send
      • user list update
      • connect
      • disconnect
      • ready
      • iflychat.startChat
      • iflychat.closeChat
      • iflychat.minimiseChat
      • iflychat.init
      • iflychat.setStatus
      • iflychat.sound
      • iflychat.openAdminDashboard
      • current user status update
      • current user sound update
      • iflychat.renderLabelInChatWindow
  • Help
    • General
      • Introduction
      • Accounts and Billing
      • Chat Theme and Colors
      • Chat Notification Sound
      • Going Offline
      • Change billing card information
    • Embedded Chatroom
      • Create a New Room
      • Create a New Embed Room
      • Embed Room in PHP
    • Feature Description
      • Moderated Chatroom
      • Group Chat
      • Private Embedded Chatroom
      • Change Guest Name
      • Resize Popup Chat Window
      • Mute Sound Notification
      • Change User Status
      • Desktop Notification
      • Popout or Full Screen Mode
      • Share Media Files
      • Video Chat
    • Chat Moderation
      • Kick/Ban/BanIP
      • Delete or Clear Messages
      • Popup Chat Position
      • Popup Chat Launcher Position
      • App Dashboard
      • Emoji Packs
      • Message Display Format
      • Time Display Format
      • Mobile Web Chat
      • Show Only Admins in Chat
      • Hide Recent Chats Section
      • Hide Users in Popup Chat List
      • Hide Popup Chat List
      • Minimize Popup Chat List
Powered by GitBook
On this page
  • Get list of all online users in the chat
  • Curl Command

Was this helpful?

  1. API Reference

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

Get 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 Body

Name
Type
Description

api_key

string

The private API key of your website

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

Curl Command

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\"}"
PreviousEdit a chat roomNextKick a user from the chat

Last updated 5 years ago

Was this helpful?