Initiates a new text chat session with 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

Starts a new text chat session with the specified computer. Returns session details including the session ID, client member IDs, the active logged-on user, and connection status. Requires the computer to be online and managed.

Request URL

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

Scope

DesktopCentralCloud.Tools.READCopied!

Header

Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Request Headers

AcceptstringMandatory
application/chatInitiationStatus.v1+jsonapplication/chatInitiationStatus.v1+jsonCopied!

- Path Parameters

resourceIdstringMandatory

The unique identifier of the target device

- Request Body

application/json
JSON Object
Hide Sub-Attributes
chatTypestringOptional
chatInitiatedFromstringOptional
initAgentFlagbooleanOptional
loggedOnUserNamestringOptional
sessionIDstringOptional

Sample Request

Curl
Java
Python
Deluge
PowerShell
Copied!
curl --request POST \
  --url https://appdomains/dcapi/tools/chat/{resourceId}/initiate \
  --header 'Accept: application/chatInitiationStatus.v1+json' \
  --header 'Authorization: Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52' \
  --header 'content-type: application/json' \
  --data '{}'

Sample Request Body

Copied!
  {
    "chatInitiatedFrom": "console",
    "loggedOnUserName": "john.doe",
    "sessionID": 998877665544,
    "initAgentFlag": true,
    "chatType": 1
  }
                
Show full

Response Parameters

- HTTP code 200

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

Unique identifier of the initiated chat session

techMemberIDstring

Technician member ID in the chat session

agentMemberIDstring

Agent member ID on the remote computer

loggedOnUserstring

Logged-on user on the remote computer

connectionStatusstring

Session status: initiated, connected, failed

Possible Response Codes

200HTTP code

Sample Response: HTTP 200

Copied!
  {
    "agentMemberID": "agent_101",
    "loggedOnUser": "john.doe",
    "connectionStatus": "initiated",
    "techMemberID": "tech_001",
    "sessionId": 998877665544
  }
                
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.