Introduction
Interact with the Virtual Scale API through HTTP requests from any programming language. We currently provide examples in JavaScript and Python for making requests to our API. Our API enables you to initiate voice calls to multiple recipients simultaneously, facilitating efficient communication with leads or clients.
Note: If you have any questions about API usage or need more examples, feel free to ask our AI agent in the chat widget located at the bottom right of your screen. We're here to help!
Authentication
The Virtual Scale API uses API keys for authentication. Each API key is scoped to a specific project for security purposes.
Remember to keep your API key secure and never expose it in client-side code. Production requests should be routed through your backend server, where the API key can be securely loaded from an environment variable or key management service.
Include your API key in the Authorization header of your API requests as follows:
Authorization: api-key YOUR_API_KEY
Post Interactions
Sends interactions to the queue. (This will create lead when the interaction is processed)
Endpoint
POST /v1/interactions/queue
Request Body
The request body should be a JSON array containing objects, each representing a call to be made. Each object may contain the following fields:
- to (Required): List of recipient phone numbers to call.
- channel (Optional):Communication channel, default is "call",available are ["call","whatsapp","sms"].
- name (Required): Lead's name.
- language (Required): Language preference of the call in ISO format.
- code (Optional): The code of the Lead.
- country (Optional): Country of the Lead.
- email (Optional): Lead's email address.
- additional_information (Optional): Any additional information relevant to the call.
- specific_utc_call_time (Optional): Specific UTC time to schedule the call in datetime format.
- extra_field_one (Optional): Additional custom fields for sharing any type of data, with a maximum of 20 custom fields allowed. Ask the Chat widget for the limits.
- queue_priority (Optional): The priority level assigned to a call in the queue, determining the order in which calls are made. A lower value indicates a higher priority. Valid values range from 1 (highest priority) to 3 (lowest priority). The default value is 3.
- queue_verification (Optional): If set to
true
, the system will check if the lead is already in the queue. If the lead exists, it will not be added again. - team_id (Optional): A string identifier that determines which team will contact the lead.
Get Interactions
Retrieves information about Interactions based on specified criteria.
Endpoint
GET /v1/interactions
Parameters
- phone (optional): Phone number of the Lead.
- code (optional): Lead code.
- date (optional): Date of the call.
- categories (optional): List of call categories.
- date_range (optional): Range of dates for filtering calls.
- calls_range (default: 10): Number of calls to retrieve.
Headers
- api-key: Your API key for authentication.
- Content-Type: application/json
API Testing
Use the Swagger UI below to test the API endpoints: