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

< / >

APIs Agent

Establecer el micrófono del agente en “Mute”

URL:

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

Descripción:

Esta API permite silenciar el micrófono del agente.

Beneficio:

Al usar esta API obtienes control remoto de los micrófonos del agente, automatización de operaciones, optimización de recursos y mejora de la experiencia del usuario.

¿Cómo funciona?

  • El consumo de esta API se realiza mediante el método POST.
  • Reemplaza {{wolkvox_server}} en la URL por la nomenclatura de su operación en el servidor.
  • Debes reemplazar {{agent_id}} por el número de extensión del agente asignado en el sistema wolkvox.
  • Debes usar  “wolkvox-token: {{token}}” en el HEADER y reemplazar  {{token}} por el token de autorización generado en su operación de wolkvox.
  • Tenga en cuenta que un mismo token no puede ser consumidos de manera simultanea, por lo cual puede programar que la siguiente API sea consumida cuando el resultado de la anterior sea exitoso.
  • Nota: Si se consume esta API y en el aplicativo del agente el botón de MUTE estaba activo, este se desactiva y viceversa.
  • Nota: Esta API es compatible con wolkvox Agent de escritorio y versión web.

REQUEST
NAME DESCRIPTION TYPE
token Código de token generado en el aplicativo wolkvox Manager. INT
wolkvox_server Nomenclatura del servidor en el que se encuentra su operación. Este código es proporcionado por personal de soporte. INT
agent_id Número de extensión del agente asignado en el sistema wolkvox. INT
RESPONSE
NAME DESCRIPTION TYPE
code Indica el código de estado de la respuesta. String
error Proporciona 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
msg Es un mensaje informativo que describe la respuesta. String
Posibles códigos de respuesta
				
					$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=mute',
  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": "Microphone agentbox has been excecuted"
}
				
			

Hacemos uso de cookies, si continúas navegando asumiremos que estás de acuerdo. Puede leer más sobre el uso de cookies en nuestras políticas de privacidad y tratamiento de datos personales

Hacemos uso de cookies, si continúas navegando asumiremos que estás de acuerdo. Puede leer más sobre el uso de cookies en nuestras políticas de privacidad y tratamiento de datos personales