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

# System & Access

> Manage integrations, users, permissions, communication settings, and APIs.

# System & Access

The System & Access section contains administrative settings related to platform operations, security, and integrations.

## Available Sections

<Accordion title="SMTP">
  Configure SMTP settings used for outgoing platform emails, including invitations, password reset emails, MFA codes, billing alerts, and system notifications.

  ### SMTP Host

  Type: `string`

  Hostname of the outgoing mail server.

  Example:

  ```text theme={null}
  smtp.gmail.com
  ```

  ### SMTP Port

  Type: `number`

  Port used for SMTP communication.

  Common values:

  ```text theme={null}
  465
  587
  25
  ```

  ## Connection Options

  ### Use Secure Connection

  Type: `boolean`

  Enables SSL/TLS encrypted connection to the SMTP server.

  ### Disable TLS Certificate Validation

  Type: `boolean`

  Disables TLS certificate verification.

  <Warning>
    Use this option only for testing or internal SMTP servers.
  </Warning>

  ## Authentication

  ### SMTP Username

  Type: `string`

  Username used to authenticate with the SMTP server.

  Example:

  ```text theme={null}
  platform@example.com
  ```

  ### SMTP Password

  Type: `password`

  Password or application-specific password used for SMTP authentication.

  The value is hidden in the interface.

  ## Email Sender Settings

  ### Mail From

  Type: `string`

  Sender address used for outgoing emails.

  Must be a valid email address or use the following format:

  ```text theme={null}
  Name <email@example.com>
  ```

  Examples:

  ```text theme={null}
  no-reply@example.com
  ```

  ```text theme={null}
  Monobot <no-reply@example.com>
  ```

  ### Notification BCC

  Type: `string`

  Optional email address that receives copies of outgoing platform notifications.

  Example:

  ```text theme={null}
  bcc@example.com
  ```

  ### Support Email

  Type: `string`

  Email address displayed or used for support-related communication.

  Example:

  ```text theme={null}
  support@example.com
  ```

  ## Test Settings

  Use **Test Settings** to verify SMTP connection, credentials, and email delivery configuration before saving or using the setup.

  <Info>
    SMTP configuration is required for system emails such as invitations, password resets, MFA codes, billing alerts, and notification templates.
  </Info>
</Accordion>

<Accordion title="Members">
  Manage platform users and their access to the current tenant.

  The Members section provides a list of all users associated with the selected tenant and allows administrators to manage user access.

  ## Members List

  The table displays all users currently registered within the tenant.

  ### First Name

  Type: `string`

  User's first name.

  Example:

  ```text theme={null}
  John
  ```

  ### Last Name

  Type: `string`

  User's last name.

  Example:

  ```text theme={null}
  Doe
  ```

  ### Email

  Type: `string`

  User's email address used for authentication and notifications.

  Example:

  ```text theme={null}
  john.doe@example.com
  ```

  ## User Management

  Administrators can use the Members section to:

  * View all tenant users
  * Verify user information
  * Manage platform access
  * Monitor active users
  * Review organization membership
</Accordion>

