BSG використовує HTTP-cookies (а також подібні або додаткові технології), щоб:
1) забезпечити безпечну, стабільну та доступну роботу сайту (через використання обов’язкових cookies) та
2) зрозуміти, як ви користуєтеся сайтом (через використання необов’язкових cookies) — з метою покращення вашого досвіду та надання персоналізованого контенту.

Інформація у cookie-файлах може бути пов’язана з вашими уподобаннями або пристроєм і допомагає сайту працювати так, як ви очікуєте. Зазвичай ці файли не ідентифікують вас безпосередньо, але дозволяють забезпечити більш персоналізовану взаємодію з сайтом.

Відповідно до вимог Загального регламенту про захист даних (GDPR), який регулює обробку та передачу персональних даних осіб у ЄС, ми надаємо вам можливість заборонити використання певних типів cookies під час відвідування нашого сайту.

Ознайомтеся з нашими Правилами використання cookies та Політикою конфіденційності, щоб дізнатися більше про те, як BSG збирає та використовує cookies.
Зверніть увагу, що заборона певних типів cookies може вплинути на роботу сайту та обмежити доступ до деяких сервісів. Оберіть відповідну категорію нижче, щоб дізнатися більше або вимкнути cookies.

Прийняти всі cookies*

*Рекомендовано для комфортного користування сайтом

Прийняти лише необхідні cookies

Прийняти лише вибрані cookies

Необхідні cookies

Соціальні мережі

Аналітика

Маркетинг

Отримати SMS-повідомлення

Метод дозволяє отримати інформацію про статус одного повідомлення або статус кожного повідомлення в SMS-кампанії.

Request URL

GET https://one-api.bsg.world/api/messages

Request parameters:

Parameter	Required	Type	Default	Description
page[limit]	No	Integer	50	Кількість повідомлень у відповіді. Діапазон значень параметра: мін. — 15, макс. — 500.
page[offset]	No	Integer	0	Отримати повідомлення, починаючи зі зсуву (offset)
filter[from]	No	String	No	Фільтр за датою надсилання «від». Формат ISO 8601: yyyy-mm-dd hh:mm:ss
filter[to]	No	String	Now	Фільтр за датою надсилання «до». Формат ISO 8601: yyyy-mm-dd hh:mm:ss
filter[campaign_id]	No	Integer	No	Фільтр для отримання повідомлень за ідентифікатором кампанії, створеної за допомогою: POST /api/campaigns/sms/send POST /api/campaigns/sms/send-groups POST /api/campaigns/sms/send-individual
filter[reference_id]	No	String	No	Фільтр для отримання повідомлень за зовнішнім ідентифікатором повідомлення
filter[id]	No	Integer	No	Отримати повідомлення за ідентифікатором повідомлення
Sort	No	String	id	Сортування за id, phone, delivered
Way	No	String	asc	Варіанти сортування: asc, desc

Response parameters:

Parameter		Type	Description
id		integer	Message ID
campaign_id		integer	Campaign ID
reference_id		string	Зовнішній ідентифікатор повідомлення (reference)
type		string	Тип кампанії: sms
source		string	Possible values: web rest
text		string	Message text
phone		string
validity		integer
status		string	Статус повідомлення. Можливі значення: delivered — повідомлення отримано одержувачем scheduled — повідомлення заплановано до надсилання moderation — повідомлення на модерації accepted — повідомлення прийнято оператором sending — повідомлення в черзі на надсилання sent — повідомлення надіслано, очікується доставка expired — повідомлення не доставлено — телефон вимкнено failed — помилка надсилання повідомлення (можливо, відсутній префікс) undelivered — повідомлення не доставлено unknown — немає звіту про доставку
amount		object	Дані про вартість повідомлення:
	value	string	Message price
	currency	string	Валюта, у якій вказано вартість повідомлення. Формат ISO 4217
sender		string	Імʼя відправника SMS
created_at		string	Дата й час створення повідомлення. Формат ISO 8601: yyyy-mm-dd hh:mm:ss
send_at		string	Дата й час надсилання повідомлення. Формат ISO 8601: yyyy-mm-dd hh:mm:ss
delivered_at		string	Дата й час отримання звіту про доставку. Формат ISO 8601: yyyy-mm-dd hh:mm:ss

Response sample

Якщо запит виконано успішно, ви отримаєте відповідь:


{
  "data": [
    {
      "id": 26130,
      "campaign_id": 1,
      "reference_id": "string",
      "type": "sms",
      "source": "web",
      "text": "text",
      "phone": 12345678900,
      "validity": 72,
      "status": "scheduled",
      "amount": {
        "value": "string",
        "currency": "UAH"
      },
      "sender": "sender",
      "created_at": "2021-04-27 19:44:06",
      "send_at": "2021-04-27 19:44:06",
      "delivered_at": "2021-04-27 19:44:06"
    }
  ],
  "meta": {
    "page": {
      "total": 1,
      "offset": 20,
      "limit": 40
    }
  }
}