Документація для розробників
RCS
SMS / 2Way SMS API
Viber API
Number Intelligence
Контакти
Відправники
Списки
Стоп-листи
Статистика
Отримати контакти зі стоп-листа
Метод дозволяє отримати список контактів, доданих до стоп-листа SMS та/або Viber.
Щоб отримати контакти зі стоп-листа, надішліть запит на цей URL:
| GET https://one-api.bsg.world/api/stoplist |
Request parameters:
| Параметр | Required | Тип | Опис |
|---|---|---|---|
| page[limit] | Ні | integer | Кількість записів у відповіді. Діапазон значень параметра: мін. — 15, макс. — 500. За замовчуванням — 30. |
| page[offset] | Ні | integer | Отримати контакти стоп-листа, починаючи зі зсуву (offset). За замовчуванням — 0. |
| types | Ні | string | Вкажіть тип стоп-листа, для якого потрібно повернути список контактів. Можливі значення: sms, viber. Якщо тип стоп-листа не вказано, метод поверне дані для обох типів стоп-листів |
Response parameters:
| Параметр | Тип | Опис |
|---|---|---|
| id | integer | Ідентифікатор контакту, доданого до стоп-листа |
| phone | string | Номер телефону контакту |
| created_at | datetime | Дата додавання контакту до стоп-листа |
| sms_stoplist | boolean | Чи додано контакт до стоп-листа SMS. Можливі значення: true або false |
| viber_stoplist | boolean | Чи додано контакт до стоп-листа Viber. Можливі значення: true або false |
| total | string | Загальна кількість контактів у стоп-листі |
Якщо запит успішний, ви отримаєте відповідь:
{
"data": [
{
"id": 9392897,
"phone": 85267202829,
"created_at": "2022-04-18 19:22:16",
"sms_stoplist": true,
"viber_stoplist": false
}
],
"total": 1
}
Зацікавлені у спеціальній пропозиції?
Готові розширювати можливості?
Давайте обговоримо.
Надіслати