infobip/infobip-api-php-client

[ 6.2.1 ] - 2025-01-24

Added

• An option to define the messageId for all channels in Messages API failover flow.
• New voices and languages for Calls API.

Fixed

• Serialization of CallsDtmfOptions, CallsCollectOptions and CallsCallApiOptions in IVR scenario scripts.
• Issue #67: Fetching WhatsApp media metadata methods now return an array that contains header values provided by the API.
  This version provides an additional fix that fully resolves the issue.

Changed

• Field from is no longer required when creating outbound calls.
• Form parameter processing code is refactored and removed from the API methods where it is not needed.

Removed

• A no longer required DISCONNECTED call state.

Added

• An option to define the messageId for all channels in Messages API failover flow.
• New voices and languages for Calls API.

Fixed

• Serialization of CallsDtmfOptions, CallsCollectOptions and CallsCallApiOptions in IVR scenario scripts.
• Issue #67: Fetching WhatsApp media metadata methods now return an array that contains header values provided by the API. This version provides an additional fix that fully resolves the issue.

Changed

• Field from is no longer required when creating outbound calls.
• Form parameter processing code is refactored and removed from the API methods where it is not needed.

Removed

• A no longer required DISCONNECTED call state.

[ 6.2.0 ] - 2025-01-20

⚠️ IMPORTANT NOTE: This release contains breaking changes!

Added

• Support for Calls Configuration.
• Additional validation for WhatsApp sender parameters.
• Support for Email IP Management instead of set of deprecated Email IP endpoints.
  Check Email API documentation for additional details (BREAKING).
• Footer support for Messages API Message. For additional details check Messages API documentation.
• Add calendar event button support for Messages API Message. For additional details check Messages API documentation.
• Card options for Carousel and Rich Link body types in Messages API Message. For additional details check Messages API documentation.
• Support for OTP templates for Viber messages. For additional details check Viber API documentation.
• Support for telemarketerId in India DLT options when sending failover SMS messages through Viber API.
• Support for cache duration when playing audio files by providing the URL to the audio file in Calls API.
• New Call state: DISCONNECTED.
• Support for downloading Voice IVR recorded files. Check the Voice API documentation for additional details.

Changed

• Email Suppression type enum models are now consolidated. Use EmailSuppressionType and EmailAddSuppressionType instead of EmailAddDeleteSuppressionType and Infobip/Model/EmailGetSuppressionType (BREAKING).
• Don't allow empty text when sending failover SMS messages through Viber API.
• Explicitly allow enum denormalization only for string types.
• Extend OneOfInterfaceNormalizer with enum support.
• Adjusted Call Voice models, so both CallsVoice and CallsSynthesisVoice are used in the correct context (BREAKING).
• Adjusted Call Language models, so both CallsLanguage and CallTranscriptionLanguages are used in the correct context (BREAKING).

Fixed

• Issue #67: Fetching WhatsApp media metadata methods now return an array that contains header values provided by the API.
  Check the API Documentation and the ReceiveWhatsAppApiTest for additional details.
• EmailSuppressionInfo model to correctly specify DateTime type for createdDate field.
• Invalid type hints for map-like properties.
• Number Masking:
  • DELETE requests and error processing
  • Content schema when uploading audio files
  • UTC date-time deserialization in setup response model.
• Interactive Voice Response:
  • lastUsageDate filed processing (yyyy-MM-dd format)
  • Adjusted models in script processing

⚠️ IMPORTANT NOTE: This release contains breaking changes!

Added

• Support for Calls Configuration.
• Additional validation for WhatsApp sender parameters.
• Support for Email IP Management instead of set of deprecated Email IP endpoints. Check Email API documentation for additional details (BREAKING).
• Footer support for Messages API Message. For additional details check Messages API documentation.
• Add calendar event button support for Messages API Message. For additional details check Messages API documentation.
• Card options for Carousel and Rich Link body types in Messages API Message. For additional details check Messages API documentation.
• Support for OTP templates for Viber messages. For additional details check Viber API documentation.
• Support for telemarketerId in India DLT options when sending failover SMS messages through Viber API.
• Support for cache duration when playing audio files by providing the URL to the audio file in Calls API.
• New Call state: DISCONNECTED.
• Support for downloading Voice IVR recorded files. Check the Voice API documentation for additional details.

