Документація для розробників
RCS
SMS / 2Way SMS API
Viber API
Number Intelligence
Контакти
Відправники
Списки
Стоп-листи
Статистика
Скасувати SMS-кампанію
Метод дозволяє скасувати SMS-кампанію, надіслану через API.
Скасування можливе лише для кампанії в статусі creation / paused / sending / scheduled.
Щоб скасувати кампанію, надішліть запит на цей URL:
| PATCH https://one-api.bsg.world/api/campaigns/{id}/stop |
Request parameters:
| Parameter | Required | Type | Default | Description |
|---|---|---|---|---|
| id | Yes | integer | No |
Ідентифікатор кампанії, створеної за допомогою:
|
Response parameters:
| Parameter | Type | Description | |
|---|---|---|---|
| id | integer | Ідентифікатор завдання, створеного для масової кампанії | |
| name | string | Campaign name | |
| sender | string | Імʼя відправника SMS | |
| status | string |
Статус кампанії. Можливі значення:
| |
| mesage_type | string | Тип кампанії: sms | |
| start_at | string | Дата й час початку кампанії (заплановані). Формат ISO 8601: yyyy-mm-dd hh:mm:ss | |
| real_start_at | string | Фактичні дата й час початку кампанії. Формат ISO 8601: yyyy-mm-dd hh:mm:ss | |
| finished_at | string | Дата й час завершення кампанії. Формат ISO 8601: yyyy-mm-dd hh:mm:ss | |
| created_at | string | Дата й час створення кампанії. Формат ISO 8601: yyyy-mm-dd hh:mm:ss | |
| statistics | array | Campaign statistics: | |
| delivered | integer | Загальна кількість доставлених повідомлень у межах кампанії | |
| sent | integer | Загальна кількість надісланих повідомлень у межах кампанії |
якщо запит виконано успішно, ви отримаєте відповідь:
{
"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
}
}
}
Зацікавлені у спеціальній пропозиції?
Готові розширювати можливості?
Давайте обговоримо.
Надіслати