Документація для розробників
RCS
SMS / 2Way SMS API
Viber API
Number Intelligence
Контакти
Відправники
Списки
Стоп-листи
Статистика
Пошук у списку контактів
Метод для пошуку в списку контактів за допомогою операцій like, =, >, >=, <, <=. Пошук можливий за такими полями:
- name
- description
- date
- items
- phone
- id
Щоб виконати пошук у списку контактів, надішліть запит на цей сервер:
| GET https://one-api.bsg.world/api/groups/search |
Request parameters:
| Parameter | Required | Type | Default | Description | |
|---|---|---|---|---|---|
| page[offset] | No | integer | 0 | Отримати групи контактів, починаючи зі зсуву (offset) | |
| page[limit] | No | integer | 50 | Кількість груп контактів у відповіді | |
| sort | No | string | id | Умови сортування: id, items, name, description, date | |
| way | No | string | asc | Варіанти сортування: asc, desc | |
| search[operator] | No | string | = | Оператор для пошуку значень: like, =, >, >=, <, <= | |
| search[field] | No | string | no | Поля для пошуку: name, items, date, description, phone, id | |
| search[value] | Значення для пошуку: | No | string | no | |
| name | Назва списку. До 50 символів | ||||
| description | Опис списку. До 250 символів | ||||
| date | Дата створення списку у форматі ISO 8601: yyyy-mm-dd hh:mm:ss | ||||
| items | Кількість контактів у списку | ||||
| phone | Номер телефону, який список містить/не містить. 9–15 цифр | ||||
| id | Ідентифікатор списку контактів |
Response parameters:
| Parameter | Type | Description |
|---|---|---|
| id | integer | List ID |
| name | string | List name |
| description | string | List description |
| is_default | boolean | Чи є список списком за замовчуванням. Можливі значення: true, false |
| items | integer | Кількість контактів у списку |
| created at | string | Дата й час створення списку. Формат ISO 8601 yyyy-mm-dd hh:mm:ss |
Якщо запит виконано успішно, ви отримаєте відповідь:
{
"data": [
{
"id": 1,
"name": "string",
"description": "string",
"is_default": true,
"items": 0,
"created_at": "2022-04-28 14:21:16"
}
],
"meta": {
"page": {
"total": 1,
"offset": 20,
"limit": 40
},
"search": {
"field": "id",
"operator": "like",
"value": "string"
}
}
}
Зацікавлені у спеціальній пропозиції?
Готові розширювати можливості?
Давайте обговоримо.
Надіслати