Changed

• Email Suppression type enum models are now consolidated. Use EmailSuppressionType and EmailAddSuppressionType instead of EmailAddDeleteSuppressionType and Infobip/Model/EmailGetSuppressionType (BREAKING).
• Don't allow empty text when sending failover SMS messages through Viber API.
• Explicitly allow enum denormalization only for string types.
• Extend OneOfInterfaceNormalizer with enum support.
• Adjusted Call Voice models, so both CallsVoice and CallsSynthesisVoice are used in the correct context (BREAKING).
• Adjusted Call Language models, so both CallsLanguage and CallTranscriptionLanguages are used in the correct context (BREAKING).

Fixed

• Issue #67: Fetching WhatsApp media metadata methods now return an array that contains header values provided by the API. Check the API Documentation and the ReceiveWhatsAppApiTest for additional details.
• EmailSuppressionInfo model to correctly specify DateTime type for createdDate field.
• Invalid type hints for map-like properties.
• Number Masking:
  • DELETE requests and error processing
  • Content schema when uploading audio files
  • UTC date-time deserialization in setup response model.
• Interactive Voice Response:
  • lastUsageDate filed processing (yyyy-MM-dd format)
  • Adjusted models in script processing

[ 6.1.0 ] - 2024-12-16

Added

• Support for Infobip Moments.

Changed

• Removed no longer supported 50 business-initiated conversations messaging tear limit for WhatsApp senders.
• Added createdAt and lastUpdatedAt fields to WhatsApp Template response models.
• Added new Calls error code type: MACHINE_DETECTED.
• CallRoutingWebRtcEndpoint now allows using default to value used in inbound call as an identity.
• Refactored a part of Calls API tests.

Fixed

• IVR scenario action scripts types.

Added

• Support for Infobip Moments.

Changed

• Removed no longer supported 50 business-initiated conversations messaging tear limit for WhatsApp senders.
• Added createdAt and lastUpdatedAt fields to WhatsApp Template response models.
• Added new Calls error code type: MACHINE_DETECTED.
• CallRoutingWebRtcEndpoint now allows using default to value used in inbound call as an identity.
• Refactored a part of Calls API tests.

Fixed

• IVR scenario action scripts types.

[ 6.0.0 ] - 2024-12-09

⚠️ IMPORTANT NOTE: This release contains breaking changes! From this point onward PHP version 8.0 is no longer supported. Minimum PHP version required is 8.3.

In this release we updated the library to use the latest version of the Infobip API. We also updated the library to use the latest version of the Symfony components. Minimum Symfony
version required is 7.0.

🎉 NEW Major Version of infobip-api-php-client.

Added

• Support for Infobip Messages API.
• Most recent Infobip Voice API feature set.
• Most recent Infobip SMS API feature set.
• Most recent Infobip 2FA API feature set.
• Most recent Infobip MMS API feature set.
• Most recent Infobip Email API feature set.
• Most recent Infobip WhatsApp API feature set.
• Most recent Infobip Viber API feature set.
• Most recent Infobip WebRTC API feature set.
• PHP CS Fixer and PHPStan dev dependencies for code quality checks.
• Additional set of integration tests.

Changed

Dependencies

• Require PHP version 8.3 or higher.
• Bumped Symfony components to the latest major version.

Model changes

