1. API
  2. v1
  3. OTHER
  4. GENERAL

Sessions

Resource Fields

Name Type Read-only Description
portal string
ip_address string
user_agent string
instance_id string
instance_name string
user User
status string ONLINE, OFFLINE, AWAY, BACK, BUSY, AUTOAWAY, INVISIBLE
last_activity_at timestamp ISO-8601 Format
created_at timestamp ISO-8601 Format



Metadata




 
 



Version 1.0
Last Updated July 04, 2016

Actions

Retrieve session

GET /api/v1/session.json

Information

Allowed for Public

Request Parameters

  • remember_me - true/false(default). If sent true, Remember Me Token is returned as the value of X-RememberMe header.

Response Headers

X-RememberMe: PxAjGDZERVVCxi88CrqTJpDD7S6vbu9lr2OneIS+xbK/wB/NrJcp+CJzfxQQj9aV3QTvtmtt+2r6vkSrdetoUc7glF5G/agcnw8o3dZxyB8=

Response Body

    {
        "status": 200,
        "data": {
    "id": "9GrwKuIMvHdjmf369ed75a56fd7a8d4606026cd7a34d4e99c487a3NjrBdRw4npE3qYlczSrV0DA6",

    "portal": "API",
    "ip_address": "10.0.2.2",
    "user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_10_3) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/44.0.2403.125 Safari/537.36",
    "instance_id": "153479",
    "instance_name": "brewfictus.kayako.com",
    "user": 



{
    "id": 1,

    "resource_type": "user"

}
,
    "status": "ONLINE",
    "last_activity_at": "2015-08-03T06:41:22+05:00",
    "created_at": "2015-08-03T06:41:03+05:00",

    "resource_type": "session"
}
,
        "resource": "session"
    }

Update session activity

PUT /api/v1/session/ack.json

Information

Allowed for Customers, Collaborators, Agents, Admins & Owners

Response

{
    "status": 200
}

Delete a session

DELETE /api/v1/session.json

Information

Allowed for Customers, Collaborators, Agents, Admins & Owners

Response

{
    "status": 200
}