API
API
API
API
API
API
API

BSG використовує HTTP-cookies (а також подібні або додаткові технології), щоб:
1) забезпечити безпечну, стабільну та доступну роботу сайту (через використання обов’язкових cookies) та
2) зрозуміти, як ви користуєтеся сайтом (через використання необов’язкових cookies) — з метою покращення вашого досвіду та надання персоналізованого контенту.

Інформація у cookie-файлах може бути пов’язана з вашими уподобаннями або пристроєм і допомагає сайту працювати так, як ви очікуєте. Зазвичай ці файли не ідентифікують вас безпосередньо, але дозволяють забезпечити більш персоналізовану взаємодію з сайтом.

Відповідно до вимог Загального регламенту про захист даних (GDPR), який регулює обробку та передачу персональних даних осіб у ЄС, ми надаємо вам можливість заборонити використання певних типів cookies під час відвідування нашого сайту.

Ознайомтеся з нашими Правилами використання cookies та Політикою конфіденційності, щоб дізнатися більше про те, як BSG збирає та використовує cookies.
Зверніть увагу, що заборона певних типів cookies може вплинути на роботу сайту та обмежити доступ до деяких сервісів. Оберіть відповідну категорію нижче, щоб дізнатися більше або вимкнути cookies.

Прийняти всі cookies*
*Рекомендовано для комфортного користування сайтом
Прийняти лише необхідні cookies
Прийняти лише вибрані cookies
Необхідні cookies
Соціальні мережі
Аналітика
Маркетинг

BSG переїхав на новий DevPortal
щоб швидше випускати найновіші версії One API

Використовуйте його для актуальних ендпоінтів, гайдів і журналів змін

Перейти на новий DevPortal
Документація для розробників
Number Intelligence

Contact search

Метод для пошуку контактів в адресній книзі. У пошуку можна використовувати операції: like, =, >, >=, <, <=.

Пошук можливий за такими полями:

  • id:  =, >, >=, <, <=
  • phone: like, =
  • {field_id}:
    • для поля з типом «Text»: like, =
    • для поля з типом «Number»: =, >, >=, <, <=
    • для поля з типом «Date»: =, >, >=, <, <=

Щоб виконати пошук контактів, надішліть запит на цей URL:

GET https://one-api.bsg.world/api/contacts/search

Request parameters:

Parameter Required Type Default Description
page[offset] No int 0 Отримати контакти, починаючи зі зсуву (offset)
page[limit] No int 50 Кількість контактів у відповіді
sort No string id Умови сортування: id, phone
way No string asc Варіанти сортування: asc, desc
search[operation] No string = Оператор для пошуку значень: like, =, >, >=, <, <=
search[field] No string no Поле для пошуку. Можливі значення: id, phone, group_id, date, {field_id}
{field_id} — ідентифікатор користувацького поля; можна отримати через GET /api/contacts/fields
search[value] Значення для пошуку: No string no
id Contact ID
phone Номер телефону контакту. 9–15 цифр.
date Дата створення контакту у форматі ISO 8601
{field_id} Значення, вказане в полі контакту

Response parameters:

Parameter Type Description
id integer Contact ID
phone integer Номер телефону контакту
fields Містить вкладені параметри користувацького поля
created_at datetime Дата створення контакту — встановлюється автоматично системою BSG під час додавання контакту до адресної книги. Формат ISO 8601 yyyy-mm-dd hh:mm:ss
groups — містить вкладені параметри списку, до якого додано контакт:
id string Ідентифікатор списку контактів, до якого додано контакт
name string Назва списку контактів, до якого додано контакт
description string Опис списку контактів, до якого додано контакт
default boolean Показує, чи є список списком за замовчуванням
created_at datetime Дата створення/редагування списку, до якого додано контакт. Формат ISO 8601 yyyy-mm-dd hh:mm:ss
hlr_status string Статус перевірки номера телефону контакту в HLR. Можливі значення: barred, absent, active, unknown, failed.
hlr_last_check datetime Дата й час останньої перевірки номера телефону контакту в HLR. Формат ISO 8601 yyyy-mm-dd hh:mm:ss

Якщо запит виконано успішно, ви отримаєте відповідь:


{
  "data": [
    {
      "id": 1,
      "phone": 33601148802,
      "fields": [
        {
          "code": 0,
          "text": "string"
        }
      ],
      "created_at": "2022-04-28 14:21:16",
      "groups": [
        {
          "id": 1,
          "name": "string",
          "description": "string",
          "default": 0,
          "created_at": "2022-04-28 14:21:16"
        }
      ],
      "hlr_status": "string",
      "hlr_last_check": "2022-04-28 14:21:16"
    }
  ],
  "meta": {
    "page": {
      "total": 1,
      "limit": 50,
      "offset": 0
    },
    "search": {
      "field": 0,
      "operation": "like",
      "value": "string"
    }
  }
}

Зацікавлені у спеціальній пропозиції?

Готові розширювати можливості?
Давайте обговоримо.

Надіслати

Корисні Матеріали

WhatsApp Business API: повний гайд — налаштування, ціни, сценарії [2026]
WhatsApp Business API: повний гайд — налаштування, ціни, сценарії використання [2026]

WhatsApp Business API у 2026 — кроки налаштування, нова модель тарифікації за повідомлення та перевірені сценарії використання за галузями.

Що таке CPaaS? Повний бізнес-гайд із Communications Platform as a Service
Що таке CPaaS? Повний бізнес-гайд із Communications Platform as a Service

Що таке CPaaS? Хмарний API-шар, що додає SMS, WhatsApp, голос та OTP у ваші застосунки — як це працює і чому це краще за стек із кількох вендорів.

Один комунікаційний API для SMS, WhatsApp, Viber і RCS — чому він кращий за пʼять
Один комунікаційний API для SMS, WhatsApp, Viber та RCS — чому він кращий за пʼять

Чому один комунікаційний API для SMS, WhatsApp, Viber та RCS кращий за пʼять окремих інтеграцій — каскадний fallback, єдині звіти.