Sinch Community

What's Changed SDK [design] Requires explicit  sms_region  and  conversation_region  on  SinchClient  before using SMS and Conversation APIs (no silent US/EU defaults); runtime failure if unset (#49, #110). [design] The v1 asynchronous client and httpx-based async stack were removed; only synchronous  SinchClient  is supported (#55). [feature] Automatic pagination via a shared  Paginator  pattern for paged list APIs (#46, #54). [doc] README and configuration tests clarify which credentials apply to each API (#48). Conversation [feature] Messages API refresh: convenience send methods ( send_text_message() ,  send_card_message() ,  send_carousel_message() ,  send_choice_message() ,  send_contact_info_message() ,  send_list_message() ,  send_location_message() ,  send_media_message() ,  send_template_message() ),  list()  as a paginator,  update() ,  event_destination_target  (wires  callback_url ), and a  sinch_client.conversation.sinch_events(...)  helper for inbound event handling (#109–#120). [feature] Conversation Sinch Events (webhooks) support (#122, #131, #132, #133). [design] Conversation webhook REST client removed; handle inbound traffic via Sinch Events (see MIGRATION_GUIDE.md) (#131, #132, #133). Numbers [feature] Flatter API ( rent ,  list ,  event_destinations , and related entry points),  event_destination_target , and a Numbers Sinch Events helper (#44, #53, #57, #58, #59, #62). [feature] Available Regions endpoint (#56). [feature] Webhook helper validates the signing secret in  validate_signature_header()  (#61). [tech] Numbers Events payloads are passed through without client-side pre-processing (#63). Number Lookup [feature] Number Lookup v1 (lookup API, models, snippets, and E2E coverage) (#99, #101, #104). SMS [design] SMS client configuration and authentication paths refactored for project vs service-plan credentials, including delivery-report flows (#90). [feature] SMS delivery reports models and pagination (#87).  groups  and  inbounds  are planned for a future release (see migration guide). [feature] SMS Sinch Events (webhooks) support (#103). [doc] SMS migration guide and Sinch events quickstart material (#107, #108). Verification [design] Verification V1 APIs are removed (#124). V2 Verification support is planned in a future release (see MIGRATION_GUIDE.md). Voice [design] Voice V1 APIs are removed (#124). V2 Voice support is planned in a future release (see MIGRATION_GUIDE.md). Others [dependency] Pydantic v2 ( pydantic = ">=2.0.0" ). [releasing] Ruff linter adoption (#84) and CI workflow updates (#121). [doc] Snippets and Getting Started live under  examples/  (#95, #98, #105, #106, #115, #118, #125, #127). [doc] Docstring updates across Numbers, SMS, and Conversation (#64, #65, #67, #96, #97). [refactor] Model, type, and class renames (#60, #70, #82). [tech] Conversation, Numbers, and SMS models and endpoints resynchronized with OpenAPI specification (#68, #75, #123, #128, #129, #134, #135). [test] E2E test infrastructure and refactoring (#45, #66, #102); SMS batches test coverage (#91, #93, #94). ... View more

What's Changed New API supported: Number Lookup v2 SDK Client [Bugfix] Fix token refresh concurrency issue Conversation [Deprecation notice] Deprecate Template V1 [Deprecation notice] Deprecate Viber channel support [Feature] Support Calendar Message and Share Location Message types [Feature] Support WhatsApp Card message properties [Feature] Support Consents (List identities and list audit records from consent list) [Feature] Support Project Settings [Feature] Support Identity conflicts listing [Feature] Support KakaoTalk commerce and carousel commerce messages in the channel-specific messages [Feature] Support Line notification template messages in the channel-specific messages [Feature] Support various payment buttons for whatsapp: payment link, dynamic pix and boleto [Feature] Support list last messages by channel identity Elastic SIP Trunking [Feature] Support add projects operation [Feature] Support export call history [Feature] Support Call Blocking Rules [Feature] Support Credential Lists Fax: [Deprecation] Fax API is not using regions anymore, only 1 single endpoint [Feature] Support cover pages [Bugfix] Fix pagination parameters Numbers: [Feature] Support emergency address for SIP numbers [Bugfix] Fix non-required parameters for listing rented numbers SMS: [Tech]: implemented E2E tests with servicePlanId authentication Verification: [Feature] Support WhatsApp verification Voice: [Feature] Support  streamingOptions  in the connectStream SVAML action Overvall: [Tech]: Lazy load a single ApiFetchClient instance for a given domain service [QoL]: List methods with only optional parameters accept no parameter, instead of a necessary empty object domain.sub.list({})  can now also be written  domain.sub.list() Full Changelog:  v1.3.0...v1.4.0 ... View more

