Polls the current connection status of an active or recently initiated chat session

Open in ChatGPT Open in ChatGPT to ask questions about this page
Open in Claude Open in Claude to ask questions about this page
Copy as MarkdownCopy this page as markdown to use with AI assistants
View as Markdown Open this page as markdown in a new tab

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

Tools.READCopied!

Header

Authorization: d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Request Headers

AcceptstringMandatory
application/jsonapplication/jsonCopied!

- Path Parameters

sessionIdstringMandatory

The unique identifier of the session

Sample Request

Curl
Java
Python
Deluge
PowerShell
Copied!
curl --request GET \
  --url https://appdomain/dcapi/tools/chat/{sessionId}/chatStatus \
  --header 'Accept: application/json' \
  --header 'Authorization:  d92d4xxxxxxxxxxxxx15f52'

Response Parameters

- HTTP code 200

Response Body - application/json
JSON Object
Hide Sub-Attributes
sessionIdlong

Unique identifier of the chat session

connectionStatusstring

Current connection state: connected, disconnected, or pending

agentStatusstring

Agent availability status: active or inactive

Possible Response Codes

200HTTP code

Sample Response: HTTP 200

Copied!
  {
    "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.