RESTful API Телефонистки

Для выгрузки Звонков и Сообщений предоставлен REST API. Данная документация описывает все ресурсы и их параметры.

Общие положения

Сервис отправляет ответы в фомате JSON.
Ответы на запросы одиночных ресурсов содержат сразу объект, либо пустое тело и код 204 No Content, если объект не найден.
Ответы на списочные запросы содержат список объектов в поле list и их полное количество в поле total.

{
					    "total": 348,
					    "list": [
					        ...
					    ]
					}

Ответы на списочные запросы содержат максимум 100 элементов.
В ответах и запросах поля и параметры с типом дата всегда указываются в UTC.

Коды ответов и их значения

200 Ok — Запрос успешно выполнен и возвращен результат.
204 No Content — Запрос успешно выполнен, но результат пустой.
400 Bad Request — Запрос не выполнен. Ошибка в строке запроса, указанный в ресурс не существут, не верный формат парамета.
401 Unauthorized — Запрос не выполнен. Ошибка авторизации. Не указан API Key, указанный API Key не существует.
410 Gone — Запрос не выполнен, т.к. указанного ресурса больше нет в базе.
500 Internal Server Error — Запрос не выполнен. Ошибка на стороне сервиса при выполнении запроса.

Авторизация

Для авторизации используется API Key, полученный на странице настройки Линии. Для каждой линии нужно использовать свой API Key.

API Key может указываться либо как HTTP заголовок: Auth-Api-Key, либо как параметр запроса: auth_api_key

Ресурсы

Звонки

Поиск Звонков

Возвращает список Звонков, удовлетворяющих заданным параметрам или все Звонки Линии, если никакие параметры не заданы.

Имя: phone
Описание: Последние цифры номера телефона Звонков в выборке

Имя: from_offset
Описание: Смещение выборки. Сколько Звонков пропустить в начале выборки. Используется для педжинации.

Имя: from_call
Описание: ID Звонка. С какого Звонка начинать выборку. Используется для педжинации.

Имя: from_time
Описание: Дата и время в формате ISO 8601 YYYY-MM-DDThh:mm[:ss[.sss]] в UTC. С какой даты (включительно) делать выборку.

Имя: to_time
Описание: Дата и время в формате ISO 8601 YYYY-MM-DDThh:mm[:ss[.sss]] в UTC. По какую дату (включительно) делать выборку.

Имя: sort
Описание: Значения: desc | asc. Направление сортировки Звонков в выборке по дате. По умолчанию: desc.

Проверить

Получение Звонка

Имя: id
Описание: ID Звонка, который запрашивается.

Проверить

Получение Сообщений Звонка

Возвращает список Сообщений Звонка с указанным ID.

Имя: id
Описание: ID Звонка, Сообщения которого запрашиваются.

Проверить

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

Возвращает запись Звонка с указанным ID, если она существует, иначе ответ с кодом 410 Gone или 404 Not Found.

Имя: id
Описание: ID Звонка, запись которого запрашиваются.

Проверить

Сообщения

Поиск Сообщений

Возвращает список Сообщений, удовлетворяющих заданным параметрам или все Сообщения линии, если никакие параметры не заданы.

Имя: for_call
Описание: ID Звонка. Сообщения только этого Звонка.

Имя: from_offset
Описание: Смещение выборки. Сколько Сообщенйи пропустить в начале выборки. Используется для педжинации.

Имя: from_message
Описание: ID Сообщения. С какого Сообщения начинать выборку. Используется для педжинации.

Имя: from_time
Описание: Дата и время в формате ISO 8601 YYYY-MM-DDThh:mm[:ss[.sss]] в UTC. С какой даты (включительно) делать выборку.

Имя: to_time
Описание: Дата и время в формате ISO 8601 YYYY-MM-DDThh:mm[:ss[.sss]] в UTC. По какую дату (включительно) делать выборку.

Имя: sort
Значения: desc | asc. Направление сортировки Сообщений в выборке по дате. По умолчанию: desc.

Проверить

Получение Сообщения

Возвращает Сообщение с указанным ID.

Имя: id
Описание: ID Сообщения, которое запрашивается.

Проверить

Получение Звонка Сообщения

Возвращает Звонок Сообщения с указанным ID.

Имя: id
Описание: ID Сообщения, Звонок которого запрашиваются.

Проверить