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

Дата створення 2026-03-23

Дата останньої зміни 2026-03-31

Масове відправлення SMS з шаблону повідомлень

Метод дозволяє надіслати SMS-повідомлення на основі обраного шаблону. Для відправлення SMS з шаблону повідомлень необхідно:
  1. Отримати профілі провайдерів SMS повідомлень.
  2. Отримати шаблони повідомлень.
Метод: POST

URL

https://{API_ENDPOINT}:8443/ics3/rest/sms/sms-integration/from-template/send-messages

Body

Назва параметра Доступні значення (тип) Примітки
providerProfile SmsProviderProfile Профіль SMS-провайдера, який буде використовуватись
text string Текст повідомлення (якщо не використовується шаблон)
messageTemplate MessageTemplate Обраний шаблон повідомлення
receivers SmsSendingCampaignReceiver[] Список отримувачів повідомлення

SmsSendingCampaignReceiver

Назва параметра Доступні значення (тип) Примітки
phoneNumbers string[] Список номерів телефону отримувачів
crmLeadId number ID ліда у CRM. 0, якщо порожнє.
crmContactId number ID контакту у CRM. 0, якщо порожнє.
crmCompanyId number ID компанії у CRM. 0, якщо порожнє.

Приклад запиту

curl -X POST \
  "https://{API_ENDPOINT}:8443/ics3/rest/sms/sms-integration/from-template/send-messages" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer {TOKEN}" \
  -d '{
        "providerProfile": { "id": 1 },
        "text": "",
        "messageTemplate": { "id": 10 },
        "receivers": [
            { "phoneNumbers": ["380501234567"], "crmLeadId": 123, "crmContactId": 0, "crmCompanyId": 0}
        ]
      }

Масове відправлення звичайного тексту

Метод дозволяє надіслати SMS-повідомлення із вказаним текстом без використання шаблону. Для відправлення SMS повідомлення необхідно:
  1. Отримати профілі провайдерів SMS повідомлень.
Метод: POST

URL

https://{API_ENDPOINT}:8443/ics3/rest/sms/sms-integration/send-messages

Приклад запиту

curl -X POST \
  "https://{API_ENDPOINT}:8443/ics3/rest/sms/sms-integration/send-messages" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer {TOKEN}" \
  -d '{
        "providerProfile": { "id": 1 },
        "text": "Тестове повідомлення",
        "messageTemplate": null,
        "receivers": [
            { "phoneNumbers": ["380501234567"], "crmLeadId": 123, "crmContactId": 0, "crmCompanyId": 0}
        ]
      }'

Навігація