Документація для розробників
RCS
SMS / 2Way SMS API
Viber API
Number Intelligence
Контакти
Відправники
Списки
Стоп-листи
Статистика
Редагувати контакт
BSG API дає змогу керувати контактами для подальшого одноразового чи багаторазового використання під час проведення кампаній SMS, Viber або Number Verification. Ви можете створювати нові контакти, а також переглядати, редагувати, групувати й видаляти наявні.
Редагувати контакт
Метод дає змогу вносити зміни до наявного контакту: змінювати номер телефону, дані в кастомних полях контакту, а також додавати контакт до списку.
Зверніть увагу: у режимі акаунта TEST для цього методу діє обмеження — змінити номер телефону контакту можна лише на верифікований номер (верифікація номера виконується в особистому кабінеті на платформі BSG).
Для редагування виконайте запит на цей URL:
| PUT https://one-api.bsg.world/api/contacts/{id} |
Параметри запиту
| Параметр | Обовʼязковий | Тип | Опис | |
|---|---|---|---|---|
| id | Так | integer | ID контакту, який потрібно змінити | |
| phone | Так | integer | Номер телефону контакту. Значення у форматі ITU. Від 9 до 15 цифр. | |
| groups | Ні | array | Масив ID списків контактів, до яких потрібно додати контакт. | |
| fields | Ні | array | Інші дані в кастомних полях контакту | |
| id | integer | ID кастомного поля контакту | ||
| value | string | Значення кастомного поля контакту |
Приклад запиту:
{
"phone": 85267202829,
"groups": [
1
],
"fields": [
{
"id": 25964,
"value": "TARAS SHEVCHENKO"
}
]
}
Параметри відповіді
| Параметр | Тип | Опис | |
|---|---|---|---|
| id | integer | ID контакту, для якого виконано запит. | |
| phone | integer | Номер телефону контакту. | |
| fields | array | Містить вкладені дані кастомних полів | |
| id | integer | ID кастомного поля. | |
| value | string | Дані кастомного поля. | |
| created_at | datetime | Дата створення контакту в системі — встановлюється автоматично, коли контакт додається до книги контактів. Формат відображення — Y-m-d H:i:s | |
| groups | array | Містить вкладені дані списку, до якого додано контакт. | |
| id | string | ID списку (генерується автоматично під час створення списку контактів), до якого додано контакт. | |
| 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 | string | Дата й час останньої перевірки номера телефону контакту в базі HLR. Формат відображення — Y-m-d H:i:s |
Якщо запит успішний, ви отримаєте відповідь:
{
"data": {
"id": 1,
"phone": 85267202829,
"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"
}
}
Зацікавлені у спеціальній пропозиції?
Готові розширювати можливості?
Давайте обговоримо.
Надіслати