1. Отримати інформацію про SMS-кампанію

Метод дозволяє отримувати детальну інформацію про кампанію разом із статистикою надісланих повідомлень.

URL запиту

GET http://one-api.bsg.world/api/campaigns/{id}/detail

Параметри запиту

Параметр	Необхідність	Тип	За замовчуванням	Опис
id	Так	Ціле число	Ні	Ідентифікатор кампанії, створений за допомогою: POST /api/campaigns/sms/send POST /api/campaigns/sms/send-groups POST /api/campaigns/sms/send-individual

 

 

 

Параметри відповіді

Параметр		Тип	Опис
id		Ціле число	ID кампанії.
name		Рядок	Автоматично створена назва кампанії.
sender		Рядок	Ім'я відправника.
status		Рядок	Статус кампанії. Можливі значення: creation – створений; spam - кампанія не пройшла модерацію; scheduled - кампанія запланована; відправка - кампанія почала відправлятися; sending - кампанія призупинена; stopped - кампанію зупинено; done - кампанія завершена.
message_type		Рядок	Тип кампанії: sms.
start_at		Рядок	Дата та час початку запланованої кампанії. Формат відображення відповідно до ISO 8601: рррр-мм-дд гг:хх:сс
real_start_at		Рядок	Фактична дата та час початку кампанії. Формат відображення відповідно до ISO 8601: рррр-мм-дд гг:хх:сс
finished_at		Рядок	Дата й час завершення кампанії. Формат відображення відповідно до ISO 8601: рррр-мм-дд гг:хх:сс
created_at		Рядок	Дата й час створення кампанії. Формат відображення відповідно до ISO 8601: рррр-мм-дд гг:хх:сс
statistics		Масив	Статистика кампанії:
	delivered	Ціле число	Кількість повідомлень, отриманих одержувачем
	scheduled	Ціле число	Кількість повідомлень, запланованих на кампанію
	moderation	Ціле число	Кількість повідомлень у модерації
	accepted	Ціле число	Кількість повідомлень, прийнятих оператором
	sending	Ціле число	Кількість повідомлень у черзі на відправку
	sent	Ціле число	Кількість повідомлень, які були надіслані та очікуються на доставку
	expired	Ціле число	Кількість недоставлених повідомлень (телефон вимкнено)
	failed	Ціле число	Кількість повідомлень із помилкою надсилання (ймовірно, відсутній префікс)
	undelivered	Ціле число	Кількість недоставлених повідомлень
	unknown	Ціле число	Кількість повідомлень, для яких немає звіту про доставку
total_messages		Ціле число	Загальна кількість повідомлень, створених у рамках кампанії
total_phones		Ціле число	Кількість контактів у кампанії
total_price		Рядок	Загальна вартість кампанії
currency		Рядок	Валюта, в якій вказана вартість кампанії. Формат ISO 4217.

 

Приклад відповіді

У разі успішного виконання запиту ви отримаєте відповідь:

{

 "data": {

   “id”: “12345”,

   “name”: “string”

   “sender”: “testsms”,

   “status”: “done”,

   “type”: “instant”,

   “start_at”: “2022-01-01 00:01:02”,

   “actual_start_at”: “2022-01-01 00:01:03”,

   “creation_at”: “2022-01-01 00:00:01”,

   “finished_at”: “2022-01-01 00:10:03”,

   “statistics”: [

{ 

  “delivered”: 0,

  “scheduled”: 0,

  “moderation”: 0,

  “accepted”: 0,

  “sending”: 20,

  “sent”: 100,

  “expired”: 0,

  “failed”: 0,

  “undelivered”: 0,

  “unknown”: 0

}

]

   “total_messages”: 120,

   “total_phones”: 120,

   “total_price”: “35,0987645”,

   “currency”: “USD”

}

}

 

2. Отримуйте SMS-повідомлення

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

URL запиту

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

 

 

Параметри запиту

Параметр	Необхідність	Тип	За замовчуванням	Опис
page[limit]	Ні	Ціле число	50	Кількість повідомлень у відповіді. Діапазон значень параметра: min - 15, max - 500.
page[offset]	Ні	Ціле число	0	Отримувати повідомлення, починаючи зі зміщення
filter[from]	Ні	Рядок	Ні	Фільтруйте за датою надсилання «від». Формат ISO 8601: рррр-мм-дд гг:хх:сс
filter[to]	Ні	Рядок	Нинішній час	Фільтрувати за датою надсилання «до». Формат ISO 8601: рррр-мм-дд гг:хх:сс
filter[campaign_id]	Ні	Ціле число	Ні	Фільтруйте, щоб отримати повідомлення за ідентифікатором кампанії, створеної за допомогою: POST /api/campaigns/sms/send POST /api/campaigns/sms/send-groups POST /api/campaigns/sms/send-individual
filter[reference_id]	Ні	Рядок	Ні	Фільтр, щоб отримати повідомлення за зовнішнім ідентифікатором повідомлення
filter[id]	Ні	Ціле число	Ні	Отримати повідомлення за ідентифікатором повідомлення
sort	Ні	Рядок	id	Сортувати по id, телефону, доставці
way	Ні	Рядок	за зростанням	Параметри сортування: за зростанням, за спаданням

