fbpx

< / >

APIs Information

5. Agents

URL:

https://wv{{wolkvox_server}}.wolkvox.com/api/v2/information.php?api=agents

Descripción:

Esta API Permite tener información acerca de los Agentes. 

Beneficio:

Permite tener información básica como última conexión, estados y skill al cual pertenecen los agentes.

Cómo funciona:

  • El consumo de esta API se realiza por método GET.
  • Para consumir esta API debe reemplazar en la url {{wolkvox_server}} por la nomenclatura del servidor de la operación.
  • Se debe hacer uso del header wolkvox-token para hacer uso de el token de autorización.
  • 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.
  • En términos de tiempo, para hacer seguimiento a su operación puede hacer un consumo cada 5 minutos de la información.
REQUEST
NAME DESCRIPTION TYPE
api Tipo de reporte requerido String
RESPONSE
NAME DESCRIPTION TYPE
agent_id Es el usuario numérico que se asigna a cada uno de los usuarios de wolkvox Agente String
agent_name Es el nombre que se asigna a cada uno de los usuarios de wolkvox Agente String
agent_dni Es el documento de identificación de cada uno de los usuarios de wolkvox Agente String
agent_status Estado del agente String
last_use Fecha de la última conexión​ String

 

Posibles códigos de respuesta
				
					$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL =&gt; 'https://wv{{wolkvox_server}}.wolkvox.com/api/v2/information.php?api=agents',
  CURLOPT_RETURNTRANSFER =&gt; true,
  CURLOPT_ENCODING =&gt; '',
  CURLOPT_MAXREDIRS =&gt; 10,
  CURLOPT_TIMEOUT =&gt; 0,
  CURLOPT_FOLLOWLOCATION =&gt; true,
  CURLOPT_HTTP_VERSION =&gt; CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST =&gt; 'GET',
  CURLOPT_HTTPHEADER =&gt; array(
    'wolkvox-token: {{token}}'
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;
				
			

RESPONSE

				
					{
    "code": "",
    "error": null,
    "msg": "1 records were found",
    "data": [
        {
            "agent_id": "",
            "agent_name": "",
            "agent_dni": "",
            "agent_status": "",
            "last_use": ""
        }
    ]
}
				
			

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