feat: User phone identity lookup for external voice calls (#40680)

Author: aleksandernsilva

ee/packages/media-calls/src/server/CastDirector.ts

@@ -2,12 +2,12 @@ import type { IUser, MediaCallActor, MediaCallActorType, MediaCallContact, Media
 import type { CallRole } from '@rocket.chat/media-signaling';
 import { Users } from '@rocket.chat/models';
 
+import { BroadcastActorAgent } from './BroadcastAgent';
 import type { IMediaCallAgent } from '../definition/IMediaCallAgent';
 import type { IMediaCallCastDirector } from '../definition/IMediaCallCastDirector';
 import type { GetActorContactOptions, MinimalUserData, MediaCallHeader } from '../definition/common';
 import { UserActorAgent } from '../internal/agents/UserActorAgent';
 import { logger } from '../logger';
-import { BroadcastActorAgent } from './BroadcastAgent';
 
 type ContactList = Record<MediaCallActorType, MediaCallContact | null>;
 
@@ -89,11 +89,28 @@ export class MediaCallCastDirector implements IMediaCallCastDirector {
 
 		const list = user
 			? this.buildContactListForUser(user, defaultContactInfo)
-			: this.buildContactListForExtension(sipExtension, defaultContactInfo);
+			: await this.buildContactListForExtension(sipExtension, defaultContactInfo);
 
 		return this.getContactFromList(list, options);
 	}
 
+	private async findUserByPhone(phoneNumber: string): Promise<Pick<IUser, '_id' | 'name' | 'username' | 'freeSwitchExtension'> | null> {
+		const users = await Users.findByPhone<Pick<IUser, '_id' | 'name' | 'username' | 'freeSwitchExtension'>>(phoneNumber, {
+			projection: { name: 1, username: 1, freeSwitchExtension: 1 },
+		}).toArray();
+
+		if (!users.length) {
+			return null;
+		}
+
+		if (users.length > 1) {
+			logger.warn({ msg: 'Multiple users found for phone number, identity cannot be resolved', phoneNumber });
+			return null;
+		}
+
+		return users[0];
+	}
+
 	public async getAgentForActorAndRole(actor: MediaCallContact, role: CallRole): Promise<IMediaCallAgent | null> {
 		if (actor.type === 'user') {
 			return this.getAgentForUserActorAndRole(actor, role);
@@ -141,10 +158,17 @@ export class MediaCallCastDirector implements IMediaCallCastDirector {
 		};
 	}
 
-	protected buildContactListForExtension(sipExtension: string, defaultContactInfo?: MediaCallContactInformation): ContactList {
+	protected async buildContactListForExtension(
+		sipExtension: string,
+		defaultContactInfo?: MediaCallContactInformation,
+	): Promise<ContactList> {
+		const user = await this.findUserByPhone(sipExtension);
+
 		const data: Partial<MediaCallContact> = {
 			...defaultContactInfo,
 			...(sipExtension && { sipExtension }),
+			...(user?.username && { username: user.username }),
+			...(user?.name && { displayName: user.name }),
 		};
 
 		return {

packages/model-typings/src/models/IUsersModel.ts

@@ -443,6 +443,7 @@ export interface IUsersModel extends IBaseModel<IUser> {
 	findAgentsAvailableWithoutBusinessHours(userIds?: IUser['_id'][]): FindCursor<Pick<ILivechatAgent, '_id' | 'openBusinessHours'>>;
 	updateLivechatStatusByAgentIds(userIds: string[], status: ILivechatAgentStatus): Promise<UpdateResult | Document>;
 	findOneByFreeSwitchExtension<T extends Document = IUser>(freeSwitchExtension: string, options?: FindOptions<IUser>): Promise<T | null>;
+	findByPhone<T extends Document = IUser>(phoneNumber: string, options?: FindOptions<IUser>): FindCursor<T>;
 	countUsersInRoles(roles: IRole['_id'][]): Promise<number>;
 	countAllUsersWithPendingAvatar(): Promise<number>;
 	findOneByIdAndRole(userId: IUser['_id'], role: string, options: FindOptions<IUser>): Promise<IUser | null>;

packages/models/src/models/Users.ts

@@ -68,6 +68,7 @@ export class UsersRaw extends BaseRaw<IUser, DefaultFields<IUser>> implements IU
 			{ key: { openBusinessHours: 1 }, sparse: true },
 			{ key: { statusLivechat: 1 }, sparse: true },
 			{ key: { freeSwitchExtension: 1 }, sparse: true, unique: true },
+			{ key: { 'phones.number': 1 }, sparse: true },
 			{ key: { language: 1 }, sparse: true },
 			{ key: { 'active': 1, 'services.email2fa.enabled': 1 }, sparse: true }, // used by statistics
 			{ key: { 'active': 1, 'services.totp.enabled': 1 }, sparse: true }, // used by statistics
@@ -2765,6 +2766,15 @@ export class UsersRaw extends BaseRaw<IUser, DefaultFields<IUser>> implements IU
 		);
 	}
 
+	findByPhone<T extends Document = IUser>(phoneNumber: string, options: FindOptions<IUser> = {}): FindCursor<T> {
+		return this.find<T>(
+			{
+				'phones.number': phoneNumber,
+			} as Filter<IUser>,
+			options,
+		);
+	}
+
 	// UPDATE
 	addImportIds(_id: IUser['_id'], importIds: string[]) {
 		importIds = ([] as string[]).concat(importIds);