Skip to content

Latest commit

 

History

History
587 lines (427 loc) · 30.9 KB

CHANGELOG.md

File metadata and controls

587 lines (427 loc) · 30.9 KB

Change Log

v4.75.7 (2026-02-18)

Feature - Campaign API optional fields support

  • Added sample3, sample4, sample5 optional sample message fields to Campaign create and update methods
  • Added termsAndConditionsLink and privacyPolicyLink optional fields to Campaign create and update methods

v4.75.6 (2026-01-21)

Feature - HA Number support

  • Added haEnabled optional parameter to phone number buy method
  • Added fallbackNumber field to BuyNumberResponse

v4.75.5 (2026-01-13)

Feature - Profile API business_contact_email support

  • Added business_contact_email parameter support to Profile create and update methods for PUBLIC entity types

v4.75.4 (2026-01-06)

Feature - Typescript definition for list endpoints function

  • Added Typescript definition for list endpoints function params

v4.75.3 (2025-11-27)

Feature - TypeScript Definitions for Missing APIs

  • Added TypeScript definitions for Profile API
  • Added TypeScript definitions for Brand API
  • Added TypeScript definitions for Campaign API
  • Added TypeScript definitions for MultiPartyCall API

v4.75.2 (2025-10-15)

Feature - Compliance application rejection reason

  • Added rejectionReason to compliance application responses (get, create)
  • Updated TypeScript definitions to include rejectionReason

v4.75.1 (2025-07-21)

Feature - Comprehensive Compliance APIs TypeScript Support

  • Added missing submit method for compliance applications
  • Fixed property name inconsistencies (endUserID → endUserId, ComplianceRequirementId → complianceRequirementId, documentTypeID → documentTypeId)
  • Corrected property types (endUserType: object → endUserType: string)
  • Fixed class name consistency (ListComplianceDocumentResponse → ListComplianceDocumentsResponse)
  • Improved return type accuracy for delete methods (Promise<unknown> → Promise<boolean>)
  • Added missing properties and removed incorrect ones in compliance document responses
  • Enhanced TypeScript definitions to match JavaScript implementations for better type safety and IntelliSense support

v4.75.0 (2025-07-07)

Bug Fix - Update Number API

  • Fixed the issue where the subaccount parameter was not being updated in the Plivo Number API in node SDK

v4.74.0 (2025-06-20)

Feature - New Param added for Dial XML.

  • Added support for two new elements - callerId and callerName - in Number and User element in Dial XML

v4.73.0 (2025-06-20)

Feature - New Param added for MPC - Update participant state API.

  • Support disable_state_change_sound in MPC - Update participant state API.

v4.72.0 (2025-06-16)

Bug Fix - sendDigits validation issue

  • Fixed isRequired validator to properly handle falsy values including the number 0, resolving "Missing mandatory field: digits" error when sending digit "0"
  • Updated TypeScript definitions for sendDigits method to accept string instead of number to match API expectations and existing tests

v4.71.0 (2025-06-13)

Bug Fix

  • Added HTTP/HTTPS agent configuration with connection pooling to prevent progressive API latency increase.
  • Fixed memory leak in retryWrapper interceptors that accumulated over time causing CPU spikes and performance degradation.
  • Improved resource cleanup in voice request handling to maintain stable memory usage and eliminate need for server restarts

v4.70.0 (2025-04-30)

Feature - New Param added for Start Recording API.

  • Support record_channel_type in Start Recording API and recordChannelType in Record XML.

v4.69.6 (2025-03-18)

Vulnerabilities Fix

  • Update library: Axios

v4.69.5 (2025-02-25)

Feature - Supporting parameter_name in WhatsApp Template .

  • Supporting parameter_name in WhatsApp Template .

v4.69.4 (2025-02-18)

Feature - Throw GeoPermissionException on synchronous geopermissions error

v4.69.3 (2024-12-12)

Feature - Typescript support for verify session

  • Added typescript support for verify session

