Repository navigation
Add comprehensive HLD for Automated Phone Calls feature using Yemot API - All Decisions Finalized#74
Conversation
- Complete 715-line HLD document covering all aspects - Data models for PhoneTemplate and PhoneCampaign entities - Backend services (YemotApiService, PhoneTemplateService, PhoneCampaignService) - Frontend components and bulk action integration - Yemot API integration details - 8 design questions with alternatives and recommendations - Implementation phases (MVP, Enhanced, Advanced) - Security, testing, monitoring, and deployment considerations - 10 open questions for product owner - Summary document for quick reference Co-authored-by: buzz-code <72219643+buzz-code@users.noreply.github.com>
- Comprehensive ASCII diagrams showing system architecture - Data flow diagrams for template creation and campaign execution - Component interaction matrix - Authentication and error handling flows - Deployment architecture visualization - README for docs directory with reading order and quick reference Co-authored-by: buzz-code <72219643+buzz-code@users.noreply.github.com>
|
@copilot
API Endpoints - verify you use only standard endpoints defined on BaseEntityModule & BaseEntityController, I think you can do whatever you what there, ask me if you cannot do somthing in this way Campaign execution - I think it should be done on backend, it will be regular bulk action request, backend will extract phone numbers and use selected tempale to create a campaign and execute it Background polling: |
…sions - Per-user API KEY in User.yemotApiKey field (user settings) - Each user pays via their own Yemot account (no shared billing) - First integration: Student attendance report pivot table - MVP: TTS messages only, audio files deferred to Phase 2 - No scheduled campaigns in MVP - Summary-level campaign tracking (MVP detail level) - Per-user templates and campaigns with CrudAuth isolation - Compliance handled by Yemot system - No integration with YemotCall (incoming calls) - Terminology: EN "Phone Template"/"Campaign", HE "תבנית שיחה"/"מסע פרסום" - Standard BaseEntityModule endpoints with doAction for custom operations - Backend extracts phone numbers from selected IDs - User-triggered status refresh (no background polling) - Updated all design questions with final decisions - Converted "Open Questions" to "Decisions Made" section Co-authored-by: buzz-code <72219643+buzz-code@users.noreply.github.com>
Updated HLD with all your feedback (commit 858ac3c): Architecture Changes:
MVP Scope:
Terminology:
Implementation:
All "Open Questions" converted to "Decisions Made" section with ✅ checkmarks. HLD is now finalized and ready for implementation tickets. |
|
@copilot
|
…rvice integration - Hebrew campaign term: "משלוח שיחות" (Mishloach Sichot) only - API KEY in User.additionalData.yemotApiKey (no schema changes) - No custom routes - use standard BaseEntityModule patterns only - Entity services (StudentAttendanceService) override doAction to handle campaign execution - Entity service extracts phone numbers and calls PhoneCampaignService.executeCampaign() - Campaign execution flow: Entity /action endpoint → Entity service → PhoneCampaignService - Added detailed code example for entity service integration - Updated all references from User.yemotApiKey field to User.additionalData.yemotApiKey - Clarified no database migrations needed for User table - Updated terminology, implementation phases, and migration sections Co-authored-by: buzz-code <72219643+buzz-code@users.noreply.github.com>
Updated HLD with all refinements (commit 6d3b42f): 1. Hebrew Terminology: Using "משלוח שיחות" (Mishloach Sichot) for campaign throughout 2. User Settings Storage: Changed to 3. No Custom Routes: Removed all custom endpoints. Using only standard BaseEntityModule patterns:
4. Entity Service Integration: Added detailed example (Section 3.2.5) showing how StudentAttendanceService overrides doAction:
Flow: Frontend → Entity /action → Entity Service extracts phones → PhoneCampaignService → YemotApiService All documentation updated to reflect this pattern. |
Prepared a complete High-Level Design for automated phone call campaigns via Yemot API, enabling bulk-action triggered messaging to students/parents from the admin interface. All design decisions have been finalized based on product owner feedback.
Documentation Structure
Main HLD (
docs/HLD-Automated-Phone-Calls.md, 750+ lines)PhoneTemplate(per-user TTS message configs),PhoneCampaign(per-user execution tracking),User.additionalData.yemotApiKey(stored in existing user settings field)YemotApiService(per-user API client),PhoneTemplateService,PhoneCampaignService(extend BaseEntityService)StudentAttendanceServiceexample with doAction override patternPhoneTemplateBulkButtonfor student attendance pivot tableCreateTemplate,UploadPhoneList,RunCampaign(TTS mode),GetCampaignStatusSupporting Docs
HLD-Summary.md: Quick reference with finalized decisionsHLD-Architecture-Diagram.md: ASCII diagrams for system flowdocs/README.md: Navigation and reading orderFinalized Design Decisions (14 total)
Authentication & Storage:
User.additionalData.yemotApiKey(no schema changes)MVP Scope:
5. First Integration: Student attendance report pivot table
6. Message Content: TTS text only (embedded in PhoneTemplate), audio files deferred to Phase 2
7. Scheduled Campaigns: Not in MVP, deferred to Phase 3
8. Result Tracking: Summary-only (total, successfulCalls, failedCalls counts)
9. Status Updates: User-triggered via
/actionendpoint (no background polling)Architecture:
10. Phone Extraction: Entity service extracts from its own records
11. Execution Flow: Entity service →
PhoneCampaignService.executeCampaign()12. API Endpoints: Standard BaseEntityModule only (no custom routes)
13. Entity Integration: Entity services override
doActionfor campaign execution14. Multi-tenancy: Per-user templates and campaigns (CrudAuth isolation)
15. Terminology: EN: "Phone Template"/"Campaign", HE: "תבנית שיחה"/"משלוח שיחות"
Compliance & Integration:
Entity Service Integration Pattern
Campaign execution follows clean separation of concerns:
Execution Flow:
Integration Example
Implementation Phases
/actionendpoints only, summary trackingStatus: ✅ Ready for Implementation
All 14 design questions answered by product owner. HLD includes entity service integration pattern with code examples. Strictly uses standard BaseEntityModule patterns (no custom routes).
Next Steps
additionalData.yemotApiKeyOriginal prompt
💬 We'd love your input! Share your thoughts on Copilot coding agent in our 2 minute survey.