# Initiates a new text chat session with the specified computer

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.

## Endpoint

[POST /dcapi/tools/chat/{resourceId}/initiate](https://www.manageengine.com/products/desktop-central/help/api/onpremise/chat-initiate-chat.html)

## Request

### Request URL

```text
https://{server-hostname}:8383/dcapi/tools/chat/{resourceId}/initiate
```

### Scope

```text
Tools.READ
```

### Header

```text
Authorization: d92d4xxxxxxxxxxxxx15f52
```

### Request Parameters

#### Request Headers

- **Accept** `string` — Mandatory
  - `application/chatInitiationStatus.v1+json`

#### Path Parameters

- **resourceId** `string` — Mandatory
  - The unique identifier of the target device

#### Request Body

`application/json`

- `JSON Object`
  - **chatType** `string` — Optional
  - **chatInitiatedFrom** `string` — Optional
  - **initAgentFlag** `boolean` — Optional
  - **loggedOnUserName** `string` — Optional
  - **sessionID** `string` — Optional

### Sample Request

```curl
curl --request POST \
  --url https://appdomain/dcapi/tools/chat/{resourceId}/initiate \
  --header 'Accept: application/chatInitiationStatus.v1+json' \
  --header 'Authorization:  d92d4xxxxxxxxxxxxx15f52' \
  --header 'content-type: application/json' \
  --data '{"chatInitiatedFrom":"console","loggedOnUserName":"john.doe","sessionID":998877665544,"initAgentFlag":true,"chatType":1}'
```

### Sample Request Body

```json
{
  "chatInitiatedFrom": "console",
  "loggedOnUserName": "john.doe",
  "sessionID": 998877665544,
  "initAgentFlag": true,
  "chatType": 1
}
```

## Response

### Response Parameters

#### HTTP Code 200

Response Body — `application/json`

- `JSON Object`
  - **sessionId** `long`
    - Unique identifier of the initiated chat session
  - **techMemberID** `string`
    - Technician member ID in the chat session
  - **agentMemberID** `string`
    - Agent member ID on the remote computer
  - **loggedOnUser** `string`
    - Logged-on user on the remote computer
  - **connectionStatus** `string`
    - Session status: initiated, connected, failed

### Sample Response: HTTP 200

```json
{
  "agentMemberID": "agent_101",
  "loggedOnUser": "john.doe",
  "connectionStatus": "initiated",
  "techMemberID": "tech_001",
  "sessionId": 998877665544
}
```

### Possible Response Codes

- **200** `HTTP code`

## Rate Limits

![](https://www.zohowebstatic.com/sites/zweb/images/people/ico-help.png)

**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.