Introduction

wolkvox APIs allow you to connect your operation with external systems to automate tasks, extract data, or execute actions directly from your own applications.

All APIs in the wolkvox ecosystem follow a common structure based on secure HTTPS requests, token-based authentication, and JSON-formatted responses.

Each API may vary slightly depending on its function: some require more or fewer parameters in the URL, others need information sent in the request body (form-data or raw JSON), and the consumption method can be GET, POST, PUT, or DELETE.

This article explains the general elements you need to understand to correctly consume any wolkvox API.

Accessing the List of Available APIs

1. Go to the wolkvox developer portal: https://developers.wolkvox.com/es-apis-v2/
2. In the left-hand menu, you’ll find APIs grouped by category (Agent, Reports, Real-Time, Campaigns, Configuration, Billing, WhatsApp, Information, Quality Analyzer, Speech Analytics, Gamification, Listenvox, etc.).
3. You can also explore and test the APIs from the official Postman collection: https://postman.com/wolkvox-api/workspace/team-workspace
4. There you’ll find each API with its variables, parameters, code examples, and response structure, ready to use.

Basic Elements of a wolkvox API

Generate and Use the Authentication Token

1. Log in to wolkvox Manager.
   1. Click the Settings icon (gear) located in the upper-right menu of the application.
2. In the pop-up Settings window, navigate and select the Integrations main tab.
3. Within this section, click the Tokens sub-tab.
4. In the Token Description field, enter a clear name or description to identify the token’s purpose. This field is required.
5. Press the “Add Token” button.
6. The new token will immediately appear in the lower table, showing the token itself, its description, daily usage count, and total consumption limit.
7. Right-click on the token value and select “Copy Token”, then add it to your request header as:
   1. wolkvox-token: {{token}}
   2. Important: The same token cannot be used simultaneously in multiple requests. Wait for the API response before making the next call.

General Structure of a Request

Example of a GET API (URL only)

Read-type API, such as “Agent time by status”:

GET https://wv01.wolkvox.com/api/v2/reports_manager.php?api=agent_1&date_ini=20250101000000&date_end=20250101235959

Header

wolkvox-token: {{token}}

Example of a POST API with form-data

Upload-type API, such as “Upload audio”:

POST https://wv01.wolkvox.com/api/v2/configuration.php?api=upload_audio

Header

wolkvox-token: {{token}}

Body (form-data)

Example of a PUT API with parameters

Update-type API, such as “Start campaign”:

PUT https://wv01.wolkvox.com/api/v2/campaign.php?api=start&type_campaign={{type_campaign}}&campaign_id={{campaign_id}}

Header

wolkvox-token: {{token}}

Interpreting the API Response

Each API page contains documentation for every field in the response object.

Best Practices for API Consumption

• Schedule your API calls at regular intervals (e.g., every 5 minutes).
• Keep your tokens secure and avoid sharing them.
• Respect API consumption limits (60,000 records per request or 256 MB of result).
• Do not execute simultaneous requests using the same token.
• Use testing environments (wolkvox Postman Workspace) before integrating into production.