What's Changed   Major breaking changes with major release see MIGRATION-GUIDE Chore [dependency] Updated maven-model dependency to 3.9.14 or more recent version to fix security vulnerabilities #8 Conversation [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 Verification [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 Voice [feature] Support new DICE reason values ... View more

What's Changed   SMS [fix] Fixed API error response deserialization ... View more

What's Changed   Core [fix] Added SDK User-Agent header to authentication requests Conversation [fix] Fixed Webhooks deserialization containing unexpected properties ... View more

What's Changed [Bugfix]: Issue #273 : Fix NPE when handling 401 response without a token expired header ... View more

What's Changed   Conversation [deprecation notice] ListMessageRequest.MessageSource deprecated and to be replaced by field replace ListMessageRequest.MessagesSource (plural form) [feat] ConversationMessage support SenderId and ProcessingMode fields   Numbers [fix] Fix end of auto pagination detection based onto empty token [fix] Fix null value usage for types onto Regions.List [fix] Fix scheduled provisioning serialization/deserialization [feat] Support CallbackUrl field onto ActiveNumber and related requests [feat] Enhanced EventType values for Webhooks [feat] Provide Webhooks header validation ValidateAuthenticationHeader helper   SMS [fix] Fix end of auto pagination detection for Batches , DeliveryReport , Groups , InBounds   Verification [fix] Fix ReportFlashCallVerificationRequest serialization [feat] Provide Webhooks header validation ValidateAuthenticationHeader helper [feat] Provide generic GetById , GetByIdentity and GetByReference functions [feat] [BETA] Support WhatsApp verification. This is a beta feature, contact you account manager   Voice [fix] Fix QueryNumberResponse de-serilization [fix] Fix PlayFiles.Ids field type [feat] Provide Webhooks header validation ValidateAuthenticationHeader helper [feat] Support Webhooks AnsweredCallEvent.ApplicationKey field [feat] Support Webhooks DisconnectedCallEvent.ConferenceId field [feat] Support Webhooks IncomingCallEvent.ConferenceId field [feat] Support Webhooks PromptInputEvent.ConferenceId and PromptInputEvent.Custom fields   tests Added end to end tests onto CI ... View more

What's New [Feature] Webhooks: When parsing a webhook event, the method  parseEvent  now accepts the raw string input on top of the parsed object. What’s changed since v1.2.1 SMS SDK Highlights: [Feature] Support  mo_media  message type for inbounds and webhooks [Feature] Add  subject  property to  MediaBody  model [Feature] Add  client_reference ,  feedback_enabled ,  from_ton  and  from_npi  to  ApiUpdateBinaryMtMessage  model [Feature] Fix groups models. Request bodies become mandatory. [Feature] Support webhook signature validation [Feature] Fix channel-specific template model with new interface  ChannelSpecificTemplateReference  where the version is optional [Early deprecation notice] In the next major version the  conversationRegion  parameter will be required to use an endpoint from the Conversation API (no defaulting to  us  anymore) See full content here: SMS CHANGELOG.md Numbers SDK Highlights: [Feature] Details of an NotFound error have their own type  NotFoundErrorDetails[]  instead of a generic  object[] [Feature] Ordering rented number parameter defines its own enum  OrderByEnum See full content here: Numbers CHANGELOG.md Conversation SDK Highlights: [Feature] Fix  MediaProperties  model and support media property [Feature] Support latest API updates regarding WhatsApp messaging [Feature] Support Line Enterprise credentials [Early deprecation notice] In the next major version the  conversationRegion  parameter will be required to use an endpoint from the Conversation API (no defaulting to  us  anymore) See full content here: Conversation CHANGELOG.md Voice SDK Highlights: [Feature] Add enum values for properties previsously defined as  string [Feature] Support Voice ICE instruction  stopRecording [Feature] Support Voice PIE action  connectPstn [Feature] Support Voice ICE action  connectStream  (beta feature) See full content here: Voice CHANGELOG.md Verification SDK Highlights: [Feature] Support  VerificationSmsDeliveredEvent  as callback event See full content here: Verification CHANGELOG.md Fax SDK Highlights: [API breaking change]  faxToEmail  endpoints require a  serviceId  as mandatory path parameter [API breaking change] the  phoneNumbers  property for an  EmailRequest  is not a  string[]  anymore but a  NumberWithPermissions[] [Feature] Support  resolution ,  coverPageId ,  coverPageData  and  pagesSentSuccessfully  in a  Fax  object [Feature] Support  resolution ,  coverPageId  in a  Service  object [Deprecation notice]  emails  subdomain is deprecated, use  faxToEmail  instead See full content here: Fax CHANGELOG.md Elastic SIP Trunking SDK Highlights: [Feature] Support  RegisteredEndpoint  on top of  StaticEndpoint : a  SipEndpoint  is now the union of both models [Feature] Support  TLS  as a transport option [Feature] New properties from a  SipTrunk :  callForwardNumber  and  enableCallForward See full content here: Elastic SIP Trunking CHANGELOG.md ... View more

