WHY WOLKVOX? OMNICHANNEL PLATFORM WOLKVOX CRM CHATBOTS AND VOICEBOTS MANUALS

COLOMBIA Medellín +57 (4) 322 98 80 Bogotá +57 (1) 381 90 40 Cali +57 (2) 891 28 46 Barranquilla +57 (5) 316 10 34 ARGENTINA Buenos Aires +54 (11) 5217 5933 SPAIN Madrid +34 (910) 601 691 MEXICO Ciudad de México +52 (55) 8526 36 34 BRASIL Brasilia +55 (61) 9836 4127 São Paulo +55 (12) 9811 155 83 UNITED STATES New York +1 (914) 373 71 36 DOMINICAN REPUBLIC Santo Domingo +1 (829) 249 69 68 CHILE Santiago de Chile +56 (2) 240 533 89 GUATEMALA Ciudad de Guatemala +502 (2) 314 1344 PERU Lima +51 (1) 644 91 39

10. Query scheduled recalls in campaigns -

< / >

APIs Real Time

10. Query scheduled recalls in campaigns

URL:

https://wv{{wolkvox_server}}.wolkvox.com/api/v2/real_time.php?api=recall&type=all

Description:

This API provides a centralized and unified view of all recalls scheduled in campaigns. This tool is designed for administrators and integrators who need to consolidate recall information from various sources, whether they were created manually, automatically, through the API, or by uploading a database. This functionality allows you to obtain detailed information about active recalls, regardless of their origin.

Benefits:

Unified and Centralized View: Consolidates information on all active recalls, eliminating the need to search multiple sources.
Improved Traceability and Auditing: Allows you to identify the date, time, campaign, and assigned agent for each recall, facilitating auditing and the tracking of your contact strategy.
Optimized Operational Control: Provides real-time data to make operational decisions, such as reassigning tasks or identifying bottlenecks.
Flexible Integration: Facilitates integration with custom dashboards, external analytics systems, or task assignment engines, thereby enhancing your operational management capabilities.
Strategic Planning: Improves campaign planning by providing a clear view of the future workload related to pending recalls.

How it works:

This API is consumed using the GET method.
To consume this API, replace {{wolkvox_server}} in the URL with your operation’s server nomenclature.
You must use the header `wolkvox-token: {{token}}` to include the authorization token.
Note that the same token cannot be used simultaneously, so you can schedule the next API call to be consumed only after the previous one succeeds.
In the URL, you can use `type=` to filter the search with the values “all”, “manual”, or “auto”.
In terms of timing, you can consume this information every 5 minutes to monitor your operation.
Limits:
- Maximum records per download: 60,000 records.
- Maximum records per upload: 10,000 records.
- Maximum days for date queries: 31 days.
- Maximum result size: 256 MB.
- API consumption time limit: 60 seconds.
- Simultaneous token usage limit: 2 concurrent requests.
- Daily token limit: Number of licenses multiplied by 1,000 tokens per day.

Code examples:

In our Postman workspace (click here to access), you have access to code examples that make it easier to integrate with our APIs in various programming languages, such as cURL, Python, JavaScript, and more.
This feature is ideal for quick integrations and allows you to adapt API calls according to your system’s programming language.

How to use the code examples:

Navigate to our Postman workspace.
Select the API you want to query.
Edit the necessary API parameters according to your goals.
In the “Code” tab, choose your preferred language.
You will get an auto-generated code snippet, ready to use with the previously configured parameters and authentication.

Request

NAME	DESCRIPTION	TYPE
api	Required report type.	String

Response

NAME	DESCRIPTION	TYPE
code	Response status code.	String
error	Detailed information about any errors that may have occurred during API execution. If there are no errors, the value is null.	String
msg	Informative message describing the API response.	String
data	Array containing the details of each scheduled recall found in the database.	String
type_recall	Recall source type. Indicates how it was created.	String
date_recall	Exact date and time when the recall is scheduled to be executed.	String
phone_number	Phone number to which the callback should be made.	String
id_campaing	Unique identifier of the campaign to which the scheduled recall belongs.	String
id_agent	Unique identifier of the agent assigned to the recall.	String

Possible response codes

				
					$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://wv{{wolkvox_server}}.wolkvox.com/api/v2/real_time.php?api=recall&type=all',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => '',
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'GET',
  CURLOPT_HTTPHEADER => array(
    'wolkvox-token: {{wolkvox-token}}'
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

				
					curl --location --globoff 'https://wv{{wolkvox_server}}.wolkvox.com/api/v2/real_time.php?api=recall&type=all' \
--header 'wolkvox-token: {{wolkvox-token}}'

				
					OkHttpClient client = new OkHttpClient().newBuilder()
  .build();
MediaType mediaType = MediaType.parse("text/plain");
RequestBody body = RequestBody.create(mediaType, "");
Request request = new Request.Builder()
  .url("https://wv{{wolkvox_server}}.wolkvox.com/api/v2/real_time.php?api=recall&type=all")
  .method("GET", body)
  .addHeader("wolkvox-token", "{{wolkvox-token}}")
  .build();
Response response = client.newCall(request).execute();

				
					import requests

url = "https://wv{{wolkvox_server}}.wolkvox.com/api/v2/real_time.php?api=recall&type=all"

payload = {}
headers = {
  'wolkvox-token': '{{wolkvox-token}}'
}

response = requests.request("GET", url, headers=headers, data=payload)

print(response.text)

RESPONSE

				
					{
    "code": "200",
    "error": null,
    "msg": "X records were found",
    "data": [
        {
            "type_recall": "",
            "date_recall": "",
            "phone_number": "",
            "id_campaing": "",
            "id_agent": ""
        },
        {
            "type_recall": "",
            "date_recall": "",
            "phone_number": "",
            "id_campaing": "",
            "id_agent": ""
        }
    ]
}

APPLICATIONS

MULTICHANNEL DIALER

WOLKVOX STUDIO

ARTIFICIAL INTELLIGENCE

VOICE OF THE CUSTOMER

QUALITY AND PRODUCTIVITY

ANALYTICS

TELEPHONY

INTEGRATIONS

BY INDUSTRY

BY COMPANY TYPE

SMART TEAMS

AUTOMATION AND
ARTIFICIAL INTELLIGENCE

DIGITAL TRANSFORMATION

< / >

APIs Real Time

10. Query scheduled recalls in campaigns

Request

Response

RESPONSE

UNITED STATES

ARGENTINA

BRAZIL

CHILE

SPAIN

COLOMBIA

GUATEMALA

MEXICO

DOMINICAN REPUBLIC

PERU

APPLICATIONS

MULTICHANNEL DIALER

WOLKVOX STUDIO

ARTIFICIAL INTELLIGENCE

VOICE OF THE CUSTOMER

QUALITY AND PRODUCTIVITY

ANALYTICS

TELEPHONY

INTEGRATIONS

BY INDUSTRY

BY COMPANY TYPE

SMART TEAMS

AUTOMATION AND ARTIFICIAL INTELLIGENCE

DIGITAL TRANSFORMATION

< / >

APIs Real Time

10. Query scheduled recalls in campaigns

Request

Response

RESPONSE

UNITED STATES

ARGENTINA

BRAZIL

CHILE

SPAIN

COLOMBIA

GUATEMALA

MEXICO

DOMINICAN REPUBLIC

PERU

AUTOMATION AND
ARTIFICIAL INTELLIGENCE