Introduction
The Campaign API allows you to manage voice campaigns programmatically. You can list campaigns and start campaign execution through WordPress-integrated endpoints.Authentication
Campaign endpoints use WordPress Integration Token authentication via thewordpress middleware.
All campaign endpoints require a valid
user_token parameter. See Authentication for details.Base URL
Available Endpoints
List Campaigns
Get all campaigns for authenticated user
Start Campaign
Execute a campaign by ID
Common Use Cases
1. WordPress Integration
Integrate TelemanAI campaigns directly into your WordPress site:- Trigger campaigns from WordPress admin panel
- Display campaign lists in custom WordPress pages
- Automate campaign execution based on WordPress events
2. External Application Integration
Connect third-party applications to TelemanAI:- CRM systems triggering voice campaigns
- Marketing automation platforms
- Custom dashboards and reporting tools
3. Automated Campaign Management
Automate campaign workflows:- Schedule campaigns via cron jobs
- Trigger campaigns based on business logic
- Integrate with webhooks and event systems
Campaign Workflow
Campaign Validation
When starting a campaign, the API performs several validation checks:Error Handling
The Campaign API returns specific error messages for different failure scenarios:| Error Message | Status Code | Description |
|---|---|---|
Unauthorized | 401 | Invalid or missing user_token |
Insufficient balance | 401 | User account has insufficient funds |
Campaign has no group or provider | 401 | Campaign missing required configuration |
Hourly quota crossed | 400 | Provider hourly limit reached |
Connection Failed | 401 | Twilio connection issue |
Rate Limits
Next Steps
List Campaigns
Learn how to retrieve campaign lists
Start Campaign
Learn how to execute campaigns