Атрибут клиента — это специально созданное поле в панели оператора, которое хранит в себе информацию о клиенте. Содержание атрибутов клиента отображается в панели оператора в разделе О клиенте. Атрибуты клиента можно использовать для различных целей, однако основная цель — сообщить оператору необходимую информацию о клиенте. Такой подход поможет улучшить качество взаимодействия между клиентом и оператором.
¶ Создание атрибута через API
Каждый атрибут создаётся с помощью отдельного запроса.
Метод: POST
Authorization: Bearer Token
URL: https://chat-api.twin24.ai/api/v1/clients/attributes
¶ cURL
curl --location 'https://chat-api.twin24.ai/api/v1/clients/attributes' \
--header 'accept: application/json' \
--header 'content-type: application/json' \
--header 'Authorization: Bearer TOKEN' \
--data '{"name":"Имя клиента"}'
¶ Пример тела запроса
{
"name":"Имя клиента"
}
| Параметр | Описание |
|---|---|
| name | Устанавливает название для атрибута |
¶ Пример ответа
{
"id": "bf1fee...70dc544"
}
| Параметр | Описание |
|---|---|
| id | Идентификатор созданного атрибута |
¶ Результат работы метода
В панели оператора в разделе О клиенте появится доступное для редактирования поле Имя клиента. Значение поля доступно для просмотра и редактирования из панели оператора и по API.
¶ Работа с ранее созданными атрибутами
Метод: GET
Authorization: Bearer Token
URL: https://chat-api.twin24.ai/api/v1/clients/attributes
¶ cURL
curl --location 'https://chat-api.twin24.ai/api/v1/clients/attributes' \
--header 'accept: application/json' \
--header 'Authorization: Bearer TOKEN'
¶ Пример ответа
{
"count": 3,
"items": [
{
"id": "bf1fee...70dc544",
"companyId": 123,
"name": "Имя клиента"
},
{
"id": "bf1fee...70dc544",
"companyId": 123,
"name": "Возраст"
},
{
"id": "bf1fee...70dc544",
"companyId": 123,
"name": "Тема обращения"
}
]
}
¶ Описание полей ответа:
| Параметр | Описание |
|---|---|
| count | Общее кол-во атрибутов |
| items | Array[Object] |
| id | Идентификатор атрибута |
| companyId | Идентификатор компании |
| name | Название атрибута |
Метод: POST
Authorization: Bearer Token
URL: https://chat-api.twin24.ai/api/v1/clients/{ИДЕНТИФИКТОР_КЛИЕНТА}/attributes/{ИДЕНТИФИКАТОР_АТРИБУТА}
¶ cURL
curl --location 'https://chat-api.twin24.ai/api/v1/clients/{ИДЕНТИФИКТОР_КЛИЕНТА}/attributes/{ИДЕНТИФИКАТОР_АТРИБУТА}' \
--header 'accept: application/json' \
--header 'content-type: application/json' \
--header 'Authorization: Bearer TOKEN' \
--data '{"value":"ИМЯ"}'
¶ Пример тела запроса
{
"value":"Имя"
}
При успешном выполнении возвращается ответ с кодом 200 без тела.
Метод: GET
Authorization: Bearer Token
URL: https://chat-api.twin24.ai/api/v1/clients/{ИДЕНТИФИКТОР_КЛИЕНТА}/attributes
¶ cURL
curl --location 'https://chat-api.twin24.ai/api/v1/clients/{ИДЕНТИФИКТОР_КЛИЕНТА}/attributes' \
--header 'accept: application/json' \
--header 'Authorization: Bearer TOKEN'
¶ Пример ответа
{
"count": 1,
"items": [
{
"id": "0c1f0-...-9dc052045452",
"clientId": "35e45a67-...-9dc052045452",
"companyId": 123,
"name": "Имя клиента",
"value": "Иван"
}
]
}
¶ Описание полей ответа:
| Параметр | Описание |
|---|---|
| count | Общее кол-во атрибутов |
| items | Array[Object] |
| | id | Идентификатор атрибута |
| | clientId | Идентификатор клиента |
| | companyId | Идентификатор компании |
| | name | Название атрибута |
| | value | Значение атрибута |
Метод: DELETE
Authorization: Bearer Token
URL: https://chat-api.twin24.ai/api/v1/clients/attributes/{ИДЕНТИФИКАТОР_АТРИБУТА}
Данный метод удалит атрибут из личного кабинета пользователя. После удаления, атрибут не будет отображаться в разделе О клиенте.
¶ cURL
curl --location --request DELETE 'https://chat-api.twin24.ai/api/v1/clients/attributes/{ИДЕНТИФИКАТОР_АТРИБУТА}' \
--header 'accept: application/json' \
--header 'Authorization: Bearer TOKEN'
При успешном выполнении метода придет ответ с кодом 200 без тела.
Метод: DELETE
Authorization: Bearer Token
URL: https://chat-api.twin24.ai/api/v1/clients/{ИДЕНТИФИКТОР_КЛИЕНТА}/attributes/{ИДЕНТИФИКАТОР_АТРИБУТА}
¶ cURL
curl --request DELETE \
--location 'https://chat-api.twin24.ai/api/v1/clients/{ИДЕНТИФИКТОР_КЛИЕНТА}/attributes/{ИДЕНТИФИКАТОР_АТРИБУТА}' \
--header 'accept: application/json' \
--header 'authorization: Bearer TOKEN'
При успешном выполнении метода придет ответ с кодом 200 без тела.
Метод: PATCH
Authorization: Bearer Token
URL: https://chat-api.twin24.ai/api/v1/clients/attributes
¶ cURL
curl --request PATCH \
--location 'https://chat-api.twin24.ai/api/v1/clients/attributes/{ИДЕНТИФИКАТОР_АТРИБУТА}'\
--header 'accept: application/json' \
--header 'authorization: Bearer TOKEN' \
--header 'content-type: application/json' \
--data '{"name":"Ответ клиента"}'
¶ Пример тела запроса
{
"name":"Ответ клиента"
}
¶ Описание полей ответа:
| Параметр | Описание |
|---|---|
| name | Новое название атрибута |
При успешном выполнении метода придет ответ с кодом 200 без тела.