• Migration to the new SMS v3 API. Check the [README.md][readme] for updated examples.
  • Introduced the new SmsMessage class to replace SmsTextualMessage and SmsBinaryMessage, providing a unified structure for SMS messaging.
  • Added a content field within SmsMessage to define the message content.
    This supports both textual and binary messages, which can be created using SmsTextContent or SmsBinaryContent, respectively.
  • Unified request classes by replacing SmsAdvancedTextualRequest and SmsAdvancedBinaryRequest with the new SmsRequest class.
  • Consolidated sending functions: use sendSmsMessages instead of the sendSmsMessage and sendBinarySmsMessage functions.
• Across all Call models, the applicationId field has been removed and replaced with the platform field, as encapsulates platform fields and reflects the current state of the endpoint.
  In addition to that, a new required callsConfigurationId field has been added.
• Removed delivery time window configuration classes (SmsDeliveryTimeWindow, MmsDeliveryTimeWindow, ViberDeliveryTimeWindow, CallRoutingAllowedTimeWindow, CallsDeliveryTimeWindow, SmsDeliveryTimeWindow, CallsTimeWindow) in favor of a unified class: DeliveryTimeWindow
• Removed delivery time configuration classes (SmsDeliveryTimeFrom, SmsDeliveryTimeTo, MmsDeliveryTime, ViberDeliveryTime, CallsTimeWindowPoint, WebRtcTimeOfDay, CallRoutingAllowedTimeFrom, CallRoutingAllowedTimeTo, WebRtcTimeOfDay) in favor of a unified class: DeliveryTime
• Removed URL options configuration classes (MessagesApiUrlOptions, ViberUrlOptions, WhatsAppUrlOptions) in favor of a unified class: UrlOptions
• Removed CPaaS X platform configuration classes (ViberPlatform, MessagesApiPlatform) in favor of a unified class: Platform
• Removed delivery day enumeration classes (SmsDeliveryDay, MmsDeliveryDay, CallsDeliveryDay, CallRoutingAllowedDay) in favor of a unified class: DeliveryDay
• Removed validity period configuration classes (ViberValidityPeriod, MessagesApiValidityPeriod) in favor of a unified class: ValidityPeriod
• Removed validity period time unit enumeration classes (ViberValidityPeriodTimeUnit, MessagesApiValidityPeriodTimeUnit) in favor of a unified class: ValidityPeriodTimeUnit
• Removed ModelInterface since it's no longer needed and not used in serialization anymore.

Fixed

• Sending Email to multiple recipients.

⚠️ IMPORTANT NOTE: This release contains breaking changes! From this point onward PHP version 8.0 is no longer supported. Minimum PHP version required is 8.3.

In this release we updated the library to use the latest version of the Infobip API. We also updated the library to use the latest version of the Symfony components. Minimum Symfony version required is 7.0.

🎉 NEW Major Version of infobip-api-php-client.

Added

• Support for Infobip Messages API.
• Most recent Infobip Voice API feature set.
• Most recent Infobip SMS API feature set.
• Most recent Infobip 2FA API feature set.
• Most recent Infobip MMS API feature set.
• Most recent Infobip Email API feature set.
• Most recent Infobip WhatsApp API feature set.
• Most recent Infobip Viber API feature set.
• Most recent Infobip WebRTC API feature set.
• PHP CS Fixer and PHPStan dev dependencies for code quality checks.
• Additional set of integration tests.

Changed

Dependencies

• Require PHP version 8.3 or higher.
• Bumped Symfony components to the latest major version.

Model changes

• Migration to the new SMS v3 API. Check the [README.md][readme] for updated examples.
  • Introduced the new SmsMessage class to replace SmsTextualMessage and SmsBinaryMessage, providing a unified structure for SMS messaging.
  • Added a content field within SmsMessage to define the message content. This supports both textual and binary messages, which can be created using SmsTextContent or SmsBinaryContent, respectively.
  • Unified request classes by replacing SmsAdvancedTextualRequest and SmsAdvancedBinaryRequest with the new SmsRequest class.
  • Consolidated sending functions: use sendSmsMessages instead of the sendSmsMessage and sendBinarySmsMessage functions.
