REST API для Обзвонилки
REST API позволяет автоматизировать работу с информацией в системе.
Получение ключа API
Для работы API нужен ключ API. Для этого откройте "Настройки / Свойства организации" и перейдите на вкладку "API для разработчиков".
Если значение в поле "Ключ API" не задано, нажмите кнопку "Сформировать новый". Страница обновится, и будет показан ключ.
Ключ API передается либо параметром GET или POST запроса, либо заголовком HTTP. Оба способа работают одинаково.
Пример запроса:
https://obzvonilka.ru/api/contact_bases.json?api_key=my_api_key
Описание API
База контактов
Атрибуты:
- id: уникальный код.
- auto_open_window_params: внутреннее поле.
- deleted: база удалена в корзину (true/false).
- name: название базы.
- parser_name: внутреннее поле.
- parser_settings: внутреннее поле.
- remark: примечание.
- select_from_last: признак выборки сначала последних контактов (true/false).
- use_predictive_call: внутреннее поле.
Получение списка баз контактов
GET /api/contact_bases.json
Отдает список баз контактов (массив).
Получение информации по одной базе контактов
GET /api/contact_bases/1.json
Отдает информацию по одной базе с заданным кодом.
Примечание: Добавление и изменение баз контактов на данный момент не поддерживается.
Контакты в базе контактов
Атрибуты:
- id: уникальный код контакта.
- name: "Лапшина Ирина Дмитриевна",
- address_string: адрес контакта (строка).
- description: примечание.
- email: e-mail контакта.
- external_code: внешний код контакта (указывается при загрузке, может отсутствовать).
- www: сайт контакта.
- phone1, phone2...phone10: номера телефонов контакта.
- phone_remark1, phone_remark2...phone_remark10: примечания к номерам телефонов.
Получение списка контактов для заданной базы.
GET /api/contact_bases/1/contacts.json
Возвращает полный список контактов для базы с id=1.
Получение информации по одному контакту
GET /api/contact_bases/1/contacts/1.json
Возвращает описание одного контакта.
Поиск контакта по внешнему коду.
GET /api/contact_bases/1/contacts/find_by_external/code.json
При загрузке можно указать параметр "Внешний код". Контакты можно искать по этому коду.
Добавление контакта в базу
POST /api/contact_bases/1/contacts.json
Добавляет новый контакт в базу.
Пример запроса:
curl 'https://obzvonilka.ru/api/contact_bases/1/contacts.json?api_key=your_api_key' -X POST \
-F "contact[name]=abc" -F "contact[phone1]=987654321"
Обновление контакта
PATCH /api/contact_bases/1/contacts/1.json
Обновляет контакт в базе.
Пример запроса:
curl 'https://obzvonilka.ru/api/contact_bases/1/contacts/22.json?api_key=your_api_key' -X PATCH \
-F "contact[name]=abcd" -F "contact[phone1]=9876543210"
Пользователи организации
Атрибуты:
- id: уникальный код пользователя
- account_enabled: разрешена ли работа (не заблокирован) пользователя в системе (true/false);
- email: логин (он же e-mail) пользователя;
- name: ФИО пользователя;
- admin: признак администратора (true/false).
Получение списка пользователей
GET /api/users.json
Отдает список пользователей (массив).
Получение информации по одному пользователю
GET /api/users/1.json
Отдает информацию по пользоателю с заданным кодом (id).
Примечания:
- Добавление и изменение пользователей не поддерживается;
- Список пользователей показывается только по организации с указанным ключом API.