Skip to content

chore!: Remove deprecated livechat transfer method and endpoint #36871

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
kodiakhq merged 7 commits into from
Sep 11, 2025
Merged

chore!: Remove deprecated livechat transfer method and endpoint #36871

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
aa34cea
chore!: Remove deprecated livechat `transfer` methods
MartinSchoeler Aug 28, 2025
fc0a9af
Create quiet-bees-turn.md
MartinSchoeler Sep 4, 2025
3336adb
test: add tests to new endpoint
MartinSchoeler Sep 4, 2025
a1b02a8
chore: types
MartinSchoeler Sep 4, 2025
832400e
fix: reviews
MartinSchoeler Sep 4, 2025
77a85d9
fix: correct 400 return on error
MartinSchoeler Sep 8, 2025
4039b9d
test: Adjust tests and improve cleanup
MartinSchoeler Sep 9, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions .changeset/quiet-bees-turn.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
---
"@rocket.chat/meteor": major
"@rocket.chat/ddp-client": major
"@rocket.chat/livechat": major
"@rocket.chat/rest-typings": major
---

Removes the `livechat:transfer` deprecated method
Removes the `livechat/room.transfer` deprecated endpoint
Creates the `livechat/visitor.department.transfer` for visitors department transfer use
121 changes: 81 additions & 40 deletions apps/meteor/app/livechat/server/api/v1/room.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,21 +1,31 @@
import { Omnichannel } from '@rocket.chat/core-services';
import type { ILivechatAgent, IOmnichannelInquiryExtraData, IUser, SelectedAgent, TransferByData } from '@rocket.chat/core-typings';
import type {
ILivechatAgent,
IOmnichannelInquiryExtraData,
IUser,
SelectedAgent,
TransferByData,
TransferData,
} from '@rocket.chat/core-typings';
import { isOmnichannelRoom, OmnichannelSourceType } from '@rocket.chat/core-typings';
import { LivechatVisitors, Users, LivechatRooms, Messages } from '@rocket.chat/models';
import { LivechatVisitors, Users, LivechatRooms } from '@rocket.chat/models';
import {
isLiveChatRoomForwardProps,
isPOSTLivechatRoomCloseParams,
isPOSTLivechatRoomTransferParams,
isPOSTLivechatVisitorDepartmentTransferParams,
isPOSTLivechatRoomSurveyParams,
isLiveChatRoomJoinProps,
isLiveChatRoomSaveInfoProps,
isPOSTLivechatRoomCloseByUserParams,
ajv,
validateBadRequestErrorResponse,
} from '@rocket.chat/rest-typings';
import { check } from 'meteor/check';

import { callbacks } from '../../../../../lib/callbacks';
import { i18n } from '../../../../../server/lib/i18n';
import { API } from '../../../../api/server';
import type { ExtractRoutesFromAPI } from '../../../../api/server/ApiClass';
import { isWidget } from '../../../../api/server/helpers/isWidget';
import { canAccessRoomAsync } from '../../../../authorization/server';
import { hasPermissionAsync } from '../../../../authorization/server/functions/hasPermission';
Expand Down Expand Up @@ -221,43 +231,6 @@ API.v1.addRoute(
},
);

API.v1.addRoute(
'livechat/room.transfer',
{ validateParams: isPOSTLivechatRoomTransferParams, deprecation: { version: '7.0.0' } },
{
async post() {
const { rid, token, department } = this.bodyParams;

const guest = await findGuest(token);
if (!guest) {
throw new Error('invalid-token');
}

let room = await findRoom(token, rid);
if (!room) {
throw new Error('invalid-room');
}

// update visited page history to not expire
await Messages.keepHistoryForToken(token);

const { _id, username, name } = guest;
const transferredBy = normalizeTransferredByData({ _id, username, name, userType: 'visitor' }, room);

if (!(await transfer(room, guest, { departmentId: department, transferredBy }))) {
return API.v1.failure();
}

room = await findRoom(token, rid);
if (!room) {
throw new Error('invalid-room');
}

return API.v1.success({ room });
},
},
);

API.v1.addRoute(
'livechat/room.survey',
{ validateParams: isPOSTLivechatRoomSurveyParams },
Expand Down Expand Up @@ -350,6 +323,74 @@ API.v1.addRoute(
},
);

const livechatVisitorDepartmentTransfer = API.v1.post(
'livechat/visitor/department.transfer',
{
response: {
200: ajv.compile<void>({
type: 'object',
properties: {
success: {
type: 'boolean',
enum: [true],
},
},
required: ['success'],
additionalProperties: false,
}),
400: validateBadRequestErrorResponse,
},
body: isPOSTLivechatVisitorDepartmentTransferParams,
},
async function action() {
const { rid, token, department } = this.bodyParams;

const visitor = await findGuest(token);
if (!visitor) {
return API.v1.failure('invalid-token');
}
const room = await LivechatRooms.findOneById(rid);

if (!room || room.t !== 'l') {
return API.v1.failure('error-invalid-room');
}

if (!room.open) {
return API.v1.failure('This_conversation_is_already_closed');
}

// As this is a visitor endpoint, we should not show the mac limit error
if (!(await Omnichannel.isWithinMACLimit(room))) {
return API.v1.failure('error-transefing-chat');
}

const guest = await LivechatVisitors.findOneEnabledById(room.v?._id);
if (!guest) {
return API.v1.failure('error-invalid-visitor');
}

const transferredBy = normalizeTransferredByData(
{ _id: guest._id, username: guest.username, name: guest.name, userType: 'visitor' },
room,
);

const transferData: TransferData = { transferredBy, departmentId: department };

const chatForwardedResult = await transfer(room, guest, transferData);
if (!chatForwardedResult) {
return API.v1.failure('error-transfering-chat');
}

return API.v1.success();
},
);

type LivechatAnalyticsEndpoints = ExtractRoutesFromAPI<typeof livechatVisitorDepartmentTransfer>;
declare module '@rocket.chat/rest-typings' {
// eslint-disable-next-line @typescript-eslint/naming-convention, @typescript-eslint/no-empty-interface
interface Endpoints extends LivechatAnalyticsEndpoints {}
}

API.v1.addRoute(
'livechat/room.join',
{ authRequired: true, permissionsRequired: ['view-l-room'], validateParams: isLiveChatRoomJoinProps },
Expand Down
1 change: 0 additions & 1 deletion apps/meteor/app/livechat/server/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,6 @@ import './methods/saveCustomField';
import './methods/saveDepartment';
import './methods/sendMessageLivechat';
import './methods/sendFileLivechatMessage';
import './methods/transfer';
import './methods/setUpConnection';
import './methods/takeInquiry';
import './methods/returnAsInquiry';
Expand Down
105 changes: 0 additions & 105 deletions apps/meteor/app/livechat/server/methods/transfer.ts
View file
Open in desktop

This file was deleted.

Loading
Loading