Документація API керування викликами
Ці кінцеві точки дозволяють вам отримати ваші Пропущені дзвінки, Вхідні прийняті дзвінки, і Вихідні дзвінки синхронізовано з мобільного додатку SMSMobileAPI на вашу панель інструментів + API.
Важливо: якщо мобільний додаток працює у фоновому режимі, телефонна система може запровадити затримку (часто до ~10 хвилин) між синхронізаціями. Ви завжди можете відкрити додаток для синхронізації вручну, якщо це необхідно.
Швидкий старт
Базова URL-адреса
Приклади
Аутентифікація
Кінцеві точки керування викликами автентифікуються за допомогою apikey параметр запиту.
Загальні поняття
Пагінація
використання ліміт і зміщення для пагінації результатів.
Позначки часу
- дата_дзвінка_мс є міткою часу UNIX у мілісекунди.
- дата_час_дзвінка UTC зберігається як рядок дати та часу UTC (поле бази даних).
- Для пропущених дзвінків API повертає відформатований дата рядок (походить зі значення мілісекунд).
Пошук
- Пропущені дзвінки: пошук збігається з числом або ім'ям.
- Вхідні/Вихідні: q матчі номер_телефону або кешована_ім'я.
Сортування (лише вхідні/вихідні)
Сортування контролюється сортувати_за + каталог_сортування (лише поля з білого списку). Пропущені дзвінки завжди відображаються в порядку найновіших.
Помилки
| HTTP | Приклад помилки | Значення |
|---|---|---|
| 400 | {"успіх":хибність,"помилка":"відсутній_ключ_апікею"} | Відсутній або порожній apikey. |
| 403 | {"успіх":хибно,"помилка":"недійсний_ключ_апікею"} | Ключ API не знайдено / не розпізнано. |
| 403 | {"успіх":хибно,"помилка":"термін дії api_expired"} | Термін дії вашої підписки закінчився (ліміт дати це до сьогоднішнього дня). |
| 500 | {"успіх":false,"помилка":"помилка_сервера","деталі":"..."} | Помилка сервера (база даних, SQL, виняток). |
Примітка: кінцева точка пропущених дзвінків також може повертати такі повідомлення, як Відсутній apikey або помилки підготовки SQL залежно від ситуації.
Пропущені дзвінки – Список
Отримання пропущених дзвінків, синхронізованих з мобільного пристрою.
Кінцева точка
Параметри запиту
| Параметр | Тип | опис |
|---|---|---|
| apikey | рядок | Обов'язковий Ваш 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": "Алекс Картер", "date": "2026-03-20 16:12:00" }, { "number": "+447700900123", "name": "Тейлор Рід", "date": "2026-03-20 15:48:41" } ] }
Пояснення відповіді
| Поле | опис |
|---|---|
| успіх | правда означає, що запит успішно оброблено. |
| зміщення | Зсув пагінації, повернутий API. |
| ліміт | До запиту застосовано обмеження на сторінкування. |
| рахувати | Кількість рядків, що повертаються в дані. |
| дані | Масив, що містить записи про пропущені виклики. |
| дані[].число | Номер телефону абонента. |
| дані[].назва | Кешоване ім'я контакту. Може бути порожнім, якщо ім'я контакту недоступне. |
| дані[].дата | Відформатовані дата та час дзвінка. |
Вхідні дзвінки – Список
Отримувати вхідні відповіді на дзвінки, синхронізовані з мобільного пристрою.
Кінцева точка
Параметри запиту
| Параметр | Тип | опис |
|---|---|---|
| apikey | рядок | Обов'язковий Ваш ключ API (підтверджений за допомогою підписки). |
| ліміт | ціл. | Необов'язково Рядків на сторінці (за замовчуванням: 50, макс.: 200). |
| зміщення | ціл. | Необов'язково Зсув сторінок (за замовчуванням: 0). |
| сортувати_за | рядок | Необов'язково Дозволено: дата_дзвінка_мс дата_час_дзвінка UTC тривалість_сек номер_телефону створено_за_адресою кешована_ім'я геолокація |
| каталог_сортування | зростання|спадання | Необов'язково За замовчуванням: опис. |
| дата_від_мс | ціле (мс) | Необов'язково Фільтрувати, де дата_дзвінка_мс >= дата_від_мс. |
| дата_до_мс | ціле (мс) | Необов'язково Фільтрувати, де дата_дзвінка_мс <= дата_до_мс. |
| q | рядок | Необов'язково Пошук на номер_телефону або кешована_ім'я (ПОДОБАЄТЬСЯ). |
Приклад запиту
Приклад 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": "Джордан Блейк", "call_date_ms": 1774027779390, "call_datetime_utc": "2026-03-20 17:29:39", "duration_sec": 23, "geo_location": "Канада", "created_at": "2026-03-20 17:46:45" }, { "phone_number": "+15551230011", "cached_name": "Морган Лі", "call_date_ms": 1774018268663, "call_datetime_utc": "2026-03-20 14:51:08", "duration_sec": 50, "geo_location": "Канада", "created_at": "2026-03-20 14:58:37" }, { "phone_number": "+447700900124", "cached_name": "Сем Паркер", "call_date_ms": 1774011205123, "call_datetime_utc": "2026-03-20 12:53:25", "duration_sec": 92, "geo_location": "Канада", "created_at": "2026-03-20 12:59:01" } ] }
Пояснення відповіді
| Поле | опис |
|---|---|
| успіх | правда означає, що запит успішно оброблено. |
| apikey | Відтворене значення ключа API. У прикладах документації це завжди слід маскувати. |
| ліміт | Кількість рядків, що запитуються на сторінці. |
| зміщення | Зсув пагінації, повернутий API. |
| сортувати_за | Поле сортування, застосоване API. |
| каталог_сортування | Напрямок сортування, що застосовується API. |
| фільтри | Об'єкт, що містить активні фільтри, що використовуються для запиту. |
| рахувати | Кількість рядків, що повертаються в рядки. |
| рядки | Масив, що містить записи вхідних прийнятих дзвінків. |
| рядки[].номер_телефону | Номер телефону, пов’язаний із дзвінком. |
| рядки[].кешована_ім'я | Кешоване ім'я контакту. Може бути null або порожнім залежно від доступних даних. |
| рядки[].call_date_ms | Мітка часу виклику в мілісекундах. |
| рядки[].call_datetime_utc | Дата та час виклику за UTC. |
| рядки[].duration_sec | Тривалість дзвінка в секундах. |
| рядки[].геолокація | Географічна мітка, пов'язана з номером, якщо така є. |
| рядки[].created_at | Дата та час, коли рядок було вставлено на сервер. |
Вихідні дзвінки – Список
Отримувати вихідні дзвінки, синхронізовані з мобільного пристрою.
Кінцева точка
Параметри запиту
Ті ж параметри та поведінка, що й для вхідних дзвінків.
| Параметр | Тип | опис |
|---|---|---|
| apikey | рядок | Обов'язковий Ваш ключ API (підтверджений за допомогою підписки). |
| ліміт | ціл. | Необов'язково Рядків на сторінці (за замовчуванням: 50, макс.: 200). |
| зміщення | ціл. | Необов'язково Зсув сторінок (за замовчуванням: 0). |
| сортувати_за | рядок | Необов'язково Дозволено: дата_дзвінка_мс дата_час_дзвінка UTC тривалість_сек номер_телефону створено_за_адресою кешована_ім'я геолокація |
| каталог_сортування | зростання|спадання | Необов'язково За замовчуванням: опис. |
| дата_від_мс | ціле (мс) | Необов'язково Фільтрувати, де дата_дзвінка_мс >= дата_від_мс. |
| дата_до_мс | ціле (мс) | Необов'язково Фільтрувати, де дата_дзвінка_мс <= дата_до_мс. |
| q | рядок | Необов'язково Пошук на номер_телефону або кешована_ім'я (ПОДОБАЄТЬСЯ). |
Приклад запиту
Приклад 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": "Кейсі Морган", "call_date_ms": 1774025965645, "call_datetime_utc": "2026-03-20 16:59:25", "duration_sec": 15, "geo_location": "Канада", "created_at": "2026-03-20 17:17:58" }, { "phone_number": "+15551230021", "cached_name": "Тейлор Брукс", "call_date_ms": 1774023172638, "call_datetime_utc": "2026-03-20 16:12:52", "duration_sec": 556, "geo_location": "Канада", "created_at": "2026-03-20 16:28:38" }, { "phone_number": "+33198765432", "cached_name": "Джеймі Картер", "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" } ] }
Пояснення відповіді
| Поле | опис |
|---|---|
| успіх | правда означає, що запит успішно оброблено. |
| apikey | Відтворене значення ключа API. У прикладах документації це завжди слід маскувати. |
| ліміт | Кількість рядків, що запитуються на сторінці. |
| зміщення | Зсув пагінації, повернутий API. |
| сортувати_за | Поле сортування, застосоване API. |
| каталог_сортування | Напрямок сортування, що застосовується API. |
| фільтри | Об'єкт, що містить активні фільтри, що використовуються для запиту. |
| рахувати | Кількість рядків, що повертаються в рядки. |
| рядки | Масив, що містить записи вихідних дзвінків. |
| рядки[].номер_телефону | Номер телефону, пов’язаний із дзвінком. |
| рядки[].кешована_ім'я | Кешоване ім'я контакту. Може бути null або порожнім залежно від доступних даних. |
| рядки[].call_date_ms | Мітка часу виклику в мілісекундах. |
| рядки[].call_datetime_utc | Дата та час виклику за UTC. |
| рядки[].duration_sec | Тривалість дзвінка в секундах. |
| рядки[].геолокація | Географічна мітка, пов'язана з номером, якщо така є. |
| рядки[].created_at | Дата та час, коли рядок було вставлено на сервер. |
Поля пропущених викликів
| Поле | Тип | опис |
|---|---|---|
| успіх | логічна змінна | Запит статусу. |
| зміщення | ціл. | Повернуто зміщення пагінації. |
| ліміт | ціл. | Повернуто обмеження на пагінацію. |
| рахувати | ціл. | Кількість рядків, що повертаються в дані. |
| дані | масив | Список пропущених дзвінків. |
| дані[].число | рядок | Номер телефону абонента. |
| дані[].назва | рядок | Кешоване ім'я контакту (може бути порожнім). |
| дані[].дата | рядок | Відформатований рядок дати та часу, отриманий з позначки часу в мілісекундах. |
Поля вхідних/вихідних повідомлень
| Поле | Тип | опис |
|---|---|---|
| успіх | логічна змінна | Запит статусу. |
| apikey | рядок | Відтворюється API (ваш ключ). У публічних документах завжди маскуйте його. |
| ліміт | ціл. | Повернуто рядків на сторінці. |
| зміщення | ціл. | Повернуто зміщення пагінації. |
| сортувати_за | рядок | Застосоване поле сортування. |
| каталог_сортування | рядок | Застосовано напрямок сортування. |
| фільтри | об'єкт | Відлуння фільтрів (дата_від_мс, дата_до_мс, q). |
| рахувати | ціл. | Кількість рядків, що повертаються в рядки. |
| рядки | масив | Список дзвінків. |
| рядки[].номер_телефону | рядок | Номер телефону. |
| рядки[].кешована_ім'я | рядок|нуль | Кешоване ім'я контакту (може бути null). |
| рядки[].call_date_ms | ціл. | Мітка часу виклику в мілісекундах. |
| рядки[].call_datetime_utc | рядок | Поле дати та часу UTC (база даних). |
| рядки[].duration_sec | ціл. | Тривалість у секундах. |
| рядки[].геолокація | рядок|нуль | Мітка геолокації (може бути null/порожньою). |
| рядки[].created_at | рядок | Мітка часу вставки на сервер. |