v4.69.2 (2024-10-23)

Feature - FraudCheck param in Create, Get and List Session

  • Support for the fraud_check parameter in sms verify session request
  • Added support for fraud_check in GET and LIST verify session.

v4.69.1 (2024-10-10)

Feature - Dtmf param in Create, Get and List Session

  • Support for the dtmf parameter in voice verify session request
  • Added support for dtmf in GET and LIST verify session.

v4.69.0 (2024-09-30)

**Feature - Adding new param support for Number Masking session with single party **

  • Added create_session_with_single_party, virtual_number_cooloff_period and force_pin_authentication attributes in Masking Session

v4.68.3 (2024-09-06)

Feature - Adding more attribute on mdr object

  • Added message_sent_time, message_updated_time and error-message on get and list Message API

v4.68.2 (2024-09-06)

Feature - Adding support for brand_name and app_hash in Create,Get and List Session

  • Added new request param brand_name and app_hash in create Session API
  • Added support for brand_name and app_hash param in get and list Session response

v4.68.1 (2024-09-03)

**Feature - Adding new element for Audio Stream XML **

  • Added keepCallAlive element in Audio Stream XML

v4.68.0 (2024-07-11)

Feature - Locale param supported for Create, Get and List Verify Session API's

  • Added new request param locale in create Session API
  • Added support for locale param in get and list Session response

v4.67.0 (2024-05-22)

Feature - Adding support for participant level recording

  • Added new param recordParticipantTrack to add participant API to support participant level recording
  • Added new param recordTrackType in start/stop/pause/resume to support participant level recording

v4.66.0 (2024-05-17)

Feature - Adding support for location whatsapp messages

  • Added new param location to send message API to support location whatsapp messages
  • Added new param location in templates to support location based templated messages

v4.65.0 (2024-05-07)

Feature - Adding support for interactive whatsapp messages

  • Added new param interactive to send message API to support interactive whatsapp messages

v4.64.0 (2024-04-04)

Vulnerabilities Fix

  • Axios Cross-Site Request Forgery Vulnerability Fix.

v4.63.0 (2024-05-02)

Feature - Pin Based Authentication, SubAccount and GeoMatch for Number Masking

  • Pin Based Authentication, SubAccount and GeoMatch added in Create Session API for Number Masking

v4.62.0 (2024-04-18)

Feature - Support for dynamic button components when sending a templated WhatsApp message

  • Added new param payload in templates to support dynamic payload in templates

v4.61.0 (2024-03-13)

Feature - Import Campaign API

  • Import Campaign API endpoint added

v4.60.2 (2024-02-29)

Feature - Log Redaction Enhancement

  • Added log attribute in GET and List MDR response
  • Change log field from bool to string in send SMS

v4.60.1 (2023-11-28)

Bug Fix - JWT Token Creation Issues

  • Fix for incorrect token getting created when generated using TypeScript

v4.60.0 (2023-11-08)

[BETA] Feature - TollFree Verification API Support

  • API support for Create, Update, Get, Delete and List Tollfree Verification.
  • Added New Param toll_free_sms_verification_id and toll_free_sms_verification_order_status in to the response of the [list all numbers API], [list single number API]
  • Added toll_free_sms_verification_order_status filter to AccountPhoneNumber - list all my numbers API.

v4.59.0 (2023-10-19)

Feature - Verify Caller ID

  • API support for verifying, updating, getting and deleting caller IDs.

v4.58.0 (2023-10-16)

Introducing camapign_source field

  • campaign_source field added for LIST / GET

v4.57.0 (2023-09-21)

Support starter brand

  • OTP validation
  • starter brand creation

v4.56.2 (2023-09-01)

Bug fix - Unable to build TypeScript on Version 4.56.0

  • Fix TypeScript build error

v4.56.1 (2023-09-01)

Bug Fix - unrent powerpack number

  • Fix for Error: invalid powerpack number delete request (400) - Unrent Powerpack Number

v4.56.0 (2023-08-25)

Feature - Added New Param 'carrier_fees', 'carrier_fees_rate', 'destination_network' in Get Message and List Message APIs

  • Added new params on message get and list response

v4.55.0 (2023-08-10)

Verify Service API's

  • Create Session API - To initiate a session
  • Get Session API - Get session detail
  • List Session API - List Session details
  • Validate Session API

v4.54.0 (2023-08-07)

Feature - WhatsApp message support

4.53.0 (2023-08-03)

Feature - DLT parameters

4.52.0 (2023-07-31)

Feature - Number Masking

  • Added Create, Delete, Update, Get and List Masking Session API

v4.51.0 (2023-07-07)

Fix Intermediate GET request failure

  • GET API request body removed

v4.50.0 (2023-06-28)

Feature - Audio Streaming

  • Audio Stream over Call added API to start and stop streaming on a live call and get details of running or stopped streams. Also implemented the ability to generate stream XML.

4.49.0 (2023-06-02)

Feature - CNAM Lookup

  • Added New Param cnam_lookup in to the response of the [list all numbers API], [list single number API]
  • Added cnam_lookup filter to AccountPhoneNumber - list all my numbers API.
  • Added cnam_lookup parameter to buy number[Buy a Phone Number] to configure CNAM Lookup while buying a US number
  • Added cnam_lookup parameter to update number[Update an account phone number] to configure CNAM Lookup while buying a US number

4.48.0 (2023-03-16)

Feature : Adding new param in getCallDetails API

  • Added CNAM (Caller_id Name) details at CDR level.

v4.47.0 (2023-05-29)

v4.46.1 (2023-05-08)

Chore - Bump xml2js from 0.4.19 to 0.5.0

4.46.0 (2023-05-04)

Adding new attribute - 'renewalDate' in Get Number and List Numbers APIs

4.45.0 (2023-04-25)

Adding new attribute - 'isDomestic' in Get Message and List Message APIs

v4.44.0 (2023-04-11)

Feature - Added New Param 'source_ip' in GetCall and ListCalls

4.43.0 (2023-03-14)

Adding new status code - Hosted Messaging order

  • Added new status code for create hosted messaging order.

4.42.0 (2023-03-07)

Bug fix - 'text' parameter should be optional for MMS

  • Make text as an optional parameter for sending MMS.
  • Fix code breaking due to undefined error.response while accessing response status property.

4.41.0 (2023-03-03)

Adding new attribute - 'isDomestic' in Get Message and List Message APIs

4.40.0 (2023-02-23)

**Feature - Enhance MDR filtering capabilities **

  • Added new fields on MDR object response

v4.39.0 (2022-01-25)

Feature - Added New Param(requesterIP) in Get Message and List Mssage APIs

v4.38.0 (2023-01-18)

Feature - Added New Param(Message Expiry) in Send Message API

  • Added new param(Message Expiry) in Send Message API

v4.37.0 (2022-12-16)

Update Campaign Request

  • Update Campaign Request endpoint added

v4.36.0 (2022-12-06)

Delete Brand and Campaign Request

  • Delete Brand and Campaign Request endpoint added

v4.35.0 (2022-11-04)

Brand Usecase Request

  • Brand Usecase Request endpoint added

v4.34.3 (2022-11-07)

Bug fix - List all Endpoint

  • Removed duplicate responses

v4.34.2 (2022-10-17)

List Endpoint query param support

  • Adding limit and offset to fetch list of endpoints.

v4.34.1 (2022-09-28)

10DLC campaign creation

  • Adding more attributes to campaign creation request.

v4.34.0 (2022-08-07)

Feature - Token Creation

  • JWT Token Creation API added API to create a new JWT token.

v4.33.0 (2022-07-11)

Feature - STIR Attestation

  • Add stir attestation param as part of Get CDR and Get live call APIs Response

v4.32.1 (2022-06-09)