What's Changed   [fix] Conversation/Messages: message_source VS messages_source query parameter [feat] Conversation/Messages: Support missing sender_id and 'processing_mode' fields [deprecation notice] Conversation/Messages: message_source is deprecated in favor of messages_source   ... View more

What's Changed   chore [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   Conversation [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 change and namespace pollution, SDK is accepting a common TemplateReference instance. Validation about the required version field won't be performed at client level by client, but will validated at backend level. [feat] 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   Mailgun [feat] 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.   Numbers [feat] Support Emergency Address [feat] Add new API rent(phoneNumber) without configuration [feat] 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   SMS [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.   Voice [test] Extend end to end tests against notify [feat] Support SVAML 'connectStream' action [feat] Support "asynch" field for amdRequest [feat] Define two new values for AnsweringMachineDetection.Reason enum ... View more

What's Changed General Hide sensitive fields in ToString with hidden string(*******) Conversation Added support for Templates V1 Synchronize with latest open-api spec Change ExpirationTime from string to DateTime Update ConversationChannelCredentials Add missing Media to ListMessage Make ChannelCredentials a one of Add payment specific messages Sms Synchronize with latest open-api spec Add Media inbound message Numbers Add support for Callback Configuration endpoints Add distinct  VoiceConfigs(RTC, EST, FAX) and Provisioning models   Full Changelog:  v1.2.1...v1.3.0 ... View more

What's Changed   Voice Fix model deserialization bug for Hooks Added helper methods to deserialize hooks to ISinchVoiceClient Updated Hooks models to match latest specification.  Full Changelog:   v1.2.1...v1.2.2 ... View more

What's Changed   Conversation Split model for TemplateReference into TemplateReference and OmniTemplateReference  so TemplateReference could have optional Version field Full Changelog: v1.2.0...v1.2.1 ... View more

What's Changed   chore [feat]: Lazy HTTP client initialization until really required   Cross domains [feat] Relax domains init for Webhooks when credentials are not required [feat] Validation against missing required property at protocol level   Conversation [fix] CardMessage.media_message is now of MediaMessage type [feat] New ListMessage.media field is supported [feat] New SG (Singapore) country defined for WhatsApp order payment details [feat] New ConversationChannelCredentials.credential_ordinal_number field is supported [feat] New LineEnterpriseCredentials is supported [feat] New LineCredentialsField.isDefault field is supported [feat] New SendMessageRequest.message_content_type is supported (enum of MessageContentType) [feat] New ChannelSpecificMessage classes for WhatsApp: OrderDetails OrderStatus [deprecation notice] CardMessageMedia class is deprecated in favor of shared MediaMessage   Mailgun as PREVIEW features [feat] Support "Emails" [feat] Support "Templates"   SMS [fix] 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 [feat] DryRunPerRecipientDetails.encodingEnum defined as an enum [feat] 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   Voice [feat] Define AnsweringMachineDetection used by AnsweredCallEvent and NotificationEvent [feat] conferenceId field is supported by AnsweredCallEvent DisconnectCallEvent IncomingCallEvent NotificationEvent PromptInputEvent [feat] NotificationEvent support destination and amd fields [deprecation notice] AnsweredCallEventAnsweringMachineDetection is replaced by AnsweringMachineDetection [deprecation notice] Following backend endpoint deprecation applications.queryNumber is deprecated ... View more

What's Changed   Fix: Conversation CardMessage.media field is of MediaMessage type (see Javadoc ) CardMessageMedia class is @deprecated (see Javadoc)   ... View more