fbpx

< / >

APIs Configuration

2. Crear agente

URL:

https://wv{{wolkvox_server}}.wolkvox.com/api/v2/configuration.php?api=create_agent

Descripción:

Esta API permite crear desde soluciones externas nuevos agentes,  parametrizando el nombre, su identificación y usuario de red, información requerida para hacer el logueo. 

Beneficio:

Optimice los procesos y el tiempo al crear agentes de soluciones externas de manera ágil y simple.

Cómo funciona:

  • El consumo de esta API se realiza por método POST.
  • En el json se agregan los parametros de acuerdo a la operación o proceso a realizar.
  • 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.
REQUEST
NAME DESCRIPTION TYPE
agent_dni Numero de identificación personal del agente String
agent_name Nombre del agente String
agent_sso Usuario de red para la función single sign on String
RESPONSE
NAME DESCRIPTION TYPE
agent_id Se refiere a la identificación numerica del agente String
password Contraseña del agente 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/configuration.php?api=create_agent',
  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; 'POST',
  CURLOPT_POSTFIELDS =&gt;'{
    "agent_dni": "",
    "agent_name": "",
    "agent_sso": ""
}',
  CURLOPT_HTTPHEADER =&gt; array(
    'wolkvox-token: {{token}}',
    'Content-Type: application/json'
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;
				
			

RESPONSE

				
					{
    "code": 201,
    "error": null,
    "msg": "Agent has been created",
    "data": [
        {
            "agent_id": "",
            "password": ""
        }
    ]
}
				
			

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