Документація для розробників
RCS
SMS / 2Way SMS API
Viber API
Number Intelligence
Контакти
Відправники
Списки
Стоп-листи
Статистика
Отримати контакт за ідентифікатором
Метод дозволяє отримати детальну інформацію про наявний контакт у системі та його користувацькі поля.
Щоб отримати контакт, надішліть запит на цей URL:
| GET https://one-api.bsg.world/api/contacts/{id} |
Request parameters
| Parameter | Required | Type | Description |
|---|---|---|---|
| id | Yes | integer | Ідентифікатор контакту, про який потрібно отримати інформацію (ідентифікатор контакту генерується автоматично системою BSG під час додавання контакту). |
Response parameters
| Parameter | Type | Description | ||
|---|---|---|---|---|
| id | integer | Ідентифікатор контакту, за яким зроблено запит інформації. | ||
| phone | integer | Номер телефону контакту. | ||
| fields | array | Містить вкладені параметри користувацьких полів | ||
| id | string | Ідентифікатор поля даних контакту | . | |
| value | string | Значення, вказане в полі контакту | . | |
| created_at | datetime | Дата створення контакту — встановлюється автоматично системою BSG під час додавання контакту до адресної книги. Формат відображення — 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 | ||
| 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"
}
],
"hlr_status": "string",
"hlr_last_check": "2022-04-28 14:21:16"
}
}
Зацікавлені у спеціальній пропозиції?
Готові розширювати можливості?
Давайте обговоримо.
Надіслати