Документация для разработчиков

Документация для разработчиков

Нужны данные и инструкции для интеграции или выгрузки данных?
Воспользуйтесь нашими инструкциями.

Получение ключа API
Добавление задачи (номера) в обзвон
Удаление задачи (номера) из обзвона
Журнал звонков
Добавление данных о звонке
Получение данных о звонке
Получение записи разговора
Сводные отчеты по очередям и пользователям
Смена статуса оператора
Выгрузка контактов из CRM
Проверка существования значения в списке
Полные данные о заказе (модуль SHOP)
API для списка автодозвонов

 

API v.1

 

Получение ключа API

Ключ API создается в настройках вашего пользователя.

 

Добавление задачи (номера) в обзвон

URL https://noname.oki-toki.net/api/v1/dialers/create_task

Method: POST or GET

*ключ API создается в настройках Вашего пользователя, как показано в первом пункте документации

Передача переменных:

Стандартным способом в POST или GET запросе
Нестандартным способом. POST или GET переменная json_request должна содержать в себе json строку с данными для добавления задачи

Авторизация по апи токену пользователя. В запросе обязательно должна быть переменная api_token содержащая токен пользователя.

Обязательные данные:

dialer_id — номер автообзвона в который добавлять задачу
phones — номера телефонов, максимум 5. Через запятую, либо json подстрокой (если переаlется в json_request)

Необязательные данные:

contact_id — номер контакта из CRM Oki-Toki,
bp_id — номер процесса из CRM Oki-Toki,
date — время на которое назначаются звонки, в формате 21.02.2017 12:00:00,
import_id — номер импорта,
priority приоритет от 0 до 2,
region регион в формате часовой зоны. например Europe/Kiev (если регион будет указан, но будет пустым, то автокоррекция пояса(если включена) не сработает, клиентское расписание не сработает, и звонок пойдет по расписанию работы автообзвона),
ttl время жизни задачи, в секундах,
user_id номер пользователя на которого назначить задачу,
details — json подстрока с дополнительной информацией, например {«name»:»John», «order»:»12″}
force_create — 1 или 0. Если force_create=1, в настройках автообзвона включена уникальность и задача не добавляется по причине этой самой уникальности, то при добавлении все существующие задачи конфликтующие с добавляемой по уникальному ключу автоматически отменятся,
task_id — номер задачи в автообзвоне. если указан то номера телефонов добавятся к задаче с указаным номером, если она в работе,

reset_task_id — номер задачи в автообзвоне. если указан — то система попытется найти эту задачу и поставить ее в работу, вместо того что бы создавать новую. Если заданы номера телефонов (phones), то система поставит в работу только те которые заданы. если у задачи нет какого либо указаного номера — то он бует к ней добавлен. если номера не указаны — все телефоны в задаче станут в очередь.
В ответ возвращается сообщение об успешном добавлении задачи с ее номером, либо сообщение об ошибке.

 

Удаление задачи (номера) из обзвона

URL https://noname.oki-toki.net/api/v1/dialers/cancel_task

Method: POST or GET

*ключ API создается в настройках Вашего пользователя, как показано в первом пункте документации.

Передача переменных:

Стандартным способом в POST или GET запросе.
Нестандартным способом. POST или GET переменная json_request должна содержать в себе json строку с данными для добавления задачи.
Авторизация по апи токену пользователя. В запросе обязательно должна быть переменная api_token содержащая токен пользователя.

Обязательные данные:
dialer_id — номер автообзвона из которого удалять задачу (если номер = 0, то удаляется со всех автообзвонов).
Необязательные данные:
task_id — номер задачи,
phone — номер телефона,который есть в задаче,
contact_id — номер контакта из Оки-Токи CRM,
bp_id — номер процесса из Оки-Токи CRM,
details — json подстрока с дополнительной информацией, например {«name»:»John», «order»:»12″}. Отменяются задачи в которых есть заданная дополнительная информация,
cancel_phone — 1 (флаг, если установлен, то отменяет только указанный номер телефона),
cancel_reason — причина отмены (может быть следующим из: wrong_number).
Возможно комбинировать необязательные параметры между собой, тогда будут удалятся разные задачи. Например: можно удалить все задачи с конкретным номером телефона, или с деталями.

Если не указан ни один необязательный параметр, вернется ошибка.

В ответ возвращается сообщение об успешной отмене задачи(задач) с ее(их) номером(номерами), либо сообщение об ошибке.

 

Журнал звонков

URL https://noname.oki-toki.net/api/v1/reports/acd/calls-log

