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

< / >

APIs Agent

Mostrar / Ocultar botones

URL:

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

Descripción:

Esta API permite ocultar o mostrar tres elementos clave: el botón de llamar, el panel de tipificación y el botón de colgar.

Beneficio:

Al usar esta API obtienes flexibilidad en la interfaz del agente, optimización de la experiencia, eficiencia operativa y control de acceso a funcionalidades.

¿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 reemplazar {{display}} por “show” si quieres que el botón se muestre o “hide” si quieres que el botón se oculte.
  • Debes reemplazar {{button}} por el botón que quieres mostrar u ocultar. “hungup” para referirse al botón de colgar, “disposition” que es el panel de tipificación y “dial” que es el botón para llamar.
  • 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 simultánea, por lo cual puede programar que la siguiente API sea consumida cuando el resultado de la anterior sea exitoso.
  • Nota: Esta API es compatible con wolkvox Agent de escritorio y versión web.
REQUEST
NAMEDESCRIPTIONTYPE
tokenCódigo de token generado en el aplicativo wolkvox Manager.INT
wolkvox_serverNomenclatura del servidor en el que se encuentra su operación. Este código es proporcionado por personal de soporte.INT
agent_idNúmero de extensión del agente asignado en el sistema wolkvox.INT
displayIndica “show” si quieres que el botón se muestre o “hide” si quieres ocultar el botón.STRING
buttonReferencia el botón de colgar con “hungup”, el panel de tipificación con “disposition” o el botón de llamar con “dial”.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
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=agent_display&display={{display}}&button={{button}}',
  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: {{wolkvox-token}}'
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

				
			

RESPONSE

				
					{
    "code": "200",
    "error": null,
    "msg": "default",
    "data": "Agentbox has been show"
}
				
			

RESPONSE

				
					{
    "code": "200",
    "error": null,
    "msg": "default",
    "data": "Agentbox has been hide"
}
				
			

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