Session

This API allows you to create remote support.

Required OAuth scope
This API can be accessed with the OAuth scope: ZohoLens.sessionapi.CREATE

Create a session

ParametersDescription
department_id

Department ID of the technician (Can be taken from user API)

Note:

To construct the technician URL = {Lens URL} + {technician_url}

Example

  • technician_url - /lens-viewer?x-com-zoho-lens-orgid=875096689&key=568020403
  • When custom domain is enabled - https://lens.zylker.com/lens-viewer?x-com-zoho-lens-orgid=875096689&key=568020403

POST /session

Copied
$ curl https://lens.zoho.com/api/v2/lens_session
-X POST
-H "Content-Type: application/x-www-form-urlencoded;charset=UTF-8"
-H "Authorization: Zoho-oauthtoken ba4604e8e433g9c892e360d53463oec5"
-d 'department_id=969371001';
Copied

HTTP/1.1 200 OK
For Remote Support,
Content-Type:application/json;charset=UTF-8

{

   "representation": {

       "technician_url": "/lens-viewer?x-com-zoho-lens-orgid=803220518&key=783201119"

   },

   "resource_type": "/api/v2/session/lens"