Search
Close this search box.

< / >

Agent APIs

Schedule callback in predictive dialing

URL:

https://wv{{wolkvox_server}}.wolkvox.com/api/v2/agentbox.php?agent_id={{agent_id}}&api=recall&id_camp={{id_camp}}&id_customer={{id_customer}}&telefono={{telefono}}&rellamada={{rellamada}}&recall_style={{recall_style}}&name_recall={{name_recall}}

Description:

This API allows scheduling callbacks in predictive campaigns.

Benefit:

By using this API, you gain ease in managing and tracking communications with clients, time optimization, improved customer experience, process automation, and greater control.

How it works?

  • The consumption of this API is done through the POST method.
  • Replace {{wolkvox_server}} in the URL with the nomenclature of your operation on the server.
  • You must replace {{agent_id}} with the extension number assigned to the agent in the wolkvox system.
  • Replace {{customer_phone}} with the customer’s phone number.
  • Replace {{YYYYmmddHHiiss}} with the date and time when the callback should be executed. It should be in the format YYYYmmddHHiiss, for example: 20231122101520 Where “YYYY” is the year, “mm” is the month, “dd” is the day, “HH” is the hour in military format, “ii” is the minutes, and “ss” is the seconds.

  • Replace {{type_recall}} with the type of callback you want to establish. It can accept the value “auto” to make the callback automatically or “manual” for the agent to make the callback manually.
  • Use “wolkvox-token: {{token}}” in the HEADER, replacing {{token}} with the authorization token generated in your wolkvox operation.
  • Note that the same token cannot be consumed simultaneously, so you can schedule the next API to be consumed when the result of the previous one is successful.
  • The agent APIs v2 require an authentication token for access; however, the use of this token does not affect the assigned consumption. It is important to note that all other restrictions and limits set for API consumption remain applicable when using the agent v2 APIs.
  • Limit of records that can be downloaded per consumption: 60,000 records.
  • Limit of records that can be uploaded per consumption: 10,000 records.
  • Limit of days queried in dates: 31 days.
  • Limit of result weight: 256 MB.
  • API consumption time limit: 60 seconds.
  • Concurrent consumption limit of a token: 2 simultaneous requests.
  • Daily limit of tokens: Number of licenses multiplied by 1000 daily tokens.
  • Note: This API is compatible with both wolkvox Desktop Agent and web version.
     

 

REQUEST
NAME DESCRIPTION TYPE
wolkvox-token Token code generated in the wolkvox Manager application. INT
wolkvox_server Server code where your operation is located. This code is provided by the support team. INT
agent_id Agent extension number assigned in the wolkvox system. INT
id_camp Campaign identification number. INT
id_customer Customer identification number. String
telefono Customer’s phone number. INT
rellamada Date when the callback should be executed. It must follow the format YYYYmmddHHiiss, for example: 20231122101520 — where “YYYY” is the year, “mm” the month, “dd” the day, “HH” the hour in 24-hour format, “ii” the minutes, and “ss” the seconds. INT
recall_style Type of callback to set. It accepts the value “auto” for an automatic callback or “manual” for a callback manually executed by the agent. String
name_recall Customer’s name. This name will not replace the one in the campaign. If the customer did not have a name in the campaign, the name in this field will be used. This field is optional for API consumption. String
RESPONSE
NAME DESCRIPTION TYPE
code Indicates the status code of the response. INT
error Provides detailed information about any errors that may occur during the execution of the API. The value ‘null’ indicates that no errors occurred, and the API execution was successful. String
msg Is an informative message that describes the response. String
Possible response codes
				
					$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://wv{{wolkvox_server}}.wolkvox.com/api/v2/agentbox.php?agent_id={{agent_id}}&api=recall&id_camp={{id_camp}}&id_customer={{id_customer}}&telefono={{telefono}}&rellamada={{rellamada}}&recall_style={{recall_style}}&name_recall={{name_recall}}',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => '',
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'POST',
  CURLOPT_HTTPHEADER => array(
    'wolkvox_server: {{wolkvox_server}}',
    'wolkvox-token: {{wolkvox-token}}'
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

				
			

RESPONSE

				
					{
    "code": "200",
    "error": null,
    "msg": "Recall has been successful"
}
				
			
We use cookies, if you continue browsing we will assume that you agree. You can read more about the use of cookies in our privacy policies and treatment of personal data