Virtual Scale API Documentation

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:

Get Interactions

Retrieves information about Interactions based on specified criteria.

Endpoint

GET /v1/interactions

Parameters

Headers

API Testing

Use the Swagger UI below to test the API endpoints: