Class PlivoVoiceProvider

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).

  Algorithm (step by step)

  1. Extract the X-Plivo-Signature-V3-Nonce and X-Plivo-Signature-V3 headers.
  2. Build the signed data string: {fullRequestURL}{nonce}. Note: the POST body is NOT included in the signed data (unlike Twilio).
  3. Compute HMAC-SHA256(authToken, signedData).
  4. Base64-encode the digest.
  5. Compare with the X-Plivo-Signature-V3 header.

  Parameters

  • ctx: WebhookContext

    Raw webhook request context.

  Returns WebhookVerificationResult

  Verification result with valid: true if the signature matches.

parseWebhookEvent

• parseWebhookEvent(ctx): WebhookParseResult

• Parse a Plivo webhook body into normalized NormalizedCallEvents.

  Plivo sends most webhooks with URL-encoded bodies, but some callbacks may arrive as JSON. This parser handles both formats by inspecting whether the body starts with { (JSON) or not (form-encoded).

  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.

  Parameters

  • ctx: WebhookContext

    Raw webhook request context.

  Returns WebhookParseResult

  Parsed result containing zero or more normalized events.

initiateCall

• initiateCall(input): Promise<InitiateCallResult>

• Initiate an outbound call via the Plivo Call API.

  POSTs a JSON body to /v1/Account/{authId}/Call/ with the caller, callee, and answer URL. Returns the request_uuid as the provider call ID.

  Parameters

  • input: InitiateCallInput

    Call initiation parameters (from/to numbers, webhook URL).

  Returns Promise<InitiateCallResult>

  Result containing the Plivo request_uuid on success.

  Throws

  Never throws; returns { success: false, error: '...' } on failure.

hangupCall

• hangupCall(input): Promise<void>

• Hang up an active call using the Plivo Call DELETE endpoint.

  Plivo uses HTTP DELETE to terminate a call (unlike Twilio's POST with Status=completed or Telnyx's POST to /actions/hangup). This is a RESTful convention where deleting the call resource ends the call.

  Parameters

  • input: HangupCallInput

    Contains the Plivo call_uuid to hang up.

  Returns Promise<void>

playTts

• playTts(input): Promise<void>

• Speak text into a live call using the Plivo Speak API.

  POSTs a JSON body to /v1/Account/{authId}/Call/{callUuid}/Speak/ with the text, voice (default 'WOMAN'), and language (default 'en-US').

  Parameters

  • input: PlayTtsInput

    TTS parameters (text, optional voice, call ID).

  Returns Promise<void>

Readonly name