All notable changes to the Sinch Java SDK are documented in this file.

Tag legend

• [feature] — new capability
• [fix] — bug fix
• [deprecation notice] — will be removed in a future release
• [dependency] — third-party library update
• [doc] — documentation only
• [test] — test coverage
• [refactor] — internal restructuring
• [releasing] — release infrastructure
• [design] — API design change
• [tech] — technical improvement

• see MIGRATION-GUIDE

• [dependency] Updated maven-model dependency to 3.9.14 or more recent version to fix security vulnerabilities #8

• [feature] Support Project Settings API
• [feature] Support Contacts Identity Conflicts API
• [feature] [Messages] Support new direction query parameter for MessagesListQueryParameters
• [feature] [Messages] Support listLastMessagesByChannelIdentity API
• [feature] [KakaoTalk] Support COMMERCE and CAROUSEL_COMMERCE channel specific message
• [feature] [LINE] Support NOTIFICATION_MESSAGE_TEMPLATE channel specific message
• [deprecation notice] [OrderDetailsSettings] PaymentSettings deprecated in favor of PaymentButtons

• [feature] Support VerificationSmsDeliveredEvent webhook events
• FlashCall
  • [feature] VerificationStartRequestFlashCall support interceptionTimeout and additionalProperties
  • [feature] VerificationStartResponseFlashCall support additionalProperties
  • [feature] VerificationRequestEventResponseFlashCall support interceptionTimeout and additionalProperties
• PhoneCall
  • [feature] VerificationStartRequestPhoneCall support additionalProperties
  • [feature] VerificationRequestEventResponsePhoneCall support additionalProperties
• SMS
  • [feature] VerificationStartResponseSms support codeType and additionalProperties
  • [feature] VerificationRequestEventResponseSms support codeType, expiry and additionalProperties
• WhatsApp
  • [feature] [BETA] Support WhatsApp verification method

• [feature] Support new DICE reason values

• [fix] Issue #273: Fix NPE when handling 401 response without a token expired header

• [dependency] Bump Jackson dependency to '2.19.0'
• [dependency] Bump generated sources based onto generator '7.13'
• [dependency] Bump maven-gpg-plugin used to sign released artifacts to '1.6'
• [releasing] Migration to replace deprecated OSSRH in favor of SonaType Central
• [test] Activate parallel mode for unit tests

• [fix] Specifications fixed:
  • TemplateMessage.OmniTemplate field is now requiring a TemplateReference with version field filled.
  • TemplateMessage.ChannelTemplate still use a TemplateReference with version field not required. To avoid breaking changes and namespace pollution, SDK is accepting a common TemplateReference instance and validation about the required version field won't be performed at client level by client, but will validate at backend level after having sent the request.
• [feature] Reason.channel_code field added (only for supported by WhatsApp)
• [deprecation notice] Emit a warning log onto using default region for Conversation (US). To avoid regulation issue, defaulting to US will no longer be supported in future version and defining the region will be required.
• [test] Clean Jackson cache during unit tests

• [feature] copyVersion API based now return version field in place of deprecated template one
• [doc] Improve Javadoc rendering by separating summary and notes
• [deprecation notice] Emit a warning log onto using default region for Mailgun (US). To avoid regulation issue, defaulting to US will no longer be supported in future version and defining the region will be required.

• [feature] Support Emergency Address
• [feature] Add new API rent(phoneNumber) without configuration
• [feature] Switch from 'Basic' to 'OAuth' auth
• [deprecation notice]
  • list(ActiveNumberListRequest) replaced by list(ActiveNumbersListQueryParameters)
  • searchForAvailableNumbers(AvailableNumberListRequest) replaced by searchForAvailableNumbers(AvailableNumbersListQueryParameters)
  • list(AvailableRegionListRequest) replaced by list(AvailableRegionsListQueryParameters)
• [refactor] Voice configuration RTC is optional onto requests. No effect at SDK interface level
• [refactor] Move to facade pattern and consume APIs from generator

• [doc] Improve Javadoc rendering by separating summary and notes
• [deprecation notice] Emit a warning log onto using default region for SMS (US). To avoid regulation issue, defaulting to US will no longer be supported in future version and defining the region will be required.

• [test] Extend end-to-end tests against notify
• [feature] Support SVAML connectStream action
• [feature] Support asynch field for amdRequest
• [feature] Define two new values for AnsweringMachineDetection.Reason enum

• [feature] Lazy HTTP client initialization until really required

• [feature] Relax domains init for Webhooks when credentials are not required
• [feature] Validation against missing required property at protocol level

• [fix] CardMessage.media_message is now of MediaMessage type
• [feature] New ListMessage.media field is supported
• [feature] New SG (Singapore) country defined for WhatsApp order payment details
• [feature] New ConversationChannelCredentials.credential_ordinal_number field is supported
• [feature] New LineEnterpriseCredentials is supported
• [feature] New LineCredentialsField.isDefault field is supported
• [feature] New SendMessageRequest.message_content_type is supported (enum of MessageContentType)
• [feature] New ChannelSpecificMessage classes for WhatsApp:
  • OrderDetails
  • OrderStatus
