1. Configuration
  • HMS Sovereign API
  • Get started
    • Authentication
    • Introduction
    • Quickstart
  • Core concepts
    • Assistants
    • Calls
    • Phone Numbers
    • Webhooks
  • Platform
    • Billing & Credits
    • EU Data Sovereignty
    • Voice Selection
    • Whitelabel Portal
  • Webhooks
    • Assistant Request
    • End of Call Report
    • Webhooks Overview
    • Webhook Security
    • Status Update
    • Tool Calls
  • Configuration
    • Analysis Templates
    • Custom Tools
    • SIP Trunks
    • Tool Templates
  • Features
    • AI Generation
    • Autonomous Silence Handling
    • Call Analysis
    • Call Transfers
    • Campaigns Setup
    • Outbound Campaigns
    • Voicemail Detection
    • Web Calls
  • Integrations
    • BYOK Setup
    • Provider Pricing
    • xAI Grok Integration
  • Reference
    • Error Codes
    • Rate Limits
    • Troubleshooting
Documentation
API Reference
Documentation
API Reference
Book a meeting
Linkedin
Github
  1. Configuration

Analysis Templates

Analysis templates let you define reusable configurations for post-call analysis. Instead of configuring analysis on each assistant, create templates and reference them across multiple assistants.

What are Analysis Templates?#

An analysis template defines:
Schema - The structured data format to extract
Prompts - Instructions for the AI analyzer
Settings - Minimum messages threshold and other options

Creating an Analysis Template#

Response:
{
  "analysis_template": {
    "id": "template-uuid",
    "name": "Customer Satisfaction Analysis",
    "description": "Extract satisfaction metrics from support calls",
    "schema": { ... },
    "messages": [ ... ],
    "min_messages_threshold": 5,
    "created_at": "2025-12-13T10:00:00.000Z"
  }
}

Template Fields#

FieldTypeRequiredDescription
namestringYesDisplay name
descriptionstringNoDescription of what this template analyzes
schemaobjectYesJSON Schema for output structure
messagesarrayYesPrompt messages with placeholders
min_messages_thresholdintegerNoMinimum messages before running analysis (default: 2)

Using Templates with Assistants#

Reference a template when creating or updating an assistant:
The template's configuration will be used for all calls handled by this assistant.

Template Examples#

Sales Lead Qualification#

{
  "name": "Sales Lead Qualification",
  "schema": {
    "type": "object",
    "properties": {
      "lead_quality": {
        "type": "string",
        "enum": ["hot", "warm", "cold"]
      },
      "budget_discussed": {
        "type": "boolean"
      },
      "timeline": {
        "type": "string",
        "description": "When does the prospect want to buy?"
      },
      "decision_maker": {
        "type": "boolean",
        "description": "Is the caller a decision maker?"
      },
      "products_interested": {
        "type": "array",
        "items": { "type": "string" }
      },
      "next_steps": {
        "type": "string"
      }
    }
  },
  "messages": [
    {
      "role": "system",
      "content": "Analyze this sales call and qualify the lead based on BANT criteria (Budget, Authority, Need, Timeline)."
    },
    {
      "role": "user",
      "content": "Schema: {{schema}}\n\nTranscript: {{transcript}}"
    }
  ]
}

Support Ticket Classification#

{
  "name": "Support Ticket Classification",
  "schema": {
    "type": "object",
    "properties": {
      "category": {
        "type": "string",
        "enum": ["billing", "technical", "account", "product", "general"]
      },
      "priority": {
        "type": "string",
        "enum": ["low", "medium", "high", "urgent"]
      },
      "resolution_status": {
        "type": "string",
        "enum": ["resolved", "escalated", "pending", "unresolved"]
      },
      "root_cause": {
        "type": "string"
      },
      "action_items": {
        "type": "array",
        "items": { "type": "string" }
      }
    }
  },
  "messages": [
    {
      "role": "system",
      "content": "Classify this support call for ticket creation. Identify the category, priority, and resolution status."
    },
    {
      "role": "user",
      "content": "Schema: {{schema}}\n\nTranscript: {{transcript}}\n\nCall ended: {{ended_reason}}"
    }
  ]
}

Appointment Booking#

{
  "name": "Appointment Booking Analysis",
  "schema": {
    "type": "object",
    "properties": {
      "appointment_booked": {
        "type": "boolean"
      },
      "appointment_date": {
        "type": "string",
        "description": "Date in YYYY-MM-DD format if booked"
      },
      "appointment_time": {
        "type": "string",
        "description": "Time in HH:MM format if booked"
      },
      "service_type": {
        "type": "string"
      },
      "customer_name": {
        "type": "string"
      },
      "notes": {
        "type": "string"
      }
    }
  },
  "messages": [
    {
      "role": "system",
      "content": "Extract appointment booking details from this call. If no appointment was booked, set appointment_booked to false."
    },
    {
      "role": "user",
      "content": "Schema: {{schema}}\n\nTranscript: {{transcript}}"
    }
  ]
}

Listing Templates#

Updating a Template#

Deleting a Template#

Deleting a template does not affect assistants using it. They will continue to use the configuration they had at the time of association.

Related#

Call Analysis Guide
Analysis Templates API
End of Call Report Webhook
Modified at 2026-03-17 10:59:50
Previous
Tool Calls
Next
Custom Tools
Built with