Bug fix - Typescript

  • Make a call API response to support the parameter requestUuid of data types Array<string> and string.

v4.32.0 (2022-05-05)

Features - List all recordings

v4.31.0 (2022-04-27)

Feature - 10DLC API callback

  • Added callback support for campaign, brand, link number request.

v4.30.0 (2022-04-14)

Features - Profile Api

  • Profile api added for 10dlc support

v4.29.1 (2022-03-25)

Bug Fix - DialElement

v4.29.0 (2022-03-25)

Features - DialElement

v4.28.0 (2022-02-23)

Features - Numbers: Hosted Messaging API

  • Add support for Hosted Messaging APIs.

v4.27.0 (2022-02-02)

Features - MPCStartCallRecording

  • Parameter change from statusCallback to recordingCallback

v4.26.1 (2022-01-21)

Bug Fix

  • Making AppId non mandatory for Buy number and update number APIs(#234)

v4.26.0 (2021-12-14)

Features - Voice

  • Routing SDK traffic through Akamai endpoints for all the Voice APIs

v4.25.1 (2021-12-08)

Bug Fix

  • Handling undefined response error from axios.
  • Timeout has been eliminated for messaging requests.

v4.25.0 (2021-12-02)

Features - Messaging: 10DLC API

  • 10DLC API's for brand and campaign support

v4.24.0 (2021-11-30)

Features - Voice: Multiparty calls

  • The Add Multiparty Call API allows for greater functionality by accepting options like start recording audio, stop recording audio, and their HTTP methods.
  • Multiparty Calls now has new APIs to stop and play audio.

v4.23.1 (2021-10-13)

Bug Fix

v4.23.0 (2021-10-11)

Features - Messaging

  • This version includes advancements to the Messaging Interface that deals with the Send SMS/MMS interface, Creating a standard structure for request/input arguments to make implementation easier and incorporating support for the older interface.

Example for send SMS

v4.22.4 (2021-09-27)

Bug Fix

  • Handle invalid destination number API response for send SMS API.

v4.22.3 (2021-09-22)

Bug Fix

  • Fix Typings for Make call & Send SMS API response.

v4.22.2 (2021-09-16)

  • Typescript import fix.

v4.22.1 (2021-09-08)

  • Fix on voice GET request and exception handle.

v4.22.0 (2021-08-17)

v4.21.0 (2021-08-05)

  • Fixed a Typescript warning about base interpretation.
  • Add retrievable object responses support for Retrieve a Power pack API.

v4.20.1 (2021-07-27)

  • Updates to add a member a multi-party call API.
    • Remove validation range for delay and ringtimeout parameters.
    • Add appropriate error message for multiple ringtimeout and delaydial values.
  • Updated default HTTP client request timeout to 5 seconds.

v4.20.0 (2021-07-13)

v4.19.2 (2021-07-08)

  • MPC SDK fixes to pass params in a user-friendly manner.

v4.19.1 (2021-07-05)

  • WARNING: Removed the total_count parameter in meta data for list MDR response

4.19.0(2021-07-02)

  • Added CallerName param in AddParticpant
  • Added support for Parallel behaviour of RingTimeout and Delaydial.
  • Added support for Recording at Member Level

4.18.1(2021-06-25)

  • Fixed the mms media upload functionality

4.18.0(2021-06-15)

  • Added stir verification param as part of Get CDR and live call APIs

4.17.1(2021-05-06)

  • Added Fix for Adaptive Powerpack Create & Update functions

4.17.0(2021-05-04)

  • Update library: Axios
  • Add Exception Support
  • Updated README

4.16.0(2021-04-19)

  • Added SDK support for Voice MultiPartyCall APIs and XML

4.15.0(2021-04-19)

  • Add support for Regulatory Compliance APIs.
  • Add "npanxx" and "local_calling_area" support for Search Phone Number.

4.14.3(2021-03-26)

  • Fix bug on stopRecording and all voice API flows post Typescript changes.

4.14.2(2021-02-17)

  • Fix duplicate call issue for make call API.

4.14.1(2021-02-09)

  • Fix Buy Number API & env variables support for TypeScript.

4.14.0(2021-01-29)

  • Add axios as HTTP client library.

4.13.0(2021-01-19)

  • Add TypeScript support.

4.12.0(2020-11-17)

  • Add number_priority support for Powerpack API.

4.11.0(2020-10-30)

  • Change lookup API endpoint and response.

4.10.0(2020-09-21)

  • Add Lookup API support.

4.9.0(2020-08-25)

  • Add Powerpack for MMS

4.8.0(2020-07-23)

  • Add retries to multiple regions for voice requests.

4.7.0(2020-05-28)

  • Add JWT helper functions.

4.6.0(2020-04-29)

  • Add V3 signature helper functions.

4.5.2(2020-04-28)

  • Fix List Conferences API response.

4.5.1(2020-04-13)

  • Fix Cannot read property 'hasOwnProperty' of undefined error.

4.5.0(2020-03-31)

  • Add application cascade delete support.

4.4.0(2020-03-30)

  • Add Tollfree support for Powerpack

4.3.0(2020-03-27)

  • Add post call quality feedback API support.

4.2.0(2020-02-25)

  • Add Media support.

4.1.9(2020-02-12)

  • Fix end_time_gte param in Retrieve a call API.

4.1.8(2019-12-20)

  • Add Powerpack support.

4.1.7(2019-12-04)

  • Add MMS support.

4.1.6(2019-11-14)

  • Fix list APIs to return meta in response.

4.1.5(2019-11-13)

  • Add GetInput XML support

4.1.4(2019-11-06)

  • Add SSML support

4.1.3(2019-07-30)

  • Add proxy-support for Signature Validation
  • Add HTTP status codes in responses

4.1.2(2019-03-19)

  • Add support: Handling circular reference stringify logic

4.1.1(2019-03-11)

  • Add PHLO support
  • Add Multiparty call triggers

4.0.6(2019-02-04)

  • Bugfix: ListAllMessages API: Fixed filter-by message_time parameter.

4.0.5(2018-11-21)

  • Add sub-account cascade delete support.

4.0.4(2018-10-29)

  • Add live calls filtering by from, to numbers and call_direction.

4.0.3(2018-09-18)

  • Queued status added for filtering calls in queued status.
  • Added log_incoming_messages parameter to application create and update.

4.0.2(2018-08-14)

  • Add Powerpack option for sending messages.

4.0.1(2018-06-28)

  • Fix create subaccount method to enable subaccount while creation

4.0.0(2018-01-18)

  • Add timeout support while making the API requests
  • Add meta property to list responses

4.0.0-beta.1(2017-10-24)

  • The new SDK works with Node.js >= 4. It has been tested against the versions 4, 5, 6, 7 and 8.
  • The API interfaces are consistent and guessable
  • Handles pagination automatically when listing all objects of a resource
  • The new SDK has excellent IDE support

0.4.1(2017-02-28)

  • Bugfix: validate signature middleware

0.4.0(2016-09-09)

  • Added an entry to the .gitignore for WebStorm IDE's, this prevents un-needed files from being checked in.
  • Updated Request to version 2.71.0
  • Some logic for how JSON serialazation has changed, I have updated the request method to reflect that changed
  • Updated xmlBuilder to 8.0.0
  • Slight update to syntax for creating a new xml doc : xmlBuilder.begin().ele(this.element);
  • Had to update Utility.areEqual to reflect a change in how xmlBuild stores values of child elements
  • Updated nock to version 8.0.0,
  • Updated Mocha to 2.4.5
  • Fix Travis tests (node v6 and v4)

Other changes

  • 2015-01-14 Adds support for PhoneNumber API
  • 2013-09-25 Added relayDTMF to and async to
  • 2013-07-23 addRecord Response mandatory parameter 'body' dropped
  • 2013-02-23 pricing API added