Документация по API управления вызовами
Эти конечные точки позволяют вам получить ваши Пропущенные звонки, Входящие отвеченные звонки, и Исходящие звонки Синхронизация данных из мобильного приложения SMSMobileAPI в вашу панель управления + API.
Важно: если мобильное приложение работает в фоновом режиме, система телефона может создавать задержку (часто до ~10 минут) между синхронизациями. При необходимости вы всегда можете открыть приложение и выполнить синхронизацию вручную.
Быстрый старт
Базовый URL
Примеры
Аутентификация
Устройства управления вызовами проходят аутентификацию с использованием апики параметр запроса.
Общие понятия
Пагинация
Использовать лимит и компенсировать для постраничного отображения результатов.
Временные метки
- call_date_ms представляет собой метку времени UNIX в миллисекунды.
- call_datetime_utc хранится в виде строки даты и времени в формате UTC (поле базы данных).
- В случае пропущенных звонков API возвращает отформатированный результат. дата строка (полученная из значения в миллисекундах).
Поиск
- Пропущенные звонки: поиск Соответствует номеру или имени.
- Входящие/Исходящие: q матчи номер телефона или cached_name.
Сортировка (только входящие/исходящие)
Сортировка контролируется Сортировать по + сортировка_директории (Только поля из белого списка). Пропущенные звонки всегда сортируются по дате, начиная с самых новых.
Ошибки
| HTTP | Пример ошибки | Значение |
|---|---|---|
| 400 | {"success":false,"error":"missing_apikey"} | Отсутствует или пусто апики. |
| 403 | {"success":false,"error":"invalid_apikey"} | Ключ API не найден / не распознан. |
| 403 | {"success":false,"error":"api_expired"} | Срок действия вашей подписки истек (dateLimit это было до сегодняшнего дня). |
| 500 | {"success":false,"error":"server_error","detail":".."} | Ошибка сервера (база данных, SQL, исключение). |
Примечание: конечная точка «Пропущенные звонки» также может возвращать сообщения, подобные следующим: Отсутствует апикей или ошибки при подготовке SQL-запроса, в зависимости от ситуации.
Список пропущенных звонков
Восстановите пропущенные звонки, синхронизированные с мобильного устройства.
Конечная точка
Параметры запроса
| Параметр | Тип | Описание |
|---|---|---|
| апики | нить | Необходимый Ваш API-ключ привязан к мобильному телефону. |
| компенсировать | инт | Необязательный Смещение пагинации (по умолчанию: 0). |
| лимит | инт | Необязательный Максимальное количество строк (по умолчанию: 100, макс. 500). |
| поиск | нить | Необязательный Поиск по номеру или имени (SQL LIKE). |
| дата_начало | ГГГГ-ММ-ДД | Необязательный Фильтр по этому дню (00:00:00). |
| дата_конец | ГГГГ-ММ-ДД | Необязательный Фильтр по состоянию на сегодняшний день (23:59:59). |
Список входящих звонков
Просматривайте входящие отвеченные звонки, синхронизированные с мобильного устройства.
Конечная точка
Параметры запроса
| Параметр | Тип | Описание |
|---|---|---|
| апики | нить | Необходимый Ваш API-ключ (проверяется по подписке). |
| лимит | инт | Необязательный Количество строк на странице (по умолчанию: 50, макс. 200). |
| компенсировать | инт | Необязательный Смещение пагинации (по умолчанию: 0). |
| Сортировать по | нить | Необязательный Допустимый: call_date_ms call_datetime_utc длительность_сек номер телефона created_at cached_name геолокация |
| сортировка_директории | восхождение|нисхождение | Необязательный По умолчанию: описание. |
| дата_из_мс | целочисленный (мс) | Необязательный Фильтр по call_date_ms >= date_from_ms. |
| дата_в_мс | целочисленный (мс) | Необязательный Фильтр по call_date_ms <= date_to_ms. |
| q | нить | Необязательный Поиск по номер телефона или cached_name (НРАВИТЬСЯ). |
Список исходящих звонков
Восстанавливайте исходящие вызовы, синхронизированные с мобильного устройства.
Конечная точка
Параметры запроса
Те же параметры и поведение, что и при входящих звонках.
| Параметр | Тип | Описание |
|---|---|---|
| апики | нить | Необходимый Ваш API-ключ (проверяется по подписке). |
| лимит | инт | Необязательный Количество строк на странице (по умолчанию: 50, макс. 200). |
| компенсировать | инт | Необязательный Смещение пагинации (по умолчанию: 0). |
| Сортировать по | нить | Необязательный Допустимый: call_date_ms call_datetime_utc длительность_сек номер телефона created_at cached_name геолокация |
| сортировка_директории | восхождение|нисхождение | Необязательный По умолчанию: описание. |
| дата_из_мс | целочисленный (мс) | Необязательный Фильтр по call_date_ms >= date_from_ms. |
| дата_в_мс | целочисленный (мс) | Необязательный Фильтр по call_date_ms <= date_to_ms. |
| q | нить | Необязательный Поиск по номер телефона или cached_name (НРАВИТЬСЯ). |
Поля пропущенных звонков
| Поле | Тип | Описание |
|---|---|---|
| успех | буль | Статус запроса. |
| компенсировать | инт | Возвращено смещение при постраничной навигации. |
| лимит | инт | Возвращено ограничение на количество страниц. |
| считать | инт | Количество строк, возвращенных в данные. |
| данные | множество | Список пропущенных звонков. |
| данные[].номер | нить | Номер телефона звонящего. |
| данные[].имя | нить | Имя контакта сохранено в кэше (может быть пустым). |
| данные[].дата | нить | Отформатированная строка даты и времени, полученная из метки времени в миллисекундах. |
Поля входящих/исходящих данных
| Поле | Тип | Описание |
|---|---|---|
| успех | буль | Статус запроса. |
| апики | нить | Получено подтверждение от API (ваш ключ). |
| лимит | инт | Количество строк на странице. |
| компенсировать | инт | Возвращено смещение при постраничной навигации. |
| Сортировать по | нить | Применено поле сортировки. |
| сортировка_директории | нить | Применено направление сортировки. |
| фильтры | объект | Эхо-фильтры (дата_из_мс, дата_в_мс, q). |
| считать | инт | Количество строк, возвращенных в ряды. |
| ряды | множество | Список звонков. |
| строк[].номер_телефона | нить | Номер телефона. |
| строк[].cached_name | строка|нулевой | Кэшированное имя контакта (может быть пустым). |
| строк[].call_date_ms | инт | Отметка времени вызова в миллисекундах. |
| строк[].call_datetime_utc | нить | Поле даты и времени в формате UTC (база данных). |
| строк[].duration_sec | инт | Продолжительность в секундах. |
| строк[].гео_локация | строка|нулевой | Метка географического местоположения (может быть пустой). |
| строк[].created_at | нить | Отметка времени вставки на сервер. |
English 
French 
German 
Spanish 
Portuguese 
Russian 
Finnish 
Japanese 
Chinese 
Vietnamese 
Dutch 
Greek 
Arabic 
Danish 
Italian 
Ukrainian