Skip to main content
Add Chat Message

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

chatSessionId
integer<int32>
required

id of the chat session to add message to

Body

Message to add

A message in a chat session Carrier object for ChatMessage. Services for the ChatMessage Carrier is available from the Chat Agent.

ChatMessageId
integer<int32>

The primary key (auto-incremented)

ChatSessionId
integer<int32>

The reference to the associated chat session.

Type
enum<string>

The type of the message.

Available options:
Invalid,
ToCustomer,
ToUser,
Special
Message
string

The message.

Author
string

The author of the message.

ReadByCustomer
integer<int32>

Whether the message has been read by the customer or not.

SpecialType
enum<string>

Enum indicating if it is a special message, such as an URL redirection, etc.

Available options:
None,
Welcome,
Url,
Block,
NewSession,
TransferedSession,
Error,
SessionDeleted,
FaqSuccessQuestion,
ClosedByUser,
ClosedByCustomer,
ClosedByIdle,
TransferRejected,
ReopenedByCustomer,
ClickedOption,
BotMessage,
Options,
IllegalFileType
SpecialParam
string

Special parameter for the special_type.

WhenPosted
string<date-time>

When the message was posted (UTC timestamp).

Response

OK

A message in a chat session Carrier object for ChatMessage. Services for the ChatMessage Carrier is available from the Chat Agent.

ChatMessageId
integer<int32>

The primary key (auto-incremented)

ChatSessionId
integer<int32>

The reference to the associated chat session.

Type
enum<string>

The type of the message.

Available options:
Invalid,
ToCustomer,
ToUser,
Special
Message
string

The message.

Author
string

The author of the message.

ReadByCustomer
integer<int32>

Whether the message has been read by the customer or not.

SpecialType
enum<string>

Enum indicating if it is a special message, such as an URL redirection, etc.

Available options:
None,
Welcome,
Url,
Block,
NewSession,
TransferedSession,
Error,
SessionDeleted,
FaqSuccessQuestion,
ClosedByUser,
ClosedByCustomer,
ClosedByIdle,
TransferRejected,
ReopenedByCustomer,
ClickedOption,
BotMessage,
Options,
IllegalFileType
SpecialParam
string

Special parameter for the special_type.

WhenPosted
string<date-time>

When the message was posted (UTC timestamp).