Jump to

• Request
• Response
• Examples

Log off an agent session

post

/engagement/api/agent/{fqSiteName}/v1/logoff

This operation terminates the agent's session.
The following is the list of exception codes that can be returned from this operation:

• ACCESS_DENIED - Authentication failed.
• UNKNOWN_EXCEPTION - An unknown error has occurred.
• BAD_REQUEST - A field in the request is invalid.
• INTERNAL_SERVER_ERROR - An error occurred within the core server.

Request

Supported Media Types

• application/json; charset=utf-8

Path Parameters

• fqSiteName(required): string
  The fully qualified site name.

Header Parameters

• X-AID(required): string
  A header element containing the agent account identifier.
• X-JSESSIONID(required): string
  A header element containing the unique session identifier returned in the create automated agent session call.

Body ()

The object containing the request information.

Root Schema : com.rightnow.chat.rest.agent_api.model.requests.v1.LogoffRequest

Type: object

Show Source

• forceLogoff(required): boolean
  Indicates whether a force log off is required. If true, then the existing session is forcibly logged off.
• sequenceNumber: integer(int64)
  The client application defined transaction sequence number.
• timeCreated: integer(int64)
  The time the request was created in milliseconds.

{
    "required":[
        "forceLogoff"
    ],
    "properties":{
        "forceLogoff":{
            "type":"boolean",
            "description":"Indicates whether a force log off is required. If true, then the existing session is forcibly logged off."
        },
        "timeCreated":{
            "type":"integer",
            "format":"int64",
            "description":"The time the request was created in milliseconds."
        },
        "sequenceNumber":{
            "type":"integer",
            "format":"int64",
            "description":"The client application defined transaction sequence number."
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json; charset=utf-8

200 Response

The request completed successfully.

Body ()

Root Schema : com.rightnow.chat.rest.agent_api.model.responses.v1.LogoffResponse

Type: object

Show Source

• chatLogoffResult:
  The place holder object containing the transaction result data.
• chatSystemError: object com.rightnow.chat.rest.agent_api.model.types.v1.ChatSystemError
• clientId: integer(int64)
  The unique identifier of the agent client, created to identify the agent during this agent session.
• clientIdString: string
  The unique identifier of the agent client in string format, created to identify the agent during this agent session.
• clientSendTime: integer(int64)
  The time when the client request was received in yyyy-MM-dd'T'HH:mm:ssXXX format.
• sequenceNumber: integer(int64)
  The client application defined transaction sequence number.
• sequenceNumberString: string
  The client application defined transaction sequence number as a string.
• serviceFinishTime: integer(int64)
  The time when the chat server completed processing the client request in yyyy-MM-dd'T'HH:mm:ssXXX format.
• serviceStartTime: integer(int64)
  The time when the chat server began processing the client request in yyyy-MM-dd'T'HH:mm:ssXXX format.
• sessionId: string
  The unique identifier of the agent session.

{
    "properties":{
        "chatLogoffResult":{
            "description":"The object containing the transaction results.",
            "$ref":"#/definitions/com.rightnow.chat.rest.agent_api.model.responses.v1.results.ChatLogoffResult"
        },
        "chatSystemError":{
            "description":"The chat system error result object.",
            "$ref":"#/definitions/com.rightnow.chat.rest.agent_api.model.types.v1.ChatSystemError"
        },
        "clientSendTime":{
            "type":"integer",
            "format":"int64",
            "description":"The time when the client request was received in yyyy-MM-dd'T'HH:mm:ssXXX format."
        },
        "serviceStartTime":{
            "type":"integer",
            "format":"int64",
            "description":"The time when the chat server began processing the client request in yyyy-MM-dd'T'HH:mm:ssXXX format."
        },
        "serviceFinishTime":{
            "type":"integer",
            "format":"int64",
            "description":"The time when the chat server completed processing the client request in yyyy-MM-dd'T'HH:mm:ssXXX format."
        },
        "sessionId":{
            "type":"string",
            "description":"The unique identifier of the agent session."
        },
        "clientId":{
            "type":"integer",
            "format":"int64",
            "description":"The unique identifier of the agent client, created to identify the agent during this agent session."
        },
        "clientIdString":{
            "type":"string",
            "description":"The unique identifier of the agent client in string format, created to identify the agent during this agent session."
        },
        "sequenceNumber":{
            "type":"integer",
            "format":"int64",
            "description":"The client application defined transaction sequence number."
        },
        "sequenceNumberString":{
            "type":"string",
            "description":"The client application defined transaction sequence number as a string."
        }
    }
}

Nested Schema : com.rightnow.chat.rest.agent_api.model.types.v1.ChatSystemError

Type: object

Show Source

• errorCondition: string
  The error condition.
• text: string
  The error text.
• type: string
  The error type.

{
    "properties":{
        "errorCondition":{
            "type":"string",
            "description":"The error condition."
        },
        "text":{
            "type":"string",
            "description":"The error text."
        },
        "type":{
            "type":"string",
            "description":"The error type."
        }
    }
}

400 Response

The validation of the request object failed.

Body ()

Root Schema : schema

Type: object

403 Response

The agent session identifier is unknown.

Body ()

Root Schema : schema

Type: object

404 Response

The resource was not found.

Body ()

Root Schema : schema

Type: object

500 Response

An error occurred in the chat server while processing the request.

Body ()

Root Schema : schema

Type: object

Back to Top

Examples

The following example shows how to terminate an agent's session.

cURL Command Example

curl -X POST https://chat_rest_server_domain.com/engagement/api/agent/day001_221100_sql_001h/v1/logoff?pool=297:1 -H 'Content-Type: application/json; charset=UTF-8' -H 'X-JSESSIONID: node01h8m13tljpm7ns8nayp0pid91' -d ' -H 'X-AID: 12' {"timeCreated" :1618317020415, "sequenceNumber" : 3,  "forceLogoff": false}'

Request Body Example

The following shows an example of the request body in JSON format.

{
  "timeCreated" : 1618317020415,
  "sequenceNumber" : 3,
  "forceLogoff" : false
}

Response Header Example

The following shows an example of the response header.

Status: 200 OK
Content-Type: application/json;charset=utf-8

Response Body Example

The following shows an example of the response body in JSON format.

{
  "chatLogoffResult": {},
  "chatSystemError": null,
  "clientSendTime": 1618302560000,
  "serviceStartTime": 1652100288206,
  "serviceFinishTime": 1652100288249,
  "sessionId": "node0tgek4wvqxfq6udbauhu9abtb0",
  "clientId": 47,
  "clientIdString": "47",
  "sequenceNumber": 3,
  "sequenceNumberString": "3"
}

Back to Top