Документація для розробників
RCS
SMS / 2Way SMS API
Viber API
Number Intelligence
Контакти
Відправники
Списки
Стоп-листи
Статистика
Get contacts
Отримати список наявних контактів адресної книги вашого облікового запису з детальною інформацією про кожен. Метод також дозволяє отримати контакти з певних списків, вказаних у параметрах запиту.
Щоб отримати список контактів, надішліть запит на цей URL:
| GET https://one-api.bsg.world/api/contacts |
Request parameters
| Parameter | Required | Type | Description |
|---|---|---|---|
| page[limit] | No | integer |
Кількість записів у відповіді. Діапазон значень параметра: мін. — 15, макс. — 500.
За замовчуванням — 30. |
| per[offset] | No | integer | Отримати контакти, починаючи зі зсуву (offset). |
| groups | No | array [integer] | Індекс ідентифікаторів списків, для яких потрібно відобразити контакти. |
Response parameters
| Parameter | Type | Description | |
|---|---|---|---|
| id | integer | Ідентифікатор контакту в особистому кабінеті BSG, що генерується автоматично під час додавання контакту до адресної книги | |
| phone | integer | Номер телефону контакту | |
| fields | array | містить вкладені дані користувацьких полів: | |
| id | integer | Ідентифікатор користувацького поля | |
| value | string | Дані користувацького поля | |
| created_at | datetime | Дата створення контакту в системі — встановлюється автоматично під час додавання контакту до адресної книги. Формат відображення — Y-m-d H:i:s | |
| groups | array | містить вкладені дані списку, до якого додано контакт | |
| id | string | Ідентифікатор списку (генерується автоматично під час створення списку контактів), до якого додано контакт | |
| name | string | Назва списку, до якого додано контакт | |
| description | string | Опис списку, до якого додано контакт | |
| default | bool | Показує, чи є список контактів списком за замовчуванням | |
| created_at | datetime | Дата створення списку, до якого додано контакт. Формат відображення — Y-m-d H:i:s | |
| items | integer | Кількість номерів у списку контактів. | |
| stop_list_count | integer | Кількість номерів зі списку, що перебувають у стоп-листі SMS і Viber. | |
| hlr_status | string | Статус перевірки номера телефону контакту в базі даних HLR. Можливі значення: sent, absent, active, unknown, failed. | |
| hlr_last_check | datetime | Дата й час останньої перевірки номера телефону контакту в базі даних HLR. Формат відображення — Y-m-d H:i:s |
Якщо запит виконано успішно, ви отримаєте відповідь:
{
"data": [
{
"id": 1,
"phone": 33601148802,
"fields": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "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",
"items": 11,
"stop_list_count": 0
}
],
"hlr_status": "string",
"hlr_last_check": "2022-04-28 14:21:16"
}
],
"total": 0
}
Зацікавлені у спеціальній пропозиції?
Готові розширювати можливості?
Давайте обговоримо.
Надіслати