REST API для Обзвонилки
REST API позволяет автоматизировать работу с информацией в системе.
Получение ключа API
Для работы API нужен ключ API. Для этого откройте "Настройки / Свойства организации" и перейдите на вкладку "API для разработчиков".
Если значение в поле "Ключ API" не задано, нажмите кнопку "Сформировать новый". Страница обновится, и будет показан ключ.
Ключ API передаётся одним из двух способов:Оба способа работают одинаково.
Пример отправки запроса:
GET https://obzvonilka.ru/api/contact_bases.json?api_key=my_api_key
Описание API
База контактов
Атрибуты:
Получение списка баз контактов
GET https://obzvonilka.ru/api/contact_bases.json
отдает список баз контактов (массив)
Получение информации по одной базе контактов
GET https://obzvonilka.ru/api/contact_bases/1.json
Отдает информацию по одной базе с заданным кодом.
Примечание: Добавление и изменение баз контактов на данный момент не поддерживается.
В просмотре единичной базы есть дополнительные поля со статистикой обзвона:
Контакты в базе контактов
Атрибуты:
Получение списка контактов для заданной базы
GET https://obzvonilka.ru/api/contact_bases/1/contacts.json
Возвращает полный список контактов для базы с id=1
Получение информации по одному контакту
GET https://obzvonilka.ru/api/contact_bases/1/contacts/1.json
Возвращает описание одного контакта
Поиск контакта по внешнему коду
GET https://obzvonilka.ru/api/contact_bases/1/contacts/find_by_external/code.json
При загрузке можно указать параметр "Внешний код". Контакты можно искать по этому коду
Добавление контакта в базу
POST https://obzvonilka.ru/api/contact_bases/1/contacts.json
Добавляет новый контакт в базу
Пример запроса № 1:
curl -H "X-API-KEY: your_api_key" -H "Content-Type: application/json" -X POST \
--data '{"contact": {"name": "Name1", "phone1": "79012345678", "custom_fields": {"custom_field_1": "cf1"} } }' \
'https://obzvonilka.ru/api/contact_bases/15066/contacts.json'
Ответ сервиса (в примере немного сокращён):
{
"id":35752574,
"external_code":null,
"name":"Name1",
"description":null,
"address_string":null,
"email":null,
"phone1":"79012345678",
"phone2":null,
"phone_remark1":null,
"www":null,
"presented_phones":[
"79012345678"
],
"custom_fields":[
{
"name":"custom_field_1",
"title":"Доп.поле 1",
"value":"cf1"
},
{
"name":"custom_field_2",
"title":"Контактное лицо",
"value":null
}
]
}
Пример запроса № 2:
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 https://obzvonilka.ru/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"
Пользователи организации
Атрибуты:
Получение списка пользователей
GET https://obzvonilka.ru/api/users.json
Отдает список пользователей (массив)
Получение информации по одному пользователю
GET https://obzvonilka.ru/api/users/1.json
Отдает информацию по пользоателю с заданным кодом (id).
Примечания: