Потрібні дані та інструкції для інтеграції або вивантаження даних?
Скористайтеся нашими інструкціями.
Отримання ключа API
Додавання завдання (номера) до обдзвону
Видалення завдання (номера) з обдзвону
Журнал дзвінків
Додавання даних про дзвінок
Отримання даних про дзвінок
Отримання запису розмови
Сумарні звіти за чергами та користувачами
Зміна статусу оператора
Вивантаження контактів з CRM
Перевірка існування значення у списку
Повні дані про замовлення (модуль SHOP)
API для списку автообдзвонів
API v.1
h3>Отримання ключа API/h3>
Ключ API створюється в налаштуваннях вашого користувача.
h3>Додавання завдання (номера) до обдзвону/h3>
URL https://noname.oki-toki.net/api/v1/dialers/create_task
Метод: POST або GET
*API ключ створюється в налаштуваннях Вашого користувача, як показано в першому пункті документації
Передача змінних:
Стандартним способом в POST або GET запиті
Нестандартним способом. POST або GET змінна json_request повинна містити в собі json рядок з даними для додавання завдання
Авторизація за допомогою апі токену користувача. У запиті обов’язково повинна бути змінна api_token, яка містить токен користувача.
Обов’язкові дані:
dialer_id – номер автодзвінка, в який добавляється завдання
phones – номери телефонів, максимум 5. Через кому, або json підрядком (якщо передається в 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), то система встановить в роботу тільки ті, які вказані. якщо у завдання немає якогось вказаного номера – то він буде до нього доданий. якщо номери не вказані – всі телефони в завданні стануть в чергу.
Відповідно повертається повідомлення про успішне додавання завдання з його номером, або повідомлення про помилку.
h3>Видалення завдання (номера) з автодзвінка/h3>
URL https://noname.oki-toki.net/api/v1/dialers/cancel_task
Метод: POST або GET
*API ключ створюється у налаштуваннях Вашого користувача, як показано в першому пункті документації.
Передача змінних:
Стандартним способом в POST або GET запиті.
Нестандартним способом. POST або GET змінна json_request має містити в собі json рядок з даними для додавання завдання.
Авторизація за api токеном користувача. В запиті обов’язково має бути змінна 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).
Можливо комбінувати необов’язкові параметри між собою, тоді будуть видалені різні завдання. Наприклад: можна видалити всі завдання з конкретним номером телефону, або з деталями.
Якщо не вказано жоден необов’язковий параметр, повернеться помилка.
У відповідь повертається повідомлення про успішне скасування завдання(завдань) з її(їх) номером(номерами), або повідомлення про помилку.
h3>Журнал дзвінків/h3>
URL https://noname.oki-toki.net/api/v1/reports/acd/calls-log
Метод: GET
*API ключ створюється в налаштуваннях Вашого користувача, як показано в першому пункті документації.
Авторизація за допомогою 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=****
h3>Додавання даних про дзвінок/h3>
URL https://noname.oki-toki.net/api/v1/call/add_data
Method: POST or GET
*ключ API створюється у налаштуваннях Вашого користувача, як показано в першому пункті документації.
Передача даних:
Звичайним способом у POST або GET запиті
Незвичайним способом. POST або GET змінна json_request повинна містити в собі json рядок з даними.
Авторизація по api токену користувача. У запиті обов’язково повинна бути змінна api_token, що містить токен користувача.
Обов’язкові дані:
session_id – унікальний номер дзвінка в системі Окі-Токі, до якого додаються дані
Примітка.
Якщо дані додаються повторно, то вони додаються до вже раніше доданих.
Якщо значення якогось параметру буде порожнім, то цей параметр видалиться з набору даних.
У відповідь повертається повідомлення про успішне додавання даних з номером дзвінка, або повідомлення про помилку.
h3>Отримання даних про дзвінок/h3>
URL https://noname.oki-toki.net/api/v1/call/get_data
Method: POST or GET
*ключ API створюється в налаштуваннях Вашого користувача, як показано в першому пункті документації.
Передача даних:
Звичайним способом в POST або GET запиті
Незвичайним способом. POST або GET змінна json_request повинна містити в собі json рядок з даними.
Авторизація по api токену користувача. У запиті обов’язково повинна бути змінна api_token, що містить токен користувача.
Обов’язкові дані:
session_id – унікальний номер дзвінка в системі Окі-Токі, до якого додаються дані,
date – дата дзвінка у форматі ДД.ММ.РРРР.
У відповідь повертається повідомлення з даними про дзвінок, або повідомлення про помилку.
h3>Отримання запису розмови/h3>
URL https://noname.oki-toki.net/api/v1/record/{session_id}
Метод: GET
*ключ API створюється в налаштуваннях Вашого користувача, як показано в першому пункті документації.
Авторизація за api токеном користувача. В запиті обов’язково повинна бути змінна api_token, що містить токен користувача.
Параметри:
date – дата дзвінка. Якщо не вказати, то шукає за останні три місяці
Приклад:
https://noname.oki-toki.net/api/v1/record/1234567?date=26.09.2017&api_token=****
h3>Зведений звіт по дзвінках/h3>
URL https://noname.oki-toki.net/api/v1/reports/acd/calls-summary
Метод: GET
*ключ API створюється в налаштуваннях Вашого користувача, як показано в першому пункті документації.
Авторизація за api токеном користувача. В запиті обов’язково повинна бути змінна api_token, що містить токен користувача.
Без параметрів повертає дзвінки за останню годину.
Параметри:
date_range – період, за який повернути дані. Значення: last_hour, today, yesterday, this_week, prev_week, this_month, prev_month.
А також всі інші поля, що використовуються у фільтрі цього звіту. Імена змінних та значення можна взяти з форми звіту. Ви також можете виконати звіт у веб-інтерфейсі з потрібними параметрами та скопіювати частину url’а з параметрами з адресного рядка, додавши туди api_token.
h3>Зводні звіти за чергами та користувачами/h3>
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 (користувачі)
Метод: 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.
h3>Зміна статусу оператора/h3>
URL https://noname.oki-toki.net/api/v1/user/set_status
Метод: POST або 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 – коментар до статусу.
Відповідь повертає повідомлення про успішну зміну статусу, або повідомлення про помилку.
h3>Вивантаження контактів з CRM/h3>
URL https://noname.oki-toki.net/api/v1/contacts
Метод: GET
* API ключ створюється в налаштуваннях Вашого користувача, як показано в першому пункті документації.
Передача змінних:
Стандартним способом в GET запиті
Авторизація за апи токеном користувача. В запиті обов’язково має бути змінна api_token, що містить токен користувача.
Фільтр на вибірку контактів:
contact_field1=value1&contact_field2=value2&contact_field3=*value3&
contact_field4=*value4*
contact_field – Ім’я поля контакту, так як воно відображається в контакті.
=value – точне співпадіння з заданим значенням,
=*value* – містить задане значення
=*value – задане значення стоїть в кінці поля,
=value* – задане значення стоїть на початку поля,
value може бути списком у форматі list [1,2,3,4]. В такому випадку буде знайдено контакт, значення вказаного поля якого є у списку.
У відповідь повертається json масив, що містить знайдені контакти. Кількість контактів обмежена 1000 шт.
h3>Перевірка існування значення в списку/h3>
URL https://noname.oki-toki.net/api/v1/lists/check
Method: GET
*API ключ створюється у налаштуваннях Вашого користувача, як показано в першому пункті документації.
Передача змінних:
Стандартним способом в GET запиті
Авторизація за допомогою API токена користувача. У запиті обов’язково повинна бути змінна api_token, що містить токен користувача.
Обов’язкові дані:
list_id – номер списку, в якому проводити перевірку
Параметри перевірки:
value – значення
У відповідь повертається 1, якщо в списку. 0 – якщо ні.
h3>Повні дані про замовлення (модуль SHOP)/h3>
URL https://noname.oki-toki.net/api/v1/shop/order/$id
Method: GET
*API ключ створюється у налаштуваннях Вашого користувача, як показано в першому пункті документації.
Передача змінних:
Стандартним способом в GET запиті
Авторизація по API токену користувача. У запиті обов’язково повинна бути змінна api_token, що містить токен користувача.
Обов’язкові дані:
$id – номер замовлення
У відповідь повертаються повні дані про замовлення, включаючи його склад.
h3>API для списку автообдзвонів/h3>
URL https://noname.oki-toki.net/api/v1/dialers/stat
Метод: GET
* API-ключ створюється у налаштуваннях вашого користувача, як показано в першому пункті документації.
Передача змінних:
Стандартним способом у GET-запиті
Авторизація за токеном API користувача. У запиті обов’язково повинна бути змінна api_token, яка містить токен користувача.
Необов’язкові дані:
$dialer_id – номер авто-опитування
У відповідь повертаються дані про всі активні авто-опитування, або якщо вказано $dialer_id – тільки про одне.