[POST] .../v1/chat/removeparticipants
Удаляет участников из чата.
Входные параметры
| Название | Тип данных | Обязательность | Описание |
|---|---|---|---|
| id | String | Обязательный | UUID чата |
| participants | Array of ChatParticipantRemove | Обязательный | Список участников для удаления |
| Название | Тип данных | Описание |
|---|---|---|
| entity_type | Enum | Тип участника: User, Client, ChatBot |
| entity_id | Int64 | ID сущности участника |
Ограничения и проверки
id должен быть корректным UUID существующего чата.participants обязателен и должен содержать хотя бы одного участника.participants обязательны корректные entity_type и entity_id (entity_id > 0).User, Client, ChatBot.participants не должно быть дубликатов одной и той же пары (entity_type + entity_id).Staff.chat_manage_all (688) метод также доступен в обычных чатах.Chat/* в сущность не выполняется; состав берется только из связанной сущности.row_affected = 0).Пример запроса
{
"id": "6f6fdb2f-7d0b-4c34-b6fd-1fbcf40d37ef",
"participants": [
{
"entity_type": "User",
"entity_id": 21
}
]
}
Выходные параметры
| Название | Тип данных | Описание |
|---|---|---|
| result.row_affected | Int64 | Количество измененных строк |
Пример ответа
{
"ok": true,
"result": {
"row_affected": 1,
"ids": null
}
}