Create Session

This API allows you to create remote assistance session and update the session title.

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)

 titleTitle for the remote assistance session that is being created

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

 

Sample Request

Copied$ curl --location --request POST 'https://lens.zoho.com/api/v2/lens_session?department_id={department_id&title={On Demand Lens Session} \--header 'Authorization: Zoho-oauthtoken {access_token}'

Sample Response

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

{
    "representation": {
        "technician_url": "/lens-viewer?x-com-zoho-lens-orgid=6*******&key=822560381",
        "customer_join_url": "https://lens.zoho.com/join/822560381"
    },
    "resource_type": "/api/v2/lens_session"