Вы просматриваете старую версию данной страницы. Смотрите текущую версию.

Сравнить с текущим просмотр истории страницы

« Предыдущий Версия 5 Следующий »

Общая информация. 

В данной статье описаны способы управления атрибутами клиента с помощью 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/{clientId}/attributes/{attributeId}' \
--header 'accept: application/json' \
--header 'content-type: application/json' \
--header 'Authorization: Bearer TOKEN' \
--data '{"value":"Диитрий"}'



  • Нет меток