Package com.sinch.sdk.domains.conversation.models.v1.webhooks.events.opting

Interface OptOutEventNotification

public interface OptOutEventNotification

OptOutEventNotification

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	OptOutEventNotification.Builder	Dedicated Builder
static class	OptOutEventNotification.StatusEnum	Status of the opt-out registration.

Method Summary

Modifier and Type	Method	Description
static OptOutEventNotification.Builder	builder()	Getting builder
ConversationChannel	getChannel()	Get channel
String	getContactId()	The ID of the contact which is the subject of the opt-out.
OptOutEventNotificationErrorDetails	getErrorDetails()	Get errorDetails
String	getIdentity()	The channel identity.
ProcessingMode	getProcessingMode()	Get processingMode
String	getRequestId()	ID generated when making an opt-out registration request.
OptOutEventNotification.StatusEnum	getStatus()	Status of the opt-out registration.

Method Details

getRequestId

String getRequestId()

ID generated when making an opt-out registration request. Can be used to detect duplicates.

Returns:

requestId

getContactId

String getContactId()

The ID of the contact which is the subject of the opt-out. Will be empty if processing_mode is DISPATCH.

Returns:

contactId

getChannel

ConversationChannel getChannel()

Get channel

Returns:

channel

getIdentity

String getIdentity()

The channel identity. For example, a phone number for SMS, WhatsApp and Viber Business.

Returns:

identity

getStatus

OptOutEventNotification.StatusEnum getStatus()

Status of the opt-out registration.

Returns:

status

getErrorDetails

OptOutEventNotificationErrorDetails getErrorDetails()

Get errorDetails

Returns:

errorDetails

getProcessingMode

ProcessingMode getProcessingMode()

Get processingMode

Returns:

processingMode

builder

static OptOutEventNotification.Builder builder()

Getting builder

Returns:

New Builder instance