rtAVrtAV Platform

WordPress Plugin Integration

The rtAV Video Chat Bot WordPress plugin allows you to easily integrate AI-powered video chat bots with real-time avatars into your WordPress site. No coding required - install, configure, and enable in minutes.

Quick Start

  1. Install and activate the plugin (see installation options below)
  2. Get your API key from platform.rtav.io
  3. Configure in Settings > rtAV VBot
  4. Enable the widget and start chatting!

Installation Options:

Installation

From WordPress.org (Recommended)

  1. Navigate to Plugins > Add New in your WordPress admin
  2. Search for "rtAV Video Chat Bot"
  3. Click Install Now and then Activate

Manual Installation

Download the latest plugin ZIP file:

  1. Navigate to Plugins > Add New > Upload Plugin
  2. Choose the ZIP file and click Install Now
  3. Click Activate Plugin

Requirements

  • WordPress 5.0 or higher
  • PHP 7.2 or higher
  • An rtAV account (free tier available at platform.rtav.io)

Configuration

Access the plugin settings at Settings > rtAV VBot in your WordPress admin dashboard.

Basic Settings

Enable VBot

Toggle to enable or disable the widget on your site. The widget will only appear when enabled.

rtAV API Key

Your rtAV platform API key. Get one at platform.rtav.io/api-keys.

Important: Keep your API key secure. It's stored in your WordPress database and should never be shared publicly.

Appearance Settings

  • Theme Color: The primary color for the widget UI. Use the color picker to match your brand.
  • Widget Position: Choose where the widget appears (Bottom Right, Bottom Left, Top Right, or Top Left)
  • Widget Label: Text displayed above the collapsed widget icon (e.g., "Chat with us", "Need help?")

AI Configuration

  • Title: The title shown in the widget header (e.g., "Customer Support", "AI Assistant")
  • Name: The name of your AI assistant (e.g., "Sarah", "Support Bot")
  • AI Instructions: Define how your assistant should behave. This is crucial for customizing responses.
  • Model: The AI model to use (default: gpt-5.2)

Example AI Instructions:

  • Customer Support: "You are a friendly and helpful customer support representative for an e-commerce store. Help customers with product questions, orders, and returns. Always be polite and professional."
  • Sales Assistant: "You are an enthusiastic sales assistant. Help visitors find the right products, answer pricing questions, and guide them through the purchase process."
  • Technical Support: "You are a technical support specialist. Help users troubleshoot issues, explain features, and provide technical guidance."

Advanced Settings

  • Custom Face ID: If you have custom avatar faces configured in your rtAV account, enter the face ID here
  • Custom Voice ID: If you have custom voices configured in your rtAV account, enter the voice ID here
  • Driving: The driving style for the avatar
  • Welcome Message: The initial message shown when the widget opens
  • Idle Timeout: Number of seconds of inactivity before the widget auto-closes (default: 60 seconds)
  • Idle Message: Message shown when the widget closes due to inactivity (optional)
  • Goodbye Message: Message shown when the user closes the widget (optional)
  • Max Words: Maximum number of words per AI response (default: 60 words, set to 0 for no limit)
  • Use Page Content: When enabled, the plugin automatically includes the current page's content in the AI context

Usage

Site-Wide Widget

By default, when enabled, the widget appears on all pages of your site in the configured position. No additional configuration needed.

Shortcode

Use the [rtav_vbot] shortcode to embed the widget on specific pages or posts:

[rtav_vbot]

Examples:

  • Add to a specific page: Edit the page and add [rtav_vbot] in the content
  • Add to sidebar: Use a Text widget with the shortcode
  • Conditional display: Use shortcodes with page builders or conditional plugins

Note: When using the shortcode, make sure "Enable VBot" is still checked in settings. The shortcode overrides the site-wide display only where it's placed.

How It Works

Architecture

The plugin integrates rtAV's vBot widget into WordPress using the following components:

  • Frontend Widget: Loads the vBot JavaScript widget from platform.rtav.io/vbot.js and initializes it with configured settings
  • API Integration: Provides a secure endpoint for the widget to obtain client secrets, authenticates requests using WordPress nonces, and communicates with rtAV API
  • Settings Management: Stores and retrieves plugin configuration with proper sanitization
  • Admin Interface: Creates the settings page in WordPress admin and handles form submission

Security

  • API keys are stored securely in WordPress options
  • Client secrets endpoint uses WordPress nonces for CSRF protection
  • All user input is sanitized before storage
  • API communication uses secure HTTPS

API Flow

  1. User visits site with enabled widget
  2. Widget JavaScript loads from platform.rtav.io
  3. Widget requests client secret from WordPress AJAX endpoint
  4. Plugin validates request and calls rtAV API with stored API key
  5. rtAV API returns ephemeral client secret (valid for 1 hour)
  6. Widget uses client secret to establish WebSocket connection
  7. Real-time video and audio communication begins

Troubleshooting

Widget Not Appearing

  • Check if enabled: Go to Settings > rtAV VBot and ensure "Enable VBot" is checked
  • Verify API key: Ensure you've entered a valid API key
  • Clear cache: Clear any caching plugins (WP Super Cache, W3 Total Cache, etc.)
  • Check browser console: Open browser developer tools (F12) and look for JavaScript errors
  • Verify script loading: Check Network tab to ensure vbot.js is loading from platform.rtav.io

API Key Errors

  • Invalid API key: Verify your API key at platform.rtav.io/api-keys
  • API key expired: Create a new API key if the current one has been revoked
  • Permissions: Ensure your API key has the necessary permissions for realtime sessions

Widget Appears But Doesn't Connect

  • Check browser console: Look for WebSocket connection errors
  • Firewall/security plugins: Some security plugins may block WebSocket connections. Whitelist platform.rtav.io if needed
  • Network issues: Ensure your server can make outbound HTTPS connections to api.rtav.io
  • API quota: Check your rtAV account for usage limits or billing issues

Features

  • Real-time Video Avatars: AI assistants come to life with synchronized video avatars
  • Easy Setup: Install, configure, and enable in minutes
  • Customizable Appearance: Match your brand colors and style
  • Flexible Positioning: Place the widget in any corner of your site
  • Custom AI Instructions: Define exactly how your assistant should behave
  • Shortcode Support: Embed the widget on specific pages using [rtav_vbot]
  • Page Context Awareness: Optional feature to include page content in AI context
  • Voice & Text Chat: Users can interact via voice or text input
  • Conversation History: View past messages in the chat

Developer Information

Plugin Structure

rtav-vbot/
├── rtav-vbot.php          # Main plugin file
├── VERSION.txt            # Version number
├── readme.txt             # WordPress.org readme
├── includes/
│   ├── class-rtav-admin.php      # Admin interface
│   ├── class-rtav-frontend.php   # Frontend widget
│   ├── class-rtav-settings.php   # Settings management
│   └── class-rtav-api.php        # API integration
├── templates/
│   └── settings.php       # Settings page template
└── assets/
    └── ...                # Admin CSS/images

Programmatic Settings Access

You can access and update plugin settings programmatically:

// Get current settings
$settings = RTAV_Settings::get_settings();

// Update settings programmatically
RTAV_Settings::update_settings(array(
    'title' => 'Custom Title',
    'color' => '#FF5733',
));

For detailed developer documentation and contribution guidelines, see the Plugin Development Guide.

Support

Next Steps