Установите приложение 🪄 нажмите на значок в правой части адресной строки.

Устройства

Получить все

GET https://sms.ecofon.business/api/devices/
curl --request GET \
--url 'https://sms.ecofon.business/api/devices/' \
--header 'Authorization: Bearer {api_key}' \
Параметры Детали Описание
page Необязательный Целое число Номер страницы, с которой вы хотите получить результаты. По умолчанию: 1.
results_per_page Необязательный Целое число Кол-во результатов на странице. Допустимые значения: 10, 25, 50, 100, 250, 500, 1000. По умолчанию: 25.
search Необязательный Строка Строка поиска.
search_by Необязательный Строка Поле, по которому выполняется поиск. Допустимые значения: name, ip.
user_id Необязательный Целое число Filter results by user ID.
datetime_field Необязательный Строка Допустимые значения: last_ping_datetime, last_sent_datetime, last_received_datetime, datetime, last_datetime
datetime_start Необязательный Строка Фильтрация результатов, начиная с указанной даты и времени. Формат: Y-m-d H:i:s.
datetime_end Необязательный Строка Фильтрация результатов до указанной даты и времени. Формат: Y-m-d H:i:s.
order_by Необязательный Строка Поле сортировки результатов. Допустимые значения: device_id, name, last_ping_datetime, last_sent_datetime, last_received_datetime, datetime, last_datetime, total_sent_sms, total_pending_sms, total_failed_sms, total_received_sms.
order_type Необязательный Строка Порядок сортировки результатов. Допустимые значения: ASC (по возрастанию) и DESC (по убыванию). 
{
    "data": [
        {
            "id": 1,
            "user_id": 1,
            "name": "Example",
            "notifications": [
                1,
                2,
                3
            ],
            "settings": null,
            "sims": [
                {
                    "subscription_id": 1,
                    "phone_number": "+1234567890",
                    "carrier_name": "T-Mobile",
                    "display_name": "SIM 1",
                    "slot_index": 0
                }
            ],
            "device_fcm_token": "",
            "device_model": "sdk_gphone64_arm64",
            "device_brand": "google",
            "device_os": "16",
            "device_battery": 59,
            "device_is_charging": true,
            "ip": "123.123.123.123",
            "total_sent_sms": 50,
            "total_pending_sms": 10,
            "total_received_sms": 25,
            "total_failed_sms": 1,
            "last_sent_datetime": "2026-08-27 05:39:02",
            "last_ping_datetime": "2026-08-27 05:39:02",
            "last_received_datetime": null,
            "datetime": "2026-08-27 05:39:02",
            "last_datetime": null
        },
    ],
    "meta": {
        "page": 1,
        "results_per_page": 25,
        "total": 1,
        "total_pages": 1
    },
    "links": {
        "first": "https://sms.ecofon.business/api/devices?page=1",
        "last": "https://sms.ecofon.business/api/devices?page=1",
        "next": null,
        "prev": null,
        "self": "https://sms.ecofon.business/api/devices?page=1"
    }
}

Получить один

GET https://sms.ecofon.business/api/devices/{device_id}
curl --request GET \
--url 'https://sms.ecofon.business/api/devices/{device_id}' \
--header 'Authorization: Bearer {api_key}' \ 
{
    "data": {
        "id": 1,
        "user_id": 1,
        "name": "Example",
        "notifications": [
            1,
            2,
            3
        ],
        "settings": null,
        "sims": [
            {
                "subscription_id": 1,
                "phone_number": "+1234567890",
                "carrier_name": "T-Mobile",
                "display_name": "SIM 1",
                "slot_index": 0
            }
        ],
        "device_fcm_token": "",
        "device_model": "sdk_gphone64_arm64",
        "device_brand": "google",
        "device_os": "16",
        "device_battery": 59,
        "device_is_charging": true,
        "ip": "123.123.123.123",
        "total_sent_sms": 50,
        "total_pending_sms": 10,
        "total_received_sms": 25,
        "total_failed_sms": 1,
        "last_sent_datetime": "2026-08-27 05:39:02",
        "last_ping_datetime": "2026-08-27 05:39:02",
        "last_received_datetime": null,
        "datetime": "2026-08-27 05:39:02",
        "last_datetime": null
    },
}

Создать

POST https://sms.ecofon.business/api/devices
Параметры Детали Описание
name Обязательный Строка -
notifications Необязательный Массив ID тригеров уведомлений
sms_in_between_delay_minimum Необязательный Целое число Допустимые значения: 1 - 300
sms_in_between_delay_maximum Необязательный Целое число Допустимые значения: 1 - 300
auto_tags_condition Необязательный Массив Допустимые значения: exact, not_exact, contains, not_contains, starts_with, not_starts_with, ends_with, not_ends_with, bigger_than, lower_than
auto_tags_sms Необязательный Массив Входящее SMS
auto_tags_action Необязательный Массив Допустимые значения: add, remove
auto_tags_custom_parameter_key Необязательный Массив Свой параметр ключа
auto_tags_custom_parameter_value Необязательный Массив Значение своего параметра
curl --request POST \
--url 'https://sms.ecofon.business/api/devices' \
--header 'Authorization: Bearer {api_key}' \
--header 'Content-Type: multipart/form-data' \
--form 'name=Example name' \
{
    "data": {
        "id": 1
    }
}

Обновить

POST https://sms.ecofon.business/api/devices/{device_id}
Параметры Детали Описание
name Необязательный Строка -
notifications Необязательный Массив ID тригеров уведомлений
sms_in_between_delay_minimum Необязательный Целое число Допустимые значения: 1 - 300
sms_in_between_delay_maximum Необязательный Целое число Допустимые значения: 1 - 300
auto_tags_condition Необязательный Массив Допустимые значения: exact, not_exact, contains, not_contains, starts_with, not_starts_with, ends_with, not_ends_with, bigger_than, lower_than
auto_tags_sms Необязательный Массив Входящее SMS
auto_tags_action Необязательный Массив Допустимые значения: add, remove
auto_tags_custom_parameter_key Необязательный Массив Свой параметр ключа
auto_tags_custom_parameter_value Необязательный Массив Значение своего параметра
curl --request POST \
--url 'https://sms.ecofon.business/api/devices/{device_id}' \
--header 'Authorization: Bearer {api_key}' \
--header 'Content-Type: multipart/form-data' \
--form 'name=Example' \
{
    "data": {
        "id": 1
    }
}

Удалить

DELETE https://sms.ecofon.business/api/devices/{device_id}
curl --request DELETE \
--url 'https://sms.ecofon.business/api/devices/{device_id}' \
--header 'Authorization: Bearer {api_key}' \