> ## Documentation Index
> Fetch the complete documentation index at: https://docs.superoffice.com/llms.txt
> Use this file to discover all available pages before exploring further.

# SuperOffice.WebApi.Data.ChatMessage

# <a id="SuperOffice_WebApi_Data_ChatMessage" /> Class ChatMessage

Namespace: [SuperOffice.WebApi.Data](SuperOffice.WebApi.Data.md)\
Assembly: SuperOffice.WebApi.dll

Carrier object for ChatMessage.
A message in a chat session

```csharp theme={null}
public class ChatMessage
```

#### Inheritance

[object](https://learn.microsoft.com/dotnet/api/system.object) ←
[ChatMessage](SuperOffice.WebApi.Data.ChatMessage.md)

#### Inherited Members

[object.ToString()](https://learn.microsoft.com/dotnet/api/system.object.tostring),
[object.Equals(object)](https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals\(system-object\)),
[object.Equals(object, object)](https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals\(system-object-system-object\)),
[object.ReferenceEquals(object, object)](https://learn.microsoft.com/dotnet/api/system.object.referenceequals),
[object.GetHashCode()](https://learn.microsoft.com/dotnet/api/system.object.gethashcode),
[object.GetType()](https://learn.microsoft.com/dotnet/api/system.object.gettype),
[object.MemberwiseClone()](https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone)

## Constructors

### <a id="SuperOffice_WebApi_Data_ChatMessage__ctor" /> ChatMessage()

Default constructor - defaults any enum props to 0.

```csharp theme={null}
public ChatMessage()
```

## Properties

### <a id="SuperOffice_WebApi_Data_ChatMessage_Author" /> Author

The author of the message.

```csharp theme={null}
public virtual string Author { get; set; }
```

#### Property Value

[string](https://learn.microsoft.com/dotnet/api/system.string)

### <a id="SuperOffice_WebApi_Data_ChatMessage_ChatMessageId" /> ChatMessageId

The primary key (auto-incremented)

```csharp theme={null}
public virtual int ChatMessageId { get; set; }
```

#### Property Value

[int](https://learn.microsoft.com/dotnet/api/system.int32)

### <a id="SuperOffice_WebApi_Data_ChatMessage_ChatSessionId" /> ChatSessionId

The reference to the associated chat session.

```csharp theme={null}
public virtual int ChatSessionId { get; set; }
```

#### Property Value

[int](https://learn.microsoft.com/dotnet/api/system.int32)

### <a id="SuperOffice_WebApi_Data_ChatMessage_Message" /> Message

The message.

```csharp theme={null}
public virtual string Message { get; set; }
```

#### Property Value

[string](https://learn.microsoft.com/dotnet/api/system.string)

### <a id="SuperOffice_WebApi_Data_ChatMessage_ReadByCustomer" /> ReadByCustomer

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

```csharp theme={null}
public virtual short ReadByCustomer { get; set; }
```

#### Property Value

[short](https://learn.microsoft.com/dotnet/api/system.int16)

### <a id="SuperOffice_WebApi_Data_ChatMessage_SpecialParam" /> SpecialParam

Special parameter for the special\_type.

```csharp theme={null}
public virtual string SpecialParam { get; set; }
```

#### Property Value

[string](https://learn.microsoft.com/dotnet/api/system.string)

### <a id="SuperOffice_WebApi_Data_ChatMessage_SpecialType" /> SpecialType

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

```csharp theme={null}
[JsonIgnore]
public ChatMessageSpecialType? SpecialType { get; set; }
```

#### Property Value

[ChatMessageSpecialType](SuperOffice.WebApi.Data.ChatMessageSpecialType.md)?

#### See Also

[ChatMessage](SuperOffice.WebApi.Data.ChatMessage.md).[SpecialType\_String](SuperOffice.WebApi.Data.ChatMessage.md#SuperOffice_WebApi_Data_ChatMessage_SpecialType_String)

### <a id="SuperOffice_WebApi_Data_ChatMessage_SpecialType_String" /> SpecialType\_String

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

```csharp theme={null}
[JsonProperty("SpecialType")]
public string SpecialType_String { get; set; }
```

#### Property Value

[string](https://learn.microsoft.com/dotnet/api/system.string)

#### See Also

[ChatMessage](SuperOffice.WebApi.Data.ChatMessage.md).[SpecialType](SuperOffice.WebApi.Data.ChatMessage.md#SuperOffice_WebApi_Data_ChatMessage_SpecialType)

### <a id="SuperOffice_WebApi_Data_ChatMessage_Type" /> Type

The type of the message.
NULL if unknown enum value.

```csharp theme={null}
[JsonIgnore]
public ChatMessageType? Type { get; set; }
```

#### Property Value

[ChatMessageType](SuperOffice.WebApi.Data.ChatMessageType.md)?

#### See Also

[ChatMessage](SuperOffice.WebApi.Data.ChatMessage.md).[Type\_String](SuperOffice.WebApi.Data.ChatMessage.md#SuperOffice_WebApi_Data_ChatMessage_Type_String)

### <a id="SuperOffice_WebApi_Data_ChatMessage_Type_String" /> Type\_String

The type of the message.
Raw string enum value.

```csharp theme={null}
[JsonProperty("Type")]
public string Type_String { get; set; }
```

#### Property Value

[string](https://learn.microsoft.com/dotnet/api/system.string)

#### See Also

[ChatMessage](SuperOffice.WebApi.Data.ChatMessage.md).[Type](SuperOffice.WebApi.Data.ChatMessage.md#SuperOffice_WebApi_Data_ChatMessage_Type)

### <a id="SuperOffice_WebApi_Data_ChatMessage_WhenPosted" /> WhenPosted

When the message was posted (UTC timestamp).

```csharp theme={null}
public virtual DateTime WhenPosted { get; set; }
```

#### Property Value

[DateTime](https://learn.microsoft.com/dotnet/api/system.datetime)

## See Also

[ChatAgent](SuperOffice.WebApi.Agents.ChatAgent.md)


## Related topics

- [SuperOffice.WebApi.Data.ChatMessageType](/en/api/reference/webapi/SuperOffice.WebApi.Data.ChatMessageType.md)
- [SuperOffice.WebApi.Data.ChatMessageSpecialType](/en/api/reference/webapi/SuperOffice.WebApi.Data.ChatMessageSpecialType.md)
- [SuperOffice.WebApi.Data.Chat AddChatMessageRequest](/en/api/reference/webapi/SuperOffice.WebApi.Data.Chat_AddChatMessageRequest.md)
- [SuperOffice.WebApi.Agents.ChatAgent](/en/api/reference/webapi/SuperOffice.WebApi.Agents.ChatAgent.md)
- [SuperOffice.WebApi.Agents.IChatAgent](/en/api/reference/webapi/SuperOffice.WebApi.Agents.IChatAgent.md)
- [SuperOffice.WebApi.Data.Chat GetChatMessagesRequest](/en/api/reference/webapi/SuperOffice.WebApi.Data.Chat_GetChatMessagesRequest.md)