Dialogi
Начать бесплатно

Начало работы

Быстрый старт

Пять шагов: подключить дополнение, создать ключ, прочитать список контактов, создать контакт и найти его в личном кабинете. Понадобится доступ владельца или администратора компании и терминал с curl.

Базовый адрес API:

https://api.ru.dialogi.io/v1

1. Подключите дополнение

Доступ к API открывает дополнение «Публичный API». В личном кабинете откройте «Оплата», вкладку «Тариф», и в блоке «Дополнительно» нажмите «Подключить» у «Публичного API».

Без дополнения API отвечает ошибкой 402 api-addon-required. Ключи можно создать и раньше - они заработают, когда дополнение подключат.

2. Создайте ключ

Откройте «Настройки» → «Разработчикам» и нажмите «Создать ключ».

  • Название - по системе, которая будет работать с ключом: «Интеграция с 1С», «Сайт - заявки».
  • Доступ - для быстрого старта подойдёт «Полный».
  • Проекты - выберите один проект. Тогда при создании контакта не придётся указывать project_id.

Нажмите «Создать» и скопируйте ключ. Целиком его показывают один раз, дальше в списке видно только начало и последние символы. Храните ключ на сервере и не вставляйте его в код сайта - подробнее в разделе Ключи и права.

3. Первый запрос

Прочитайте список контактов:

curl https://api.ru.dialogi.io/v1/contacts \
  -H "Authorization: Bearer dk_live_…"

Ответ 200:

{
  "object": "list",
  "data": [
    {
      "object": "contact",
      "id": "01a0d3f0-aa80-7592-ae85-1a0309a9fd64",
      "project_id": "019cdbe8-e800-76c7-bd8d-a1cee5cdcca0",
      "type": "person",
      "name": "Иван Петров",
      "first_name": null,
      "last_name": null,
      "email": "ivan@example.com",
      "phone": "+79161234567",
      "position": null,
      "lifecycle": "customer",
      "status": "active",
      "source": "widget_lead",
      "metadata": null,
      "created_at": "2026-09-24T15:02:40Z",
      "updated_at": "2026-09-24T15:02:40Z"
    }
  ],
  "has_more": false
}

Контакты идут от новых к старым, по 20 на странице. Как получить следующие страницы - в разделе Пагинация.

Если пришла ошибка:

  • 401 - ключ скопирован не полностью или без Bearer перед ним.
  • 402 - дополнение не подключено. Если его подключили только что, подождите минуту и повторите запрос.

4. Создайте контакт

curl https://api.ru.dialogi.io/v1/contacts \
  -H "Authorization: Bearer dk_live_…" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: quickstart-contact-1" \
  -d '{"name": "Анна Смирнова", "phone": "+79101234567", "email": "anna@example.com"}'

Ответ 201 - созданный контакт:

{
  "object": "contact",
  "id": "01a0d7f0-b6c0-7a1a-82e4-2cab98a901c7",
  "project_id": "019cdbe8-e800-76c7-bd8d-a1cee5cdcca0",
  "type": "person",
  "name": "Анна Смирнова",
  "first_name": null,
  "last_name": null,
  "email": "anna@example.com",
  "phone": "+79101234567",
  "position": null,
  "lifecycle": "lead",
  "status": "active",
  "source": "api",
  "metadata": null,
  "created_at": "2026-09-25T09:41:12Z",
  "updated_at": "2026-09-25T09:41:12Z"
}

Заголовок Idempotency-Key обязателен в запросах на создание. Если повторить запрос с тем же ключом и тем же телом, второй контакт не появится - API вернёт первый ответ. Подробнее - в разделе Идемпотентность.

Без заголовка Content-Type: application/json тело не прочитается, и API ответит 422.

Если у ключа несколько проектов, добавьте в тело "project_id", иначе будет ошибка 422. id проекта есть в поле project_id каждого контакта из шага 3.

5. Найдите контакт в личном кабинете

Откройте проект, раздел «Клиенты» → «Контакты». Там появится Анна Смирнова. В колонке «Источник» у неё будет «API» - колонку включает кнопка «Колонки».

Правки, сделанные в личном кабинете, видны через API. Прочитайте контакт по id:

curl https://api.ru.dialogi.io/v1/contacts/01a0d7f0-b6c0-7a1a-82e4-2cab98a901c7 \
  -H "Authorization: Bearer dk_live_…"

Что дальше