name: zoom-virtual-agent
description: |
Zoom Virtual Agent API integration guide. Covers AI-powered conversational chatbots for automated
customer service, including intent management, knowledge bases, conversation flows, and analytics.
Use when building AI customer service bots, automated support systems, or integrating conversational
AI into Zoom Contact Center workflows.

Zoom Virtual Agent API

Build AI-powered customer service solutions with Zoom Virtual Agent APIs.

Overview

Zoom Virtual Agent (ZVA) is an AI-driven conversational chatbot that handles customer inquiries using natural language processing:
- Automated customer support with NLP
- Intent recognition and entity extraction
- Knowledge base integration
- Conversation flow management
- Analytics and resolution tracking
- Multi-channel deployment

Choose Your Integration

API Endpoints

Virtual Agents

Intents

Entities

Knowledge Base

Conversations

Flows

Analytics

Example: Create an Intent

curl -X POST "https://api.zoom.us/v2/virtual_agents/{agentId}/intents" \
  -H "Authorization: Bearer {accessToken}" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "check_order_status",
    "display_name": "Check Order Status",
    "training_phrases": [
      "Where is my order?",
      "Track my package",
      "What is my order status?"
    ],
    "responses": [
      {
        "type": "text",
        "text": "I can help you check your order status. Could you please provide your order number?"
      }
    ]
  }'

Example: Add Knowledge Base Article

curl -X POST "https://api.zoom.us/v2/virtual_agents/{agentId}/knowledge_base/articles" \
  -H "Authorization: Bearer {accessToken}" \
  -H "Content-Type: application/json" \
  -d '{
    "title": "Return Policy",
    "content": "Our return policy allows returns within 30 days of purchase...",
    "category": "Policies",
    "keywords": ["return", "refund", "exchange"],
    "url": "https://example.com/help/returns"
  }'

Example: Get Agent Analytics

const response = await fetch(
  'https://api.zoom.us/v2/virtual_agents/{agentId}/analytics?from=2024-01-01&to=2024-01-31',
  {
    headers: { 'Authorization': `Bearer ${accessToken}` }
  }
);

const analytics = await response.json();
// analytics.resolution_rate, analytics.total_conversations, etc.

Response Types

Entity Types

Conversation Status

Prerequisites

1. Zoom Virtual Agent license - Account must have ZVA enabled
2. OAuth app - Create in Zoom App Marketplace
3. Scopes - Required OAuth scopes:
4. virtual_agent:read - Read virtual agent data
5. virtual_agent:write - Manage virtual agents
6. virtual_agent:read:admin - Admin read access
7. virtual_agent:write:admin - Admin write access

Channel Integration

Virtual Agent can be deployed across:
- Web chat widget
- Mobile app
- Zoom Contact Center
- Messaging platforms

Common Use Cases

Detailed References

• references/virtual-agent.md - Full API reference

Resources

• API Reference: https://developers.zoom.us/docs/api/rest/reference/zoom-api/methods/#tag/Virtual-Agent
• Virtual Agent Documentation: https://developers.zoom.us/docs/virtual-agent/
• Bot Building Guide: https://developers.zoom.us/docs/virtual-agent/building/
• Marketplace: https://marketplace.zoom.us/