Перейти к основному содержимому

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

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

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

Параметр

Тип

Описание

Пример

Значение по умолчанию

start

date

Начала интервала, когда были созданы треды

2021-07-15T21:00:00.000Z

Текущая дата минус 1 день

end

date

Начала интервала, когда были созданы треды

2021-07-16T20:59:59.999Z

Текущая дата

length

long

Длительность треда в секундах. Используется вместе с параметром lengthOperator

350

-

lengthOperator

string

Оператор сравнения, указанный для параметра length

Возможные опции:

LESS

GREATER

EQUAL

LESS_EQUAL

GREATER_EQUAL

-

firstTimeAnswer

long

Количество секунд до первого ответа агента в треде. Используется вместе с параметром firstTimeAnswerOperator

60

-

firstTimeAnswerOperator

string

Оператор сравнения, указанный для параметра firstTimeAnswer

Возможные опции:

LESS

GREATER

EQUAL

LESS_EQUAL

GREATER_EQUAL

-

messageCount

long

Количество сообщений. Используется вместе с параметром messageCountOperator

10

-

messageCountOperator

string

Оператор сравнения, указанный для параметра messageCount

Возможные опции:

LESS

GREATER

EQUAL

LESS_EQUAL

GREATER_EQUAL

-

states

string

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

- Опция QUEUED_STATES: NEW, UNASSIGNED, SUSPENDED

- Опция WORKING_STATES: ASSIGNED, ANSWER_NEEDED, WAITING, IN_PROGRESS, REASSIGNED

- Опция CLOSED_STATES: CLOSED

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

QUEUED_STATES

WORKING_STATES

CLOSED_STATES

-

channels

long array

Список ID каналов в edna. Чтобы получить список ID существующих каналов, обратитесь в службу поддержки или проверьте таблицу channels, если edna размещена на вашем сервере.

1,3,7

-

emailAccounts

long array

Список ID email аккаунтов. Когда используется вместе с параметром channels, используйте оператор OR между этими параметрами.

1,2,5

-

operators

long array

Список ID агентов

1,5,8

-

tags

long array

Список ID ваших тегов в edna. Чтобы получить список существующих тегов, обратитесь в службу поддержки или проверьте таблицу tags, если edna размещена на вашем сервере.

2,4,6

-

client

string

Строка, использующаяся для того, чтобы найти клиента по externalClientId, name, username, email или phone.

SomeUserName

79876543210

-

Параметры запроса
ПараметрТипОписание

length

string

Длительность треда

  • lengthOperator

  • messageCountOperator

  • firstAnswerTimeOperator

string

Значения (операторы сравнения)
  • LESS

  • GREATER

  • EQUAL

  • LESS_EQUAL

  • GREATER_EQUAL

messageCount

number

Количество сообщений

firstAnswerTime

number

Время первого ответа агента

states

string

Значения
  • QUEUED_STATES

  • WORKING_STATES

  • CLOSED_STATES

tags

number

ID тега в базе данных

Пример curl

$ curl 'http://localhost:8080/api/v1/threads/filter?start=2024-12-27T11%3A39%3A38.015Z&end=2024-12-28T11%3A39%3A38.015Z&length=600&lengthOperator=GREATER&messageCount=3&messageCountOperator=GREATER_EQUAL&firstAnswerTime=1000&firstAnswerTimeOperator=LESS_EQUAL&states=CLOSED_STATES&channels=1&channels=2&operators=1&operators=2&operators=3&tagIds=1&tagIds=5&page=1&pageSize=10' -i -X GET \
-H 'Authorization: Bearer <integrator_token>' \
-H 'X-Tenant-Name: local'

Пример HTTP запроса

GET /api/v1/threads/filter?start=2024-12-27T11%3A39%3A38.015Z&end=2024-12-28T11%3A39%3A38.015Z&length=600&lengthOperator=GREATER&messageCount=3&messageCountOperator=GREATER_EQUAL&firstAnswerTime=1000&firstAnswerTimeOperator=LESS_EQUAL&states=CLOSED_STATES&channels=1&channels=2&operators=1&operators=2&operators=3&tagIds=1&tagIds=5&page=1&pageSize=10 HTTP/1.1
Authorization: Bearer <integrator_token>
X-Tenant-Name: local
Host: localhost:8080

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

HTTP/1.1 200 OK
X-Request-Id: 7804ffaa-c548-41dd-b899-008b81236c9a
Vary: Origin
Vary: Access-Control-Request-Method
Vary: Access-Control-Request-Headers
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 0
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
X-Frame-Options: DENY
Content-Length: 2670

{
"count" : 5,
"pages" : 1,
"threads" : [ {
"id" : 1,
"startTime" : "2024-12-27T22:00:00.000Z",
"clientId" : 1,
"clientName" : "client name",
"clientPhone" : "8-900-800-7060",
"authorized" : false,
"externalClientId" : "111",
"blocked" : false,
"operator" : {
"id" : 1,
"name" : "operator name",
"role" : "OPERATOR",
"photoUrl" : null
,
"channel" : "WEB",
"initialChannel" : "WEB",
"state" : "IN_PROGRESS",
"tags" : [ ],
"questionAnswer" : null,
"blockRequested" : false
, {
"id" : 2,
"startTime" : "2024-12-27T22:00:00.000Z",
"clientId" : 1,
"clientName" : "client name",
"clientPhone" : "8-900-800-7060",
"authorized" : false,
"externalClientId" : "111",
"blocked" : false,
"operator" : {
"id" : 1,
"name" : "operator name",
"role" : "OPERATOR",
"photoUrl" : null
,
"channel" : "WEB",
"initialChannel" : "WEB",
"state" : "WAITING",
"tags" : [ ],
"questionAnswer" : null,
"blockRequested" : false
, {
"id" : 3,
"startTime" : "2024-12-27T22:00:00.000Z",
"clientId" : 2,
"clientName" : "client name 2",
"clientPhone" : "8-900-800-7061",
"authorized" : false,
"externalClientId" : "222",
"blocked" : false,
"operator" : {
"id" : 2,
"name" : "operator name 2",
"role" : "OPERATOR",
"photoUrl" : null
,
"channel" : "MOBILE",
"initialChannel" : "WEB",
"state" : "REASSIGNED",
"tags" : [ ],
"questionAnswer" : null,
"blockRequested" : true
, {
"id" : 4,
"startTime" : "2024-12-27T22:00:00.000Z",
"clientId" : 2,
"clientName" : "client name 2",
"clientPhone" : "8-900-800-7061",
"authorized" : false,
"externalClientId" : "222",
"blocked" : false,
"operator" : {
"id" : 2,
"name" : "operator name 2",
"role" : "OPERATOR",
"photoUrl" : null
,
"channel" : "MOBILE",
"initialChannel" : "WEB",
"state" : "ANSWER_NEEDED",
"tags" : [ ],
"questionAnswer" : null,
"blockRequested" : true
, {
"id" : 5,
"startTime" : "2024-12-27T22:00:00.000Z",
"clientId" : 3,
"clientName" : null,
"clientPhone" : null,
"authorized" : false,
"externalClientId" : "3",
"blocked" : true,
"operator" : {
"id" : 2,
"name" : "operator name 2",
"role" : "OPERATOR",
"photoUrl" : null
,
"channel" : "MOBILE",
"initialChannel" : "WEB",
"state" : "WAITING",
"tags" : [ ],
"questionAnswer" : null,
"blockRequested" : false
],
"empty" : false