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

SMS

Получить все

GET https://sms.ecofon.business/api/sms/
curl --request GET \
--url 'https://sms.ecofon.business/api/sms/' \
--header 'Authorization: Bearer {api_key}' \
Параметры Детали Описание
page Необязательный Целое число Номер страницы, с которой вы хотите получить результаты. По умолчанию: 1.
results_per_page Необязательный Целое число Кол-во результатов на странице. Допустимые значения: 10, 25, 50, 100, 250, 500, 1000. По умолчанию: 25.
search Необязательный Строка Строка поиска.
search_by Необязательный Строка Поле, по которому выполняется поиск. Допустимые значения: phone_number, content.
sms_id Необязательный Целое число Filter results by SMS ID.
user_id Необязательный Целое число Filter results by user ID.
device_id Необязательный Целое число Filter results by device ID.
contact_id Необязательный Целое число Filter results by contact ID.
sim_subscription_id Необязательный Целое число Filter results by sim subscription ID.
campaign_id Необязательный Целое число Filter results by campaign ID.
flow_id Необязательный Целое число Filter results by flow ID.
rss_automation_id Необязательный Целое число Filter results by RSS automation ID.
recurring_campaign_id Необязательный Целое число Filter results by recurring campaign ID.
type Необязательный Строка Допустимые значения: sent, received
status Необязательный Строка Допустимые значения: sent, pending, failed, received
datetime_field Необязательный Строка Допустимые значения: scheduled_datetime, datetime
datetime_start Необязательный Строка Фильтрация результатов, начиная с указанной даты и времени. Формат: Y-m-d H:i:s.
datetime_end Необязательный Строка Фильтрация результатов до указанной даты и времени. Формат: Y-m-d H:i:s.
order_by Необязательный Строка Поле сортировки результатов. Допустимые значения: sms_id, scheduled_datetime, datetime.
order_type Необязательный Строка Порядок сортировки результатов. Допустимые значения: ASC (по возрастанию) и DESC (по убыванию). 
{
    "data": [
        {
            "sms_id": 1,
            "device_id": 1,
            "sim_subscription_id": 1,
            "contact_id": 1,
            "campaign_id": 0,
            "flow_id": 0,
            "rss_automation_id": 0,
            "recurring_campaign_id": 0,
            "user_id": 1,
            "type": "sent",
            "content": "Hello world",
            "status": "sent",
            "error": null,
            "scheduled_datetime": ""2026-08-27 04:38:33"",
            "datetime": ""2026-08-27 04:38:33"",
        },
    ],
    "meta": {
        "page": 1,
        "results_per_page": 25,
        "total": 1,
        "total_pages": 1
    },
    "links": {
        "first": "https://sms.ecofon.business/api/sms?page=1",
        "last": "https://sms.ecofon.business/api/sms?page=1",
        "next": null,
        "prev": null,
        "self": "https://sms.ecofon.business/api/sms?page=1"
    }
}

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

GET https://sms.ecofon.business/api/sms/{sms_id}
curl --request GET \
--url 'https://sms.ecofon.business/api/sms/{sms_id}' \
--header 'Authorization: Bearer {api_key}' \ 
{
    "data": {
        "sms_id": 1,
        "device_id": 1,
        "sim_subscription_id": 1,
        "contact_id": 1,
        "campaign_id": 0,
        "flow_id": 0,
        "rss_automation_id": 0,
        "recurring_campaign_id": 0,
        "user_id": 1,
        "type": "sent",
        "content": "Hello world",
        "status": "sent",
        "error": null,
        "scheduled_datetime": ""2026-08-27 04:38:33"",
        "datetime": ""2026-08-27 04:38:33"",
    },
}

Создать

POST https://sms.ecofon.business/api/sms
Параметры Детали Описание
content Обязательный Строка -
device_id Обязательный Целое число -
sim_subscription_id Обязательный Целое число -
phone_numbers Обязательный Строка Один номер на строку или через запятую (формат E.164).
is_scheduled Необязательный Логический тип -
scheduled_datetime Необязательный Строка -
curl --request POST \
--url 'https://sms.ecofon.business/api/sms' \
--header 'Authorization: Bearer {api_key}' \
--header 'Content-Type: multipart/form-data' \
--form 'content=Hello world' \
--form 'device_id=1' \
--form 'sim_subscription_id=1' \
--form 'phone_numbers=+1234567890,+9876543210' \
{
    "data": {
        "sms_ids": [1,2]
    }
}

Удалить

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