Active Sessions

This API retrieves real-time active sessions in your organization.

  • Required OAuth Scope:
    ZohoLens.sessionapi.READ

  • Endpoint:
    GET /api/v2/sessions/active

  • Parameters:

    • index (optional):
      Index of the record. Default is 1

    • count (optional):
      Number of rows per page. Default is 10

    • department_id (required):
      Department ID of the technician (obtainable from the user API).

       

Response params : 
Session status types :  YET_TO_START, INITIATED, CUSTOMER_WAITING, TECHNICIAN_WAITING, COMPLETED, ONGOING;

Sample Request

Copiedcurl --location --request GET 'https://lens.zoho.com/api/v2/sessions/active?department_id={department_id}' \ --header 'Authorization: Zoho-oauthtoken {access_token}'

Sample Response

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

{
  "representation": [
    {
      "session_id": "87*******",
      "context_title": "On Demand Lens session #87*******",
      "context_schedule_time": "17***********",
      "context_edited_time": "17***********",
      "context_edited_user_email": "john.f@zylker.com",
      "session_status": "INITIATED",
      "context_customer_email": "Guest",
      "sys_id": "86*************"
    }
  ],
  "resource_type": "/api/v2/sessions/active"
}