Method: GET

*ключ API создается в настройках Вашего пользователя, как показано в первом пункте документации.

Авторизация по апи токену пользователя. В запросе обязательно должна быть переменная api_token, содержащая токен пользователя.

Без параметров возвращает звонки за последний час.

Параметры:
date_range — период, за который вернуть данные. Значения: last_hour, today, yesterday, this_week, prev_week, this_month, prev_month,
date — дата, за которую вернуть звонки,
anis — номер телефона или ID сессии,
format — формат, в котором вернуть результат. Значения: default, csv, csv_2016. По-умолчанию возвращает в JSON, csv — кодировка CP-1251, csv_2016 — кодировка UTF-8.
А также все остальные поля, используемые в фильтре этого отчёта. Имена переменных и значения можно взять из формы отчёта. Можно так же выполнить отчёт в веб-интерфейсе с нужными параметрами, и скопировать часть url’а с параметрами из адресной строки, добавив туда api_token.

Примеры

Вместо звёздочек подставьте свой api_token

Звонки за сегодня:
https://noname.oki-toki.net/api/v1/reports/acd/calls-log?date_range=today&api_token=****

Поиск звонка с ID сессии 12345678, совершенный 29.08.2017:
https://noname.oki-toki.net/api/v1/reports/acd/calls-log?date=28.08.2017&anis=12345678&api_token=****

Звонки на/с номера 380501234567, совершенные на прошлой неделе:
https://noname.oki-toki.net/api/v1/reports/acd/calls-log?date_range=prev_week&anis=380501234567&api_token=****

Все звонки за прошлую неделю в CSV (кодировка «Кириллица Windows-1251»):
https://noname.oki-toki.net/api/v1/reports/acd/calls-log?date_range=this_week&format=csv&api_token=****

 

Добавление данных о звонке

URL https://noname.oki-toki.net/api/v1/call/add_data

Method: POST or GET

*ключ API создается в настройках Вашего пользователя, как показано в первом пункте документации.

Передача данных:
Стандартным способом в POST или GET запросе
Нестандартным способом. POST или GET переменная json_request должна содержать в себе json строку с данными.
Авторизация по апи токену пользователя. В запросе обязательно должна быть переменная api_token содержащая токен пользователя.

Обязательные данные:
session_id — уникальный номер звонка в системе Оки-Токи к которому добавляются данные
Примечание.
Если данные добавляются повторно, то они добавляются к уже ранее добавленным.
Если значение какого то параметра будет пустым, то это параметр удалится из набора данных.
В ответ возвращается сообщение об успешном добавлении данных с номером звонка, либо сообщение об ошибке.

 

Получение данных о звонке

URL https://noname.oki-toki.net/api/v1/call/get_data

Method: POST or GET

*ключ API создается в настройках Вашего пользователя, как показано в первом пункте документации.

Передача данных:
Стандартным способом в POST или GET запросе
Нестандартным способом. POST или GET переменная json_request должна содержать в себе json строку с данными.
Авторизация по апи токену пользователя. В запросе обязательно должна быть переменная api_token содержащая токен пользователя.

Обязательные данные:
session_id — уникальный номер звонка в системе Оки-Токи к которому добавляются данные,
date — дата звонка в формате ДД.ММ.ГГГГ.
В ответ возвращается сообщение с данными о звонке, либо сообщение об ошибке.

 

Получение записи разговора

URL https://noname.oki-toki.net/api/v1/record/{session_id}

Method: GET

*ключ API создается в настройках Вашего пользователя, как показано в первом пункте документации.

Авторизация по апи токену пользователя. В запросе обязательно должна быть переменная api_token, содержащая токен пользователя.

Параметры:
date — дата звонка. Если не указать, то ищет за последние три месяца
Пример:
https://noname.oki-toki.net/api/v1/record/1234567?date=26.09.2017&api_token=****

Сводный отчёт по звонкам

URL https://noname.oki-toki.net/api/v1/reports/acd/calls-summary

Method: GET

*ключ API создается в настройках Вашего пользователя, как показано в первом пункте документации.

Авторизация по апи токену пользователя. В запросе обязательно должна быть переменная api_token, содержащая токен пользователя.

Без параметров возвращает звонки за последний час.

Параметры:
date_range — период, за который вернуть данные. Значения: last_hour, today, yesterday, this_week, prev_week, this_month, prev_month.
А также все остальные поля, используемые в фильтре этого отчёта. Имена переменных и значения можно взять из формы отчёта. Можно так же выполнить отчёт в веб-интерфейсе с нужными параметрами, и скопировать часть url’а с параметрами из адресной строки, добавив туда api_token.

 

