Документация API

Звонки

Запрос на получение списка звонков

GET /v1/calls/list/{page}

Примечание: Без подключенного модуля Фиды.

Параметры пагинации:

Имя параметраТипОписаниеПример значенияОбязательное
pageintegerНомер страницы1Нет
limitintegerКол-во записей на страницу20Нет

Принимаемые параметры:

Имя параметраТипОписаниеПример значенияОбязательное
phoneNumberstringНомер телефона78005553535Нет
dateFromCalledAtstringДата начала периода для фильтрации звонков2024/01/01Нет
dateToCalledAtstringДата окончания периода для фильтрации звонков2024/12/31Нет
timeFromCalledAtstringВремя начала периода для фильтрации звонков05:00Нет
timeToCalledAtstringВремя окончания периода для фильтрации звонков17:00Нет
callLengthFromintegerМинимальная длительность звонка в секундах300Нет
callLengthTointegerМаксимальная длительность звонка в секундах600Нет
callWaitingFromintegerМинимальное время ожидания ответа в секундах5Нет
callWaitingTointegerМаксимальное время ожидания ответа в секундах10Нет
idPacketsintegerID пакета54321Нет
status[]integerСтатус звонка0 (Без статуса) / 1 (Целевой звонок) / 2 (Нецелевой звонок)Нет
projectNamestringНазвание проектаДжойниоНет

Результат запроса:

  • 200 OK - успешное выполнение
  • 401 Unauthorized - требуется предварительная авторизация
  • 403 Forbidden - операция недоступна данному пользователю

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


{
    "items": [
        {
            "id": 11111,
            "calledAt": "2024-01-01 11:50:09",
            "phone": "78005553535",
            "callLength": 508,
            "callWaiting": 6,
            "callFile": "https://stat.jcat.ru/comagic_calls/abc832347abded4583627bbd32347abded4583.mp3",
            "projectName": "Джойнио",
            "status": 1,
            "idPacket": 12312,
            "packetTitle": "Джойнио Недвижимость"
        },
        {
            "id": 11112,
            "calledAt": "2024-12-31 13:27:39",
            "phone": "78005553535",
            "callLength": 325,
            "callWaiting": 2,
            "callFile": "https://stat.jcat.ru/comagic_calls/abc832347abded4583627bbd426623abc4358.mp3",
            "projectName": "Джойнио",
            "status": 1,
            "idPacket": 12312,
            "packetTitle": "Джойнио Недвижимость"
        }
    ],
    "total": 2,
    "pages": {
        "page": 1,
        "total": 1,
        "limit": 20
    }
}

Описание полей ответа:

ПолеТипОписание
idintegerУникальный идентификатор звонка
calledAtstringДата и время звонка
phonestringНомер телефона
callLengthintegerДлительность звонка в секундах
callWaitingintegerВремя ожидания ответа в секундах
callFilestringURL файла записи звонка
projectNamestringНазвание проекта
statusintegerСтатус звонка
idPacketintegerID пакета
packetTitlestring|nullНазвание пакета

Примечание: С подключенным модулем Фиды.

Принимаемые параметры:

Имя параметраТипОписаниеПример значенияОбязательное
phoneNumberstringНомер телефона78005553535Нет
dateFromCalledAtstringДата начала периода для фильтрации звонков2024/01/01Нет
dateToCalledAtstringДата окончания периода для фильтрации звонков2024/12/31Нет
timeFromCalledAtstringВремя начала периода для фильтрации звонков05:00Нет
timeToCalledAtstringВремя окончания периода для фильтрации звонков17:00Нет
callLengthFromintegerМинимальная длительность звонка в секундах300Нет
callLengthTointegerМаксимальная длительность звонка в секундах600Нет
callWaitingFromintegerМинимальное время ожидания ответа в секундах5Нет
callWaitingTointegerМаксимальное время ожидания ответа в секундах10Нет

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


{
    "items": [
        {
            "id": 12345,
            "calledAt": "2024-01-01 20:45:50",
            "phone": "78005553535",
            "callLength": 200,
            "callWaiting": 0,
            "idPacket": 5432112,
            "orderTitle": "Коттедж 240 м2 на участке 6 сот.",
            "orderPrice": "42900000"
        },
        {
            "id": 12346,
            "calledAt": "2024-12-31 18:12:39",
            "phone": "78005553535",
            "callLength": 0,
            "callWaiting": 0,
            "idPacket": 543211,
            "orderTitle": "Продам 1-комн. квартиру 33 кв.м.",
            "orderPrice": "10000000"
        }
    ],
    "total": 2,
    "pages": {
        "page": 1,
        "total": 1,
        "limit": 20
    }
}

Описание полей ответа:

ПолеТипОписание
idintegerУникальный идентификатор звонка
calledAtstringДата и время звонка
phonestringНомер телефона
callLengthintegerДлительность звонка в секундах
callWaitingintegerВремя ожидания ответа в секундах
idPacketintegerID пакета
orderTitlestringЗаголовок объявления
orderPricestringЦена объявления