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

< / >

Agent APIs

Change agent state

URL:

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

Description:

This API allows changing the agent’s state to the “Ready” state or an auxiliary state created in the wolkvox system of your operation.

Benefit:

By using this API, you achieve dynamic changes in the agent’s state, automation of state changes, integration with workflows, and operational efficiency.

How it works?

  • The consumption of this API is done using the POST method.
  • Replace {{wolkvox_server}} in the URL with the nomenclature of your operation on the server.
  • You should replace {{status}} with the code of the state you want to assign to the agent. You can obtain the codes for auxiliary states in the “ID” column of the “Agent States” tab in the configuration of the wolkvox Manager application for your operation. For default states, you can use “ready” or “logout.”
  • Replace {{agent_id}} with the agent’s extension number assigned in the wolkvox system.
  • Use “wolkvox-token: {{token}}” in the HEADER and replace {{token}} with the authorization token generated in your wolkvox operation.
  • Keep in mind that the same token cannot be consumed simultaneously, so you can schedule the consumption of the next API when the result of the previous one is successful.
  • 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
status It is the code of the state you want to assign to the agent. You can obtain the codes for auxiliary states in the “ID” column of the “Agent States” tab in the configuration of the wolkvox Manager application for your operation. For default states, you can send “ready” or “logout.” String
agent_id Agent’s 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?status={{status}}&api=change_status&agent_id={{agent_id}}',
  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": "Agent status has been modified to Active breaks"
}
				
			
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