IMsupporting Live Chat API
An easy way to access your information and modify system settings.
Live Chat API
The IMSupporting API is a new platform that enables you to control and retrieve data from / to the chat platform itself.
To use the API you will need a SITEID and the APIKEY assigned to your account. Please contact us for an API key. ( support@imsupporting.com )
The API is a JSONbased API. All results are returned in a JSON format. Data posted to our platform is sent with a simple key=value pair, results are returned in a JSON format
To request data from the API.
You need to send the following via an HTTP-GET Request
- SiteID
- Your API Key
- The Command to Run
Below is an example request using CURL from the command line.
Your scripts can call this via your own method of choice.
The following commands (cmd=) are available to you using the HTTP ‘GET’ Method.
GetLiveVisitorList
Returns a numbered JSON formatted list of recent and live visitors to your website.
Example Data:
“websiteVisitor”: {
“0”: {
“paCurPage”: “https://www.imsupporting.com/api/”,
“paID”: “4957815”,
“paLastSeen”: “2017-10-17 19:16:49”,
“paOnline”: “1”,
“paOnlineInfo”: “This tells us if the end user is pinging us via the popup.js script. This means we can send them a direct message if needed”,
“paRings”: “5”,
“visCountry”: “GB”,
“visIsInChatNameIs”: “None”,
“visIsInChatWithAdmin”: “None”,
“visLandingPage”: “https://www.imsupporting.com/api/”,
“visPingTime”: “0000-00-00 00:00:00”,
“visRefPage”: “https://www.imsupporting.com/”,
“visTown”: “Wigan”,
“visUA”: “Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/69.0.3497.100 Safari/537.36”,
“visUserState”: “Online”,
“visipAddr”: “80.192.137.xxx”,
“vistime”: “2018-10-17 19:16:29”
},
heartBeat
Tells the system that your account has been used. — Marks the time that you last used the account to “Now”
You will receive an OK via JSON if it worked. ( “rescode”: “200” )
GetStaffOnlineNum
Returns the number of operators / staff online in your account.
GetVisitorNumNow
Returns the number of visitors on your website RIGHT NOW
GetChatStatus
Returns the chat status of the account ( 0 | 1 )
“result”: {
“onlinestatus”: “0”
},
GetAudioStatus
Returns if the Audio notification is enabled on the dashboard or not.
GetAutoStatus
Returns if the Automated Replies are enabled on the dashboard or not.
GetIdleStatus
Returns if the Idle Check is enabled on the dashboard or not.
If this enabled, the system will set you to “offline” if you dont answer a chat within a few minutes.
GetAllStats
Returns all of the above and any other basic stats.
(Now stats are added often)
GetWaitingChatNum
Returns the number of chats waiting for answer
GetChatNumToday
Returns the number of chats today so far (since midnight GMT)
GetVisitorNumToday
Returns the number of visitors today (Since midnight GMT)
GetNumOpenChats
Returns the number of open chats currently
GetNumWaitingChats
Returns the number of chats waiting to be answered
GetChatSessions
Returns a list of the chat sessions (Open and Waiting)
This will return a large amount of JSON if you have open chats.
The data here is essentially what appears in the main dashboard that shows all chats.
GetUnreadMessagesNum
Returns the number of unread offline messages.
GetUnreadMessagesNum
Returns the number of unread offline messages.
GetWaitingChatDetails
Returns details about the chats waiting for answer.