Документація для розробників
RCS
SMS / 2Way SMS API
Viber API
Number Intelligence
Контакти
Відправники
Списки
Стоп-листи
Статистика
API BSG дозволяє керувати контактами для подальшого одноразового або багаторазового використання під час проведення кампаній SMS, Viber або перевірки номерів. Ви можете створювати нові контакти, переглядати, редагувати, групувати та видаляти наявні.
Edit contact
Метод дозволяє вносити зміни до наявного контакту: змінювати номер телефону, дані в користувацьких полях контакту та додавати контакт до списку.
Зверніть увагу: у режимі облікового запису TEST для цього методу діє обмеження — номер телефону контакту можна змінити лише на верифікований номер (верифікація номера виконується в особистому кабінеті платформи BSG).
Щоб редагувати, надішліть запит на цей URL:
| PUT https://one-api.bsg.world/api/contacts/{id} |
Request parameters
| Parameter | Required | Type | Description | |
|---|---|---|---|---|
| id | Yes | integer | Ідентифікатор контакту, який потрібно змінити | |
| phone | Yes | integer | Номер телефону контакту. Значення у форматі ITU. 9–15 цифр. | |
| groups | No | array | Масив ідентифікаторів списків контактів, до яких додається контакт. | |
| fields | No | array | Інші дані в користувацьких полях контакту | |
| id | integer | Ідентифікатор користувацького поля контакту | ||
| value | string | Значення користувацького поля контакту |
Request example:
{
"phone": 85267202829,
"groups": [
1
],
"fields": [
{
"id": 25964,
"value": "TARAS SHEVCHENKO"
}
]
}
Response parameters
| Parameter | Type | Description | |
|---|---|---|---|
| id | integer | Ідентифікатор контакту, для якого зроблено запит. | |
| 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 | Description списка where the contact is added. | |
| 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"
}
}
Зацікавлені у спеціальній пропозиції?
Готові розширювати можливості?
Давайте обговоримо.
Надіслати