Сводные отчеты по очередям и пользователям

URL https://noname.oki-toki.net/api/v1/reports/sec/queue-status-summary (очереди)

и https://noname.oki-toki.net/api/v1/reports/sec/user-status-summary (пользователи)

Method: GET

*ключ API создается в настройках Вашего пользователя, как показано в первом пункте документации.

Авторизация по апи токену пользователя. В запросе обязательно должна быть переменная api_token, содержащая токен пользователя.

Без параметров возвращает статусы за последний час без разбивки.

Параметры:
date_range — период, за который вернуть данные. Значения: last_hour, today, yesterday, this_week, prev_week, this_month, prev_month.
split_by — разбить по очередям или пользователям. Значения: queue, user.

А также все остальные поля, используемые в фильтре этого отчёта. Имена переменных и значения можно взять из формы отчёта. Можно так же выполнить отчёт в веб-интерфейсе с нужными параметрами, и скопировать часть url’а с параметрами из адресной строки, добавив туда api_token.

Смена статуса оператора

URL https://noname.oki-toki.net/api/v1/user/set_status

Method: POST or GET

*ключ API создается в настройках Вашего пользователя, как показано в первом пункте документации.

Передача переменных:
Стандартным способом в POST или GET запросе
Нестандартным способом. POST или GET переменная json_request должна содержать в себе json строку с данными для изменения статуса
Авторизация по апи токену пользователя. В запросе обязательно должна быть переменная api_token содержащая токен пользователя.

Обязательные данные:
user_id — номер пользователя
status_id — номера статуса (см. тут https://noname.oki-toki.net/company/statuses)

Необязательные данные:
away_status_id — номер дополнительного статуса (см. тут https://noname.oki-toki.net/company/statuses),
status_comment — комментарий к статусу.
В ответ возвращается сообщение об успешном изменении статуса, либо сообщение об ошибке.

 

Выгрузка контактов из CRM

URL https://noname.oki-toki.net/api/v1/contacts

Method: GET

*ключ API создается в настройках Вашего пользователя, как показано в первом пункте документации.

Передача переменных:

Стандартным способом в GET запросе

Авторизация по апи токену пользователя. В запросе обязательно должна быть переменная api_token содержащая токен пользователя.

Фильтр на выборку контактов:
contact_field1=value1&contact_field2=value2&contact_field3=*value3&
contact_field4=*value4*

contact_field — Имя поля контакта, так как оно отображается в контакте.
=value — точное совпадение с заданным значением,
=*value* — содержит заданное значение
=*value — заданное значение стоит в конце поля,
=value* — заданное значение стоит в начале поля,

value может быть списком в формате списка [1,2,3,4]. Тогда будет найден контакт значение указанного поля которого есть в списке.

В ответ возвращается json массив, содержащий найденные контакты. Количество контактов ограничено 1000 шт.

Проверка существования значения в списке

URL https://noname.oki-toki.net/api/v1/lists/check

Method: GET

*ключ API создается в настройках Вашего пользователя, как показано в первом пункте документации.

Передача переменных:

Стандартным способом в GET запросе

Авторизация по апи токену пользователя. В запросе обязательно должна быть переменная api_token содержащая токен пользователя.

Обязательные данные:
list_id — номер списка в котором делать проверку

Параметры проверки:
value — значение

В ответ возвращается 1 если в списке. 0 — если нет.

 

Полные данные о заказе (модуль SHOP)

URL https://noname.oki-toki.net/api/v1/shop/order/$id

Method: GET

*ключ API создается в настройках Вашего пользователя, как показано в первом пункте документации.

Передача переменных:

Стандартным способом в GET запросе

Авторизация по апи токену пользователя. В запросе обязательно должна быть переменная api_token содержащая токен пользователя.

Обязательные данные:

$id — номер заказа

В ответ возвращаются полные данные о заказе включая его состав.

 

API для списка автодозвонов

URL https://noname.oki-toki.net/api/v1/dialers/stat

Method: GET

*ключ API создается в настройках Вашего пользователя, как показано в первом пункте документации.

Передача переменных:
Стандартным способом в GET запросе

Авторизация по апи токену пользователя. В запросе обязательно должна быть переменная api_token содержащая токен пользователя.

Необязательные данные:
$dialer_id — номер автообзвона

В ответ возвращаются данные о всех неархивных автодозвонах, либо если указан $dialer_id — только об одном.