<Accordion title="Access Control">
  Manage role-based permissions and advanced platform access settings.

  The Access Control section allows administrators to define what actions users can perform within the platform by assigning privileges to specific roles.

  ## Bot Change Control

  ### Enable switching bots to Production mode

  Type: `boolean`

  Allows users assigned to the selected role to publish bots to the Production environment.

  When enabled:

  * Bots can be promoted from Draft to Production
  * Published bots become available for live usage
  * Future changes require a commit message before publishing

  <Info>
    After a bot is published, every subsequent change requires a commit message describing the modification.
  </Info>

  ## RBAC Settings

  Role-Based Access Control (RBAC) determines which resources a role can access and what actions can be performed.

  ### Role

  Type: `select`

  Select the role whose permissions you want to configure.

  Example:

  ```text theme={null}
  Tenant Administrator
  Agent Manager
  Operator
  Viewer
  ```

  ## Privileges

  Configure permissions for each platform entity.

  Each entity supports the following permissions:

  | Permission | Description                  |
  | ---------- | ---------------------------- |
  | Can Read   | View records and information |
  | Can Update | Modify existing records      |
  | Can Delete | Remove records               |
  | Can Create | Create new records           |

  ### Available Entities

  #### Organization

  Manage organizations and tenant-level configuration.

  #### Interaction

  Manage interaction history, transcripts, and conversations.

  #### Usage

  Access usage statistics and consumption reports.

  #### Agent

  Manage AI agents and bot configurations.

  #### Billing

  Access invoices, subscriptions, and payment information.

  #### Language

  Manage supported languages and localization settings.

  #### Phone

  Manage phone numbers and telephony resources.

  #### Sub Organization

  Manage child organizations and organizational hierarchy.

  #### Template

  Manage notification, email, and message templates.

  ## Bot Advanced Access

  Grant advanced permissions for bot configuration and administration.

  ### Change Voice Processor

  Type: `boolean`

  Allows users to modify the Voice Processor used by the bot.

  Examples:

  * OpenAI Voice
  * ElevenLabs
  * Azure Speech

  ### Change STT Processor

  Type: `boolean`

  Allows users to change the Speech-to-Text (STT) engine.

  Examples:

  * Deepgram
  * OpenAI Whisper
  * Google Speech-to-Text

  ### Change LLM

  Type: `boolean`

  Allows users to modify the Large Language Model used by the bot.

  Examples:

  * GPT-4o
  * Claude
  * Gemini

  ### Full Access to Integrations

  Type: `boolean`

  Provides access to the Integrations tab and allows management of connected services.

  Examples:

  * Google Calendar
  * SMTP
  * SIP
  * Altegio
  * WooCommerce

  ### Read Interaction Metrics

  Type: `boolean`

  Allows viewing interaction analytics and performance metrics.

  Examples:

  * Conversation statistics
  * Call duration
  * Resolution rate
  * Usage metrics
  * Interaction transcripts

  <Warning>
    Changes made in Access Control take effect immediately for all users assigned to the selected role.
  </Warning>
</Accordion>

<Accordion title="SIP">
  Configure SIP authentication and network access settings for inbound SIP and SIPS connections.

  ## IP Whitelist

  Type: `list`

  Defines which IP addresses are allowed to connect to the platform through SIP or SIPS.

  Supported formats:

  ```text theme={null}
  88.214.8.230
  88.214.8.*
  88.214.8.230-88.214.8.240
  2001:db8::1
  ```

  ### Examples

  #### Single IP

  ```text theme={null}
  88.214.8.230
  ```

  Allows connections only from the specified IP address.

  #### Wildcard Range

  ```text theme={null}
  88.214.8.*
  ```

  Allows all IPs within the specified subnet.

  #### IP Range

  ```text theme={null}
  88.214.8.230-88.214.8.240
  ```

  Allows all addresses within the defined range.

  #### IPv6 Address

  ```text theme={null}
  2001:db8::1
  ```

  Allows a specific IPv6 endpoint.

  <Info>
    If no IP addresses are configured, connections are allowed from any IP address.
  </Info>

  ## SIP Username

  Type: `string`

  Username used for SIP Digest Authentication and SIP REGISTER requests.

  The connecting SIP client must provide this username when authenticating with the platform.

  ### Example

  ```text theme={null}
  sip_test_user
  ```

  ## SIP Password

  Type: `password`

  Password associated with the SIP Username.

  The platform validates incoming SIP authentication requests using this password.

  ### Example

  ```text theme={null}
  StrongPassword123!
  ```

  <Warning>
    Store SIP credentials securely and rotate them regularly to prevent unauthorized access.
  </Warning>

  ## Authentication Flow

  1. SIP provider or PBX sends a SIP REGISTER or INVITE request.
  2. Platform validates the supplied SIP Username.
  3. Platform verifies the SIP Password using Digest Authentication.
  4. If an IP Whitelist is configured, the source IP is validated.
  5. Connection is accepted only when all validation checks pass.

  <Info>
    SIP Username and SIP Password are required only when SIP Digest Authentication is enabled on the call initiator side.
  </Info>
</Accordion>

