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

    Interface CreateConversationRequest

    The conversation to create.

    interface CreateConversationRequest {
        active?: boolean;
        active_channel?: string;
        app_id: string;
        contact_id: string;
        correlation_id?: string;
        metadata?: string;
        metadata_json?: object;
    }
    Index

    Properties

    active? active_channel? app_id contact_id correlation_id? metadata? metadata_json?

    Properties

    active?: boolean

    Flag for whether this conversation is active.

    active_channel?: string

    ConversationChannel

    app_id: string

    The ID of the participating app.

    contact_id: string

    The ID of the participating contact.

    correlation_id?: string

    Arbitrary correlation ID related to the MT message set by the Conversation API user.

    metadata?: string

    Arbitrary data set by the Conversation API clients. Up to 1024 characters long. NOTE: This field has been deprecated due to changes in the system architecture or functionality.

    It is no longer actively maintained and may be removed in future versions. Please avoid relying on this field in new code.

    metadata_json?: object

    Arbitrary data set by the Conversation API clients and/or provided in the conversation_metadata field of a SendMessageRequest. A valid JSON object.

    Settings

    Member Visibility

    On This Page

    Properties