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

< / >

APIs

13. Editar agente

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

Ejemplos de código:

En nuestro workspace de Postman (da clic aquí para ir), tienes acceso a ejemplos de código que facilitan la integración con nuestras APIs en diferentes lenguajes de programación, como cURL, Python, JavaScript, y más.

Esta funcionalidad es ideal para integraciones rápidas y permite adaptar los llamados a la API según el lenguaje de programación de tu sistema.

Cómo Usar los Ejemplos de Código:

  1. Navega a nuestro workspace en Postman.
  2. Selecciona la API que deseas consultar.
  3. Edita los parámetros necesarios de la API según tus objetivos.
  4. En la pestaña de “Code”, selecciona el lenguaje de tu preferencia.
  5. Obtendrás un fragmento de código autogenerado, listo para usarse con los parámetros y autenticación configurados anteriormente.

 

Descripción:

Esta API permite actualizar o editar la información de un agente.

Beneficio:
Optimice los procesos y el tiempo al editar la información del agente desde soluciones externas.

Tipo de petición:
PUT

Cómo funciona:

  • El consumo de esta API se realiza por método PUT.
  • En el json se agregan los parámetros 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: {{token}} para hacer uso de el token de autorización.
  • Tenga en cuenta que un mismo token no puede ser consumido de manera simultánea, por lo cual puede programar que la siguiente API sea consumida cuando el resultado de la anterior sea exitoso.
  • El campo “agent_sso”: “” es opcional y permite a los usuarios iniciar sesión en el sistema utilizando sus credenciales de autenticación existentes, sin la necesidad de proporcionar información de inicio de sesión separada para nuestro software.
  • El campo para asignar una contraseña “agent_pass”: “” puede permanecer vacío y el sistema asignará una contraseña aleatoria.
  • La contraseña deberá tener mínimamente una letra mayúscula, minúscula, un número y un caracter especial (!#%&*@).
  • Límite de registros que se pueden bajar por consumo: 60,000 registros.
  • Límite de registros que se pueden subir por consumo: 10,000 registros.
  • Límite de días consultados en fechas: 31 días.
  • Límite de peso del resultado: 256 MB.
  • Límite de tiempo de consumo del API: 60 segundos.
  • Límite de consumo simultáneo de un token: 2 solicitudes simultáneas.
  • Límite diario de tokens: Número de licencias multiplicado por 1000 tokens diarios.

 

Request

NAME DESCRIPTION TYPE
agent_id Número de extensión del agente en wolkvox Agent. String
agent_dni Número del documento de identificación del agente. String
agent_name Nombre del agente. String
agent_sso Single Sign-On (SSO) es una característica opcional que permite a los usuarios iniciar sesión en el sistema utilizando sus credenciales de autenticación existentes, sin la necesidad de proporcionar información de inicio de sesión separada para nuestro software. String
agent_pass Contraseña que deseas asignar al agente. String

 

Response

NAME DESCRIPTION TYPE
code Código de respuesta. int
error Error. String
msg Descripción de 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/configuration.php?api=edit_agent&agent_id={{agent_id}}',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => '',
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'PUT',
  CURLOPT_POSTFIELDS =>'{
    "agent_dni": "{{agent_dni}}",
    "agent_name": "{{agent_name}}",
    "agent_sso": "{{agent_sso}}",
    "agent_pass": "{{agent_pass}}"
}',
  CURLOPT_HTTPHEADER => array(
    'wolkvox_server: {{wolkvox_server}}',
    'wolkvox-token: {{wolkvox-token}}',
    'Content-Type: application/json'
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

				
			

RESPONSE

				
					{
    "code": 202,
    "error": null,
    "msg": "agent has been updated"
}
				
			

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