Документація для розробників
RCS
SMS / 2Way SMS API
Viber API
Number Intelligence
Контакти
Відправники
Списки
Стоп-листи
Статистика
Отримати загальну інформацію про RCS-кампанію
Method : GET
Endpoint : /api/campaigns/{id}
Description : метод для отримання загальної інформації про RCS-кампанію.
Параметр рядка запиту
| Parameter | Mandatory | Type | Description. |
|---|---|---|---|
| id | Yes | integer |
ідентифікатор кампанії, отриманий у відповіді на запит:
POST /api/campaigns/rcs/send POST /api/messages/rcs/send POST /api/campaigns/rcs/send-groups |
Answer elements
| Parameter | Type | Description. |
|---|---|---|
| id | integer | campaign id. |
| name | string | Назва кампанії. Приклад: «RCS api campaign / {yyyyy-mm-dd hh:mm:ss}», де yyyy-mm-dd hh:mm:ss — дата й час створення кампанії. |
| sender | string | Імʼя агента. |
| status | string | Поточний статус кампанії. Можливі значення: creation — кампанію створено; |
| spam — кампанія не пройшла модерацію; scheduled — кампанію заплановано; sending — розпочато надсилання повідомлень кампанії; paused — кампанію призупинено (повідомлення не надсилаються); stopped — кампанію зупинено (фінальний статус); done — кампанію завершено (фінальний статус). | ||
| message_type | string | Тип повідомлень у кампанії. Можливі значення: sms, rcs |
| start_at | string | Дата й час початку кампанії у форматі: yyyy-mm-dd hh:mm:ss |
| real_start_at | string | Фактичні дата й час початку кампанії у форматі: yyyy-mm-dd hh:mm:ss |
| finished_at | null|strin g | Дата завершення кампанії у форматі: yyyy-mm-dd hh:mm:ss |
| created_at | string | Дата й час створення кампанії у форматі: yyyy-mm-dd hh:mm:ss. |
| statistics | array | Масив обʼєктів статистики кампанії. |
| statistics[]delivered | integer | Загальна кількість повідомлень, доставлених кінцевим користувачам у межах кампанії зі статусами: DELIVERED, READ |
| statistics[]sent | integer | Загальна кількість повідомлень, надісланих у межах кампанії зі статусами: DELIVERED, SENT, ACCEPTED, SENDING, UNDELIVERED, FAILED, EXPIRED, UNKNOWN |
| calculated_price | float | Попередня вартість кампанії. |
| alternative_channels | object | Обʼєкт з інформацією про повідомлення кампанії, надіслані через альтернативний канал. |
| alternative_channels[]sms | object | Обʼєкт визначає канал для альтернативного надсилання повідомлень у межах кампанії. |
| alternative_channels[]sms[]sta tistics | object | Обʼєкт статистики повідомлень, надісланих через альтернативний канал. |
| alternative_channels[]sms[]sta tistics[]sent | integer | Загальна кількість повідомлень, надісланих у межах кампанії зі статусом: DELIVERED |
| SENT, ACCEPTED, SENDING, UNDELIVERED, FAILED, EXPIRED, UNKNOWN | ||
| alternative_channels[]sms[]sta tistics[]delivered | integer | Загальна кількість повідомлень, доставлених у межах кампанії зі статусами: DELIVERED, READ |
Приклад відповіді
Якщо запит виконано успішно:
{
"data":[
{
"id":1,
"name":"string",
"sender":"string",
"status":"creation",
"message_type":"rcs",
"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
},
"calculated_price":123.4,
"alternative_channels":{
"sms":{
"statistic":{
"delivered":0,
"sent":0
}
}
}
}
]
}
Зацікавлені у спеціальній пропозиції?
Готові розширювати можливості?
Давайте обговоримо.
Надіслати