Документація для розробників
RCS
SMS / 2Way SMS API
Viber API
Number Intelligence
Контакти
Відправники
Списки
Стоп-листи
Статистика
Отримати список контактів зі стоп-листа RCS
Method : GET
Endpoint : /api/stoplist/
Description: метод для отримання списку контактів, що перебувають у стоп-листі RCS.
Параметри рядка запиту
| Parameter | Mandatory | Type | Description. |
|---|---|---|---|
| page[limit] | No | integer | Кількість записів у відповіді. Діапазон значень: мін. — 15, макс. — 500. За замовчуванням — 50. |
| page[offset] | No | integer | Отримати контакти стоп-листа, починаючи зі зсуву (offset). За замовчуванням — 0 |
| types | No | string | Тип стоп-листа, для якого потрібно отримати список контактів. Можливі значення: sms, viber, rcs. Якщо тип стоп-листа не вказано, метод повертає дані для всіх типів стоп-листів. |
Answer elements
| Parameter | Type | Description. |
|---|---|---|
| id | integer | ідентифікатор контакту, що перебуває в стоп-листі. |
| phone | string | Номер телефону контакту. |
| created_at | datetime | Дата додавання контакту до стоп-листа. |
| sms_stoplist | boolean | Показує, чи перебуває контакт у стоп-листі SMS. Можливі значення: true/false. |
| viber_stoplist | boolean | Показує, чи перебуває контакт у стоп-листі Viber. Можливі значення: true/false. |
| rcs_stoplist | boolean | Показує, чи перебуває контакт у стоп-листі RCS. Можливі значення: true/false. |
| total | string | Загальна кількість контактів. |
Приклад відповіді
{
"data":[
{
"id":9392897,
"phone":380661231231,
"created_at":"2022-04-18 19:22:16",
"sms_stoplist":true,
"viber_stoplist":true,
"rcs_stoplist":true
}
],
"total":1
}
Зацікавлені у спеціальній пропозиції?
Готові розширювати можливості?
Давайте обговоримо.
Надіслати