Files
calendar/packages/features/tasker/tasks/executeAIPhoneCall.ts
T
d7fc11df5e feat: use form responses as workflow variables (#24716)
* remove add variable dropdown

* feat: lang support

* fix: type errors

* feat: select voice agent

* refactor: address feedback

* refactor: address feedback

* refactor: missing import

* fix: types

* add getAllWorkflowsFromRoutingForm to WorkflowService

* fix error caused by undefined evt

* fix type error

* fix type error

* fix tests

* feat: add inbound calls

* chore: formatting

* chore

* feat: finish inbound call

* chore: formatting

* fix: update bug

* fix: types

* code clean up

* final fixes and clean up

* remove console.log

* remove template text form from triggers

* add routing form repoditory function

* refactor: Agent Configuration Sheet (#23930)

* refactor: agent configuration sheet

* chore: use default phone numbre

* refactor: improvements

* refactor: improvements

* fix: types

* fix: feedback

* fix bug with key

* chore:

* fix: feedback

* fix: prompt

* add comments

* fix: review

* fix: review

* refactor: class

* refactor: class

* fix test

* allow cal ai action on form triggers

* move any reusable code to scheduleAIPhoneCall

* add missing await

* use predefined FormSubmissionData type

* add .trim() to sms message

* pass contextData instead

* finish base setup

* add missing trigger in update-workflow.input.ts

* allow cal.ai action for form triggers in handler

* chore: add support for form workflows on api v2

* fixup! chore: add support for form workflows on api v2

* ai phone call on form submissions (WIP)

* use existing type for Option array

* pass chosen event type id

* refactor: rename

* Update apps/web/public/static/locales/en/common.json

* Update apps/web/public/static/locales/en/common.json

* add missing imports

* chore: update set value

* fix: remove index

* fix: type error

* fix: update tetss

* use only repository functions in update handler

* move all prisma queries from list.handler

* review suggestions

* fix: use logger

* chore: handle workflows api v2

* chore: handle workflows api v2, split in 2 endpoints

* fix workflow step creation

* remove connect agent and fixes types

* add type to workflow

* chore: use workflow type in apiv2 WorkflowsOutputService

* update worklfow type on update

* chore: use workflow type in apiv2 WorkflowsOutputService

* fix template body for torm trigger

* some UI fixes for email subject/body

* resetting email body when changing form triggers

* use type field to query workflows

* clean up all old active on values

* remove responseId from all funciton calls

* remove undefined from updateTemplate

* refactor: don't use static

* fix: type

* refactor: split routing form and event-type workflows code

* refactor: split routing form and event-type workflows code

* fix template  text when adding action

* chore: don't rename WorkflowActivationDto to avoid ci blocking

* refine update schedule to use only allowed actions

* fix type error

* don't allow whatsapp action with form trigger

* fix type error

* return early if activeOn array is empty

* fix: from step type in BaseFormWorkflowStepDto

* fixup! fix: from step type in BaseFormWorkflowStepDto

* api v2 updates

* move all prisma calls to repository (service/workflows.ts)

* use FORM_TRIGGER_WORKFLOW_EVENTS for form queries

* use userRepository

* use FORM_TRIGGER_WORKFLOW_EVENTS in isFormTrigger

* code clean up

* code clean up

* use repository functions in formSubmissionValidation.ts

* fix: schema

* refactor:

* remove action check in update handler

* add event type selection

* event type selector improvements

* adjust update.handler

* set outboundEventTypeId

* add back trpc  import

* fix agent repository functions

* clean up

* fix bugs caused by merge

* pass eventTypeId to updateToolsFromAgentId

* add migration for outboundEventTypeId

* add SMS actions to allowed form action constants

* add cal ai to allowed form actions

* pick correct event type for web call

* pass correct routed event type id

* remove unsued import

* fixes for offset api v2

* add missing responseId

* fix failing test

* fix failing test

* improve error message

* remove unused imports

* chore: handle sms step action for form worklfow in dtos

* fix typo

* missing missing newStep

* minor fixes

* remove changes

* add routedEventTypeId

* fix type error

* fix type error

* fix typ error in executAPIPhoneCall.tsx

* add back inboundEventTypeId

* remove console.log

* remove outdated code

* small fixes

* don't throw error for missing phone number

* add  back filtered triggerOptions

* fix eventTypeId in testCall handler

* fix type error

* update migration

* fix trigger is not defined

* convert eventTypeId to string

* only use outboundEventTypeId for FORM_SUBMITTED trigger

* show toast when no event type selected

* fix type errors

* add missing translation

* fix type error

* remove callType

* fix tests

* small fixes

* clean up AgentConfigurationSheet

* remove EventTypeSelector file

* code clean up

* clean up

* clean up

* use resusable function for TestPhoneCallDialog and WebCallDialog

* rename result

* fix types for event type id

* use repository runction in workflowReminder.ts

* fix type error

* pass eventTypeIds correctly

* fix typo

* custom variables from form responses

* remove comment

* Update apps/web/public/static/locales/en/common.json

Co-authored-by: Udit Takkar <53316345+Udit-takkar@users.noreply.github.com>

* use watch instead of getValues

* change to  z.record(z.unknown()) instead of any()

* fix type of eventTypeId

* check permissinon for outBoundEventTypeId

* add isNaN check

* improve function name

* add tests

* fixes for custom variables

* improve test

* update tools when outbound agent event type id changes

* handle undefined eventDate in customTemplate

* add info how to use form responses as variables

* rename responses to routingFormResponses

* remove cal ai from allowed steps api v2

* remove old migration file

---------

Co-authored-by: CarinaWolli <wollencarina@gmail.com>
Co-authored-by: Udit Takkar <udit222001@gmail.com>
Co-authored-by: Udit Takkar <53316345+Udit-takkar@users.noreply.github.com>
Co-authored-by: Benny Joo <sldisek783@gmail.com>
Co-authored-by: cal.com <morgan@cal.com>
Co-authored-by: Morgan <33722304+ThyMinimalDev@users.noreply.github.com>
Co-authored-by: Peer Richelsen <peeroke@gmail.com>
2025-11-13 15:34:44 +00:00

280 lines
9.8 KiB
TypeScript

import type { FORM_SUBMITTED_WEBHOOK_RESPONSES } from "@calcom/app-store/routing-forms/lib/formSubmissionUtils";
import dayjs from "@calcom/dayjs";
import { getCalEventResponses } from "@calcom/features/bookings/lib/getCalEventResponses";
import { createDefaultAIPhoneServiceProvider } from "@calcom/features/calAIPhone";
import { handleInsufficientCredits } from "@calcom/features/ee/billing/helpers/handleInsufficientCredits";
import { formatIdentifierToVariable } from "@calcom/features/ee/workflows/lib/reminders/templates/customTemplate";
import { WorkflowReminderRepository } from "@calcom/features/ee/workflows/lib/repository/workflowReminder";
import { FeaturesRepository } from "@calcom/features/flags/features.repository";
import {
getSubmitterEmail,
getSubmitterName,
} from "@calcom/features/tasker/tasks/triggerFormSubmittedNoEvent/formSubmissionValidation";
import { checkRateLimitAndThrowError } from "@calcom/lib/checkRateLimitAndThrowError";
import logger from "@calcom/lib/logger";
import prisma from "@calcom/prisma";
import { CreditUsageType } from "@calcom/prisma/enums";
interface ExecuteAIPhoneCallPayload {
workflowReminderId: number;
agentId: string;
fromNumber: string;
toNumber: string;
bookingUid: string | null;
userId: number | null;
teamId: number | null;
providerAgentId: string;
responses?: FORM_SUBMITTED_WEBHOOK_RESPONSES | null;
routedEventTypeId?: number | null;
}
const log = logger.getSubLogger({ prefix: [`[[executeAIPhoneCall] `] });
type BookingWithRelations = NonNullable<
NonNullable<
Awaited<ReturnType<typeof WorkflowReminderRepository.findWorkflowReminderForAIPhoneCallExecution>>
>["booking"]
>;
function getVariablesFromFormResponse({
responses,
eventTypeId,
numberToCall,
}: {
responses: FORM_SUBMITTED_WEBHOOK_RESPONSES;
eventTypeId: number | null;
numberToCall: string;
}) {
const submittedEmail = getSubmitterEmail(responses);
const submittedName = getSubmitterName(responses);
return {
ATTENDEE_NAME: submittedName || "",
ATTENDEE_EMAIL: submittedEmail || "",
NUMBER_TO_CALL: numberToCall,
eventTypeId: eventTypeId?.toString() || "",
// Include any custom form responses
...Object.fromEntries(
Object.entries(responses || {}).map(([key, value]) => [
formatIdentifierToVariable(key),
value.value?.toString() || "",
])
),
};
}
function getVariablesFromBooking(booking: BookingWithRelations, numberToCall: string) {
const attendee = booking.attendees[0];
const timeZone = booking.user?.timeZone || attendee?.timeZone || "UTC";
const { responses } = getCalEventResponses({
bookingFields: booking.eventType?.bookingFields ?? null,
booking: {
...booking,
customInputs: null,
},
});
const attendeeNameWords = attendee?.name?.trim().split(" ") || [];
const attendeeFirstName = attendeeNameWords[0] || "";
const attendeeLastName =
attendeeNameWords.length > 1 ? attendeeNameWords[attendeeNameWords.length - 1] : "";
return {
EVENT_NAME: booking.eventType?.title || "",
EVENT_DATE: dayjs(booking.startTime).tz(timeZone).format("dddd, MMMM D, YYYY"),
EVENT_TIME: dayjs(booking.startTime).tz(timeZone).format("h:mm A"),
EVENT_END_TIME: dayjs(booking.endTime).tz(timeZone).format("h:mm A"),
TIMEZONE: timeZone,
LOCATION: booking.location || "",
ORGANIZER_NAME: booking.user?.name || "",
ATTENDEE_NAME: attendee?.name || "",
ATTENDEE_FIRST_NAME: attendeeFirstName,
ATTENDEE_LAST_NAME: attendeeLastName,
ATTENDEE_EMAIL: attendee?.email || "",
NUMBER_TO_CALL: numberToCall,
ATTENDEE_TIMEZONE: attendee?.timeZone || "",
ADDITIONAL_NOTES: booking.description || "",
EVENT_START_TIME_IN_ATTENDEE_TIMEZONE: dayjs(booking.startTime)
.tz(attendee?.timeZone || timeZone)
.format("h:mm A"),
EVENT_END_TIME_IN_ATTENDEE_TIMEZONE: dayjs(booking.endTime)
.tz(attendee?.timeZone || timeZone)
.format("h:mm A"),
// DO NOT REMOVE THIS FIELD. It is used for conditional tool routing in prompts
eventTypeId: booking.eventTypeId?.toString() || "",
// Include any custom form responses
...Object.fromEntries(
Object.entries(responses || {}).map(([key, value]) => [
formatIdentifierToVariable(key),
value.value?.toString() || "",
])
),
};
}
export async function executeAIPhoneCall(payload: string) {
let data: ExecuteAIPhoneCallPayload;
try {
data = JSON.parse(payload);
} catch (error) {
log.error("Failed to parse AI phone call payload", { error, payload });
throw new Error("Invalid JSON payload");
}
const featuresRepository = new FeaturesRepository(prisma);
const calAIVoiceAgents = await featuresRepository.checkIfFeatureIsEnabledGlobally("cal-ai-voice-agents");
if (!calAIVoiceAgents) {
log.warn("Cal.ai voice agents are disabled - skipping AI phone call");
return;
}
log.info(`Executing AI phone call for workflow reminder ${data.workflowReminderId}`, data);
try {
const workflowReminder = await WorkflowReminderRepository.findWorkflowReminderForAIPhoneCallExecution(
data.workflowReminderId
);
if (!workflowReminder || !workflowReminder.scheduled) {
log.warn(`Workflow reminder ${data.workflowReminderId} not found or not scheduled`);
throw new Error("Reminder not found or not scheduled");
}
if (data.userId || data.teamId) {
const { CreditService } = await import("@calcom/features/ee/billing/credit-service");
const creditService = new CreditService();
const hasCredits = await creditService.hasAvailableCredits({
userId: data.userId || undefined,
teamId: data.teamId || undefined,
});
if (!hasCredits) {
log.warn(`Insufficient credits for AI phone call for workflow reminder ${data.workflowReminderId}`, {
userId: data.userId,
teamId: data.teamId,
workflowReminderId: data.workflowReminderId,
bookingUid: workflowReminder.booking?.uid,
});
await handleInsufficientCredits({
userId: data.userId,
teamId: data.teamId,
creditFor: CreditUsageType.CAL_AI_PHONE_CALL,
prismaClient: prisma,
context: {
workflowReminderId: data.workflowReminderId,
bookingUid: workflowReminder.booking?.uid,
},
});
return;
}
}
const rateLimitIdentifier = data.teamId
? `ai-phone-call:team:${data.teamId}`
: data.userId
? `ai-phone-call:user:${data.userId}`
: null;
if (!rateLimitIdentifier) {
log.warn(`No rate limit identifier found for AI phone call. This should not happen.`, {
userId: data.userId,
teamId: data.teamId,
workflowReminderId: data.workflowReminderId,
});
throw new Error("No rate limit identifier found for AI phone call. This should not happen.");
}
// TODO: add better rate limiting for AI phone calls
await checkRateLimitAndThrowError({
rateLimitingType: "core",
identifier: rateLimitIdentifier,
});
// form triggers don't have a booking
const booking = workflowReminder.booking as BookingWithRelations | null;
const routingFormResponses = data.responses;
if (!booking && !routingFormResponses) {
log.warn(`No form responses or booking found for workflow reminder ${data.workflowReminderId}`);
throw new Error("No booking, response, or form responses found");
}
const numberToCall = data.toNumber;
if (!numberToCall) {
log.warn(`No phone number found in booking ${booking?.uid} or the routing form responses`);
throw new Error("No phone number found");
}
type VariablesType = {
ATTENDEE_EMAIL: string;
ATTENDEE_NAME: string;
NUMBER_TO_CALL: string;
eventTypeId: string;
} & Partial<ReturnType<typeof getVariablesFromBooking>>;
// Prefer response variables if present, else fall back to booking
let dynamicVariables: VariablesType | undefined;
if (routingFormResponses) {
const workflowStep = workflowReminder.workflowStep;
const eventTypeId =
data.routedEventTypeId ??
(workflowStep?.workflow.trigger === "FORM_SUBMITTED"
? workflowStep.agent?.outboundEventTypeId
: null);
if (!eventTypeId) {
log.warn(
`Form not routed to an event type and no event type id found for workflow reminder ${data.workflowReminderId}`
);
return;
}
dynamicVariables = getVariablesFromFormResponse({
responses: routingFormResponses,
eventTypeId,
numberToCall,
});
} else if (booking) {
dynamicVariables = getVariablesFromBooking(booking, numberToCall);
}
if (!dynamicVariables) return;
const aiService = createDefaultAIPhoneServiceProvider();
await aiService.updateToolsFromAgentId(data.providerAgentId, {
eventTypeId: dynamicVariables.eventTypeId ? Number(dynamicVariables.eventTypeId) : null,
timeZone: dynamicVariables.TIMEZONE || "UTC",
userId: data.userId,
teamId: data.teamId,
});
const call = await aiService.createPhoneCall({
fromNumber: data.fromNumber,
toNumber: numberToCall,
dynamicVariables,
});
log.info("AI phone call created successfully:", call);
await WorkflowReminderRepository.updateWorkflowReminderReferenceAndScheduled(data.workflowReminderId, {
referenceId: call.call_id,
scheduled: true,
});
log.info(`AI phone call executed successfully for workflow reminder ${data.workflowReminderId}`, {
callId: call.call_id,
agentId: data.agentId,
fromNumber: data.fromNumber,
toNumber: numberToCall,
bookingUid: data.bookingUid,
workflowReminderId: data.workflowReminderId,
});
} catch (error) {
log.error("Error executing AI phone call:", error);
throw error;
}
}