Skip to main content

Communications API

The VenturEd Solutions Communications API provides a powerful, reliable platform for sending text messages and emails through our Messenger service. Built for education technology partners and organizations, our API enables seamless communication with students, parents, and staff while maintaining full message history and compliance tracking.

🚀 What You Can Do​

Multi-Channel Messaging​

  • SMS: Send text messages with delivery tracking and callback support
  • Email: Rich HTML emails with templates and personalization
  • Smart Routing: Automatic delivery optimization based on recipient preferences

Education-Focused Features​

  • Integration with school management systems
  • Compliance with education data protection requirements
  • Message history tracking in Groupcall and Teachers2Parents platforms
  • Automatic school billing and usage tracking

Developer-Friendly​

  • RESTful API design with comprehensive documentation
  • Multiple authentication methods for different use cases
  • Sandbox environment for testing and development
  • Real-time delivery status via webhooks

🎯 Who This Is For​

EdTech Partners​

Third-party application developers who need to send communications on behalf of multiple schools and organizations.

School Systems​

Educational institutions looking to integrate messaging capabilities directly into their existing platforms.

SaaS Providers​

Software providers serving the education sector who need reliable communication infrastructure.

🏗️ API Architecture​

Our API provides a unified interface for multi-channel messaging:

┌─────────────────┐      ┌──────────────────┐      ┌─────────────────┐
│                 │      │                  │      │                 │
│ Your Application│ ───> │ Communications   │ ───> │   SMS Gateway   │
│                 │      │      API         │      │                 │
└─────────────────┘      │                  │      └─────────────────┘
                         │                  │      
                         │                  │      ┌─────────────────┐
                         │                  │ ───> │  Email Service  │
                         │                  │      └─────────────────┘
                         │                  │      
                         │                  │      ┌─────────────────┐
                         │                  │ ───> │ Message History │
                         └──────────────────┘      └─────────────────┘
                                                            │
                                                            V
                                                   ┌─────────────────┐
                                                   │ Reporting       │
                                                   │ Dashboard       │
                                                   └─────────────────┘

Our API handles the complexity of multi-channel delivery, compliance tracking, and integration with education platforms, so you can focus on building great user experiences.

📚 Getting Started​

New to Our Platform?​

Start with our Partner Onboarding guide to get your API credentials and sandbox access.

Ready to Integrate?​

Jump to Quick Start for a guide with code examples.

Need Technical Details?​

Explore our comprehensive API Reference with interactive examples.

🔐 Authentication & Security​

We offer two flexible authentication methods to suit different integration scenarios:

Customer-Specific Authentication​

For direct customer integrations, the API payload includes a messageData object with:

  • CustomerId: The internal ID of the customer account
  • Password: Customer-specific API key (generated and available through the UI)
{
  "messageData": {
    "CustomerId": "customer_123",
    "Password": "cust_api_key_abc123"
  },
  "messages": [...]
}

Partner Authentication​

For partners managing multiple customers, the payload structure includes:

  • PartnerKey: Unique API key provided to the partner at onboarding
  • CustomerId: Identifies which customer you're sending on behalf of
  • Password: Customer-specific API key delivered to your callback URL when the customer authorizes your partner access
{
  "PartnerKey": "partner_key_xyz789",
  "messageData": {
    "CustomerId": "customer_123", 
    "Password": "cust_auth_token_def456"
  },
  "messages": [...]
}

Partner Onboarding Process:

  1. Partner receives PartnerKey during onboarding
  2. Partner provides a callback URL during onboarding
  3. When customers authorize the partner, their Password (API key) is delivered to the partner's callback URL
  4. Partner can then send messages on behalf of that customer

Learn more in our Authentication Guide.

🌍 Global Reach, Local Compliance​

  • UK & International: Support for multiple regions and carriers
  • GDPR Compliant: Built-in data protection and privacy controls
  • Education Standards: Compliant with education sector requirements
  • Audit Trails: Complete message tracking and reporting

📊 Reliability & Scale​

  • 99.9% Uptime: Enterprise-grade reliability
  • High Throughput: Handle millions of messages per day
  • Real-time Monitoring: Live delivery status and analytics
  • Automatic Retry: Built-in failure handling and retry logic
SectionDescription
🚀 Getting StartedPartner onboarding, sandbox setup, and first message
🔐 AuthenticationAPI keys, security, and authentication methods
📖 API GuidesSMS, email, and advanced messaging features
💡 ConceptsCore concepts, best practices, and patterns
📚 API ReferenceComplete technical documentation

Ready to get started? Begin with Partner Onboarding or explore our API Reference for technical details.