Документація API керування викликами
Ці кінцеві точки дозволяють вам отримати ваші Пропущені дзвінки, Вхідні прийняті дзвінки, і Вихідні дзвінки синхронізовано з мобільного додатку SMSMobileAPI на вашу панель інструментів + API.
Важливо: якщо мобільний додаток працює у фоновому режимі, телефонна система може запровадити затримку (часто до ~10 хвилин) між синхронізаціями. Ви завжди можете відкрити додаток для синхронізації вручну, якщо це необхідно.
Потрібна допомога? api@smsmobileapi.com
Швидкий старт
Базова URL-адреса
ОТРИМАТИ https://api.smsmobileapi.com
Усі кінцеві точки нижче задокументовані як ОТРИМАТИ запити. Замінити ВАШ_КЛЮЧ_API з вашим справжнім ключем (не поширюйте його публічно).
Приклади
ОТРИМАТИ https://api.smsmobileapi.com/call/missed/list/?apikey=ВАШ_КЛЮЧ_API
ОТРИМАТИ https://api.smsmobileapi.com/call/incoming/list/?apikey=ВАШ_КЛЮЧ_API&limit=50&offset=0&sort_by=call_date_ms&sort_dir=desc
ОТРИМАТИ https://api.smsmobileapi.com/call/outgoing/list/?apikey=YOUR_API_KEY&q=3247&date_from_ms=1700000000000&date_to_ms=1700864000000
Аутентифікація
Кінцеві точки керування викликами автентифікуються за допомогою apikey параметр запиту.
Підтвердження підписки: Вхідні/вихідні кінцеві точки перевіряють ваш ключ API та дійсність вашої підписки (dateLimit >= CURDATE()). Якщо термін дії закінчився, ви отримаєте термін дії api_expired.
Загальні поняття
Пагінація
використання ліміт і зміщення для пагінації результатів.
Позначки часу
- дата_дзвінка_мс є міткою часу UNIX у мілісекунди.
- дата_час_дзвінка UTC зберігається як рядок дати та часу UTC (поле бази даних).
- Для пропущених дзвінків API повертає відформатований дата рядок (походить зі значення мілісекунд).
Пошук
- Пропущені дзвінки: пошук збігається з числом або ім'ям.
- Вхідні/Вихідні: q матчі номер_телефону або кешована_ім'я.
Сортування (лише вхідні/вихідні)
Сортування контролюється сортувати_за + каталог_сортування (лише поля з білого списку). Пропущені дзвінки завжди відображаються в порядку найновіших.
Помилки
| HTTP | Приклад помилки | Значення |
|---|---|---|
| 400 | {"успіх":хибність,"помилка":"відсутній_ключ_апікею"} | Відсутній або порожній apikey. |
| 403 | {"успіх":хибно,"помилка":"недійсний_ключ_апікею"} | Ключ API не знайдено / не розпізнано. |
| 403 | {"успіх":хибно,"помилка":"термін дії api_expired"} | Термін дії вашої підписки закінчився (ліміт дати це до сьогоднішнього дня). |
| 500 | {"успіх":false,"помилка":"помилка_сервера","деталі":"..."} | Помилка сервера (база даних, SQL, виняток). |
Примітка: кінцева точка пропущених дзвінків також може повертати такі повідомлення, як Відсутній apikey або помилки підготовки SQL залежно від ситуації.
Пропущені дзвінки – Список
Отримання пропущених дзвінків, синхронізованих з мобільного пристрою.
Кінцева точка
ОТРИМАТИ https://api.smsmobileapi.com/call/missed/list/
Параметри запиту
| Параметр | Тип | опис |
|---|---|---|
| apikey | рядок | Обов'язковий Ваш API-ключ, прив'язаний до мобільного телефону. |
| зміщення | ціл. | Необов'язково Зсув сторінок (за замовчуванням: 0). |
| ліміт | ціл. | Необов'язково Максимум рядків (за замовчуванням: 100, макс.: 500). |
| пошук | рядок | Необов'язково Пошук за номером або назвою (SQL LIKE). |
| дата_початку | РРРР-ММ-ДД | Необов'язково Фільтр з цього дня (00:00:00). |
| дата_кінця | РРРР-ММ-ДД | Необов'язково Фільтрувати до сьогодні (23:59:59). |
Вхідні дзвінки – Список
Отримувати вхідні відповіді на дзвінки, синхронізовані з мобільного пристрою.
Кінцева точка
ОТРИМАТИ https://api.smsmobileapi.com/call/incoming/list/
Параметри запиту
| Параметр | Тип | опис |
|---|---|---|
| apikey | рядок | Обов'язковий Ваш ключ API (підтверджений за допомогою підписки). |
| ліміт | ціл. | Необов'язково Рядків на сторінці (за замовчуванням: 50, макс.: 200). |
| зміщення | ціл. | Необов'язково Зсув сторінок (за замовчуванням: 0). |
| сортувати_за | рядок | Необов'язково Дозволено: дата_дзвінка_мс дата_час_дзвінка UTC тривалість_сек номер_телефону створено_за_адресою кешована_ім'я геолокація |
| каталог_сортування | зростання|спадання | Необов'язково За замовчуванням: опис. |
| дата_від_мс | ціле (мс) | Необов'язково Фільтрувати, де дата_дзвінка_мс >= дата_від_мс. |
| дата_до_мс | ціле (мс) | Необов'язково Фільтрувати, де дата_дзвінка_мс <= дата_до_мс. |
| q | рядок | Необов'язково Пошук на номер_телефону або кешована_ім'я (ПОДОБАЄТЬСЯ). |
Вихідні дзвінки – Список
Отримувати вихідні дзвінки, синхронізовані з мобільного пристрою.
Кінцева точка
ОТРИМАТИ https://api.smsmobileapi.com/call/outgoing/list/
Параметри запиту
Ті ж параметри та поведінка, що й для вхідних дзвінків.
| Параметр | Тип | опис |
|---|---|---|
| apikey | рядок | Обов'язковий Ваш ключ API (підтверджений за допомогою підписки). |
| ліміт | ціл. | Необов'язково Рядків на сторінці (за замовчуванням: 50, макс.: 200). |
| зміщення | ціл. | Необов'язково Зсув сторінок (за замовчуванням: 0). |
| сортувати_за | рядок | Необов'язково Дозволено: дата_дзвінка_мс дата_час_дзвінка UTC тривалість_сек номер_телефону створено_за_адресою кешована_ім'я геолокація |
| каталог_сортування | зростання|спадання | Необов'язково За замовчуванням: опис. |
| дата_від_мс | ціле (мс) | Необов'язково Фільтрувати, де дата_дзвінка_мс >= дата_від_мс. |
| дата_до_мс | ціле (мс) | Необов'язково Фільтрувати, де дата_дзвінка_мс <= дата_до_мс. |
| q | рядок | Необов'язково Пошук на номер_телефону або кешована_ім'я (ПОДОБАЄТЬСЯ). |
Поля пропущених викликів
| Поле | Тип | опис |
|---|---|---|
| успіх | логічна змінна | Запит статусу. |
| зміщення | ціл. | Повернуто зміщення пагінації. |
| ліміт | ціл. | Повернуто обмеження на пагінацію. |
| рахувати | ціл. | Кількість рядків, що повертаються в дані. |
| дані | масив | Список пропущених дзвінків. |
| дані[].число | рядок | Номер телефону абонента. |
| дані[].назва | рядок | Кешоване ім'я контакту (може бути порожнім). |
| дані[].дата | рядок | Відформатований рядок дати та часу, отриманий з позначки часу в мілісекундах. |
Поля вхідних/вихідних повідомлень
| Поле | Тип | опис |
|---|---|---|
| успіх | логічна змінна | Запит статусу. |
| apikey | рядок | Відповідь від API (ваш ключ). |
| ліміт | ціл. | Повернуто рядків на сторінці. |
| зміщення | ціл. | Повернуто зміщення пагінації. |
| сортувати_за | рядок | Застосоване поле сортування. |
| каталог_сортування | рядок | Застосовано напрямок сортування. |
| фільтри | об'єкт | Відлуння фільтрів (дата_від_мс, дата_до_мс, q). |
| рахувати | ціл. | Кількість рядків, що повертаються в рядки. |
| рядки | масив | Список дзвінків. |
| рядки[].номер_телефону | рядок | Номер телефону. |
| рядки[].кешована_ім'я | рядок|нуль | Кешоване ім'я контакту (може бути null). |
| рядки[].call_date_ms | ціл. | Мітка часу виклику в мілісекундах. |
| рядки[].call_datetime_utc | рядок | Поле дати та часу UTC (база даних). |
| рядки[].duration_sec | ціл. | Тривалість у секундах. |
| рядки[].геолокація | рядок|нуль | Мітка геолокації (може бути null/порожньою). |
| рядки[].created_at | рядок | Мітка часу вставки на сервер. |
English 
French 
German 
Spanish 
Portuguese 
Russian 
Finnish 
Japanese 
Chinese 
Vietnamese 
Dutch 
Greek 
Arabic 
Danish 
Italian 
Ukrainian