Class PlivoVoiceProvider

webhookIdentity

• get webhookIdentity(): "legacy" | "stable-v1"

• Declares whether callback ids satisfy the durable manager contract.

  Returns "legacy" | "stable-v1"

constructor

• new PlivoVoiceProvider(config): PlivoVoiceProvider

• Parameters

  • config: PlivoVoiceProviderConfig

    Plivo credentials and optional overrides.

  Returns PlivoVoiceProvider

verifyWebhook

• verifyWebhook(ctx): WebhookVerificationResult

• Verify an incoming Plivo webhook request using HMAC-SHA256 (v3 scheme).

  Computes computePlivoV3Signature over the request's method, URL and fields (read by readPlivoRequest, as parseWebhookEvent reads them) in both SDKs' texts (see PlivoCanonicalStyle) and compares each in constant time with every signature listed in X-Plivo-Signature-V3 and X-Plivo-Signature-Ma-V3.

  Parameters

  • ctx: WebhookContext

    Raw webhook request context.

  Returns WebhookVerificationResult

  Verification result with valid: true if a signature matches.

parseWebhookEvent

• parseWebhookEvent(ctx): WebhookParseResult

• Parse a Plivo webhook into normalized NormalizedCallEvents.

  Fields come from readPlivoRequest and plivoEventFields, as the signature check reads them: a GET callback's query, otherwise the URL-encoded or JSON body.

  Plivo uses two naming conventions for the same fields:

  • PascalCase (CallUUID, CallStatus, Digits) in URL callbacks.
  • snake_case (call_uuid, call_status) in some API responses. Both are checked for maximum compatibility.

  In carrier mode each event carries a stable id from stableCarrierEvents and the callback's RequestUUID; a DTMF event's occurrence is the signed SequenceNumber or Timestamp, else the callback URL's event_key, and a DTMF event with none throws.

  Parameters

  • ctx: WebhookContext

    Raw webhook request context.

  Returns WebhookParseResult

  Parsed result containing zero or more normalized events.

initiateCall

• initiateCall(input): Promise<InitiateCallResult>

• Initiates a call, retaining a separate request id until a verified callback binds the call leg.

  Parameters

  • input: InitiateCallInput

  Returns Promise<InitiateCallResult>

hangupCall

• hangupCall(input): Promise<void>

• Cancels pending requests through Request; real call ids use the existing Call endpoint.

  Parameters

  • input: HangupCallInput

  Returns Promise<void>

playTts

• playTts(input): Promise<void>

• Refuses pending request ids; speaks only to a bound carrier call.

  Parameters

  • input: PlayTtsInput

  Returns Promise<void>

Readonly name