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

Interface OptOutEvent

All Superinterfaces:

ConversationWebhookEvent

public interface OptOutEvent
extends ConversationWebhookEvent

This callback is used to deliver opt-out notifications from the channels.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	OptOutEvent.Builder	Dedicated Builder

Method Summary

Modifier and Type	Method	Description
static OptOutEvent.Builder	builder()	Getting builder
Instant	getAcceptedTime()	Timestamp marking when the channel callback was accepted/received by the Conversation API.
String	getAppId()	Id of the subscribed app.
String	getCorrelationId()	The value provided in field correlation_id of a send message request.
Instant	getEventTime()	Timestamp of the event as provided by the underlying channels.
String	getMessageMetadata()	Context-dependent metadata.
OptOutEventNotification	getNotification()	Get notification
String	getProjectId()	The project ID of the app which has subscribed for the callback.

Method Details

getAppId

String getAppId()

Id of the subscribed app.

Specified by:

getAppId in interface ConversationWebhookEvent

Returns:

appId

getAcceptedTime

Instant getAcceptedTime()

Timestamp marking when the channel callback was accepted/received by the Conversation API.

Specified by:

getAcceptedTime in interface ConversationWebhookEvent

Returns:

acceptedTime

getEventTime

Instant getEventTime()

Timestamp of the event as provided by the underlying channels.

Specified by:

getEventTime in interface ConversationWebhookEvent

Returns:

eventTime

getProjectId

String getProjectId()

The project ID of the app which has subscribed for the callback.

Specified by:

getProjectId in interface ConversationWebhookEvent

Returns:

projectId

getMessageMetadata

String getMessageMetadata()

Context-dependent metadata. Refer to specific callback's documentation for exact information provided.

Specified by:

getMessageMetadata in interface ConversationWebhookEvent

Returns:

messageMetadata

getCorrelationId

String getCorrelationId()

The value provided in field correlation_id of a send message request.

Specified by:

getCorrelationId in interface ConversationWebhookEvent

Returns:

correlationId

getNotification

OptOutEventNotification getNotification()

Get notification

Returns:

notification

builder

static OptOutEvent.Builder builder()

Getting builder

Returns:

New Builder instance