POST ChatSession/{id}/Reset

• 5 minutes to read
 • 5 minutes to read 
POST /api/v1/ChatSession/{chatSessionId}/Reset

Reset chat session, put it back on the queue for pickup.

Used by bots to hand off a session to human

Path Part Type Description
chatSessionId int32 id of the chat session to reset Required

Request Headers

Parameter Name Description
Authorization Supports 'Basic', 'SoTicket' and 'Bearer' schemes, depending on installation type.
X-XSRF-TOKEN If not using Authorization header, you must provide XSRF value from cookie or hidden input field
Accept Content-type(s) you would like the response in: application/json, text/json, application/xml, text/xml, application/json-patch+json, application/merge-patch+json
Accept-Language Convert string references and multi-language values into a specified language (iso2) code.
SO-Language Convert string references and multi-language values into a specified language (iso2) code. Overrides Accept-Language value.
SO-Culture Number, date formatting in a specified culture (iso2 language) code. Partially overrides SO-Language/Accept-Language value. Ignored if no Language set.
SO-TimeZone Specify the timezone code that you would like date/time responses converted to.
SO-AppToken The application token that identifies the partner app. Used when calling Online WebAPI from a server.

Response:

OK

Response Description
200 OK

Response body: ChatSessionEntity

Property Name Type Description
ChatSessionId int32 The primary key (auto-incremented)
TopicId int32 The reference to the associated chat topic.
User Associate User agent handling this session
Person Person Customer person in this session - could be empty if we don't know exactly.
CustomerAlias string The alias for the customer.
CustomerHost string The hostname or IP address for the customer.
CustomerName string The name of customer, if provided
CustomerEmail string The email address of the customer, if provided
CustomerPhone string The phone number of the customer, if provided
CustomerConsented bool The customer consented when starting the session
CustomerCompanyName string The name of the customers company, if provided
Status string Enum indicating the status for the session (pending, active, closed, etc).
FirstMessage string A copy of the first message in the chat session
LastMessage string A copy of the last message in the chat session
WhenRequested date-time When the session was requested by the customer.
WhenStarted date-time When the session was accepted by a user.
WhenEnded date-time When the session was ended.
WhenIdle date-time The last time anyone sent a message for this session.
WhenFetched date-time The last time the customer's client refetched the data. Used to detect 'dead' session.
SessionKey string Key used to authenticate the session.
InitialQueuePos int32 The initial queue pos (i.e. the number of pending sessions + 1) when the session was requested.
AlertLevel int32 The alert level for this chat session.
Rank int32 Lowest possible unique number for active sessions for user. User for color index. Starting at 1.
Flags string Various flags for the chat session
Contact Contact Contact this session is connected to - could be empty if we don't know exactly.
Project Project Project the session is connectedto - could be empty if we don't know exactly.
Sale Sale Sale the session is connected to - could be empty if we don't know exactly.
Ticket Ticket Ticket the session is connected to - could be empty if we don't know exactly.
TransferTo Associate User agent that has a pending transfer of the chat session
ChatbotIsActive bool Indicates that a chatbot is active on the session. This will cause bot triggers to fire. Set to 0 when bot hands off to user.
Rating int32 Rating of this chat conversation given by the customer
TableRight TableRight The carrier's table right
FieldProperties object Field property dictionary mapping field names to field access rights.

Sample request

POST /api/v1/ChatSession/{chatSessionId}/Reset
Authorization: Basic dGplMDpUamUw
Accept: application/json; charset=utf-8
Accept-Language: *

Sample response

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

{
  "ChatSessionId": 427,
  "TopicId": 103,
  "User": null,
  "Person": null,
  "CustomerAlias": "explicabo",
  "CustomerHost": "laudantium",
  "CustomerName": "Nitzsche Group",
  "CustomerEmail": "retta.reichel@hegmann.name",
  "CustomerPhone": "(127)619-4462 x6360",
  "CustomerConsented": false,
  "CustomerCompanyName": "McCullough Inc and Sons",
  "Status": "Closed",
  "FirstMessage": "vel",
  "LastMessage": "reiciendis",
  "WhenRequested": "2019-07-04T02:30:52.413044+02:00",
  "WhenStarted": "2002-10-20T02:30:52.413044+02:00",
  "WhenEnded": "2021-08-09T02:30:52.413044+02:00",
  "WhenIdle": "2005-08-05T02:30:52.413044+02:00",
  "WhenFetched": "2020-09-04T02:30:52.413044+02:00",
  "SessionKey": "maxime",
  "InitialQueuePos": 204,
  "AlertLevel": 557,
  "Rank": 253,
  "Flags": "CustomerIsTyping",
  "Contact": null,
  "Project": null,
  "Sale": null,
  "Ticket": null,
  "TransferTo": null,
  "ChatbotIsActive": false,
  "Rating": 877,
  "TableRight": null,
  "FieldProperties": {
    "fieldName": {
      "FieldRight": null,
      "FieldType": "System.Int32",
      "FieldLength": 258
    }
  }
}