Чи потрібні дані та інструкції для інтеграції чи вивантаження даних? Скористайтеся нашими інструкціями. Отримання ключа 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=**** Дзвінки на/з номера 38050123456 тижні: 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?
Зведений звіт за дзвінками
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 – лише про одне.