Unattended Session

This API allows you to create an unattended remote session.

POST /api/v2/unattended/{resource_id}/connect

OAuth Scope

ZohoAssist.unattended.device.CREATE

Path Params

Parameter
Data Type
Description
resource_id*
Long
Required
The resource id of the device with which the session is to be created.

Query Params

Parameters
Data Type
Description
department_id*
Long
Required
The department id in which the device is present.
osName
String
Allowed Values: Window|Linux
The OS name of the device.
Note: Applicable only for Windows and Linux OS.
user_id
Long
The user ID of logged on user.
User ID can be fetched from Unattended device details.
Note: Applicable only for Windows and Linux OS.

Create Unattended Session

Request Response

Copiedcurl --location --globoff --request POST 
'https://assist.zoho.com/api/v2/unattended/{resource_id}/connect?department_id={dept_id}&osName={os_name}&user_id={user_id}' \
--header 'Authorization: Zoho-oauthtoken {access_token}'

Copied{
    "representation": {
        "session_key": "60******",
        "authkey": "zEfh***************************",
        "authtype": "0",
        "viewerid": "-1",
        "is_user_present": true,
        "technician_uri": "https://assist.zoho.com/assist-start?key=60*******&department_id=21**************&x-com-zoho-assist-orgid=77*******&isCanvasSupported=true&viewer=html"
    },
    "resource_type": "/api/v2/unattended/*********/connect"
}