Руководство

REST API для Обзвонилки

REST API позволяет автоматизировать работу с информацией в системе.

Устаревшая информация:

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

Для работы API нужен ключ API. Для этого откройте "Настройки / Свойства организации" и перейдите на вкладку "API для разработчиков".

Если значение в поле "Ключ API" не задано, нажмите кнопку "Сформировать новый". Страница обновится, и будет показан ключ.

Ключ API передаётся одним из двух способов:

Как параметр GET или POST запроса;
HTTP-заголовком X-API-KEY.

Оба способа работают одинаково.

Пример отправки запроса:

GET https://app.obzvonilka.ru/api/contact_bases.json?api_key=my_api_key

Описание API

База контактов

Атрибуты:

id: уникальный код.
deleted: база удалена в корзину (true/false).
name: название базы.
parser_name: внутреннее поле.
parser_settings: внутреннее поле.
remark: примечание.
select_from_last: признак выборки сначала последних контактов (true/false).

Получение списка баз контактов

GET https://app.obzvonilka.ru/api/contact_bases.json

отдает список баз контактов (массив)

Получение информации по одной базе контактов

GET https://app.obzvonilka.ru/api/contact_bases/1.json

Отдает информацию по одной базе с заданным кодом.

Примечание: Добавление и изменение баз контактов на данный момент не поддерживается.

В просмотре единичной базы есть дополнительные поля со статистикой обзвона:

contact_count: Количество контактов в базе
processed_count: Количество уже обработанных контактов
rest_contact_count: Количество оставшихся (необработанных) контактов

Контакты в базе контактов

Атрибуты:

id: уникальный код контакта.
name: "Лапшина Ирина Дмитриевна",
address_string: адрес контакта (строка).
description: примечание.
email: e-mail контакта.
external_code: внешний код контакта (указывается при загрузке, может отсутствовать).
www: сайт контакта.
phone1, phone2...phone10: номера телефонов контакта.
phone_remark1, phone_remark2...phone_remark10: примечания к номерам телефонов.
custom_fields: массив значений дополнительных полей. Каждый элемент содержит атрибуты name и value

Получение списка контактов для заданной базы

GET https://app.obzvonilka.ru/api/contact_bases/1/contacts.json

Возвращает полный список контактов для базы с id=1

Получение информации по одному контакту

GET https://app.obzvonilka.ru/api/contact_bases/1/contacts/1.json

Возвращает описание одного контакта

Поиск контакта по внешнему коду

GET https://app.obzvonilka.ru/api/contact_bases/1/contacts/find_by_external/code.json

При загрузке можно указать параметр "Внешний код". Контакты можно искать по этому коду

Добавление контакта в базу

POST https://app.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://app.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://app.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://app.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 https://app.obzvonilka.ru/api/users.json

Отдает список пользователей (массив)

Получение информации по одному пользователю

GET https://app.obzvonilka.ru/api/users/1.json

Отдает информацию по пользователю с заданным кодом (id).

Примечания:

Добавление и изменение пользователей не поддерживается;
Список пользователей показывается только по организации с указанным ключом API.

Получение результатов звонков

GET https://app.obzvonilka.ru/api/report/call_history

Отдает список результатов в соответствии с параметрами запроса.

Параметры запроса:

begin_date - дата начала выгрузки (по умолчанию текущая дата) в формате yyyy-mm-dd;
end_date - дата окончания выгрузки (по умолчанию текущая дата) в формате yyyy-mm-dd;
project_id - код (id) проекта;
contact_base_id - код (id) базы контактов

Запрос возвращает список результатов (выборка совпадает с отчётом "Звонки") в формате JSON.

Пример запроса:

curl -H 'X-API-KEY: YOUR-API-KEY' \
'https://app.obzvonilka.ru/api/report/call_history?begin_date=2024-01-01&end_date=2024-07-01'

Пример ответа:

