Документация по 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). |
Пример запроса
Пример JSON-ответа
{ "success": true, "offset": 0, "limit": 100, "count": 3, "data": [ { "number": "+15551230001", "name": "", "date": "2026-03-20 16:12:28" }, { "number": "+15551230002", "name": "Alex Carter", "date": "2026-03-20 16:12:00" }, { "number": "+447700900123", "name": "Taylor Reed", "date": "2026-03-20 15:48:41" } ] }
пояснение к ответу
| Поле | Описание |
|---|---|
| успех | истинный Это означает, что запрос был успешно обработан. |
| компенсировать | Смещение пагинации, возвращаемое API. |
| лимит | К запросу применено ограничение на количество страниц. |
| считать | Количество строк, возвращенных в данные. |
| данные | Массив, содержащий записи о пропущенных звонках. |
| данные[].номер | Номер телефона звонящего. |
| данные[].имя | Кэшированное имя контакта. Может быть пустым, если имя контакта недоступно. |
| данные[].дата | Дата и время звонка в отформатированном виде. |
Список входящих звонков
Просматривайте входящие отвеченные звонки, синхронизированные с мобильного устройства.
Конечная точка
Параметры запроса
| Параметр | Тип | Описание |
|---|---|---|
| апики | нить | Необходимый Ваш 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 (НРАВИТЬСЯ). |
Пример запроса
Пример JSON-ответа
{ "success": true, "apikey": "YOUR_API_KEY_HASH", "limit": 50, "offset": 0, "sort_by": "call_date_ms", "sort_dir": "desc", "filters": { "date_from_ms": null, "date_to_ms": null, "q": null }, "count": 3, "rows": [ { "phone_number": "+15551230010", "cached_name": "Jordan Blake", "call_date_ms": 1774027779390, "call_datetime_utc": "2026-03-20 17:29:39", "duration_sec": 23, "geo_location": "Canada", "created_at": "2026-03-20 17:46:45" }, { "номер_телефона": "+15551230011", "кэшированное_имя": "Морган Ли", "дата_звонка_мс": 1774018268663, "дата_звонка_время_UTC": "2026-03-20 14:51:08", "продолжительность_сек": 50, "гео_местоположение": "Канада", "создано_в": "2026-03-20 14:58:37" }, { "номер_телефона": "+447700900124", "кэшированное_имя": "Сэм Паркер", "дата_звонка_мс": 1774011205123, "дата_звонка_время_UTC": "2026-03-20 12:53:25", "продолжительность_сек": 92, "гео_местоположение": "Канада", "created_at": "2026-03-20 12:59:01" ] }
пояснение к ответу
| Поле | Описание |
|---|---|
| успех | истинный Это означает, что запрос был успешно обработан. |
| апики | Выведенное значение ключа API. В примерах документации это значение всегда должно быть скрыто. |
| лимит | Количество строк, запрашиваемых на странице. |
| компенсировать | Смещение пагинации, возвращаемое API. |
| Сортировать по | Поле сортировки, применяемое API. |
| сортировка_директории | Направление сортировки определяется API. |
| фильтры | Объект, содержащий активные фильтры, использованные для запроса. |
| считать | Количество строк, возвращенных в ряды. |
| ряды | Массив, содержащий записи о входящих отвеченных звонках. |
| строк[].номер_телефона | Номер телефона, связанный с звонком. |
| строк[].cached_name | Кэшированное имя контакта. Может быть пустым или содержать значение null в зависимости от доступных данных. |
| строк[].call_date_ms | Отметка времени вызова в миллисекундах. |
| строк[].call_datetime_utc | Дата и время звонка по UTC. |
| строк[].duration_sec | Продолжительность разговора в секундах. |
| строк[].гео_локация | Если имеется, то к номеру может быть привязана географическая метка. |
| строк[].created_at | Дата и время вставки строки на сервер. |
Список исходящих звонков
Восстанавливайте исходящие вызовы, синхронизированные с мобильного устройства.
Конечная точка
Параметры запроса
Те же параметры и поведение, что и при входящих звонках.
| Параметр | Тип | Описание |
|---|---|---|
| апики | нить | Необходимый Ваш 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 (НРАВИТЬСЯ). |
Пример запроса
Пример JSON-ответа
{ "success": true, "apikey": "YOUR_API_KEY_HASH", "limit": 50, "offset": 0, "sort_by": "call_date_ms", "sort_dir": "desc", "filters": { "date_from_ms": null, "date_to_ms": null, "q": null }, "count": 3, "rows": [ { "phone_number": "+15551230020", "cached_name": "Casey Morgan", "call_date_ms": 1774025965645, "call_datetime_utc": "2026-03-20 16:59:25", "duration_sec": 15, "geo_location": "Canada", "created_at": "2026-03-20 17:17:58" }, { "phone_number": "+15551230021", "cached_name": "Taylor Brooks", "call_date_ms": 1774023172638, "call_datetime_utc": "2026-03-20 16:12:52", "duration_sec": 556, "geo_location": "Canada", "created_at": "2026-03-20 16:28:38" }, { "phone_number": "+33198765432", "cached_name": "Jamie Carter", "call_date_ms": 1774019040000, "call_datetime_utc": "2026-03-20 15:04:00", "duration_sec": 61, "geo_location": "Канада", "created_at": "2026-03-20 15:09:11" ] }
пояснение к ответу
| Поле | Описание |
|---|---|
| успех | истинный Это означает, что запрос был успешно обработан. |
| апики | Выведенное значение ключа API. В примерах документации это значение всегда должно быть скрыто. |
| лимит | Количество строк, запрашиваемых на странице. |
| компенсировать | Смещение пагинации, возвращаемое API. |
| Сортировать по | Поле сортировки, применяемое API. |
| сортировка_директории | Направление сортировки определяется API. |
| фильтры | Объект, содержащий активные фильтры, использованные для запроса. |
| считать | Количество строк, возвращенных в ряды. |
| ряды | Массив, содержащий записи об исходящих звонках. |
| строк[].номер_телефона | Номер телефона, связанный с звонком. |
| строк[].cached_name | Кэшированное имя контакта. Может быть пустым или содержать значение null в зависимости от доступных данных. |
| строк[].call_date_ms | Отметка времени вызова в миллисекундах. |
| строк[].call_datetime_utc | Дата и время звонка по UTC. |
| строк[].duration_sec | Продолжительность разговора в секундах. |
| строк[].гео_локация | Если имеется, то к номеру может быть привязана географическая метка. |
| строк[].created_at | Дата и время вставки строки на сервер. |
Поля пропущенных звонков
| Поле | Тип | Описание |
|---|---|---|
| успех | буль | Статус запроса. |
| компенсировать | инт | Возвращено смещение при постраничной навигации. |
| лимит | инт | Возвращено ограничение на количество страниц. |
| считать | инт | Количество строк, возвращенных в данные. |
| данные | множество | Список пропущенных звонков. |
| данные[].номер | нить | Номер телефона звонящего. |
| данные[].имя | нить | Имя контакта сохранено в кэше (может быть пустым). |
| данные[].дата | нить | Отформатированная строка даты и времени, полученная из метки времени в миллисекундах. |
Поля входящих/исходящих данных
| Поле | Тип | Описание |
|---|---|---|
| успех | буль | Статус запроса. |
| апики | нить | API возвращает данные (ваш ключ). В общедоступной документации всегда следует его скрывать. |
| лимит | инт | Количество строк на странице. |
| компенсировать | инт | Возвращено смещение при постраничной навигации. |
| Сортировать по | нить | Применено поле сортировки. |
| сортировка_директории | нить | Применено направление сортировки. |
| фильтры | объект | Эхо-фильтры (дата_из_мс, дата_в_мс, q). |
| считать | инт | Количество строк, возвращенных в ряды. |
| ряды | множество | Список звонков. |
| строк[].номер_телефона | нить | Номер телефона. |
| строк[].cached_name | строка|нулевой | Кэшированное имя контакта (может быть пустым). |
| строк[].call_date_ms | инт | Отметка времени вызова в миллисекундах. |
| строк[].call_datetime_utc | нить | Поле даты и времени в формате UTC (база данных). |
| строк[].duration_sec | инт | Продолжительность в секундах. |
| строк[].гео_локация | строка|нулевой | Метка географического местоположения (может быть пустой). |
| строк[].created_at | нить | Отметка времени вставки на сервер. |
