/**
* GoHighLevel Campaigns Tools
* Tools for managing email and SMS campaigns
*/
import { GHLApiClient } from '../clients/ghl-api-client.js';
export class CampaignsTools {
constructor(private ghlClient: GHLApiClient) {}
getToolDefinitions() {
return [
// Campaign Management
{
name: 'get_campaigns',
description: 'Get all campaigns (email/SMS) for a location',
inputSchema: {
type: 'object',
properties: {
locationId: { type: 'string', description: 'Location ID' },
status: { type: 'string', enum: ['draft', 'scheduled', 'running', 'completed', 'paused'], description: 'Filter by campaign status' },
limit: { type: 'number', description: 'Max results' },
offset: { type: 'number', description: 'Pagination offset' }
}
}
},
{
name: 'get_campaign',
description: 'Get a specific campaign by ID',
inputSchema: {
type: 'object',
properties: {
campaignId: { type: 'string', description: 'Campaign ID' },
locationId: { type: 'string', description: 'Location ID' }
},
required: ['campaignId']
}
},
{
name: 'create_campaign',
description: 'Create a new campaign',
inputSchema: {
type: 'object',
properties: {
locationId: { type: 'string', description: 'Location ID' },
name: { type: 'string', description: 'Campaign name' },
type: { type: 'string', enum: ['email', 'sms', 'voicemail'], description: 'Campaign type' },
status: { type: 'string', enum: ['draft', 'scheduled'], description: 'Initial status' }
},
required: ['name', 'type']
}
},
{
name: 'update_campaign',
description: 'Update a campaign',
inputSchema: {
type: 'object',
properties: {
campaignId: { type: 'string', description: 'Campaign ID' },
locationId: { type: 'string', description: 'Location ID' },
name: { type: 'string', description: 'Campaign name' },
status: { type: 'string', enum: ['draft', 'scheduled', 'paused'], description: 'Campaign status' }
},
required: ['campaignId']
}
},
{
name: 'delete_campaign',
description: 'Delete a campaign',
inputSchema: {
type: 'object',
properties: {
campaignId: { type: 'string', description: 'Campaign ID' },
locationId: { type: 'string', description: 'Location ID' }
},
required: ['campaignId']
}
},
// Campaign Actions
{
name: 'start_campaign',
description: 'Start/launch a campaign',
inputSchema: {
type: 'object',
properties: {
campaignId: { type: 'string', description: 'Campaign ID' },
locationId: { type: 'string', description: 'Location ID' }
},
required: ['campaignId']
}
},
{
name: 'pause_campaign',
description: 'Pause a running campaign',
inputSchema: {
type: 'object',
properties: {
campaignId: { type: 'string', description: 'Campaign ID' },
locationId: { type: 'string', description: 'Location ID' }
},
required: ['campaignId']
}
},
{
name: 'resume_campaign',
description: 'Resume a paused campaign',
inputSchema: {
type: 'object',
properties: {
campaignId: { type: 'string', description: 'Campaign ID' },
locationId: { type: 'string', description: 'Location ID' }
},
required: ['campaignId']
}
},
// Campaign Stats
{
name: 'get_campaign_stats',
description: 'Get statistics for a campaign (opens, clicks, bounces, etc.)',
inputSchema: {
type: 'object',
properties: {
campaignId: { type: 'string', description: 'Campaign ID' },
locationId: { type: 'string', description: 'Location ID' }
},
required: ['campaignId']
}
},
{
name: 'get_campaign_recipients',
description: 'Get all recipients of a campaign',
inputSchema: {
type: 'object',
properties: {
campaignId: { type: 'string', description: 'Campaign ID' },
locationId: { type: 'string', description: 'Location ID' },
status: { type: 'string', enum: ['sent', 'delivered', 'opened', 'clicked', 'bounced', 'unsubscribed'], description: 'Filter by recipient status' },
limit: { type: 'number', description: 'Max results' },
offset: { type: 'number', description: 'Pagination offset' }
},
required: ['campaignId']
}
},
// Scheduled Messages
{
name: 'get_scheduled_messages',
description: 'Get all scheduled messages in campaigns',
inputSchema: {
type: 'object',
properties: {
locationId: { type: 'string', description: 'Location ID' },
contactId: { type: 'string', description: 'Filter by contact ID' },
campaignId: { type: 'string', description: 'Filter by campaign ID' }
}
}
},
{
name: 'cancel_scheduled_campaign_message',
description: 'Cancel a scheduled campaign message for a contact',
inputSchema: {
type: 'object',
properties: {
messageId: { type: 'string', description: 'Scheduled message ID' },
locationId: { type: 'string', description: 'Location ID' }
},
required: ['messageId']
}
}
];
}
async handleToolCall(toolName: string, args: Record<string, unknown>): Promise<unknown> {
const config = this.ghlClient.getConfig();
const locationId = (args.locationId as string) || config.locationId;
switch (toolName) {
case 'get_campaigns': {
const params = new URLSearchParams();
params.append('locationId', locationId);
if (args.status) params.append('status', String(args.status));
if (args.limit) params.append('limit', String(args.limit));
if (args.offset) params.append('offset', String(args.offset));
return this.ghlClient.makeRequest('GET', `/campaigns/?${params.toString()}`);
}
case 'get_campaign': {
return this.ghlClient.makeRequest('GET', `/campaigns/${args.campaignId}?locationId=${locationId}`);
}
case 'create_campaign': {
return this.ghlClient.makeRequest('POST', `/campaigns/`, {
locationId,
name: args.name,
type: args.type,
status: args.status || 'draft'
});
}
case 'update_campaign': {
const body: Record<string, unknown> = { locationId };
if (args.name) body.name = args.name;
if (args.status) body.status = args.status;
return this.ghlClient.makeRequest('PUT', `/campaigns/${args.campaignId}`, body);
}
case 'delete_campaign': {
return this.ghlClient.makeRequest('DELETE', `/campaigns/${args.campaignId}?locationId=${locationId}`);
}
case 'start_campaign': {
return this.ghlClient.makeRequest('POST', `/campaigns/${args.campaignId}/start`, { locationId });
}
case 'pause_campaign': {
return this.ghlClient.makeRequest('POST', `/campaigns/${args.campaignId}/pause`, { locationId });
}
case 'resume_campaign': {
return this.ghlClient.makeRequest('POST', `/campaigns/${args.campaignId}/resume`, { locationId });
}
case 'get_campaign_stats': {
return this.ghlClient.makeRequest('GET', `/campaigns/${args.campaignId}/stats?locationId=${locationId}`);
}
case 'get_campaign_recipients': {
const params = new URLSearchParams();
params.append('locationId', locationId);
if (args.status) params.append('status', String(args.status));
if (args.limit) params.append('limit', String(args.limit));
if (args.offset) params.append('offset', String(args.offset));
return this.ghlClient.makeRequest('GET', `/campaigns/${args.campaignId}/recipients?${params.toString()}`);
}
case 'get_scheduled_messages': {
const params = new URLSearchParams();
params.append('locationId', locationId);
if (args.contactId) params.append('contactId', String(args.contactId));
if (args.campaignId) params.append('campaignId', String(args.campaignId));
return this.ghlClient.makeRequest('GET', `/campaigns/scheduled-messages?${params.toString()}`);
}
case 'cancel_scheduled_campaign_message': {
return this.ghlClient.makeRequest('DELETE', `/campaigns/scheduled-messages/${args.messageId}?locationId=${locationId}`);
}
default:
throw new Error(`Unknown tool: ${toolName}`);
}
}
}
