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