Terminates an active chat session for the specified computer

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

Disconnects the active chat session associated with the specified computer resource ID. Accepts a JSON body containing the session ID, chat initiator details, and identifiers for the chat session to be terminated.

Request URL

https://{serverurl}/dcapi/tools/chat/{resourceId}/disconnect

Scope

DesktopCentralCloud.Tools.UPDATECopied!

Header

Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Request Headers

Content-TypestringMandatory
application/disconnectChatInfo.v1+jsonapplication/disconnectChatInfo.v1+jsonCopied!

- Path Parameters

resourceIdstringMandatory

The unique identifier of the target device

- Request Body

application/json
JSON Object
Hide Sub-Attributes
sessionIDstringOptional
chatJoinedUserstringOptional
chatInitiatedFromRDSstringOptional
resourceTechIDParamstringOptional
annonIDstringOptional
chatIDstringOptional
cliqIDstringOptional
chatInitiatedBystringOptional

Sample Request

Curl
Java
Python
Deluge
PowerShell
Copied!
curl --request PUT \
  --url https://appdomains/dcapi/tools/chat/{resourceId}/disconnect \
  --header 'Authorization: Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52' \
  --header 'Content-Type: application/disconnectChatInfo.v1+json' \
  --data '{}'

Sample Request Body

Copied!
  {
    "chatInitiatedFromRDS": "false",
    "chatID": 12345,
    "chatInitiatedBy": "admin@corp.com",
    "annonID": "ann_01",
    "sessionID": 998877665544,
    "resourceTechIDParam": "tech_001",
    "chatJoinedUser": "john.doe",
    "cliqID": 67890
  }
                
Show full

Response Parameters

- HTTP code 200

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

Result of the operation: success or failure

Possible Response Codes

200HTTP code

Sample Response: HTTP 200

Copied!
  {
    "status": "success"
  }
                
Show full

Duration: 1 minute | Threshold: 30 | 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.