Документація для розробників
RCS
SMS / 2Way SMS API
Viber API
Number Intelligence
Контакти
Відправники
Списки
Стоп-листи
Статистика
Get list
Надає індекс усіх списків контактів з даними.
Щоб отримати список, надішліть запит на цей URL:
| GET https://one-api.bsg.world/api/groups |
Request parameters:
| Параметр | Required | Тип | Опис |
|---|---|---|---|
| page[limit] | Ні | integer |
Кількість груп у відповіді. Діапазон значень параметра: мін. — 15, макс. — 500.
За замовчуванням — 30. |
| page[offset] | Ні | integer | Отримати групи, починаючи зі зсуву (offset). За замовчуванням — 0. |
Response parameters:
| Параметр | Тип | Опис |
|---|---|---|
| id | integer | Унікальний ідентифікатор списку контактів, що генерується системою BSG автоматично під час створення списку. |
| name | string | Назва списку контактів. |
| description | string | Опис списку контактів. |
| default | boolean | Чи є список контактів списком за замовчуванням. Можливі значення: true або false. |
| created_at | datetime | Дата й час створення списку контактів. Формат відображення — Y-m-d H:i:s |
| total | integer | Загальна кількість наявних списків контактів. |
Якщо запит успішний, ви отримаєте відповідь:
{
"data": [
{
"id": 1,
"name": "string",
"description": "string",
"default": 0,
"created_at": "2022-04-28 14:21:16"
}
],
"total": 1
}
Зацікавлені у спеціальній пропозиції?
Готові розширювати можливості?
Давайте обговоримо.
Надіслати