Search
Close this search box.

< / >

Agent APIs

Hang Up, Disposition and Ready

URL:

https://wv{{wolkvox_server}}.wolkvox.com/api/v2/agentbox.php?agent_id={{agent_id}}&api=hang_type_ready&cod_act={{cod_act_1}}&cod_act_2={{cod_act_2}}&comments={{comments}}

Description:

This API allows hanging up and categorizing the call, as well as setting the agent’s status to “Ready”, thus unifying these actions and reaping significant benefits.

Benefit:

By using this API, you achieve optimization in call categorization, efficiency in encoding, and automation of the agent’s status.

How does it work?

  • The consumption of this API is done through the POST method.
  • For the API consumption to be successful, the call must be active.
  • Replace {{wolkvox_server}} in the URL with the nomenclature of its operation in the server.
  • You must replace {{agent_id}} with the extension number of the agent assigned in the wolkvox system.
  • You must replace {{cod_act_1}} with the categorization code you want to use. This code must be created in the activity code group 1.
  • You must replace {{cod_act_2}} with the categorization code you want to use. This code must be created in the activity code group 2. If you do not want to use a categorization code from the second activity code group, you can use the URL: https://wv{{wolkvox_server}}.wolkvox.com/api/v2/agentbox.php?agent_id={{agent_id}}&api=hang_type_ready&cod_act={{cod_act_1}}&comments={{comments}}
  • You must replace {{comments}} with the additional comment for the call categorization.
  • You must use “wolkvox-token: {{token}}” in the HEADER and replace {{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.
  • 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
NAMEDESCRIPTIONTYPE
tokenToken code generated in the Wolkvox Manager application.INT
wolkvox_serverServer nomenclature where your operation is located. This code is provided by support personnel.INT
agent_idExtension number of the agent assigned in the Wolkvox system.INT
cod_act_1Activity code to use for call categorization. Belonging to activity code group 1.STRING
cod_act_2Activity code to use for call categorization. Belonging to activity code group 2. If it is not necessary to use or if you do not have the second activity code option active in your operation, you can omit this field or you can also use the URL found in the ‘How does it work?’ section.STRING
commentsAdditional comments for call categorization.STRING
RESPONSE
NAMEDESCRIPTIONTYPE
codeIndica el código de estado de la respuesta.String
errorProporciona información detallada sobre cualquier error que pueda haber durante la ejecución de la API. El valor “null” indica que no se produjeron errores y que la ejecución de la API fue exitosa.String
msgEs un mensaje informativo que describe la respuesta.String
dataContiene el dato o conjunto de datos obtenidos al consumir la API. Es decir, almacena la información específica relacionada con la operación realizada mediante la API.JSON Object
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=hang_type_ready&cod_act={{cod_act_1}}&cod_act_2={{cod_act_2}}&comments={{comments}}',
  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": "Type 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