API Terceros/Ciudades

Descripción: Este reporte entrega una visión completa de la gestión del agente al resumir individualmente la actividad del asesor indicando el total de las llamadas gestionadas (inbound/ outbound/ internal), el tiempo que ha usado en cada fase de la atención al cliente (tiempo de Ring, ACW y AHT), fecha y hora de Log In/Log Out, además la cantidad de hits y RPC.

Autorización: Se requiere autenticación para todas las solicitudes. Las credenciales de autenticación deben ser incluidas en la cabecera de todas las solicitudes a través del campo Authorization utilizando el token de acceso entregado SERPI ERP.

Beneficio: Este reporte permite hacer una medición de la productividad individual de los agentes teniendo en cuenta el tiempo dedicado a la gestión de llamadas y sus logros (hits y RPC)

Tipos de peticiones: GET, POST, PUT

¿Cómo funciona?

• El consumo de esta API se realiza por método GET.
• Para consumir esta API debe reemplazar en la url {ip_ipdialbox} por la nomenclatura del servidor de la operación y el {token} generado desde wolkvox Manager para obtener la información de manera segura.
• 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.

Métodos

<Tabs> <Tab name = "API Consulta (GET) "> GET/users

EndPoint: https://www.apis.serpi.com.co/api/v1/Ciudad

EndPoint con parámetros: https://www.apis.serpi.com.co/api/v1/Ciudad?limite=50&pagina=1

Headers

Header	Descripción
secretkey	Secretkey proporcionada al cliente para consumos de las APIs

Authorization:

Usar Bearer. Ejemplo “bearer {{token}}”.
{{token}} Token de autorizacion generado por SerpiERP

Parámetros

Parámetro	Tipo de dato	Requerido	Descripción
Límite	int	No	Este parámetro indica la cantidad de resultados que se deben devolver en una sola página
Página	int	No	Este parámetro indica el número de la página que se debe devolver. Por ejemplo, si se establece en 3, se devolverán los resultados de la tercera página

Response

{
"success": true
	"code": 200,
	"message": "x registro(s) encontrados",
	"result": [
		{
            "id": 5001,
            "ciudad": "MEDELLÍN",
            "codigo": "05001",
            "codigo_postal": null,
            "id_departamento": 5
        }
	]
}

{
	"success": true
	"code": 201,
	"message": "No se encontraron registros",
	"result": []
}

Campo de resultados

Campo	Tipo de dato	Descripción
id	int	Corresponde al identificador de la Ciudad
ciudad	string	Nombre de ciudad
codigo	string	Codigo de ciudad
codigo_postal	int	Código postal de ciudad
id_departamento	int	identificador del departamento correspondiente

</Tab>

<Tab name = "API Creación (POST) "> POST /users

EndPoint: https://www.apis.serpi.com.co/api/v1/Ciudad

Headers

Header	Descripción
secretkey	Secretkey proporcionada al cliente para consumos de las APIs

Authorization:

Usar Bearer. Ejemplo “bearer {{token}}”.
{{token}} Token de autorizacion generado por SerpiERP

Request

{
    "ciudad": "MEDELLÍN",
    "codigo": "05001",
    "codigo_postal": null,
    "id_departamento": 5
}

Campos del request

Campo	Tipo de dato	Longitud	Requerido	Descripción
ciudad	string	50	SI	Nombre de ciudad
codigo	string	50	SI	codigo de ciudad
codigo_postal	int	50	NO	Codigo postal de ciudad
id_departamento	int	50	SI	identificador del departamento correspondiente

Authorization:

Usar Bearer. Ejemplo “bearer {{token}}”.
{{token}} Token de autorizacion generado por SerpiERP

Response

{
"success": true
	"code": 200,
	"message": "x registro(s) encontrados",
	"result": [
		{
            "id": 5001,
            "ciudad": "MEDELLÍN",
            "codigo": "05001",
            "codigo_postal": null,
            "id_departamento": 5
        }
	]
}

