Работа с атрибутами клиета через API

В данной статье описаны способы управления атрибутами клиента с помощью API TWIN.
Атрибут клиента — это специально созданное поле в панели оператора, которое хранит в себе информацию о клиенте. Содержание атрибутов клиента отображается в панели оператора в разделе О клиенте. Атрибуты клиента можно использовать для различных целей, однако основная цель — сообщить оператору необходимую информацию о клиенте. Такой подход поможет улучшить качество взаимодействия между клиентом и оператором.

Создание атрибута через 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`	Идентификатор созданного атрибута

Результат:

В панели оператора в разделе О клиенте появится доступное для редактирования поле Имя клиента.

Методы для работы с созданными атрибутами

Данный метод возвращает все атрибуты в личном кабинете.

Метод: GET

Authorization: Bearer Token (Метод для получения токена по логину и паролю)

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 (Метод для получения токена по логину и паролю)

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 (Метод для получения токена по логину и паролю)

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]
\| `items`	Идентификатор атрибута
\| `clientId`	Идентификатор клиента
\| `companyId`	Идентификатор компании
\| `name`	Название атрибута
\| `value`	Значение атрибута

Данный метод удалит атрибут из личного кабинета пользователя. После удаления, атрибут не будет отображаться в разделе О клиенте.

Перед использованием метода, требуется заменить {ИДЕНТИФИКАТОР_АТРИБУТА} реальным значением.

Метод: DELETE

Authorization: Bearer Token (Метод для получения токена по логину и паролю)

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 (Метод для получения токена по логину и паролю)

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 (Метод для получения токена по логину и паролю)

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 без тела.

Быстрые ссылки

Дерево страниц

Создание атрибута через API

Методы для работы с созданными атрибутами