Skip to main content

Синхронизация веток

Метод и конечная точка​

GET /chat.syncThreadsList

Описание​

Синхронизирует список веток, возвращая обновленные и удаленные ветки с момента указанной даты.

Параметры​

Перечень параметров представлен в таблице.

НазваниеОбязательныйТип данныхОписание
ridдаstringИдентификатор комнаты
updatedSinceдаstringДата последней синхронизации (формат date)
queryнетstringJSON-строка с условиями фильтрации
sortнетstringПоле для сортировки
fieldsнетstringJSON-строка с полями для включения

Запрос​

curl -X 'GET' \
'https://im-<ENV>.<DEFAULT_DOMAIN>/api/v1/chat.syncThreadsList?rid=<ROOM_ID>&updatedSince=<UPDATED_SINCE>' \
-H 'accept: application/json' \
-H 'X-User-Id: <USER_ID>' \
-H 'x-auth-token: <AUTH_TOKEN>'

Где:

  • <ENV> — окружение, на котором выполняется запрос;
  • <DEFAULT_DOMAIN> — домен сервера Squadus;
  • <USER_ID> — идентификатор пользователя, от имени которого выполняется запрос;
  • <AUTH_TOKEN> — токен аутентификации пользователя;
  • <ROOM_ID> — идентификатор комнаты;
  • <UPDATED_SINCE> — дата последней синхронизации.

Ответ​

200 — Successfully synchronize threads — Синхронизированные ветки. Пример вывода:

{
"success": true,
"threads": {
"update": [
{
"_id": "thread_123456",
"msg": "Updated thread",
"tcount": 5
}
],
"remove": [
{
"_id": "thread_789012"
}
]
}
}