¿Necesitan datos e instrucciones para integración o exportación de datos?
Utilice nuestras instrucciones.
Obtención de la clave API
Añadir tarea (número) para llamadas automáticas
Eliminar tarea (número) de llamadas automáticas
Registro de llamadas
Agregar datos sobre la llamada
Obtener datos de la llamada
Obtener grabación de la conversación
Reportes consolidados por colas y usuarios
Cambiar el estado del Agente
Exportar contactos del CRM
Verificar la existencia de un valor en la lista
Datos completos del pedido (módulo SHOP)
API para la lista de llamadas automáticas
API v.1
Obtención de la clave API
La clave API se crea en la configuración de su usuario.
Añadir tarea (número) para llamadas automáticas
URL https://noname.oki-toki.net/api/v1/dialers/create_task
Método: POST o GET
*La clave API se crea en la configuración de su usuario, como se muestra en el primer punto de la documentación
Transferencia de variables:
De forma estándar en una solicitud POST o GET
De forma no estándar. La variable POST o GET json_request debe contener una cadena json con los datos para añadir la tarea
Autorización por token de API del usuario. La solicitud debe contener obligatoriamente la variable api_token que contenga el token del usuario.
Datos obligatorios:
dialer_id – número de llamada automática al que se añade la tarea
phones – números de teléfono, máximo 5. Separados por comas o como subcadena json (si se pasa en json_request)
Datos opcionales:
contact_id – número de contacto de CRM Oki-Toki,
bp_id – número de proceso del CRM Oki-Toki,
date – tiempo para el que se programan las llamadas, en el formato 21.02.2017 12:00:00,
import_id – número de importación,
priority – prioridad de 0 a 2,
region – región en formato de zona horaria, por ejemplo, Europe/Kiev (si se especifica la región, pero está vacía, entonces la autodelimitación de zona (si está habilitada) no funcionará, el horario del cliente no funcionará y la llamada se realizará según el horario de funcionamiento de llamada automática),
ttl – tiempo de vida de la tarea, en segundos,
user_id – número de usuario al que asignar la tarea,
details – subcadena json con información adicional, por ejemplo {«name»:»John», «order»:»12″}
force_create – 1 o 0. Si force_create=1, se habilita la unicidad en la configuración de llamadas automáticas y la tarea no se añade debido a esta unicidad, entonces al añadir todas las tareas existentes que entren en conflicto con la que se añade por la clave única se cancelarán automáticamente,
task_id – número de tarea en llamada automática. Si se especifica, los números de teléfono se añadirán a la tarea con el número especificado, si está en progreso,
reset_task_id – número de tarea en llamada automática. Si se especifica, el sistema intentará encontrar esta tarea y ponerla en marcha, en lugar de crear una nueva. Si se especifican los números de teléfono (phones), el sistema solo pondrá en marcha los que se han especificado. Si la tarea no tiene alguno de los números especificados, se le añadirá. Si no se especifican los números, todos los teléfonos en la tarea se pondrán en cola.
En respuesta se devuelve un mensaje sobre el éxito del añadido de la tarea con su número o un mensaje de error.
Eliminar tarea (número) de llamadas automáticas
URL https://noname.oki-toki.net/api/v1/dialers/cancel_task
Método: POST o GET
*La clave API se crea en la configuración de su usuario, como se muestra en el primer punto de la documentación.
Transferencia de variables:
De forma estándar en una solicitud POST o GET.
De forma no estándar. La variable POST o GET json_request debe contener una cadena json con los datos para añadir la tarea.
Autorización por token de API del usuario. La solicitud debe contener obligatoriamente la variable api_token que contenga el token del usuario.
Datos obligatorios:
dialer_id – número de llamada automática del que eliminar la tarea (si el número = 0, entonces se eliminan de todas las llamadas automáticas).
Datos opcionales:
task_id – número de tarea,
phone – número de teléfono que está en la tarea,
contact_id – número de contacto de CRM Oki-Toki,
bp_id – número de proceso de CRM Oki-Toki,
details – subcadena json con información adicional, por ejemplo {«name»:»John», «order»:»12″}. Se cancelan las tareas que contengan la información adicional especificada,
cancel_phone – 1 (bandera, si se establece, solo se cancela el número de teléfono especificado),
cancel_reason – motivo de cancelación (puede ser uno de los siguientes: wrong_number).
Se pueden combinar parámetros opcionales entre ellos, entonces se eliminarán diferentes tareas. Por ejemplo: se pueden eliminar todas las tareas con un número de teléfono específico o con detalles.
Si no se especifica ningún parámetro opcional, se devuelve un error.
En respuesta se devuelve un mensaje sobre la cancelación exitosa de la tarea (tareas) con su número (números) o un mensaje de error.
Registro de llamadas
URL https://noname.oki-toki.net/api/v1/reports/acd/calls-log
Método: GET
*La clave API se crea en la configuración de su usuario, como se muestra en el primer punto de la documentación.
Autorización por token de API del usuario. La solicitud debe contener obligatoriamente la variable api_token, que contenga el token del usuario.
Sin parámetros devuelve llamadas del última hora.
Parámetros:
date_range – el periodo para el que devolver los datos. Valores: last_hour, today, yesterday, this_week, prev_week, this_month, prev_month,
date – fecha para la cual devolver llamadas,
anis – número de teléfono o ID de sesión,
format – formato en el que devolver el resultado. Valores: default, csv, csv_2016. Por defecto devuelve en JSON, csv – codificación CP-1251, csv_2016 – codificación UTF-8.
Así como todos los demás campos utilizados en el filtro de este informe. Los nombres de las variables y los valores se pueden tomar del formulario del informe. También se puede realizar el informe en la interfaz web con los parámetros deseados, y copiar parte del URL con los parámetros de la barra de direcciones, agregando allí api_token.
Ejemplos
En lugar de los asteriscos introduzca su api_token
Llamadas de hoy:
https://noname.oki-toki.net/api/v1/reports/acd/calls-log?date_range=today&api_token=****
Buscar una llamada con ID de sesión 12345678, realizada el 29.08.2017:
https://noname.oki-toki.net/api/v1/reports/acd/calls-log?date=28.08.2017&anis=12345678&api_token=****
Llamadas de/para el número 380501234567, realizadas la semana pasada:
https://noname.oki-toki.net/api/v1/reports/acd/calls-log?date_range=prev_week&anis=380501234567&api_token=****
Todas las llamadas de la semana pasada en CSV (codificación «Cirílico Windows-1251»):
https://noname.oki-toki.net/api/v1/reports/acd/calls-log?date_range=this_week&format=csv&api_token=****
Agregar datos sobre la llamada
URL https://noname.oki-toki.net/api/v1/call/add_data
Método: POST o GET
*La clave API se crea en la configuración de su usuario, como se muestra en el primer punto de la documentación.
Transferencia de datos:
De forma estándar en una solicitud POST o GET
Autorización por token de API del usuario. La solicitud debe contener obligatoriamente la variable api_token, que contenga el token del usuario.
Datos obligatorios:
session_id – número único de la llamada en el sistema Oki-Toki al que se añaden datos
Nota.
Si los datos se añaden de nuevo, entonces se añaden a los ya añadidos previamente.
Si el valor de algún parámetro está vacío, ese parámetro se eliminará del conjunto de datos.
En respuesta se devuelve un mensaje sobre el éxito del añadido de datos con el número de llamada, o un mensaje de error.
Obtener datos de la llamada
URL https://noname.oki-toki.net/api/v1/call/get_data
Método: POST o GET
*La clave API se crea en la configuración de su usuario, como se muestra en el primer punto de la documentación.
Transferencia de datos:
De forma estándar en una solicitud POST o GET
Autorización por token de API del usuario. La solicitud debe contener obligatoriamente la variable api_token, que contenga el token del usuario.
Datos obligatorios:
session_id – número único de la llamada en el sistema Oki-Toki al que se añaden datos,
date – fecha de la llamada en el formato DD.MM.AAAA.
En respuesta se devuelve un mensaje con los datos de la llamada o un mensaje de error.
Obtener grabación de la conversación
URL https://noname.oki-toki.net/api/v1/record/{session_id}
Método: GET
*La clave API se crea en la configuración de su usuario, como se muestra en el primer punto de la documentación.
Autorización por token de API del usuario. La solicitud debe contener obligatoriamente la variable api_token, que contenga el token del usuario.
Parámetros:
date – fecha de la llamada. Si no se indica, busca en los últimos tres meses
Ejemplo:
https://noname.oki-toki.net/api/v1/record/1234567?date=26.09.2017&api_token=****
Reporte consolidado por llamadas
URL https://noname.oki-toki.net/api/v1/reports/acd/calls-summary
Método: GET
*La clave API se crea en la configuración de su usuario, como se muestra en el primer punto de la documentación.
Autorización por token de API del usuario. La solicitud debe contener obligatoriamente la variable api_token, que contenga el token del usuario.
Sin parámetros devuelve llamadas del última hora.
Parámetros:
date_range – el periodo para el que devolver los datos. Valores: last_hour, today, yesterday, this_week, prev_week, this_month, prev_month.
Así como todos los demás campos utilizados en el filtro de este informe. Los nombres de las variables y los valores se pueden tomar del formulario del informe. También se puede realizar el informe en la interfaz web con los parámetros deseados, y copiar parte del URL con los parámetros de la barra de direcciones, agregando allí api_token.
Reportes consolidados por colas y usuarios
URL https://noname.oki-toki.net/api/v1/reports/sec/queue-status-summary (colas)
y https://noname.oki-toki.net/api/v1/reports/sec/user-status-summary (usuarios)
Método: GET
*La clave API se crea en la configuración de su usuario, como se muestra en el primer punto de la documentación.
Autorización por token de API del usuario. La solicitud debe contener obligatoriamente la variable api_token, que contenga el token del usuario.
Sin parámetros devuelve los estados de la última hora sin desglose.
Parámetros:
date_range – el periodo para el que devolver los datos. Valores: last_hour, today, yesterday, this_week, prev_week, this_month, prev_month.
split_by – dividir por colas o usuarios. Valores: queue, user.
Así como todos los demás campos utilizados en el filtro de este informe. Los nombres de las variables y los valores se pueden tomar del formulario del informe. También se puede realizar el informe en la interfaz web con los parámetros deseados, y copiar parte del URL con los parámetros de la barra de direcciones, agregando allí api_token.
Cambiar el estado del Agente
URL https://noname.oki-toki.net/api/v1/user/set_status
Método: POST o GET
*La clave API se crea en la configuración de su usuario, como se muestra en el primer punto de la documentación.
Transferencia de variables:
De forma estándar en una solicitud POST o GET
De forma no estándar. La variable POST o GET json_request debe contener una cadena json con los datos para cambiar el estado
Autorización por token de API del usuario. La solicitud debe contener obligatoriamente la variable api_token, que contenga el token del usuario.
Datos obligatorios:
user_id – número de usuario
status_id – número de estado (ver aquí https://noname.oki-toki.net/company/statuses)
Datos opcionales:
away_status_id – número de estado adicional (ver aquí https://noname.oki-toki.net/company/statuses),
status_comment – comentario al estado.
En respuesta se devuelve un mensaje sobre el cambio de estado exitoso o un mensaje de error.
Exportar contactos del CRM
URL https://noname.oki-toki.net/api/v1/contacts
Método: GET
*La clave API se crea en la configuración de su usuario, como se muestra en el primer punto de la documentación.
Transferencia de variables:
De forma estándar en una solicitud GET
Autorización por token de API del usuario. La solicitud debe contener obligatoriamente la variable api_token, que contenga el token del usuario.
Filtro para la selección de contactos:
contact_field1=value1&contact_field2=value2&contact_field3=*value3&contact_field4=*value4*
contact_field – Nombre del campo de contacto, tal como se muestra en el contacto.
=value – coincidencia exacta con el valor especificado,
=*value* – contiene el valor especificado,
=value* – el valor especificado está al principio del campo,
=*value – el valor especificado está al final del campo,
value puede ser una lista en el formato [1,2,3,4]. Entonces se encontrarán contactos cuyos valores de campo especificados estén en la lista.
En respuesta se devuelve una matriz json que contiene los contactos encontrados. La cantidad de contactos está limitada a 1000 unidades.
Verificar la existencia de un valor en la lista
URL https://noname.oki-toki.net/api/v1/lists/check
Método: GET
*La clave API se crea en la configuración de su usuario, como se muestra en el primer punto de la documentación.
Transferencia de variables:
De forma estándar en una solicitud GET
Autorización por token de API del usuario. La solicitud debe contener obligatoriamente la variable api_token, que contenga el token del usuario.
Datos obligatorios:
list_id – número de la lista en la que se realizará la verificación
Parámetros de verificación:
value – el valor
En respuesta se devuelve 1 si el valor está en la lista. 0 si no está.
Datos completos del pedido (módulo SHOP)
URL https://noname.oki-toki.net/api/v1/shop/order/$id
Método: GET
*La clave API se crea en la configuración de su usuario, como se muestra en el primer punto de la documentación.
Transferencia de variables:
De forma estándar en una solicitud GET
Autorización por token de API del usuario. La solicitud debe contener obligatoriamente la variable api_token, que contenga el token del usuario.
Datos obligatorios:
$id – número de pedido
En respuesta se devuelven datos completos del pedido, incluidos los detalles del mismo.
API para la lista de llamadas automáticas
URL https://noname.oki-toki.net/api/v1/dialers/stat
Método: GET
*La clave API se crea en la configuración de su usuario, como se muestra en el primer punto de la documentación.
Transferencia de variables:
De forma estándar en una solicitud GET
Autorización por token de API del usuario. La solicitud debe contener obligatoriamente la variable api_token, que contenga el token del usuario.
Datos opcionales:
$dialer_id – número de llamada automática
En respuesta se devuelven datos sobre todas las llamadas automáticas no archivadas, o si se ha especificado $dialer_id, solo sobre una.