Skip to content

Add HLD for automated phone calls feature using Yemot Templates/Campaigns API - #72

Closed
buzz-code with Copilot wants to merge 3 commits into
mainfrom
copilot/prepare-hld-for-phone-messages
Closed

buzz-code with Copilot wants to merge 3 commits into
mainfrom
copilot/prepare-hld-for-phone-messages

Conversation

Copilot AI commented Jan 15, 2026 •

Copy link
Copy Markdown
Contributor

Comprehensive design document for outbound phone calling system using Yemot's Templates/Campaigns API, allowing admins to create campaign templates and trigger bulk calls to students.

Version 2.0 - Major revision based on stakeholder feedback to focus on Yemot Templates/Campaigns system instead of generic outbound calls.

Documents Added

Full HLD (docs/HLD-automated-phone-calls.md)

  • Database schema: yemot_campaign_templates (Yemot template references with sync), yemot_campaigns (campaign execution tracking)
  • Backend architecture: YemotCampaignService orchestration, YemotTemplatesApiService client with complete Templates/Campaigns API integration
  • Frontend components: Campaign template CRUD with Yemot sync, BulkCampaignButton for entity lists, campaign history with report viewer
  • API endpoints: REST endpoints for template management, campaign execution, status monitoring, and report download
  • Integration pattern: Leverages Yemot's campaign infrastructure for managing bulk phone operations

Executive Summary (docs/HLD-automated-phone-calls-summary.md)

Quick reference with key decisions and critical questions requiring stakeholder input.

Design Highlights

Architecture: Client → YemotCampaignService → YemotTemplatesApiService → Yemot Templates/Campaigns
Integration points: Bulk campaign button on student-klasses-report, new resources in App.jsx
Yemot Templates/Campaigns API: Complete workflow using CreateTemplate, UploadPhoneList, RunCampaign, GetCampaignStatus, DownloadCampaignReport
Processing: Template creation/sync, phone list upload, campaign execution handled by Yemot, status polling and report download

Yemot Templates/Campaigns Workflow

  1. Admin creates/syncs campaign template (stored in Yemot with template ID)
  2. Template content (audio/IVR) configured in Yemot web interface
  3. Admin selects students and clicks "Run Campaign"
  4. System uploads phone numbers to Yemot template (UploadPhoneList)
  5. System triggers campaign execution (RunCampaign)
  6. Yemot executes campaign (makes calls asynchronously)
  7. System polls for status (GetCampaignStatus) and downloads report (DownloadCampaignReport)

Open Questions (18 total, 4 critical)

  • Q11 ⚠️: Yemot account has Templates/Campaigns API access enabled? Credentials and rate limits?
  • Q12: Which entity lists need bulk campaign buttons (student-klasses-report confirmed)
  • Q13: Create templates via API or sync existing templates from Yemot? (Recommended: Hybrid approach)
  • Q14: Billing/cost control requirements and quota limits

Implementation Phases

  1. MVP (2-3 weeks): Core template/campaign entities, Templates API integration, basic campaign execution and monitoring
  2. Enhanced (1-2 weeks): Report parsing, detailed per-call results, content management via API
  3. Advanced (2-3 weeks): Scheduled campaigns, job queue for large lists, analytics
  4. Hardening (1 week): Performance optimization, security audit

API Methods Used

  • Template Management: GetTemplates, CreateTemplate, UpdateTemplate, DeleteTemplate
  • Phone List Management: UploadPhoneList, GetTemplateEntries, ClearTemplateEntries
  • Campaign Execution: RunCampaign, GetCampaignStatus, DownloadCampaignReport
  • Campaign Control: GetActiveCampaigns, CampaignAction, ScheduleCampaign

No code changes in this PR - design document only for review and decision on open questions before implementation begins.

Original prompt

This section details on the original issue you should resolve

<issue_title>Automated Phone Calls HLD</issue_title>
<issue_description>Your task is to prepare a well thought of HLD for new feature
The change will probably cover client & server, shared modules & business logic
The new feature will allow users to create phone messages (we need to fiind best term for thsi)
Every type of phone message requried a first time configuration and wil be created in their matching Yemot instance
They will define the text to be said, or give file path for a recorded message (compare with text-by-user table and its usage)
After a phone message is configured it can be used
For example - by adding a bulk action button on student klasses report and selecting specific phone message, it should trigger this messag eto selected students' phone numbers

full api reference can be found here: https://f2.freeivr.co.il/topic/55/api-%D7%92%D7%99%D7%A9%D7%AA-%D7%9E%D7%A4%D7%AA%D7%97%D7%99%D7%9D-%D7%9C%D7%9E%D7%A2%D7%A8%D7%9B%D7%95%D7%AA/5 follow the links from this page too to relevant methods you may want ot use

The HLD must be well thought of, cover all relevant aspects. You should raise questions if needed to be answered by me. Suggest several possibliityies per each questino and explain the consequences</issue_description>

Comments on the Issue (you are @copilot in this section)


💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.

Co-authored-by: buzz-code <72219643+buzz-code@users.noreply.github.com>
Copilot AI changed the title [WIP] Prepare high-level design for automated phone calls feature Add HLD for automated phone calls feature with Yemot integration Jan 15, 2026
@buzz-code

Copy link
Copy Markdown
Owner

@copilot
you must rely on this - https://f2.freeivr.co.il/topic/55/api-%D7%92%D7%99%D7%A9%D7%AA-%D7%9E%D7%A4%D7%AA%D7%97%D7%99%D7%9D-%D7%9C%D7%9E%D7%A2%D7%A8%D7%9B%D7%95%D7%AA/5 as your source of truth about Yemot api!!
Focus on Templates\ Campaigns
Follow link if needed

- Shifted from generic outbound calls to Yemot Templates/Campaigns system
- Updated entities: YemotCampaignTemplate, YemotCampaign
- Documented complete Templates/Campaigns API workflow
- Added comprehensive API method references
- Updated all backend services, frontend components, and workflows
- Revised implementation phases to reflect campaign-based approach

Co-authored-by: buzz-code <72219643+buzz-code@users.noreply.github.com>

Copilot AI commented Jan 15, 2026

Copy link
Copy Markdown
Contributor Author

@copilot
you must rely on this - https://f2.freeivr.co.il/topic/55/api-%D7%92%D7%99%D7%A9%D7%AA-%D7%9E%D7%A4%D7%AA%D7%97%D7%99%D7%9D-%D7%9C%D7%9E%D7%A2%D7%A8%D7%9B%D7%95%D7%AA/5 as your source of tr...

Updated HLD to focus on Yemot Templates/Campaigns API as requested. Major changes in commit 9f93604:

Key Updates:

  • Shifted to Templates/Campaigns system (חלק 2 ניהול קמפיינים)
  • New entities: YemotCampaignTemplate, YemotCampaign
  • Complete API workflow: CreateTemplate → UploadPhoneList → RunCampaign → GetCampaignStatus → DownloadCampaignReport
  • Added comprehensive Yemot API method references with direct links

Workflow:

  1. Create/sync campaign templates from Yemot
  2. Upload phone numbers to template
  3. Run campaign
  4. Monitor progress & download reports

See full HLD v2.0 in docs/HLD-automated-phone-calls.md

Copilot AI changed the title Add HLD for automated phone calls feature with Yemot integration Add HLD for automated phone calls feature using Yemot Templates/Campaigns API Jan 15, 2026
@buzz-code buzz-code closed this Aug 22, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Automated Phone Calls HLD

2 participants