MIGRATION-GUIDE.md

Sinch Java SDK Migration Guide

Table of Contents

• 2.0.0
  • General design change
  • Conversation
  • Numbers
  • SMS
  • Voice
  • Verification
  • Mailgun
• 1.5.0

---

2.0.0

This release removes legacy SDK support.

This guide lists all removed classes and interfaces from SDK V1 and how to migrate to their SDK V2 equivalents.

General design change

• Webhooks callbacks managements and parsing are now covered with 2 different services:
  • "Event Destinations": for managing the configuration of event destinations in the Sinch platform. This includes creating, updating, listing, and deleting them.
  • "Sinch Events": for parsing and handling incoming events from the Sinch platform. This includes parsing the incoming payloads into strongly-typed Java objects and providing utilities for handling these events in your application.

Conversation

• region is no longer defaulting to US and is now a required field to use Conversation related APIs (see Configuration

• Removed support of SINCH_CHAT channel.

• channelspecific.whatsapp.payment.OrderDetailsPayment removed support of deprecated payment_settings in favor of new payment_buttons for payment methods.

• The metadata field has been removed from the Conversation and CreateConversationRequest classes. This field is no longer supported in the API and has been replaced with metadataJson.

• APIs returning a list are supporting common naming: <operation>QueyParameters models for filtering, sorting, and pagination onto requests and <opreation>ListResponse models for responses.

• New APIs supporting auto-pagination for list responses:

  • apps.list()
  • webhooks.list().
  • templates.list().
  • templates.listTranslations().

• CallbackSettings.secretForOverriddenCallbackUrls is replaced by EventDestinationSettings. secretForOverriddenTarget.

• SendEventRequest.callbackUrl is replaced by SendEventRequest.eventDestinationTarget.

• SendMessageRequest.callbackUrl is replaced by SendMessageRequest.eventDestinationTarget.

• Templates:

  • Conversation Template V1 is removed. Use ConversationTemplate V2 instead.
  • Conversation Templates models moved from com.sinch.sdk.domains.conversation.models.templates package to com.sinch.sdk.domains.conversation.templates.models.

Replacement models

Old const	New const
ComposingEndEvent.EMPTY	ComposingEndEvent.COMPOSING_END_EVENT
ComposingEvent.EMPTY	ComposingEvent.COMPOSING_EVENT
ConversationDeletedEvent.EMPTY	ConversationDeletedEvent.CONVERSATION_DELETED_EVENT
ConversationDirection.UNDEFINED_DIRECTION	Support removed
PaymentStatus	constant values are now prefixed with PAYMENT_STATUS_
ReactionAction	constant values prefixed with REACTION_ACTION_
MessageContentType	constant values prefixed with CONTENT_
OptInEventNotification	constant values prefixed with OPT_IN_
OptOutEventNotification	constant values prefixed with OPT_OUT_
Templates V1	Removed support for Templates V1

Old class	New class
api.v1.MessagesService.MessageSource	messages.request.MessageSource
messages.types.card.CardMessageMedia	messages.types.media.MediaMessage
contact.request.IdentityConflictsListRequest	contacts.request.ContactListIdentityConflictsQueryParameters
contact.request.ContactListRequest	contacts.request.ContactsListQueryParameters
contact.response.ContactsListResponse	contacts.response.ContactsListResponse
conversation.request.ConversationsListRequest	conversations.request.ConversationsListQueryParameters
conversation.request.ConversationsListRecentRequest	conversations.request.ConversationsListQueryParameters
conversation.response.ConversationsListRecentResponse	conversations.response.RecentConversationsListResponse
events.request.EventsListRequest	events.request.EventsListQueryParameters
messages.request.MessagesListRequest	messages.request.MessagesListQueryParameters
webhooks.Webhook	eventdestinations.EventDestination
webhooks.events.ConversationWebhookEvent	sinchevents.ConversationSinchEvent
webhooks.WebhookTrigger	sinchevents.EventDestinationTrigger
webhooks.WebhookTargetType	sinchevents.EventDestinationTargetType
apps.CallbackSettings	EventDestinationSettings

Replacement Services

Old package	New package
api.v1.AppService	api.v1.AppsService
api.v1.ContactService	api.v1.ContactsService
api.v1.Conversation	api.v1.ConversationsService
api.v1.EventService	api.v1.EventsService
api.v1.WebHooksService	api.v1.EventDestinationsService
	api.v1.SinchEventsService

Replacement packages

Old package	New package
models.v1.app	models.v1.apps
models.v1.contact	models.v1.contacts
models.v1.conversation	models.v1.conversations
models.v1.event	models.v1.events
models.v1.webhooks	models.v1.evendestinations
models.v1.webhooks.events	models.v1.sinchevents
api.templates.v2.TemplatesServiceV2	conversation.templates.api.v2.TemplatesV2Service

Replacement APIs

Old interface	New Equivalent
ContactsService.getChannelProfileByChannelIdentity()	Returned class is changed from String to GetChannelProfileResponse
ContactsService.getChannelProfileByContactId()	Returned class is changed from String to GetChannelProfileResponse
AppsService.list(...)	Returned class is changed from Collection<String> to AppsListResponse
MessagesService.get(...)	Is accepting now a MessagesGetQueryParameeters object for request parameters instead of individual parameters.
MessagesService.delete(...)	Is accepting now a MessagesDeleteQueryParameeters object for request parameters instead of individual parameters.
MessagesService.update(...)	Is accepting now a MessagesUpdateQueryParameeters object for request parameters instead of individual parameters.
WebhooksService.create(...)	Request parameter type is changed from Webhook to EventDestinationCreateRequest
WebhooksService.list(...)	Returned class is changed from Collection<Webhook> to EventDestinationsListResponse
TemplatesServiceV2.list(...)	Returned class is changed from Collection<TemplateV2> to TemplatesV2ListResponse
TemplatesServiceV2.listTranslations(...)	Returned class is changed from Collection<TemplateTranslation> to TranslationV2ListResponse

Numbers

Replacement models

Common models

Old class	New class
ActiveNumber	com.sinch.sdk.domains.numbers.models.v1.ActiveNumber
AvailableNumber	com.sinch.sdk.domains.numbers.models.v1.response/AvailableNumber
Capability	com.sinch.sdk.domains.numbers.models.v1.Capability
Money	com.sinch.sdk.domains.numbers.models.v1.Money
NumberPattern	com.sinch.sdk.domains.numbers.models.v1.request.SearchPattern
NumberType	com.sinch.sdk.domains.numbers.models.v1.NumberType
OrderBy	com.sinch.sdk.domains.numbers.models.v1.request.OrderBy
ProvisioningStatus	com.sinch.sdk.domains.numbers.models.v1.ProvisioningStatus
Region	Part of com.sinch.sdk.domains.numbers.models.v1.regions.available.AvailableRegion
SMSConfiguration	com.sinch.sdk.domains.numbers.models.v1.SmsConfiguration
ScheduledSmsProvisioning	com.sinch.sdk.domains.numbers.models.v1.ScheduledSmsProvisioning
ScheduledVoiceProvisioning	com.sinch.sdk.domains.numbers.models.v1.request/ScheduledVoiceProvisioning
SearchPattern	com.sinch.sdk.domains.numbers.models.v1.request/SearchPosition
SmsErrorCode	com.sinch.sdk.domains.numbers.models.v1.SmsErrorCode
VoiceConfiguration	com.sinch.sdk.domains.numbers.models.v1.VoiceConfiguration

Old enum	New enum
SmsErrorCode.EXCEEDED_10DLC_LIMIT	SmsErrorCode.EXCEEDED_10_DLC_LIMIT
NumberEvent.EXCEEDED_10DLC_LIMIT	NumberSinchEvent.FailureCodeEnum.EXCEEDED_10_DLC_LIMIT

Active Numbers

Old class	New class
requests.ActiveNumberListRequestParameters	request.ActiveNumbersListQueryParameters
requests.ActiveNumberUpdateRequestParameters	request.ActiveNumberUpdateRequest
requests.ActiveNumberUpdateSMSConfigurationRequestParameters	SmsConfiguration
requests.ActiveNumberUpdateVoiceConfigurationRequestParameters	VoiceConfiguration
responses.ActiveNumberListResponse.java	response.ActiveNumbersListResponse

Renamed field	New field
ActiveNumber.callbackUrl	ActiveNumber.eventDestinationTarget
ActiveNumberUpdateRequest.callbackUrl	ActiveNumberUpdateRequest.eventDestinationTarget

Available Numbers

Old class	New class
requests.AvailableNumberListAllRequestParameters	request.AvailableNumbersListQueryParameters
requests.AvailableNumberRentAnyRequestParameters	request.AvailableNumberRentAnyRequest
requests.AvailableNumberRentRequestParameters	request.AvailableNumberRentRequest
responses.AvailableNumberListResponse	response.AvailableNumbersListResponse
requests.RentSMSConfigurationRequestParameters	SmsConfiguration
requests.RentVoiceConfigurationRequestParameters	VoiceConfiguration

Renamed field	New field
AvailableNumberRentAnyRequestParameters.callbackUrl	AvailableNumberRentAnyRequest.eventDestinationTarget
AvailableNumberRentRequestParameters.callbackUrl	AvailableNumberRentRequest.eventDestinationTarget

Regions

Old class	New class
regions.available.request.AvailableRegionListRequest	regions.request.AvailableRegionsListQueryParameters
regions.available.responses.AvailableRegionListResponse	regions.response.AvailableRegionsListResponse

Event Destinations

Old class	New class
callbacks.request.CallbackConfigurationUpdateRequest	eventdestinations.request.EventDestinationUpdateRequest
callbacks.response.CallbackConfigurationResponse	eventdestinations.response.EventDestinationResponse

Sinch Events

Old class	New class
webhooks.NumberEvent	sinchevents.NumberSinchEvent
webhooks.ResourceType	sinchevents.ResourceType

Replacement APIs

Use the new versioned API under numbers().v1() to get access to NumbersService: sinchClient.numbers().v1()

Old interface	New Equivalent in numbers().v1()
active()	Direct access from v1()
available()	Direct access from v1()
regions()	v1().regions()
callback()	v1().callback()
webhook()	v1().sinchevents()
v1().callback()	v1().callbackConfiguration()

SMS

• region is no longer defaulting to US and is now a required field to use SMS related APIs (see Configuration

Deprecated fields

• Deprecated MediaMessageBodyDetails.status field of type String is replaced by MediaMessageBodyDetails.status of StatusEnum type
• BinaryRequest.callbackUrl is replaced by BinaryRequest.eventDestinationTarget
• UpdateBinaryRequest.callbackUrl is replaced by BinaryRequest.eventDestinationTarget
• BinaryResponse.callbackUrl is replaced by BinaryResponse.eventDestinationTarget
• MediaRequest.callbackUrl is replaced by MediaRequest.eventDestinationTarget
• UpdateMediaRequest.callbackUrl is replaced by UpdateMediaRequest.eventDestinationTarget
• MediaResponse.callbackUrl is replaced by MediaResponse.eventDestinationTarget
• TextRequest.callbackUrl is replaced by MediaRequest.eventDestinationTarget
• UpdateTextRequest.callbackUrl is replaced by UpdateTextRequest.eventDestinationTarget
• TextResponse.callbackUrl is replaced by TextResponse.eventDestinationTarget

Replacement models

Batches

Old class	New class
models/Parameters	N/A. Part of Create and Update batch requests
models/MediaBody	com.sinch.sdk.domains.sms.models.v1.batches.MediaBody
models/BaseBatch	com.sinch.sdk.domains.sms.models.v1.batches.request.BatchRequest
models/Batch	com.sinch.sdk.domains.sms.models.v1.batches.response.BatchResponse
models/BatchBinary	com.sinch.sdk.domains.sms.models.v1.batches.response.BinaryResponse
models/BatchMedia	com.sinch.sdk.domains.sms.models.v1.batches.response.MediaResponse
models/BatchText	com.sinch.sdk.domains.sms.models.v1.batches.response.TextResponse
models/DryRun	com.sinch.sdk.domains.sms.models.v1.batches.response.DryRunResponse
models/DryRunPerRecipientDetails	com.sinch.sdk.domains.sms.models.v1.batches.response.DryRunPerRecipientDetails
models/requests/BatchesListRequestParameters	com.sinch.sdk.domains.sms.models.v1.batches.request.ListBatchesQueryParameters
models/requests/SendSmsBatchBinaryRequest	com.sinch.sdk.domains.sms.models.v1.batches.request.BinaryRequest
models/requests/SendSmsBatchMediaRequest	com.sinch.sdk.domains.sms.models.v1.batches.request.MediaRequest
models/requests/SendSmsBatchTextRequest	com.sinch.sdk.domains.sms.models.v1.batches.request.TextRequest
models/requests/UpdateBaseBatchRequest	com.sinch.sdk.domains.sms.models.v1.batches.request.UpdateBatchRequest
models/requests/UpdateSmsBatchBinaryRequest	com.sinch.sdk.domains.sms.models.v1.batches.request.UpdateBinaryRequest
models/requests/UpdateSmsBatchMediaRequest	com.sinch.sdk.domains.sms.models.v1.batches.request.UpdateMediaRequest
models/requests/UpdateSmsBatchTextRequest	com.sinch.sdk.domains.sms.models.v1.batches.request.UpdateTextRequest
models/responses/BatchesListResponse	com.sinch.sdk.domains.sms.models.v1.batches.response.ListBatchesResponse

• The deprecated getEncoding/setEncoding APIs accepting String parameter are removed from com.sinch.sdk.domains.sms.models.v1.batches.response.DryRunPerRecipientDetails

Delivery Reports

Old class	New class
models/BaseDeliveryReport	com.sinch.sdk.domains.sms.models.v1.deliveryreports.DeliveryReport
models/DeliveryReportBatch	com.sinch.sdk.domains.sms.models.v1.deliveryreports.BatchDeliveryReport
models/DeliveryReportBatchMMS	com.sinch.sdk.domains.sms.models.v1.deliveryreports.BatchDeliveryReportMMS
models/DeliveryReportBatchSMS	com.sinch.sdk.domains.sms.models.v1.deliveryreports.BatchDeliveryReportSMS
models/DeliveryReportErrorCode	com.sinch.sdk.domains.sms.models.v1.deliveryreports.DeliveryReceiptErrorCode
models/DeliveryReportRecipient	com.sinch.sdk.domains.sms.models.v1.deliveryreports.RecipientDeliveryReport
models/DeliveryReportRecipientEncoding	com.sinch.sdk.domains.sms.models.v1.deliveryreports.EncodingType
models/DeliveryReportRecipientMMS	com.sinch.sdk.domains.sms.models.v1.deliveryreports.RecipientDeliveryReportMMS
models/DeliveryReportRecipientSMS	com.sinch.sdk.domains.sms.models.v1.deliveryreports.RecipientDeliveryReportSMS
models/DeliveryReportStatus	com.sinch.sdk.domains.sms.models.v1.deliveryreports.DeliveryStatus
models/DeliveryReportStatusDetails	com.sinch.sdk.domains.sms.models.v1.deliveryreports.MessageDeliveryStatus
models/DeliveryReportType	com.sinch.sdk.domains.sms.models.v1.deliveryreports.request.QueryReportType
models/requests/DeliveryReportBatchGetRequestParameters	com.sinch.sdk.domains.sms.models.v1.deliveryreports.request.BatchDeliveryReportQueryParameters
models/requests/DeliveryReportListRequestParameters	com.sinch.sdk.domains.sms.models.v1.deliveryreports.request.ListDeliveryReportsQueryParameters
models/responses/DeliveryReportsListResponse	com.sinch.sdk.domains.sms.models.v1.deliveryreports.response.ListDeliveryReportsResponse
models/v1/deliveryreports/DeliveryReceiptErrorCode	Renamed to com.sinch.sdk.domains.sms.models.v1.deliveryreports.DeliveryReceiptStatusCode

Groups

Old class	New class
models/Group	com.sinch.sdk.domains.sms.models.v1.groups.Group
models/GroupAutoUpdate	com.sinch.sdk.domains.sms.models.v1.groups.GroupAutoUpdate
models/GroupAutoUpdateKeyword	com.sinch.sdk.domains.sms.models.v1.groups.AddKeyword and com.sinch.sdk.domains.sms.models.v1.groups.RemoveKeyword
models/requests/GroupAutoUpdateKeywordRequestParameters	com.sinch.sdk.domains.sms.models.v1.groups.AddKeyword and com.sinch.sdk.domains.sms.models.v1.groups.RemoveKeyword
models/requests/GroupAutoUpdateRequestParameters	com.sinch.sdk.domains.sms.models.v1.groups.request.GroupUpdateRequest
models/requests/GroupCreateRequestParameters	com.sinch.sdk.domains.sms.models.v1.groups.request.GroupRequest
models/requests/GroupReplaceRequestParameters	com.sinch.sdk.domains.sms.models.v1.groups.request.GroupRequest
models/requests/GroupUpdateRequestParameters	com.sinch.sdk.domains.sms.models.v1.groups.request.GroupUpdateRequest
models/requests/GroupsListRequestParameters	com.sinch.sdk.domains.sms.models.v1.groups.request.ListGroupsQueryParameters
models/responses/GroupsListResponse	com.sinch.sdk.domains.sms.models.v1.groups.response.ListGroupsResponse

Inbounds

Old class	New class
models/Inbound	com.sinch.sdk.domains.sms.models.v1.inbounds.InboundMessage
models/InboundBinary	com.sinch.sdk.domains.sms.models.v1.inbounds.BinaryMessage
models/InboundText	com.sinch.sdk.domains.sms.models.v1.inbounds.TextMessage
models/requests/InboundsListRequestParameters	com.sinch.sdk.domains.sms.models.v1.inbounds.request.ListInboundMessagesQueryParameters
models/responses/InboundsListResponse	com.sinch.sdk.domains.sms.models.v1.inbounds.response.ListInboundsResponse

Webhooks

Old class	New class
webhooks/WebhooksEvent	sinchevents.SmsSinchEvent
WebHooksService	SinchEventsService

Replacement APIs

Use the new versioned API under sms().v1() to get access to SMSService: sinchClient.sms().v1()

Old interface	New Equivalent in sms().v1()
batches()	v1().batches()
deliveryReports()	v1().deliveryReports()
groups()	v1().groups()
inbounds()	v1().inbounds()
webHooks()	v1().sinchEvent()

Voice

• Applications.listNumbers() is returning a [OwnedNumbersListResponse](https://www.javadoc.io/doc/com.sinch.sdk/sinch-sdk-java/2.0.0/com/sinch/sdk/domains/voice/models/v1/application/response/OwnedNumbersListResponse.html) instead of a list of OwnedNumbersResponse. The new response still contains the list of assigned numbers but support the pagination of the results by iterator.
• Deprecated Applications.queryNumber() is removed and NumberInformation, QueryNumber related classes no longer available.

Replacement APIs

Use the new versioned API under voice().v1() to get access to VoiceService: sinchClient.voice().v1()

Old interface	New Equivalent in voice().v1()
applications()	v1().applications()
applications().getCallbackUrls()	v1().applications().getEventDestinations()
applications().updateCallbackUrls()	v1().applications().updateEventDestinations()
callouts()	v1().callouts()
calls()	v1().calls()
conferences()	v1().conferences()
webhooks()	v1().sinchEvents()

Replacement models

Old const	New const
SvamlActionContinue.DEFAULT	SvamlActionContinue.SVAML_ACTION_CONTINUE
SvamlActionHangup.DEFAULT	SvamlActionHangup.SVAML_ACTION_HANGUP
SvamlInstructionAnswer.DEFAULT	SvamlInstructionAnswer.SVAML_INSTRUCTION_ANSWER
SvamlInstructionStopRecording.DEFAULT	SvamlInstructionStopRecording.SVAML_INSTRUCTION_STOP_RECORDING

Destination

Old class	New class
models/Destination	com.sinch.sdk.domains.voice.models.v1.destination.Destination
models/DestinationNumber	com.sinch.sdk.domains.voice.models.v1.destination.DestinationSip or com.sinch.sdk.domains.voice.models.v1.destination.DestinationPstn
models/DestinationNumberType	N/A
models/DestinationSip	com.sinch.sdk.domains.voice.models.v1.destination.DestinationSip
models/DestinationUser	com.sinch.sdk.domains.voice.models.v1.destination.DestinationMxp

Applications

Old class	New class
models/ApplicationAssignedNumber	com.sinch.sdk.domains.voice.models.v1.applications.response
models/response/AssignedNumbers	com.sinch.sdk.domains.voice.models.v1.applications.response.OwnedNumbersListResponse
models/Callbacks	com.sinch.sdk.domains.voice.models.v1.applications.EventDestinations
models/CallbacskUrls	com.sinch.sdk.domains.voice.models.v1.applications.EventDestinationsTarget
models/requests/ApplicationsAssignNumbersRequestParameters	com.sinch.sdk.domains.voice.models.v1.applications.request.UpdateNumbersRequest
models/NumberType	N/A
models/CapabilityType	com.sinch.sdk.domains.voice.models.v1.applications.Capability

Callouts

Old class	New class
models/requests/CalloutRequestParameters	com.sinch.sdk.domains.voice.models.v1.callouts.request.CalloutRequest
models/requests/CalloutRequestParametersConference	com.sinch.sdk.domains.voice.models.v1.callouts.request.CalloutRequestConference
models/requests/CalloutRequestParametersCustom	com.sinch.sdk.domains.voice.models.v1.callouts.request.CalloutRequestCustom
models/requests/CalloutRequestParametersTTS	com.sinch.sdk.domains.voice.models.v1.callouts.request.CalloutRequestTTS

Calls

Old class	New class
models/CallLegType	com.sinch.sdk.domains.voice.models.v1.calls.request.CallLeg
models/response/CallInformation	com.sinch.sdk.domains.voice.models.v1.calls.response.CallInformation
models/response/CallStatusType	com.sinch.sdk.domains.voice.models.v1.calls.response.CallInformation.StatusEnum
models/CallResultType	com.sinch.sdk.domains.voice.models.v1.calls.response.CallResult
models/CallReasonType	com.sinch.sdk.domains.voice.models.v1.calls.response.CallInformation.ReasonEnum
models/DomainType	com.sinch.sdk.domains.voice.models.v1.calls.response.CallInformation.DomainEnum

Conferences

Old class	New class
models/requests/ConferenceManageParticipantCommandType	com.sinch.sdk.domains.voice.models.v1.conferences.request.ManageConferenceParticipantRequest.CommandEnum
models/requests/ConferenceManageParticipantRequestParameters	com.sinch.sdk.domains.voice.models.v1.conferences.request.ManageConferenceParticipantRequest
models/ConferenceDtfmOptions	com.sinch.sdk.domains.voice.models.v1.conferences.ConferenceDtmfOptions
models/MusicOnHoldType	com.sinch.sdk.domains.voice.models.v1.MusicOnHold
models/DtfmModeType	com.sinch.sdk.domains.voice.models.v1.conferences.ConferenceDtmfOptions.ModeEnum
models/response/ConferenceParticipant	com.sinch.sdk.domains.voice.models.v1.conferences.ConferenceParticipant

Svaml

Old class	New class
models/requests/Control	com.sinch.sdk.domains.voice.models.v1.svaml.Control
models/svaml/SVAMLControl	com.sinch.sdk.domains.voice.models.v1.svaml.SvamlControl
models/requests/ControlUrl	com.sinch.sdk.domains.voice.models.v1.svaml.ControlUrl
models/svaml/Action	com.sinch.sdk.domains.voice.models.v1.svaml.action.SvamlAction
models/svaml/ActionConnectConference	com.sinch.sdk.domains.voice.models.v1.svaml.action.SvamlActionConnectConference
models/svaml/ActionConnectMxp	com.sinch.sdk.domains.voice.models.v1.svaml.action.SvamlActionConnectMxp
models/svaml/ActionConnectPstn	com.sinch.sdk.domains.voice.models.v1.svaml.action.SvamlActionConnectPstn
models/svaml/ActionConnectSip	com.sinch.sdk.domains.voice.models.v1.svaml.action.SvamlActionConnectSip
models/svaml/ActionContinue	com.sinch.sdk.domains.voice.models.v1.svaml.action.SvamlActionContinue
models/svaml/ActionHangUp	com.sinch.sdk.domains.voice.models.v1.svaml.action.SvamlActionHangup
models/svaml/ActionPark	com.sinch.sdk.domains.voice.models.v1.svaml.action.SvamlActionPark
models/svaml/ActionRunMenu	com.sinch.sdk.domains.voice.models.v1.svaml.action.SvamlActionRunMenu
models/svaml/AnsweringMachineDetection	com.sinch.sdk.domains.voice.models.v1.svaml.action.AnsweringMachineDetectionQuery
models/svaml/IndicationType	com.sinch.sdk.domains.voice.models.v1.svaml.action.SvamlActionConnectPstn.IndicationsEnum
models/TransportType	com.sinch.sdk.domains.voice.models.v1.svaml.action.SvamlActionConnectSip.TransportEnum
models/svaml/Menu	com.sinch.sdk.domains.voice.models.v1.svaml.action.Menu
models/svaml/MenuOption	com.sinch.sdk.domains.voice.models.v1.svaml.action.MenuOption
models/svaml/MenuOptionAction	see com.sinch.sdk.domains.voice.models.v1.svaml.action.MenuOptionActionFactory
models/svaml/MenuOptionActionType	com.sinch.sdk.domains.voice.models.v1.svaml.action.MenuOptionActionFactory.MenuOptionActionType
models/v1/svaml/action/ConnectPstnAnsweringMachineDetection	com.sinch.sdk.domains.voice.models.v1.svaml.action.AnsweringMachineDetectionQuery
models/svaml/Instruction	com.sinch.sdk.domains.voice.models.v1.svaml.instruction.SvamlInstruction
models/svaml/InstructionAnswer	com.sinch.sdk.domains.voice.models.v1.svaml.instruction.SvamlInstructionAnswer
models/svaml/InstructionPlayFiles	com.sinch.sdk.domains.voice.models.v1.svaml.instruction.SvamlInstructionPlayFiles
models/svaml/InstructionSay	com.sinch.sdk.domains.voice.models.v1.svaml.instruction.SvamlInstructionSay
models/svaml/InstructionSendDtfm	com.sinch.sdk.domains.voice.models.v1.svaml.instruction.SvamlInstructionSendDtmf
models/svaml/InstructionSetCookie	com.sinch.sdk.domains.voice.models.v1.svaml.instruction.SvamlInstructionSetCookie
models/svaml/InstructionStartRecording	com.sinch.sdk.domains.voice.models.v1.svaml.instruction.SvamlInstructionStartRecording
models/svaml/InstructionStopRecording	com.sinch.sdk.domains.voice.models.v1.svaml.instruction.SvamlInstructionStopRecording
models/svaml/StartRecordingOptions	com.sinch.sdk.domains.voice.models.v1.svaml.instruction.StartRecordingOptions
models/svaml/TranscriptionOptions	com.sinch.sdk.domains.voice.models.v1.svaml.instruction.TranscriptionOptions

Sinch Events

Old class	New class
models/v1/webhooks/AnsweredCallEventAnsweringMachineDetection	Replaced by com.sinch.sdk.domains.voice.models.v1.sinchevents.AnsweringMachineDetection
models/v1/webhooks/AnsweringMachineDetection	com.sinch.sdk.domains.voice.models.v1.sinchevents.AnsweringMachineDetection
models/v1/webhooks/AnsweredCallEvent	com.sinch.sdk.domains.voice.models.v1.sinchevents.AnsweredCallEvent
models/v1/webhooks/DisconnectCallEvent	com.sinch.sdk.domains.voice.models.v1.sinchevents.DisconnectedCallEvent
models/v1/webhooks/IncomingCallEvent	com.sinch.sdk.domains.voice.models.v1.sinchevents.IncomingCallEvent
models/v1/webhooks/MenuResult	com.sinch.sdk.domains.voice.models.v1.sinchevents.MenuResult
models/v1/webhooks/NotifyEvent	com.sinch.sdk.domains.voice.models.v1.sinchevents.NotificationEvent ;
models/v1/webhooks/PromptInputEvent	com.sinch.sdk.domains.voice.models.v1.sinchevents.PromptInputEvent
models/v1/webhooks/CallEvent	com.sinch.sdk.domains.voice.models.v1.sinchevents.VoiceCallSinchEvent
models/v1/webhooks/VoiceWebhookEvent	com.sinch.sdk.domains.voice.models.v1.sinchevents.VoiceSinchEvent
models/v1/webhooks/WebhooksEventRequestType	com.sinch.sdk.domains.voice.models.v1.sinchevents.SinchEventType

Verification

Replacement APIs

Use the new versioned API under verification().v1() to get access to VerificationService: sinchClient.verification().v1()

Old interface	New Equivalent in verification().v1()
verifications() start related APIs	v1().verificationStart()
verifications() report related APIs	v1().verificationReport()
verificationStatus()	v1().verificationStatus()
webhooks()	v1().sinchEvents()
VerificationStartService	VerificationsStartService
VerificationReportService	VerificationsReportService
VerificationStatusService	VerificationsStatusService
WebHooksService	SinchEventsService

Replacement models

Common Report

Old class	New class
models/Price	com.sinch.sdk.domains.verification.models.v1.Price
models/VerificationStatusType	com.sinch.sdk.domains.verification.models.v1.VerificationStatus
models/VerificationMethodType	com.sinch.sdk.domains.verification.models.v1.VerificationMethod
models/Identity	com.sinch.sdk.domains.verification.models.v1.Identity
models/NumberIdentity	com.sinch.sdk.domains.verification.models.v1.NumberIdentity
models/VerificationId	java.lang.String
models/VerificationReference	java.lang.String

Verification Report

Old class	New class
models/requests/VerificationReportCalloutRequestParameters	com.sinch.sdk.domains.verification.models.v1.report.request.VerificationReportRequestPhoneCall
models/requests/VerificationReportFlashCallRequestParameters	com.sinch.sdk.domains.verification.models.v1.report.request.VerificationReportRequestFlashCall
models/requests/VerificationReportRequestParameters	com.sinch.sdk.domains.verification.models.v1.report.request.VerificationReportRequest
models/requests/VerificationReportSMSRequestParameters	com.sinch.sdk.domains.verification.models.v1.report.request.VerificationReportRequestSms
models/VerificationReport	com.sinch.sdk.domains.verification.models.v1.report.response.VerificationReportResponse
models/VerificationReportCallout	com.sinch.sdk.domains.verification.models.v1.report.response.VerificationReportResponsePhoneCall
models/VerificationReportFlashCall	com.sinch.sdk.domains.verification.models.v1.report.response.VerificationReportResponseFlashCall
models/VerificationReportSMS	com.sinch.sdk.domains.verification.models.v1.report.response.VerificationReportResponseSms

Verification Start

Old class	New class
models/requests/StartVerificationCalloutOptions	N/A (direct access to PhoneCallSpeech from VerificationStartRequestPhoneCall)
models/requests/StartVerificationCalloutRequestParameters	com.sinch.sdk.domains.verification.models.v1.start.request.VerificationStartRequestPhoneCall
models/requests/StartVerificationCalloutSpeechOptions	com.sinch.sdk.domains.verification.models.v1.start.request.PhoneCallSpeech
models/requests/StartVerificationFlashCallRequestParameters	com.sinch.sdk.domains.verification.models.v1.start.request.VerificationStartRequestFlashCall
models/requests/StartVerificationRequestParameters	com.sinch.sdk.domains.verification.models.v1.start.request.VerificationStartRequest
models/requests/StartVerificationSMSOptions	N/A (direct access to dedicated fields from VerificationStartRequestSms)
models/requests/StartVerificationSMSRequestParameters	com.sinch.sdk.domains.verification.models.v1.start.request.VerificationStartRequestSms
models/requests/StartVerificationSeamlessRequestParameters	com.sinch.sdk.domains.verification.models.v1.start.request.VerificationStartRequestData
models/requests/SMSCodeType	com.sinch.sdk.domains.verification.models.v1.SmsCodeType
models/response/StartVerificationResponse	com.sinch.sdk.domains.verification.models.v1.start.response.VerificationStartResponse
models/response/StartVerificationResponseCallout	com.sinch.sdk.domains.verification.models.v1.start.response.VerificationStartResponsePhoneCall
models/response/StartVerificationResponseFlashCall	com.sinch.sdk.domains.verification.models.v1.start.response.VerificationStartResponseFlashCall
models/response/StartVerificationResponseSMS	com.sinch.sdk.domains.verification.models.v1.start.response.VerificationStartResponseSms
models/response/StartVerificationResponseSeamless	com.sinch.sdk.domains.verification.models.v1.start.response.VerificationStartResponseData
models/Link	com.sinch.sdk.domains.verification.models.v1.start.response.Link
models/LinkRelType	com.sinch.sdk.domains.verification.models.v1.start.response.Link.RelEnum

Verification Status

Old class	New class
models/VerificationStatus	com.sinch.sdk.domains.verification.models.v1.status.response.VerificationStatusResponse
models/VerificationStatusCallout	com.sinch.sdk.domains.verification.models.v1.status.response.VerificationStatusResponsePhoneCall
models/VerificationStatusFlashCall	com.sinch.sdk.domains.verification.models.v1.status.response.VerificationStatusResponseFlashCall
models/VerificationStatusReasonType	com.sinch.sdk.domains.verification.models.v1.VerificationStatusReason
models/VerificationStatusSMS	com.sinch.sdk.domains.verification.models.v1.status.response.VerificationStatusResponseSms
models/VerificationSourceType	com.sinch.sdk.domains.verification.models.v1.status.StatusSource

Webhooks

Old class	New class
models/webhooks/VerificationEvent	com.sinch.sdk.domains.verification.models.v1.sinchevents.VerificationSinchEvent
models/webhooks/VerificationRequestEvent	com.sinch.sdk.domains.verification.models.v1.sinchevents.VerificationStartEvent
models/webhooks/VerificationRequestEventResponse	com.sinch.sdk.domains.verification.models.v1.sinchevents.VerificationStartEventResponse
models/webhooks/VerificationEventResponseAction	com.sinch.sdk.domains.verification.models.v1.sinchevents.VerificationStartEventAction
models/webhooks/VerificationRequestEventResponsePhoneCall	com.sinch.sdk.domains.verification.models.v1.sinchevents.VerificationStartEventResponsePhoneCall
models/webhooks/VerificationRequestEventResponseFlashCall	com.sinch.sdk.domains.verification.models.v1.sinchevents.VerificationStartEventResponseFlashCall
models/webhooks/VerificationRequestEventResponseSMS	com.sinch.sdk.domains.verification.models.v1.sinchevents.VerificationStartEventResponseSms
models/webhooks/VerificationResultEvent	com.sinch.sdk.domains.verification.models.v1.sinchevents.VerificationResultEvent

• event field removed from VerificationRequestEvent, VerificationResultEvent events.
• method values based onto common VerificationMethod class.
• VerificationMethod.DATA enum no longer defined. No need to be replaced because not public definition is required.
• template field removed from VerificationStartRequestSms.

Mailgun

Full Mailgun support (introduced in SDK 1.6 as preview) has been removed in SDK V2. There is no replacement within this SDK. To continue using Mailgun, integrate Mailgun's SDKs directly.

Removed entry point

• SinchClient.mailgun() has been removed. Remove all calls to this method and its returned service.

Removed Configuration.Builder methods

• Configuration.Builder.setMailgunApiKey(String apiKey)
• Configuration.Builder.setMailgunUrl(String url)
• Configuration.Builder.setMailgunRegion(MailgunRegion region)

Removed classes

• com.sinch.sdk.models.MailgunCredentials
• com.sinch.sdk.models.MailgunRegion

Removed service interfaces and implementations

• com.sinch.sdk.domains.mailgun.MailgunService
• com.sinch.sdk.domains.mailgun.api.v1.MailgunService
• com.sinch.sdk.domains.mailgun.api.v1.EmailsService
• com.sinch.sdk.domains.mailgun.api.v1.TemplatesService

Removed email request/response models

• com.sinch.sdk.domains.mailgun.models.v1.emails
• com.sinch.sdk.domains.mailgun.models.v1.templates

---

1.5.0

Find migration guides in the developer documentation portal:

• Messaging
• Numbers
• Verification
• Voice