Session Information

Purpose

To get the details of a particular document session.

HTTP Request URL

https://{api.office-integrator_domain}/writer/officeapi/v1/sessions/<session_id>?apikey=<apikey>

Request Parameters

Parameter	Data Type	Description
Mandatory Parameters
apikey	String	Uniquely identifies the web application in which the Writer editor is integrated.
session_id	String	Unique user session id of the document.

Note:

Users can find the 'session_id' in all Zoho Writer API responses. For example, the "session_id" is captured as part of the response and can be seen in Preview, Edit and Comparison APIs.

Sample Request

Copiedhttps://api.office-integrator.com/writer/officeapi/v1/sessions/d26aa7b8029b5rf8d34c7dd00139392357d12ffcb21c1?apikey=423s*****

Sample Response

Copied{
 "status": "active/inactive/invalid"
 "user_info":  {
       "display_name":"Amelia",
       "user_id":"1111"
        }
  "info": {
     "document_id": "12345",
     "created_time_ms": 1659578400000,
     "created_time": "2018-05-08T13:54:41Z"
     "expires_on_ms": 1659578400000,
     "expires_on": "2018-05-08T13:54:41Z",
     "session_url": "https://api.office-integrator.com/writer/officeapi/v1/documents/<session_id>/edit"
     "session_delete_url":"https://api.office-integrator.com/writer/officeapi/v1/sessions/<session_id>"
      }
}

Status Description:

active - If the session details is available and opened.
inactive - If the session url is not yet opened.
invalid - If no such session is available for that APIKey.