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

Interface OptInEventNotification

public interface OptInEventNotification

OptInEventNotification

Nested Class Summary

Nested Classes

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

Method Summary

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

Method Details

getRequestId

String getRequestId()

ID generated when making an opt-in 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-in. 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

OptInEventNotification.StatusEnum getStatus()

Status of the opt-in registration.

Returns:

status

getErrorDetails

OptInEventNotificationErrorDetails getErrorDetails()

Get errorDetails

Returns:

errorDetails

getProcessingMode

ProcessingMode getProcessingMode()

Get processingMode

Returns:

processingMode

builder

static OptInEventNotification.Builder builder()

Getting builder

Returns:

New Builder instance