• Across all Call models, the applicationId field has been removed and replaced with the platform field, as encapsulates platform fields and reflects the current state of the endpoint. In addition to that, a new required callsConfigurationId field has been added.
• Removed delivery time window configuration classes (SmsDeliveryTimeWindow, MmsDeliveryTimeWindow, ViberDeliveryTimeWindow, CallRoutingAllowedTimeWindow, CallsDeliveryTimeWindow, SmsDeliveryTimeWindow, CallsTimeWindow) in favor of a unified class: DeliveryTimeWindow
• Removed delivery time configuration classes (SmsDeliveryTimeFrom, SmsDeliveryTimeTo, MmsDeliveryTime, ViberDeliveryTime, CallsTimeWindowPoint, WebRtcTimeOfDay, CallRoutingAllowedTimeFrom, CallRoutingAllowedTimeTo, WebRtcTimeOfDay) in favor of a unified class: DeliveryTime
• Removed URL options configuration classes (MessagesApiUrlOptions, ViberUrlOptions, WhatsAppUrlOptions) in favor of a unified class: UrlOptions
• Removed CPaaS X platform configuration classes (ViberPlatform, MessagesApiPlatform) in favor of a unified class: Platform
• Removed delivery day enumeration classes (SmsDeliveryDay, MmsDeliveryDay, CallsDeliveryDay, CallRoutingAllowedDay) in favor of a unified class: DeliveryDay
• Removed validity period configuration classes (ViberValidityPeriod, MessagesApiValidityPeriod) in favor of a unified class: ValidityPeriod
• Removed validity period time unit enumeration classes (ViberValidityPeriodTimeUnit, MessagesApiValidityPeriodTimeUnit) in favor of a unified class: ValidityPeriodTimeUnit
• Removed ModelInterface since it's no longer needed and not used in serialization anymore.

Fixed

• Sending Email to multiple recipients.

UPDATED package version

Fixed

• Update composer.json to match the package version.

⚠️ IMPORTANT NOTE: This release contains breaking changes!

🎉 NEW Major Version of infobip-api-php-client.

Added

• Support for Infobip MMS API.
• Support for Infobip Voice API.
• Support for Infobip WebRTC API.
• Support for Infobip Viber API.
• Most recent Infobip SMS API feature set.
• Most recent Email feature set.
• Most recent WhatsApp feature set.

Changed

• Fully refactored codebase using Symfony components

⚠️ IMPORTANT NOTE: This release contains breaking changes!

Changed

• The minimum supported PHP version has been changed to 8.0
• Get WhatsApp template / Create WhatsApp template have breaking changes as they're using the new v2 API endpoints. The body and footer are no longer strings but objects.
• getEmailLogs' input parameters sentSince and sentUntil now correctly defined as DateTime type

Added

• Delete WhatsApp template

Fixed

• PHP 8 deprecation issues

Added

• Support for Infobip WhatsApp API

Changed

• Renamed EmailLogResponse to EmailLogsResponse
• Added default value of false for parameter flash in SmsTextualMessage

Removed

• Dev dependencies
• Unused models

Added

• Support for Infobip Email API

Changed

• Update Guzzle HTTP client version from 6.5 to 7.3

🎉 NEW Major Version

⚠️ IMPORTANT NOTE: This release contains breaking changes!

In this release, the library is vastly changed and modernized. It is auto-generated and completely different from the previous version, so we do not provide an upgrade guide from 2.x to 3.x because such a document will be a similar size as the library itself.

Added

• Support for async execution
• CONTRIBUTING.md containing guidelines for creating GitHub issues
• Support for Infobip Two-factor Authentication API

Changed

• Models, structure, examples, etc. for Infobip SMS API
• Library dependencies
• README.md which contains necessary data and examples for quickstart as well as some other important pieces of information on versioning, licensing, etc.
• LICENSE which is now MIT

Removed

• Support for Infobip Omni API (to be included back in one of the next releases)