• [deprecation notice] CardMessageMedia class is deprecated in favor of shared MediaMessage

• [feature] Support "Emails"
• [feature] Support "Templates"

• [fix] contentType VS content_type JSON field name for MediaMessageBodyDetails at protocol level
• [fix] Body requests defined as required at protocol level
• [fix] UpdateBinaryRequest.udh field is required at protocol level
• [feature] DryRunPerRecipientDetails.encodingEnum defined as an enum
• [feature] List batches query parameters is accepting a list from values of code
• [deprecation notice] List batches query parameters accepting a single from value (replaced by function above)
• [deprecation notice] DryRunPerRecipientDetails.encoding is deprecated in favor of DryRunPerRecipientDetails.encodingEnum

• [feature] Define AnsweringMachineDetection used by AnsweredCallEvent and NotificationEvent
• [feature] conferenceId field is supported by
  • AnsweredCallEvent
  • DisconnectCallEvent
  • IncomingCallEvent
  • NotificationEvent
  • PromptInputEvent
• [feature] NotificationEvent support destination and amd fields
• [deprecation notice] AnsweredCallEventAnsweringMachineDetection is replaced by AnsweringMachineDetection
• [deprecation notice] Following backend endpoint deprecation applications.queryNumber is deprecated

• [fix] CardMessage
  • CardMessage.media field is of MediaMessage type (see Javadoc)
  • CardMessageMedia class is deprecated (see Javadoc)

• [dependency] Updated Jackson dependency to jackson-jakarta-rs-providers v2.18.2

• [feature] Versioned access to SMS services
• [deprecation notice] Un-versioned access to SMS services (see SMS migration guide)

• [fix] Channel specific message (Messenger / FLOWS) fix for serialization/de-serialization
• [fix] List ChoiceItem.media field fix for serialization/de-serialization

• [deprecation notice] Un-versioned access to Numbers services (see Numbers migration guide)

• [deprecation notice] Un-versioned access to Verification services (see Verification migration guide)

• [deprecation notice] Un-versioned access to Voice services (see Voice migration guide)

• [feature] Support V1 design
• [feature] Follow specification update for SVAML PlayFiles.locale, field is no longer required
• [fix] Webhooks callbacks validation use case-insensitive headers (validateAuthenticationHeader)
• [test] Extend tests coverage (introduced end-to-end tests)

• [feature] Specification update for VoiceConfiguration.scheduledProvisioning defined as readOnly
• [feature] Specification update for SmSConfiguration.scheduledProvisioning defined as readOnly

• [fix] Enable list of parameters grouped by duplicated keys

• [fix] Generated sources with OptionalValue getter: guard against uninitialized value
• [feature] Contains serializer/deserializer to be used for delegation pattern
• [feature] Enhanced javadoc content

• [feature] Store SDK related information within sources

• [feature] Support Conversation API

• [feature] Helper function for webhook authentication header
• [feature] readOnly fields are no longer sent over network

• [feature] Align with updated specs for DryRun

• [fix] Enforce webhooks validation logic for empty or missing authorization header

• [fix] Enable list of parameters grouped by duplicated keys

• [feature] Support additional properties onto Start verification by SMS

• [fix] UTF-8 encoding for body payloads.

• [fix] Add missing WebHooksService.validateAuthenticationHeader function for Numbers

Starting with version 1.2, Numbers domain now support versioned access by using the v1() API calls. The existing non-versioned services will no longer be updated with new features/fields.

• [design] New versioned service simplified access to available or active: APIs are accessible directly under v1()
• [feature] FAX & EST number's configuration. The VoiceConfiguration and ScheduledVoiceProvisioning models have been updated to reflect the "Unified Numbers" API updates: they now hold values for Fax and Elastic SIP Trunking configuration (respectively with the properties serviceId and trunkId).

• [doc] Error message related to invalid configuration (credentials) fixed

With version 1.1 we are moving to support versioned domain access.

Starting with the Verification domain, you can access services by using the v1() API calls. The existing non-versioned services will no longer be updated with new features/fields.

• [feature] [Design] Non-versioned Verification domain is split into dedicated Start and Report new versioned services

• [feature] Synchronization with documentation terms

  • Callout related fields and APIs are now named Phone Call
  • Seamless related fields and APIs are now named Data

• [feature] Start Verification

  • VerificationStartRequestSms
    • Support Accept-Language option
    • Support code type option
    • Support expiry option
  • VerificationStartRequestPhoneCall
    • Support speech option
  • VerificationStartResponseData
    • [fix] targetUri field added

• [feature] Verification Report

  • [fix] VerificationReportResponse: Report service no longer returns a common status response shared with status service, but a dedicated verification report response.

• [feature] Webhooks

  • [deprecation notice] VerificationRequestEvent.acceptLanguage field is deprecated

• [tech] Logs

  • Reduce logging severity related to phone number not compliant with E164 format

• [feature] Support Numbers API (SDK doc)
• [feature] Support SMS API (SDK doc). Support both unified credentials (projectId) and service planId
• [feature] Support Verification API (SDK doc)
• [feature] Support Voice API (REST API)
• [doc] Online javadoc