> ## 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.ChatBotSettings

# <a id="SuperOffice_WebApi_Data_ChatBotSettings" /> Class ChatBotSettings

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

Carrier object for ChatBotSettings.
Chat Topic bot settings. Trigger script ids to run on bot events

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

#### Inheritance

[object](https://learn.microsoft.com/dotnet/api/system.object) ←
[ChatBotSettings](SuperOffice.WebApi.Data.ChatBotSettings.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_ChatBotSettings__ctor" /> ChatBotSettings()

Default constructor - defaults any enum props to 0.

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

## Properties

### <a id="SuperOffice_WebApi_Data_ChatBotSettings_BotMessageReceivedScriptId" /> BotMessageReceivedScriptId

Script id to run when new messages received from customer.

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

#### Property Value

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

### <a id="SuperOffice_WebApi_Data_ChatBotSettings_BotName" /> BotName

Chatbot name

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

#### Property Value

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

### <a id="SuperOffice_WebApi_Data_ChatBotSettings_BotRegisterScriptId" /> BotRegisterScriptId

Script id to register/unregister chatbot. 0 if there is no bot

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

#### Property Value

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

### <a id="SuperOffice_WebApi_Data_ChatBotSettings_BotSessionChangedScriptId" /> BotSessionChangedScriptId

Script id to run when session state changes.

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

#### Property Value

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

### <a id="SuperOffice_WebApi_Data_ChatBotSettings_BotSessionCreatedScriptId" /> BotSessionCreatedScriptId

Script id to run on new session.

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

#### Property Value

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

## See Also

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


## Related topics

- [SuperOffice.WebApi.Data.ChatTopicEntity](/en/api/reference/webapi/SuperOffice.WebApi.Data.ChatTopicEntity.md)
- [SuperOffice.WebApi.Data.ChatSessionEntity](/en/api/reference/webapi/SuperOffice.WebApi.Data.ChatSessionEntity.md)
- [SuperOffice.WebApi.Data.ChatbotTurn](/en/api/reference/webapi/SuperOffice.WebApi.Data.ChatbotTurn.md)
- [SuperOffice.WebApi.Data.ChatMessageSpecialType](/en/api/reference/webapi/SuperOffice.WebApi.Data.ChatMessageSpecialType.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)