Get Chat Session

User Guide > Resources > Get Chat Session

This request returns chat session information.

The resource ID of a session is retrieved by a search addressables request with the parameter type=chattable. This request returns among other things HATEOAS links to the chat sessions.

Resource

GET /chats/<OID>

Where OID is the object ID of the chat session.

Parameters

None

Payload

None

Response

Object Response < Chat Session >

Context

Authorization

User

Errors

Common Errors

Example

Request

GET https://xelion.nl/api/v1/master/chats/1588675

Response

{
  "object": {
    "participants": [
      {
        "iconId": "1590019",
        "commonName": "Arnon Ron",
        "oid": "1556377",
        "objectType": "Person"
      },
      {
        "iconId": "1566787",
        "commonName": "Wim Bokkers",
        "oid": "1557797",
        "objectType": "Person"
      }
    ],
    "sessionType": "user",
    "disabled": false,
    "commonName": "Chat Telefoonaansluiting Arnon Ron <->Telefoonaansluiting Wim Bokkers",
    "oid": "1588675",
    "objectType": "XCCChatSession"
  },
  "links": [
    {
      "rel": "self",
      "href": "http://www.xelion.nl/api/v1/master/chats/1588675",
      "method": "GET"
    }
  ]
}