{
	"success": true
	"code": 201,
	"message": "No se encontraron registros",
	"result": []
}

</Tab>

<Tab name = "API Modificar(PUT) "> PUT/users

EndPoint: https://www.apis.serpi.com.co/api/v1/Ciudad

Headers

Header	Descripción
secretkey	Secretkey proporcionada al cliente para consumos de las APIs

Authorization:

Usar Bearer. Ejemplo “bearer {{token}}”.
{{token}} Token de autorizacion generado por SerpiERP

Request

{
    "id": 5001,
    "ciudad": "MEDELLÍN",
    "codigo": "05001",
    "codigo_postal": null,
    "id_departamento": 5
}

Campos del request

Campo	Tipo de dato	Longitud	Requerido	Descripción
id	int	50	SI	identificador de ciudad
ciudad	string	50	SI	Nombre de ciudad
codigo	string	50	SI	codigo de ciudad
codigo_postal	int	50	SI	Codigo postal de ciudad
id_departamento	int	50	NO	identificador del departamento correspondiente

Authorization:

Usar Bearer. Ejemplo “bearer {{token}}”.
{{token}} Token de autorizacion generado por SerpiERP

Response

{
"success": true
    	"code": 200,
    	"message": "registro modificado exitosamente"
}

{
    	"success": false,
    	"code": 400,
    	"errors": [
        		"El campo abreviatura es obligatorio"
    	],
    	"message": "Se presentaron errores al modificar el registro"
}




{
    	"success": false,
    	"code": 204,
    	"errors": null,
    	"message": "No se encontraron registros con el id xx"
}

</Tab> </Tabs>

¿Cómo consumir la API?

<Tabs>

<Tab name = "Java"> Request

OkHttpClient client = new OkHttpClient().newBuilder()
  .build();
Request request = new Request.Builder()
  .url("https://wv9901.wolkvox.com/api/v2/reports_manager.php?api=agent_1&date_ini={{YYYYmmddHHiiss}}&date_end={{YYYYmmddHHiiss}}")
  .method("GET", null)
  .addHeader("wolkvox-token", "{{token}}")
  .build();
Response response = client.newCall(request).execute();

Response

{
    "code": 200,
    "error": null,
    "msg": "Information found for the current month",
    "data": [
        {
            "operation": "",
            "description": "",
            "items": "",
            "date": ""
        }
    ]
}

</Tab>

<Tab name = "Python"> Request

import requests

url = "https://wv9901.wolkvox.com/api/v2/reports_manager.php?api=agent_1&date_ini={{YYYYmmddHHiiss}}&date_end={{YYYYmmddHHiiss}}"

payload={}
headers = {
  'wolkvox-token': '{{token}}'
}

response = requests.request("GET", url, headers=headers, data=payload)

print(response.text)

Response

{
    "code": 200,
    "error": null,
    "msg": "Information found for the current month",
    "data": [
        {
            "operation": "",
            "description": "",
            "items": "",
            "date": ""
        }
    ]
}

</Tab>

</Tabs>

Códigos de estado HTTP

Código	Descripción
200	La solicitud ha sido exitosa
201	La solicitud ha tenido éxito y ha llevado a la creación de un recurso
204	La solicitud se ha completado correctamente, pero no hay contenido para devolver en la respuesta
400	El servidor no puede o no procesará la petición debido a algo que es percibido como un error del cliente
401	La solicitud requiere autenticación, pero el cliente no ha proporcionado credenciales válidas o no está autorizado para acceder al recurso
403	El servidor ha entendido la solicitud, pero se niega a cumplirla debido a que el cliente no tiene permisos para acceder al recurso
404	El recurso solicitado no se ha encontrado en el servidor
500	Internal Server Error
503	El servidor no está disponible actualmente debido a una sobrecarga o mantenimiento temporal