API-довідник

SENDLY SMS API

Повний довідник, згенерований з OpenAPI — завжди відповідає специфікації. Ендпоінти, схеми полів, відповіді та вебхуки.

https://api.sendly.linkopenapi.json

POSThttps://api.sendly.link/api/sms

Надсилання SMS-повідомлення

Стандартний режим роботи API, призначений для використання із застосунками, що підтримують REST API.

Тіло запиту

fromstring
Номер віртуального мобільного номера в SENDLY (необов'язкове поле).
pattern: ^[0-9]{9,11}$
tostringобовʼязкове
Цільовий мобільний номер.
pattern: ^[0-9]{9,11}$
bodystringобовʼязкове
Текст повідомлення.
min 1

curl -X POST https://api.sendly.link/api/sms \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"from":"48732129000","to":"48732129001","body":"Test SENDLY"}'

Відповідь · 200 – Повідомлення прийнято до надсилання.

{
  "message_id": "a906cff7719bd889"
}

Відповідь · 403 – Проблема з авторизацією.

{
  "errors": {
    "token": [
      "Invalid token"
    ]
  }
}

Відповідь · 422 – Проблема з валідацією даних.

{
  "description": "Проблема з валідацією даних."
}

Відповідь · 429 – Перевищено ліміт запитів.

{
  "description": "Перевищено ліміт запитів."
}

POSThttps://api.sendly.link/api/sms-multi

Надсилання повідомлення на кілька номерів

Надсилання того самого повідомлення на кілька номерів. Активація цієї функції для токена доступу можлива виключно через звернення до служби підтримки клієнтів. Валідація номерів за принципом «все або нічого» — кожен номер має бути коректним польським мобільним номером, номери мають бути унікальними; інакше запит відхиляється повністю.

Тіло запиту

fromstring
Номер віртуального мобільного номера в SENDLY (необов'язкове поле).
pattern: ^[0-9]{9,11}$
toarray<string>обовʼязкове
Цільові мобільні номери.
1–100 · unique
bodystringобовʼязкове
Текст повідомлення.
min 1

curl -X POST https://api.sendly.link/api/sms-multi \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"from":"48732129000","to":["48732129001","48732129002"],"body":"Test SENDLY"}'

Відповідь · 200 – Повідомлення прийнято до надсилання.

{
  "message_ids": [
    {
      "number": "48732129001",
      "message_id": "a906cff7719bd889"
    }
  ]
}

Відповідь · 403 – Проблема з авторизацією.

{
  "errors": {
    "token": [
      "Invalid token"
    ]
  }
}

Відповідь · 422 – Проблема з валідацією даних.

{
  "description": "Проблема з валідацією даних."
}

Відповідь · 429 – Перевищено ліміт запитів.

{
  "description": "Перевищено ліміт запитів."
}

POSThttps://api.sendly.link/api/tcx

3CX SMS API

Режим 3CX SMS API: надсилання та отримання повідомлень на основі актуальної специфікації АТС 3CX Phone System. Активація: у клієнтській панелі обидві опції (SMS API та 3CX SMS API); у розділі SMS у 3CX вказується token із панелі та ця адреса URL. Формат запитів/відповідей відповідає специфікації 3CX.

Тіло запиту

Без параметрів запиту.

Відповідь · 200 – Відповідно до специфікації АТС 3CX Phone System.

{
  "description": "Відповідно до специфікації АТС 3CX Phone System."
}

Вебхуки

Події, які SENDLY надсилає на вашу URL-адресу вебхука — вхідні повідомлення та підтвердження доставки.

POSTinboundMessage

Отримання повідомлень (webhook)

Вхідні повідомлення надсилаються на webhook, указаний у клієнтській панелі. Одна спроба доставлення; без відстеження перенаправлень і без авторизації. Запит надходить з актуальної IP-адреси домену api.sendly.link.

typestring
Тип повідомлення — для вхідного «MESSAGE».
= MESSAGE
fromstring
Презентація вихідного номера; за перевизначеного номера — перевизначений напис.
tostring
Цільовий номер телефону.
bodystring
Текст повідомлення.

Payload

{
  "type": "MESSAGE",
  "from": "48732129000",
  "to": "48732129001",
  "body": "Test sms"
}

POSTdeliveryNotification

Підтвердження доставлення повідомлення (webhook)

Після активації опції (клієнтська панель або служба підтримки клієнтів) запит надсилається на вказану адресу webhook. Одна спроба доставлення; без відстеження перенаправлень і без авторизації. Запит надходить з актуальної IP-адреси домену api.sendly.link.

typestring
Тип повідомлення — для статусу «NOTIFICATION».
= NOTIFICATION
message_idstring
Ідентифікатор повідомлення, повернений після прийняття до надсилання.
statusstring
DELIVERED — доставлено; ERROR — помилка.
DELIVERED · ERROR

Payload

{
  "type": "NOTIFICATION",
  "message_id": "a906cff7719bd889",
  "status": "DELIVERED"
}