fbpx
Search
Close this search box.
Search
Close this search box.

< / >

Agent APIs

Pause call

URL:

https://wv{{wolkvox_server}}.wolkvox.com/api/v2/agentbox.php?agent_id={{agent_id}}&api=hold

Description:

This API allows putting the agent’s call on hold.

Benefit:

Using this API provides efficient call management, greater control over calls, time optimization, and an enhanced customer experience.

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 should replace {{agent_id}} with the extension number assigned to the agent in the wolkvox system.
  • Use ‘wolkvox-token: {{token}}’ in the HEADER, replacing {{token}} with the authorization token generated in your wolkvox operation.
  • Please 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.
  • Note: If this API is consumed and the call was on hold in the agent’s application, the hold is deactivated, and vice versa.
  • Note: This API is compatible with both wolkvox Desktop Agent and web version.
     
     

REQUEST
NAME DESCRIPTION TYPE
token Token code generated in the Wolkvox Manager application. INT
wolkvox_server Server nomenclature where your operation is located. This code is provided by support personnel. INT
agent_id Agent extension number assigned in the Wolkvox system. INT
RESPONSE
NAME DESCRIPTION TYPE
code Indicates the response status code. String
error Provides detailed information about any errors that may occur during the API execution. 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=hold',
  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-token: {{token}}'
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

				
			

RESPONSE

				
					{
    "code": "200",
    "error": null,
    "msg": "Hold agentbox has been excecuted"
}
				
			
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