ServiceFlow Call Service API

Overview

The ServiceFlow Call Service API provides a comprehensive REST API for managing automated voice calls, call configurations, and call logs. Built for enterprise applications requiring reliable, scalable calling capabilities with support for multiple telephony providers.

Key Features

🔧 Call Configurations

Create and manage reusable call configurations with custom IVR flows, data extraction rules, and provider settings.

📞 Initiate Calls

Trigger automated calls programmatically with support for scheduling, immediate execution, and batch processing.

📊 Call Logs

Comprehensive call logging with status tracking, duration monitoring, and detailed analytics for all calls.

🔄 Multi-Provider

Seamless integration with Twilio and Telnyx with automatic failover and provider selection.

📡 Webhooks

Real-time webhook support for call events, status updates, and recording notifications.

🔒 Secure

Enterprise-grade security with JWT authentication, rate limiting, and encrypted communications.

API Endpoints

GET /api/call-service/calls - List all call logs

Retrieve paginated list of automated calls with filtering and sorting options.

POST /api/call-service/calls - Initiate a new call

Create and initiate an automated call using a configured call configuration.

GET /api/call-service/calls/:id - Get call details

Retrieve detailed information about a specific call including status, duration, and events.

GET /api/call-service/configs - List call configurations

Get all configured call templates and configurations for your business.

POST /api/call-service/configs - Create call configuration

Create a new call configuration with custom IVR flows and provider settings.

GET /health - Health check

Check API health status and service availability.

Authentication

All API requests require authentication using JWT tokens. Include the token in the Authorization header:

Authorization: Bearer YOUR_JWT_TOKEN

Get your API token by logging into the ServiceFlow platform and navigating to the Call Service section.

Rate Limits

API requests are rate-limited to 100 requests per 15 minutes per IP address to ensure fair usage and system stability.

Provider Support

The API supports both Twilio and Telnyx telephony providers. Configure your preferred provider in call configurations, and the system will automatically handle failover if one provider is unavailable.