Class NumbersCallbackWebhooks

Index

Constructors

Methods

parseEvent validateAuthenticationHeader parseEvent

Constructors

constructor

new NumbersCallbackWebhooks(callbackSecret: string): NumbersCallbackWebhooks
Parameters
- callbackSecret: string
Returns NumbersCallbackWebhooks

Methods

parseEvent

parseEvent(eventBody: any): CallbackPayload
Reviver for a Numbers Event. This method ensures the object can be treated as a Numbers Event and should be called before any action is taken to manipulate the object. Indeed, the server returns the timestamp without the timezone information => this method updates the property value to use the Zulu timezone and changes the parameters to a Date
Parameters
- eventBody: any
  The event body containing the numbers event notification.
Returns CallbackPayload
- The parsed voice event object.
Implementation of CallbackProcessor.parseEvent

validateAuthenticationHeader

validateAuthenticationHeader(
    headers: IncomingHttpHeaders,
    body: any,
    _path?: string,
    _method?: string,
): boolean
Validate authorization header for callback request
Parameters
- headers: IncomingHttpHeaders
  Incoming request's headers
- body: any
  Incoming request's body
- Optional_path: string
  Incoming request's path
- Optional_method: string
  Incoming request's HTTP method
Returns boolean
- true if the X-Sinch-Signature header is valid
Implementation of CallbackProcessor.validateAuthenticationHeader

`Static`parseEvent

parseEvent(eventBody: any): CallbackPayload
Static reviver for a Numbers Event. This method ensures the object can be treated as a Numbers Event.
Parameters
- eventBody: any
  The event body containing the Numbers event notification.
Returns CallbackPayload
- The parsed Numbers event object