Skip to main content
Put Chat Session Entity

Headers

Accept-Language
string

Convert string references and multi-language values into a specified language (iso2) code.

SO-Language
string

Convert string references and multi-language values into a specified language (iso2) code. Overrides Accept-Language value.

SO-Culture
string

Number, date formatting in a specified culture (iso2 language) code. Partially overrides SO-Language/Accept-Language value. Ignored if no Language set.

SO-TimeZone
string

Specify the timezone code that you would like date/time responses converted to.

SO-AppToken
string

The application token that identifies the partner app. Used when calling Online WebAPI from a server.

Path Parameters

id
integer<int32>
required

The ChatSessionEntity id to update.

Query Parameters

$select
string

Optional comma separated list of properties to include in the result. Other fields are then nulled out to reduce payload size: "Name,department,category" Default = show all fields.

Body

The ChatSessionEntity to be saved.

Chat sessions belong to a chat topic, and contain messages to/from users Carrier object for ChatSessionEntity. Services for the ChatSessionEntity Carrier is available from the Chat Agent.

ChatSessionId
integer<int32>

The primary key (auto-incremented)

TopicId
integer<int32>

The reference to the associated chat topic.

User
object

Carrier object for Associate. Services for the Associate Carrier is available from the Associate Agent.

Person
object

Carrier object for Person. Services for the Person Carrier is available from the Person Agent.

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
boolean

The customer consented when starting the session

CustomerCompanyName
string

The name of the customers company, if provided

Status
enum<string>

Enum indicating the status for the session (pending, active, closed, etc).

Available options:
Invalid,
PreChatForm,
Faq,
OfflineForm,
InQueue,
CustomerLast,
UserLast,
Finished,
Deleted,
Closed,
RequestPosted,
ClosedFromQueue
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
string<date-time>

When the session was requested by the customer.

WhenStarted
string<date-time>

When the session was accepted by a user.

WhenEnded
string<date-time>

When the session was ended.

WhenIdle
string<date-time>

The last time anyone sent a message for this session.

WhenFetched
string<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
integer<int32>

The initial queue pos (i.e. the number of pending sessions + 1) when the session was requested.

AlertLevel
integer<int32>

The alert level for this chat session.

Rank
integer<int32>

Lowest possible unique number for active sessions for user. User for color index. Starting at 1.

Flags
enum<string>

Various flags for the chat session

Available options:
CustomerIsTyping,
UserIsTyping
Contact
object

Carrier object for Contact. Services for the Contact Carrier is available from the Contact Agent.

Project
object

Carrier object for Project. Services for the Project Carrier is available from the Project Agent.

Sale
object

Carrier object for Sale. Services for the Sale Carrier is available from the Sale Agent.

Ticket
object

The ticket carrier is used for representing a service request. Carrier object for Ticket. Services for the Ticket Carrier is available from the Ticket Agent.

TransferTo
object

Carrier object for Associate. Services for the Associate Carrier is available from the Associate Agent.

ChatbotIsActive
boolean

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
integer<int32>

Rating of this chat conversation given by the customer

TableRight
object

Wraps a table right together with an explanatory reason. Code can indicate why access is restricted.

FieldProperties
object

Field property dictionary mapping field names to field access rights.

Response

ChatSessionEntity updated.

Chat sessions belong to a chat topic, and contain messages to/from users ChatSessionEntity entity with API _Links added.

ChatSessionId
integer<int32>

The primary key (auto-incremented)

TopicId
integer<int32>

The reference to the associated chat topic.

User
object

Carrier object for Associate. Services for the Associate Carrier is available from the Associate Agent.

Person
object

Carrier object for Person. Services for the Person Carrier is available from the Person Agent.

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
boolean

The customer consented when starting the session

CustomerCompanyName
string

The name of the customers company, if provided

Status
enum<string>

Enum indicating the status for the session (pending, active, closed, etc).

Available options:
Invalid,
PreChatForm,
Faq,
OfflineForm,
InQueue,
CustomerLast,
UserLast,
Finished,
Deleted,
Closed,
RequestPosted,
ClosedFromQueue
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
string<date-time>

When the session was requested by the customer.

WhenStarted
string<date-time>

When the session was accepted by a user.

WhenEnded
string<date-time>

When the session was ended.

WhenIdle
string<date-time>

The last time anyone sent a message for this session.

WhenFetched
string<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
integer<int32>

The initial queue pos (i.e. the number of pending sessions + 1) when the session was requested.

AlertLevel
integer<int32>

The alert level for this chat session.

Rank
integer<int32>

Lowest possible unique number for active sessions for user. User for color index. Starting at 1.

Flags
enum<string>

Various flags for the chat session

Available options:
CustomerIsTyping,
UserIsTyping
Contact
object

Carrier object for Contact. Services for the Contact Carrier is available from the Contact Agent.

Project
object

Carrier object for Project. Services for the Project Carrier is available from the Project Agent.

Sale
object

Carrier object for Sale. Services for the Sale Carrier is available from the Sale Agent.

Ticket
object

The ticket carrier is used for representing a service request. Carrier object for Ticket. Services for the Ticket Carrier is available from the Ticket Agent.

TransferTo
object

Carrier object for Associate. Services for the Associate Carrier is available from the Associate Agent.

ChatbotIsActive
boolean

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
integer<int32>

Rating of this chat conversation given by the customer

TableRight
object

Wraps a table right together with an explanatory reason. Code can indicate why access is restricted.

FieldProperties
object

Field property dictionary mapping field names to field access rights.