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

Что бы попробовать REST API укажите Ваш API Key

Ресурсы

Звонки

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

GET
/v1/calls/search

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

Параметры

Имя Описание Пример Значение для попробовать
phone
строка
необязательный
Последние цифры номера телефона Звонков в выборке. 4991112233
from_offset
число
необязательный
Смещение выборки. Сколько Звонков пропустить в начале выборки. Используется для педжинации. 15
from_call
число
необязательный
ID Звонка. С какого Звонка начинать выборку. Используется для педжинации. 6283933545147395652
from_time
дата время
необязательный
Дата и время в формате ISO 8601 YYYY-MM-DDThh:mm[:ss[.sss]] в UTC. С какой даты (включительно) делать выборку. 2017-06-23T08:08:54.846
to_time
дата время
необязательный
Дата и время в формате ISO 8601 YYYY-MM-DDThh:mm[:ss[.sss]] в UTC. По какую дату (включительно) делать выборку. 2017-06-23T08:21:44.848
sort
перечисление
необязательный
Значения: desc | asc. Направление сортировки Звонков в выборке по дате. По умолчанию: desc. asc

URL

			
Код


				
Тело

			



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

GET
/v1/calls/{id}

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

Параметры

Имя Описание Пример Значение для попробовать
id
число
обязательный
ID Звонка, который запрашивается. 6288794545147391289

URL

			
Код


				
Тело

			



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

GET
/v1/calls/{id}/messages

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

Параметры

Имя Описание Пример Значение для попробовать
id
число
обязательный
ID Звонка, Сообщения которого запрашиваются. 6288794545147391289

URL

			
Код


				
Тело

			



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

GET
/v1/calls/{id}/record.mp3

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

Параметры

Имя Описание Пример
id
число
обязательный
ID Звонка, запись которого запрашиваются. 6288794545147391289

Сообщения

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

GET
/v1/messages/search

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

Параметры

Имя Описание Пример Значение для попробовать
for_call
число
необязательный
ID Звонка. Сообщения только этого Звонка. 6283933545169795652
from_offset
число
необязательный
Смещение выборки. Сколько Сообщенйи пропустить в начале выборки. Используется для педжинации. 14
from_message
число
необязательный
ID Сообщения. С какого Сообщения начинать выборку. Используется для педжинации. 14
from_time
дата время
необязательный
Дата и время в формате ISO 8601 YYYY-MM-DDThh:mm[:ss[.sss]] в UTC. С какой даты (включительно) делать выборку. 2010-07-06T08:08:00
to_time
дата время
необязательный
Дата и время в формате ISO 8601 YYYY-MM-DDThh:mm[:ss[.sss]] в UTC. По какую дату (включительно) делать выборку. 2020-01-01T00:00
sort
перечисление
необязательный
Значения: desc | asc. Направление сортировки Сообщений в выборке по дате. По умолчанию: desc. asc

URL

			
Код


				
Тело

			



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

GET
/v1/messages/{id}

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

Параметры

Имя Описание Пример Значение для попробовать
id
число
обязательный
ID Сообщения, которое запрашивается. 6283933545169791573

URL

			
Код


				
Тело

			



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

GET
/v1/messages/{id}/calls

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

Параметры

Имя Описание Пример Значение для попробовать
id
число
обязательный
ID Сообщения, Звонок которого запрашиваются. 6283933545164691571

URL

			
Код


				
Тело