Polls the current connection status of an active or recently initiated chat session Returns the current connection state of the specified chat session. Accepts an optional 'userID' query parameter to scope the response. This is a polling endpoint with a higher throttle threshold.
Request URL https://{server-hostname}:8383/dcapi/tools/chat/{sessionId}/chatStatus
Scope
Header Authorization: d92d4xxxxxxxxxxxxx15f52
Request Parameters - Request Headers - Path Parameters sessionId string Mandatory
The unique identifier of the session
Curl
Java
Python
Deluge
PowerShell
Copied!
curl --request GET \
--url https://appdomain/dcapi/tools/chat/{sessionId}/chatStatus \
--header 'Accept: application/json' \
--header 'Authorization: d92d4xxxxxxxxxxxxx15f52'import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
import java.io.IOException;
import java.net.http.HttpTimeoutException;
public class Main {
public static void main(String[] args) {
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("https://appdomain/dcapi/tools/chat/{sessionId}/chatStatus"))
.header("Accept", "application/json")
.header("Authorization", " d92d4xxxxxxxxxxxxx15f52")
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
}
}
import http.client
conn = http.client.HTTPSConnection("appdomain")
headers = {
'Accept': "application/json",
'Authorization': " d92d4xxxxxxxxxxxxx15f52"
}
conn.request("GET", "/dcapi/tools/chat/{sessionId}/chatStatus", headers=headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
headersMap = Map();
headersMap.put("Accept", "application/json");
response = invokeUrl
[
url: "https://appDomain/dcapi/tools/chat/{sessionId}/chatStatus"
type: GET
headers: headersMap
connection: connection_name
]
info response;
$headers=@{}
$headers.Add("Accept", "application/json")
$headers.Add("Authorization", " d92d4xxxxxxxxxxxxx15f52")
$response = Invoke-WebRequest -Uri 'https://appdomain/dcapi/tools/chat/{sessionId}/chatStatus' -Method GET -Headers $headersResponse Parameters - HTTP code 200 Response Body - application/json JSON Object
Hide Sub-Attributes sessionId long
Unique identifier of the chat session
connectionStatus string
Current connection state: connected, disconnected, or pending
agentStatus string
Agent availability status: active or inactive
Possible Response Codes Sample Response: HTTP 200 {
"connectionStatus": "connected",
"sessionId": 998877665544,
"agentStatus": "active"
}
▼ Show full
Duration: 1 minute | Threshold: 60 | Lock period: 5 minutes
Duration - Time window for the threshold. Threshold - Number of API calls allowed within the specified duration. Lock Period - Wait time before consecutive API requests.
© 2026, Zoho Corporation Pvt. Ltd. All Rights Reserved.
© 2026, Zoho Corporation Pvt. Ltd. All Rights Reserved.