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

    Interface ConversationStartEvent

    This callback is sent when a new conversation between the subscribed app and a contact is started.

    interface ConversationStartEvent {
        accepted_time?: Date;
        app_id: string;
        conversation_start_notification?: ConversationNotification;
        correlation_id?: string;
        event_time?: Date;
        message_metadata?: string;
        project_id: string;
        trigger: "CONVERSATION_START";
    }

    Hierarchy

    • ConversationCallbackEvent
      • ConversationStartEvent
    Index

    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.

    conversation_start_notification?: ConversationNotification

    ConversationNotification

    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.

    project_id: string

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

    trigger: "CONVERSATION_START"

    Name of the trigger responsible for this event.