Sinch Node.js SDK - v1.5.0
    Preparing search index...

    Interface OptOutEvent

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

    interface OptOutEvent {
        accepted_time?: Date;
        app_id: string;
        correlation_id?: string;
        event_time?: Date;
        message_metadata?: string;
        opt_out_notification?: OptOutNotification;
        project_id: string;
        trigger: "OPT_OUT";
    }

    Hierarchy

    • ConversationCallbackEvent
      • OptOutEvent
    Index

    Properties

    accepted_time? app_id correlation_id? event_time? message_metadata? opt_out_notification? project_id trigger

    Properties

    accepted_time?: Date

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

    app_id: string

    Id of the subscribed app.

    correlation_id?: string

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

    event_time?: Date

    Timestamp of the event as provided by the underlying channels.

    message_metadata?: string

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

    opt_out_notification?: OptOutNotification

    OptOutNotification

    project_id: string

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

    trigger: "OPT_OUT"

    Name of the trigger responsible for this event.

    Settings

    Member Visibility

    On This Page

    Properties