Звонки, заявки и сделки
по REST API
Читайте звонки, заявки, контакты и сделки, создавайте задачи, управляйте SIP-аккаунтами и запускайте исходящие вызовы. Авторизация — OAuth2, ответы — JSON.
- Base URL
- crm.hotlead.io/api/v1
- Авторизация
- OAuth2 · client_credentials
- Адрес авторизации
- crm.hotlead.io/oauth
- Формат ответа
- JSON
- Версия спецификации
- OpenAPI 2.0
- Всего операций
- 27
Как получить токен и проверить доступ
Токен выдаётся по протоколу
OAuth2.
Отправьте POST на https://crm.hotlead.io/oauth
и передайте в теле запроса три параметра:
grant_type— тип авторизации, всегдаclient_credentialsclient_id— логин от личного кабинетаcrm.hotlead.ioclient_secret— пароль от личного кабинета
Полученный токен подставляйте в заголовок Authorization в каждом
следующем запросе. Проверить доступ проще всего вызовом
GET https://crm.hotlead.io/api/v1/who-am-i — он возвращает данные
текущего пользователя.
client_id и client_secret — это логин и пароль от личного
кабинета. Держите их на сервере, а не в коде страницы и не в мобильном приложении:
кто их получит, тот увидит все звонки, записи разговоров и клиентскую базу.
Все запросы — только по https.
Что можно вызвать и где попробовать запрос
Ниже — все 27 операций, разбитые по разделам. Примеры запросов и схемы ответов лежат в Swagger UI на crm.hotlead.io — там же запрос можно выполнить прямо из браузера.
Заявки и звонки
| Метод | Путь | Назначение |
|---|---|---|
| GET | /calls | Список звонков |
| GET | /calls/{id} | Карточка звонка по идентификатору |
| GET | /requests | Список заявок |
| GET | /requests/calls | Список заявок-звонков |
| GET | /requests/forms | Список заявок с форм |
| GET | /requests/{id} | Карточка заявки по идентификатору |
Контакты
| Метод | Путь | Назначение |
|---|---|---|
| GET | /contacts | Список контактов |
| POST | /contacts | Добавить контакт |
| GET | /contacts/{id} | Карточка контакта по идентификатору |
Сделки
| Метод | Путь | Назначение |
|---|---|---|
| GET | /deals | Список сделок |
Задачи
| Метод | Путь | Назначение |
|---|---|---|
| GET | /tasks | Список задач |
| POST | /tasks | Создать задачу |
| GET | /tasks/{id} | Карточка задачи |
| PUT | /tasks/{id} | Изменить задачу |
| DELETE | /tasks/{id} | Удалить задачу |
SIP-аккаунты
| Метод | Путь | Назначение |
|---|---|---|
| GET | /sip/accounts | Список SIP-аккаунтов |
| POST | /sip/accounts | Создать SIP-аккаунт |
| GET | /sip/accounts/{id} | Карточка SIP-аккаунта |
| PUT | /sip/accounts/{id} | Изменить SIP-аккаунт |
| DELETE | /sip/accounts/{id} | Удалить SIP-аккаунт |
Внешние номера
| Метод | Путь | Назначение |
|---|---|---|
| GET | /external-phon-numbers | Список внешних номеров |
Исходящие вызовы
| Метод | Путь | Назначение |
|---|---|---|
| POST | /outgoing-process | Инициировать исходящий вызов |
Обратный звонок
| Метод | Путь | Назначение |
|---|---|---|
| POST | /callback/{id} | Заказать обратный звонок |
Формы на сайте
| Метод | Путь | Назначение |
|---|---|---|
| POST | /capture-form/{site_hash} | Принять обращение с формы на сайте |
Прочее
| Метод | Путь | Назначение |
|---|---|---|
| GET | /comments | Список комментариев |
| GET | /upload-files | Список загруженных файлов |
| GET | /who-am-i | Данные текущего пользователя — проверка доступа |
Поддержка отвечает на общие вопросы по API и консультирует по интеграции — напишите в Telegram. Программирование, разработка модулей и доработка кода под ваши задачи в поддержку не входят — см. раздел 08 документации.