Параметри відповіді

Параметр		Тип	Опис
id		Ціле число	ID повідомлення
campaign_id		Ціле число	ID кампанії
reference_id		Рядок	Ідентифікатор зовнішнього повідомлення (посилання)
type		Рядок	Тип кампанії: sms
source		Рядок	Можливі значення: web rest
text		Рядок	Текст повідомлення
phone		Рядок	Номер телефону, на який надіслано повідомлення
validity		Ціле число	Час дії повідомлення, год
status		Рядок	Статус повідомлення. Можливі значення: delivered - повідомлення отримано одержувачем scheduled - повідомлення заплановано до відправки moderation - повідомлення в модерації accepted - повідомлення прийнято оператором sending - повідомлення в черзі на відправку sent- повідомлення надіслано та очікується на доставку expired- повідомлення не доставлено - телефон вимкнено failed - помилка надсилання повідомлення (ймовірно, відсутній префікс) undelivered - повідомлення не доставлено unknown - немає звіту про доставку.
amount		Об'єкт	Ціна повідомлення:
	value	Рядок	Ціна повідомлення
	currency	Рядок	Валюта, в якій вказана вартість повідомлення. Формат ISO 4217.
sender		Рядок	Ім'я відправника SMS
created_at		Рядок	Дата і час створення повідомлення. Формат ISO 8601: рррр-мм-дд гг:хх:сс
send_at		Рядок	Дата та час відправлення повідомлення. Формат ISO 8601: рррр-мм-дд гг:хх:сс
delivered_at		Рядок	Дата та час отримання звіту про доставку. Формат ISO 8601: рррр-мм-дд гг:хх:сс

Приклад відповіді

У разі успішного виконання запиту ви отримаєте відповідь:

{

​​  "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

    }

  }

}

3. Отримання списоку SMS-кампаній

Спосіб отримання списку створених кампаній.

Максимальний період, протягом якого можна пробувати кампанії, становить 3 місяці.

URL запиту

GET  http://one-api.bsg.world/api/campaigns

Параметри запиту

Параметр	Необхідність	Тип	За замовчуванням	Опис
filter[type]	Ні	Рядок	sms	Фільтрувати за типом кампанії, смс
filter[from]	Ні	Рядок	filter[to] -3 місяця	Дата і час початку відбору проб. Формат ISO 8601: рррр-мм-дд гг:хх:сс
filter[to]	Ні	Рядок	Нинішіній час	Дата і час закінчення відбору проб. Формат ISO 8601: рррр-мм-дд гг:хх:сс Можна вказати майбутню дату: дійсне значення на 30 днів випереджає поточну дату.
page[offset]	Ні	int	0	Отримувати повідомлення, починаючи зі зміщення
page[limit]	Ні	int	50	Кількість кампаній у відповідь
sort	Ні	Рядок	id	Сортувати за ідентифікатором, відправником, типом
way	Ні	Рядок	за зростанням	Параметри сортування: за зростанням, за спаданням

 

Параметри відповіді

Parameter		Type	Description
id		Ціле число	Ідентифікатор кампанії створено. POST /api/campaigns/sms/send POST /api/campaigns/sms/send-groups POST /api/campaigns/sms/send-individual
name		Рядок	Назва кампанії
sender		Рядок	Ім'я відправника SMS.
status		Рядок	Статус кампанії. Можливі значення: creation – створений; spam - кампанія не пройшла модерацію; scheduled - кампанія запланована; sending - кампанія почала відправлятися; paused - кампанія призупинена; stopped - кампанію зупинено; done - кампанія завершена.
message_type		Рядок	Тип кампанії: sms.
start_at		Рядок	Дата початку кампанії. Формат ISO 8601: рррр-мм-дд гг:хх:сс
real_start_at		Рядок	Фактична дата та час початку кампанії. Формат ISO 8601: рррр-мм-дд гг:хх:сс.
finished_at		Рядок	Дата завершення кампанії. Формат ISO 8601: рррр-мм-дд гг:хх:сс
created_at		Рядок	Дата й час створення кампанії. Формат ISO 8601: рррр-мм-дд гг:хх:сс.
statistics		Масив	Статистика кампанії:
	delivered	Ціле число	Загальна кількість повідомлень, доставлених у рамках кампанії
	sent	Ціле число	Загальна кількість повідомлень, надісланих у рамках кампанії

Приклад відповіді
У разі успішного виконання запиту ви отримаєте відповідь:

{

  "data": [

    {

      "id": 1,

      "name": "string",

      "sender": "string",

      "status": "creation",

      "message_type": "sms",

      "start_at": "2021-04-27 19:44:06",

      "real_start_at": "2021-04-27 19:44:06",

      "finished_at": "2021-04-27 19:44:06",

      "created_at": "2021-04-27 19:44:06",

      "statistics": {

        "delivered": 0,

        "sent": 0

      }

    }

  ],

  "meta": {

    "page": {

      "total": 1,

      "limit": 30,

      "offset": 0

    }

  }

}

 

 

 }