DeliveryTracker
Defined in: packages/messaging/src/delivery/tracker.ts:76
Extends
Section titled “Extends”EventEmitter
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new DeliveryTracker(
options):DeliveryTracker
Defined in: packages/messaging/src/delivery/tracker.ts:98
Parameters
Section titled “Parameters”options
Section titled “options”DeliveryTrackingOptions
Returns
Section titled “Returns”DeliveryTracker
Overrides
Section titled “Overrides”EventEmitter.constructor
Methods
Section titled “Methods”addListener()
Section titled “addListener()”addListener(
eventName,listener):this
Defined in: packages/messaging/src/shared/event-emitter.ts:16
Parameters
Section titled “Parameters”eventName
Section titled “eventName”string
listener
Section titled “listener”Listener
Returns
Section titled “Returns”this
Inherited from
Section titled “Inherited from”EventEmitter.addListener
cleanup()
Section titled “cleanup()”cleanup():
number
Defined in: packages/messaging/src/delivery/tracker.ts:443
Clean up expired tracking records
Returns
Section titled “Returns”number
emit()
Section titled “emit()”emit(
eventName, …args):boolean
Defined in: packages/messaging/src/shared/event-emitter.ts:44
Parameters
Section titled “Parameters”eventName
Section titled “eventName”string
…unknown[]
Returns
Section titled “Returns”boolean
Inherited from
Section titled “Inherited from”EventEmitter.emit
getDeliveryReport()
Section titled “getDeliveryReport()”getDeliveryReport(
messageId):DeliveryReport|undefined
Defined in: packages/messaging/src/delivery/tracker.ts:347
Get delivery report for a message
Parameters
Section titled “Parameters”messageId
Section titled “messageId”string
Returns
Section titled “Returns”DeliveryReport | undefined
getMessagesByStatus()
Section titled “getMessagesByStatus()”getMessagesByStatus(
status):TrackingRecord[]
Defined in: packages/messaging/src/delivery/tracker.ts:361
Get messages by status
Parameters
Section titled “Parameters”status
Section titled “status”Returns
Section titled “Returns”TrackingRecord[]
getStats()
Section titled “getStats()”getStats():
DeliveryStats
Defined in: packages/messaging/src/delivery/tracker.ts:371
Get delivery statistics
Returns
Section titled “Returns”DeliveryStats
getStatsForPeriod()
Section titled “getStatsForPeriod()”getStatsForPeriod(
startDate,endDate):DeliveryStats
Defined in: packages/messaging/src/delivery/tracker.ts:378
Get delivery statistics for a specific time range
Parameters
Section titled “Parameters”startDate
Section titled “startDate”Date
endDate
Section titled “endDate”Date
Returns
Section titled “Returns”DeliveryStats
getTrackingRecord()
Section titled “getTrackingRecord()”getTrackingRecord(
messageId):TrackingRecord|undefined
Defined in: packages/messaging/src/delivery/tracker.ts:354
Get tracking record for a message
Parameters
Section titled “Parameters”messageId
Section titled “messageId”string
Returns
Section titled “Returns”TrackingRecord | undefined
off(
eventName,listener):this
Defined in: packages/messaging/src/shared/event-emitter.ts:20
Parameters
Section titled “Parameters”eventName
Section titled “eventName”string
listener
Section titled “listener”Listener
Returns
Section titled “Returns”this
Inherited from
Section titled “Inherited from”EventEmitter.off
on(
eventName,listener):this
Defined in: packages/messaging/src/shared/event-emitter.ts:9
Parameters
Section titled “Parameters”eventName
Section titled “eventName”string
listener
Section titled “listener”Listener
Returns
Section titled “Returns”this
Inherited from
Section titled “Inherited from”EventEmitter.on
once()
Section titled “once()”once(
eventName,listener):this
Defined in: packages/messaging/src/shared/event-emitter.ts:35
Parameters
Section titled “Parameters”eventName
Section titled “eventName”string
listener
Section titled “listener”Listener
Returns
Section titled “Returns”this
Inherited from
Section titled “Inherited from”EventEmitter.once
removeAllListeners()
Section titled “removeAllListeners()”removeAllListeners(
eventName?):this
Defined in: packages/messaging/src/shared/event-emitter.ts:57
Parameters
Section titled “Parameters”eventName?
Section titled “eventName?”string
Returns
Section titled “Returns”this
Inherited from
Section titled “Inherited from”EventEmitter.removeAllListeners
removeListener()
Section titled “removeListener()”removeListener(
eventName,listener):this
Defined in: packages/messaging/src/shared/event-emitter.ts:31
Parameters
Section titled “Parameters”eventName
Section titled “eventName”string
listener
Section titled “listener”Listener
Returns
Section titled “Returns”this
Inherited from
Section titled “Inherited from”EventEmitter.removeListener
start()
Section titled “start()”start():
void
Defined in: packages/messaging/src/delivery/tracker.ts:123
Start delivery tracking
Returns
Section titled “Returns”void
stop()
Section titled “stop()”stop():
void
Defined in: packages/messaging/src/delivery/tracker.ts:136
Stop delivery tracking
Returns
Section titled “Returns”void
stopTracking()
Section titled “stopTracking()”stopTracking(
messageId):boolean
Defined in: packages/messaging/src/delivery/tracker.ts:470
Stop tracking a specific message
Parameters
Section titled “Parameters”messageId
Section titled “messageId”string
Returns
Section titled “Returns”boolean
trackMessage()
Section titled “trackMessage()”trackMessage(
messageId,phoneNumber,templateId,provider,options?):Promise<void>
Defined in: packages/messaging/src/delivery/tracker.ts:150
Start tracking a message
Parameters
Section titled “Parameters”messageId
Section titled “messageId”string
phoneNumber
Section titled “phoneNumber”string
templateId
Section titled “templateId”string
provider
Section titled “provider”string
options?
Section titled “options?”initialStatus?
Section titled “initialStatus?”metadata?
Section titled “metadata?”Record<string, unknown>
webhooks?
Section titled “webhooks?”DeliveryWebhook[]
Returns
Section titled “Returns”Promise<void>
updateStatus()
Section titled “updateStatus()”updateStatus(
messageId,status,details?):Promise<boolean>
Defined in: packages/messaging/src/delivery/tracker.ts:234
Update message status
Parameters
Section titled “Parameters”messageId
Section titled “messageId”string
status
Section titled “status”details?
Section titled “details?”clickedAt?
Section titled “clickedAt?”Date
deliveredAt?
Section titled “deliveredAt?”Date
error?
Section titled “error?”{ code: string; details?: Record<string, unknown>; message: string; }
error.code
Section titled “error.code”string
error.details?
Section titled “error.details?”Record<string, unknown>
error.message
Section titled “error.message”string
failedAt?
Section titled “failedAt?”Date
metadata?
Section titled “metadata?”Record<string, unknown>
provider?
Section titled “provider?”string
sentAt?
Section titled “sentAt?”Date
source?
Section titled “source?”"manual" | "provider" | "webhook" | "system"
Returns
Section titled “Returns”Promise<boolean>