Получить отфильтрованные треды

Используйте этот метод для того, чтобы получить все возможные фильтры для тредов. У фильтра есть одно ограничение: интервал между параметрами start and end не может быть дольше, чем 90 дней.

Разрешения

----
Permissions:INTEGRATOR,SUPERVISOR
----

Фильтры

ПараметрТипОписаниеПример
startdateДата начала интервала, когда были созданы треды2021-07-15T21:00:00.000Z

Значение по умолчанию: текущая дата минус 1 день
enddateДата начала интервала, когда были созданы треды2021-07-16T20:59:59.999Z

Значение по умолчанию: текущая дата
lengthlongДлительность треда в секундах. Используется вместе с параметром lengthOperator350
lengthOperatorstringОператор сравнения, указанный для параметра lengthВозможные опции:

LESS
GREATER
EQUAL
LESS_EQUAL
GREATER_EQUAL
firstTimeAnswerlongКоличество секунд до первого ответа агента в треде. Используется вместе с параметром firstTimeAnswerOperator60
firstTimeAnswerOperatorstringОператор сравнения, указанный для параметра firstTimeAnswerВозможные опции:

LESS
GREATER
EQUAL
LESS_EQUAL
GREATER_EQUAL
messageCountlongКоличество сообщений. Используется вместе с параметром messageCountOperator10
messageCountOperatorstringОператор сравнения, указанный для параметра messageCountВозможные опции:

LESS
GREATER
EQUAL
LESS_EQUAL
GREATER_EQUAL
statusstringВозможные опции статуса треда. Каждая опции включает в себя несколько статусов треда:

QUEUED_STATESNEWUNASSIGNEDSUSPENDED
WORKING_STATESASSIGNEDANSWER_NEEDEDWAITINGIN_PROGRESSREASSIGNED
CLOSED_STATESCLOSED
Одна из следующих опций:

QUEUED_STATES
WORKING_STATES
CLOSED_STATES
channelslong arrayСписок ID каналов в edna. Чтобы получить список ID существующих каналов, обратитесь в службу поддержки или проверьте таблицу channels, если edna размещена на вашем сервере.1,3,7
emailAccountslong arrayСписок ID email аккаунтов. Когда используется вместе с параметром channels, используйте оператор OR между этими параметрами.1,2,5
operatorslong arrayСписок ID агентов1,5,8
tagslong arrayСписок ID ваших тегов в edna. Чтобы получить список существующих тегов, обратитесь в службу поддержки или проверьте таблицу tags, если edna размещена на вашем сервере.2,4,6
clientstringСтрока, использующаяся для того, чтобы найти клиента по externalClientIdnameusernameemail или phone.SomeUserName79876543210

Пример curl

$ curl 'http://localhost:8080/api/v1/threads/filter?start=2022-07-13T08%3A51%3A21.647Z&end=2022-07-14T08%3A51%3A21.647Z&length=600&lengthOperator=GREATER&messageCount=3&messageCountOperator=GREATER_EQUAL&firstAnswerTime=1000&firstAnswerTimeOperator=LESS_EQUAL&status=CLOSED_STATES&channelTypes=WEB&channelTypes=MOBILE&operators=1&operators=2&operators=3&tags=1&tags=5&page=1' -i -X GET \
-H 'Authorization: Bearer <integrator_token>'

Параметры запроса

ПараметрТипОписание
lengthstringДлительность треда
lengthOperatormessageCountOperatorfirstAnswerTimeOperatorstringЗначения (операторы сравнения):

LESS
GREATER
EQUAL
LESS_EQUAL
GREATER_EQUAL
messageCountnumberКоличество сообщений
firstAnswerTimenumberВремя первого ответа агента
statusstringЗначения:

QUEUED_STATES
WORKING_STATES
CLOSED_STATES
tagsnumberID тега в базе данных

HTTP запрос

GET /api/v1/threads/filter?start=2022-07-13T08%3A51%3A21.647Z&end=2022-07-14T08%3A51%3A21.647Z&length=600&lengthOperator=GREATER&messageCount=3&messageCountOperator=GREATER_EQUAL&firstAnswerTime=1000&firstAnswerTimeOperator=LESS_EQUAL&status=CLOSED_STATES&channelTypes=WEB&channelTypes=MOBILE&operators=1&operators=2&operators=3&tags=1&tags=5&page=1 HTTP/1.1
Authorization: Bearer <integrator_token>
Host: localhost:8080

Пример успешного HTTP ответа

HTTP/1.1 200 OK
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/json
Content-Length: 2620
{
    "count": 5,
    "pages": 1,
    "threads": [
        {
            "id": 1,
            "startTime": "2022-07-13T21:00:00.000Z",
            "clientId": 1,
            "clientName": "client name",
            "clientPhone": "8-900-800-7060",
            "externalClientId": "111",
            "blocked": false,
            "operator": {
                "id": 1,
                "name": "operator name",
                "role": "OPERATOR",
                "photoUrl": null
            },
            "channel": "WEB",
            "initialChannel": null,
            "state": "IN_PROGRESS",
            "tags": [],
            "questionAnswer": null,
            "blockRequested": false
        },
        {
            "id": 2,
            "startTime": "2022-07-13T21:00:00.000Z",
            "clientId": 1,
            "clientName": "client name",
            "clientPhone": "8-900-800-7060",
            "externalClientId": "111",
            "blocked": false,
            "operator": {
                "id": 1,
                "name": "operator name",
                "role": "OPERATOR",
                "photoUrl": null
            },
            "channel": "WEB",
            "initialChannel": null,
            "state": "WAITING",
            "tags": [],
            "questionAnswer": null,
            "blockRequested": false
        },
        {
            "id": 3,
            "startTime": "2022-07-13T21:00:00.000Z",
            "clientId": 2,
            "clientName": "client name 2",
            "clientPhone": "8-900-800-7061",
            "externalClientId": "222",
            "blocked": false,
            "operator": {
                "id": 2,
                "name": "operator name 2",
                "role": "OPERATOR",
                "photoUrl": null
            },
            "channel": "MOBILE",
            "initialChannel": null,
            "state": "REASSIGNED",
            "tags": [],
            "questionAnswer": null,
            "blockRequested": true
        },
        {
            "id": 4,
            "startTime": "2022-07-13T21:00:00.000Z",
            "clientId": 2,
            "clientName": "client name 2",
            "clientPhone": "8-900-800-7061",
            "externalClientId": "222",
            "blocked": false,
            "operator": {
                "id": 2,
                "name": "operator name 2",
                "role": "OPERATOR",
                "photoUrl": null
            },
            "channel": "MOBILE",
            "initialChannel": null,
            "state": "ANSWER_NEEDED",
            "tags": [],
            "questionAnswer": null,
            "blockRequested": true
        },
        {
            "id": 5,
            "startTime": "2022-07-13T21:00:00.000Z",
            "clientId": 3,
            "clientName": null,
            "clientPhone": null,
            "externalClientId": "3",
            "blocked": true,
            "operator": {
                "id": 2,
                "name": "operator name 2",
                "role": "OPERATOR",
                "photoUrl": null
            },
            "channel": "MOBILE",
            "initialChannel": null,
            "state": "WAITING",
            "tags": [],
            "questionAnswer": null,
            "blockRequested": false
        }
    ]
}
Получить треды по статусам и логинам агентов
Cледующая статья Назначить тред агенту