<Accordion title="Call Attached Data">
  Configure custom key-value pairs that are attached to interactions and can be consumed by external systems, integrations, APIs, or downstream workflows.

  Call Attached Data (CAD) allows you to expose interaction metadata in a structured format for third-party systems.

  ## Field Name

  Type: `string`

  Defines the custom field key that will be included in the interaction payload.

  Field names should be unique and descriptive.

  ### Examples

  ```text theme={null}
  tenant_field_org_id
  tenant_field_status
  customer_id
  ticket_number
  ```

  ## Value

  Type: `variable`

  Defines the interaction variable or system value that will populate the field.

  Values are selected from available interaction variables.

  ### Examples

  #### Organization ID

  ```text theme={null}
  Interaction.organizationId
  ```

  Stores the organization identifier associated with the interaction.

  #### Interaction Status

  ```text theme={null}
  Interaction.status
  ```

  Stores the current interaction status.

  Examples:

  ```text theme={null}
  active
  completed
  failed
  transferred
  ```

  ## Creating a New Field

  Click **New Field (+)** to create an additional CAD entry.

  For each field:

  1. Enter a unique Field Name.
  2. Select a Value from the available variables.
  3. Save the configuration.

  ## Managing Existing Fields

  ### Edit Field

  Update either the field name or the mapped value.

  ### Delete Field

  Remove a CAD field using the delete icon.

  <Warning>
    Deleting a field removes it from all future interaction payloads but does not affect historical interaction data.
  </Warning>

  ## Example Configuration

  | Field Name             | Value                      |
  | ---------------------- | -------------------------- |
  | tenant\_field\_org\_id | Interaction.organizationId |
  | tenant\_field\_status  | Interaction.status         |

  Example output:

  ```json theme={null}
  {
    "tenant_field_org_id": "12345",
    "tenant_field_status": "completed"
  }
  ```

  ## Common Use Cases

  * CRM integration
  * Ticketing systems
  * Custom reporting
  * External workflow automation
  * Webhook enrichment
  * Customer data synchronization

  <Info>
    Configured CAD fields are automatically attached to interactions and can be accessed by supported APIs and integrations.
  </Info>
</Accordion>

<Accordion title="API">
  Manage API keys used to authenticate external applications, services, and integrations with the platform.

  API keys provide secure access to platform APIs without requiring interactive user authentication.

  ## Create API Key

  Generate a new API key for a specific service or integration.

  ### Key Name

  Type: `string`

  A human-readable name used to identify the API key.

  Choose a descriptive name that reflects its purpose.

  ### Examples

  ```text theme={null}
  Production SIP Integration
  CRM Connector
  Webhook Service
  Analytics API
  ```

  ### Service Type

  Type: `select`

  Select the service or feature that the API key will be authorized to access.

  Example:

  ```text theme={null}
  SIP
  ```

  Additional options may be available depending on enabled platform features.

  ### Generate

  Creates a new API key using the specified name and service type.

  <Warning>
    The generated API key should be stored securely. Depending on your deployment, the full key may only be shown once.
  </Warning>

  ## API Keys

  Displays all active API keys created within the tenant.

  ### Name

  Type: `string`

  The user-defined name assigned during key creation.

  Example:

  ```text theme={null}
  Production SIP Integration
  ```

  ### Creator Email

  Type: `email`

  Email address of the user who generated the API key.

  Example:

  ```text theme={null}
  admin@company.com
  ```

  ### Created At

  Type: `datetime`

  Date and time when the API key was created.

  Example:

  ```text theme={null}
  2026-01-15 14:30 UTC
  ```

  ### Valid Until

  Type: `datetime`

  Expiration date of the API key.

  If no expiration policy exists, the platform may display an extended validity period.

  Example:

  ```text theme={null}
  2027-01-15 14:30 UTC
  ```

  ### API Key

  Type: `secret`

  Displays the generated API credential.

  Depending on platform configuration, keys may be partially masked for security purposes.

  Example:

  ```text theme={null}
  sk_live_xxxxxxxxxxxxxxxxx
  ```

  ### Delete

  Type: `action`

  Revokes and permanently removes the API key.

  After deletion:

  * API requests using the key will immediately fail
  * Existing integrations using the key must be updated
  * The key cannot be recovered

  <Warning>
    Deleting an API key immediately revokes access for all systems using that credential.
  </Warning>

  ## Typical Use Cases

  * SIP authentication
  * External integrations
  * Webhook authorization
  * CRM synchronization
  * Internal automation services
  * Custom API clients

  ## Security Best Practices

  * Create separate keys for each integration
  * Rotate keys regularly
  * Remove unused keys immediately
  * Never share API keys publicly
  * Store credentials in a secure secrets manager

  <Info>
    API keys inherit the permissions associated with the selected service and tenant configuration.
  </Info>
</Accordion>

<Warning>
  Changes made in System & Access settings can affect platform functionality, integrations, and user access.
</Warning>