[
  {
    "row_number":1,
    "id":15666325,
    "project_id":708,
    "project_name":"Проект 2",
    "contact_base_id":15066,
    "contact_base_name":"Демо-база (4)",
    "created_at":"2024-01-05T08:35:02.517Z",
    "contact_id":12723417,
    "contact_name":"Название 1",
    "contact_description":null,
    "contact_address":null,
    "contact_www":null,
    "loaded_contact_email":null,
    "contact_external_code":null,
    "user_id":1,
    "operator_name":null,
    "operator_email":"user@mail.ru",
    "captured_user_id":1,
    "custom_fields":[
      {
        "name":"custom_field_2",
        "title":"Контактное лицо",
        "value":null
      },
      {
        "name":"custom_field_1",
        "title":"Поле 11",
        "value":null
      },
      {
        "name":"custom_field_3",
        "title":"g2",
        "value":null
      }
    ],
    "project_custom_fields":[],
    "called_phone":"9999999999",
    "call_result_id":4380,
    "call_result_name":"Р1",
    "reject_reason_id":null,
    "reject_reason_text":"",
    "contact_person":"",
    "result_contact_email":"",
    "card_processing_duration":39,
    "voice_record_count":0,
    "voice_record_seconds":0,
    "voice_record_minutes":0,
    "remark":"",
    "contact_status_name":"Р1",
    "next_call_date":null,
    "next_call_time":null,
    "visit_date":null,
    "visit_time":null
  },
  {
    "row_number":2,
    "id":15666327,
    "project_id":708,
    "project_name":"Проект 2",
    "contact_base_id":15066,
    "contact_base_name":"Демо-база (4)",
    "created_at":"2024-01-05T08:35:15.101Z",
    "contact_id":35752572,
    "contact_name":"c1",
    "contact_description":null,
    "contact_address":null,
    "contact_www":null,
    "loaded_contact_email":null,
    "contact_external_code":null,
    "user_id":1,
    "operator_name":null,
    "operator_email":"user@mail.ru",
    "captured_user_id":1,
    "custom_fields":[
      {
        "name":"custom_field_2",
        "title":"Контактное лицо",
        "value":null
      },
      {
        "name":"custom_field_1",
        "title":"Поле 11",
        "value":null
      },
      {
        "name":"custom_field_3",
        "title":"g2",
        "value":null
      }
    ],
    "project_custom_fields":[],
    "called_phone":"",
    "call_result_id":4380,
    "call_result_name":"Р1",
    "reject_reason_id":null,
    "reject_reason_text":"",
    "contact_person":"",
    "result_contact_email":"",
    "card_processing_duration":9,
    "voice_record_count":0,
    "voice_record_seconds":0,
    "voice_record_minutes":0,
    "remark":"",
    "contact_status_name":"Р1",
    "next_call_date":null,
    "next_call_time":null,
    "visit_date":null,
    "visit_time":null
  }
]

SIP-телефон Обзвонилки

Настройка SIP телефонии в сервисе автоматического обзвона клиентов Обзвонилка

Что делать, если письма уходят в SPAM

Статья о том, как настроить почту и программу Обзвонилка для того, чтобы письма не попадали в спам

Настройка интеграции с WireCRM - Обзвонилка

Интеграция. Автоматическая передача контактов для WireCRM

Настройка интеграции с Bitrix24 - Обзвонилка

Настройка интеграции с Bitrix24 в сервисе автообзвона клиентов колл-центра Обзвонилка

Настройка интеграции с amoCRM - Обзвонилка

Настройка интеграции с amoCRM с сервисом автоматического обзвона Обзвонилка

Конструктор отчётов в сервисе автообзвона - Обзвонилка

Как построить кастомный отчет в программе автоматического обзвона клиентов Обзвонилка

Отправка писем и коммерческих предложений без спама - Обзвонилка

Что сделать, чтобы письма не попадали в спам. Настройка программы Обзвонилка

Начните автоматизацию исходящих звонков

*Укажите реальный e-mail — на него придет пароль и ссылка для доступа в систему.

Оставляя заявку вы соглашаетесь с политикой конфиденциальности

Дарим 320р на баланс системы