Class WhatsAppTemplatesService

Index

Constructors

Methods

createTemplate deleteTemplate getTemplate listTemplates updateTemplate

Constructors

constructor

new WhatsAppTemplatesService(
    httpService: HttpService,
    sandboxConfig?: WhatsAppSandboxOptions,
    liveConfig?: WhatsAppLiveOptions,
    runtimeOptions?: WhatsAppRuntimeOptions,
): WhatsAppTemplatesService
Parameters
- httpService: HttpService
- OptionalsandboxConfig: WhatsAppSandboxOptions
- OptionalliveConfig: WhatsAppLiveOptions
- OptionalruntimeOptions: WhatsAppRuntimeOptions
Returns WhatsAppTemplatesService

Methods

createTemplate

createTemplate(
    wabaId: string,
    template: WhatsAppCreateTemplateDto,
    clientName?: WhatsAppMode,
): Promise<{ id: string }>
Create a new message template. Returns the new template ID.
Parameters
- wabaId: string
- template: WhatsAppCreateTemplateDto
- clientName: WhatsAppMode = WhatsAppMode.LIVE
Returns Promise<{ id: string }>

deleteTemplate

deleteTemplate(
    wabaId: string,
    name: string,
    clientName?: WhatsAppMode,
): Promise<boolean>
Delete a template by name.
Parameters
- wabaId: string
- name: string
- clientName: WhatsAppMode = WhatsAppMode.LIVE
Returns Promise<boolean>

getTemplate

getTemplate(
templateId: string,
clientName?: WhatsAppMode,
): Promise<WhatsAppTemplate>
Retrieve a single template by its ID.
Parameters
- templateId: string
- clientName: WhatsAppMode = WhatsAppMode.LIVE
Returns Promise<WhatsAppTemplate>

listTemplates

listTemplates(
wabaId: string,
clientName?: WhatsAppMode,
): Promise<WhatsAppTemplate[]>
Retrieve all message templates for a WABA.
Parameters
- wabaId: string
- clientName: WhatsAppMode = WhatsAppMode.LIVE
Returns Promise<WhatsAppTemplate[]>

updateTemplate

updateTemplate(
    templateId: string,
    template: WhatsAppUpdateTemplateDto,
    clientName?: WhatsAppMode,
): Promise<boolean>
Update an existing template's components or category.
Parameters
- templateId: string
- template: WhatsAppUpdateTemplateDto
- clientName: WhatsAppMode = WhatsAppMode.LIVE
Returns Promise<boolean>