Class WhatsAppMediaService

Index

Constructors

Methods

deleteMedia getMediaUrl uploadMedia

Constructors

constructor

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

Methods

deleteMedia

deleteMedia(mediaId: string, clientName?: WhatsAppMode): Promise<boolean>
Delete a previously uploaded media asset by its ID.
Parameters
- mediaId: string
- clientName: WhatsAppMode = WhatsAppMode.LIVE
Returns Promise<boolean>

getMediaUrl

getMediaUrl(
mediaId: string,
clientName?: WhatsAppMode,
): Promise<WhatsAppMediaUrlResponse>
Retrieve the download URL and metadata for an uploaded media asset. The returned URL is short-lived (expires in ~5 minutes).
Parameters
- mediaId: string
- clientName: WhatsAppMode = WhatsAppMode.LIVE
Returns Promise<WhatsAppMediaUrlResponse>

uploadMedia

uploadMedia(
    file: Buffer,
    mimeType: string,
    filename?: string,
    clientName?: WhatsAppMode,
): Promise<WhatsAppMediaUploadResponse>
Upload a media file to WhatsApp and receive a reusable media ID.
Parameters
- file: Buffer
  Raw file buffer
- mimeType: string
  MIME type (e.g. 'image/jpeg', 'audio/ogg', 'application/pdf')
- filename: string = 'upload'
  Optional filename for the upload
- clientName: WhatsAppMode = WhatsAppMode.LIVE
Returns Promise<WhatsAppMediaUploadResponse>