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

    Interface SendAgentJoinedEventRequest<T>

    interface SendAgentJoinedEventRequest<T extends Recipient> {
        app_id: string;
        callback_url?: string;
        channel_priority_order?: string[];
        event: AgentJoinedEvent;
        event_metadata?: string;
        queue?: string;
        recipient: T;
    }

    Type Parameters

    Hierarchy

    • SendEventRequestBase<T>
      • SendAgentJoinedEventRequest
    Index

    Properties

    app_id callback_url? channel_priority_order? event event_metadata? queue? recipient

    Properties

    app_id: string

    The ID of the app sending the event.

    callback_url?: string

    Overwrites the default callback url for delivery receipts for this message The REST URL should be of the form: http://host[:port]/path

    channel_priority_order?: string[]

    Optional. A single element array that dictates on what channel should the Conversation API try to send the event. It overrides any default set on the contact. Providing more than one option has no effect.

    event: AgentJoinedEvent

    AgentJoinedEvent

    event_metadata?: string

    Optional. Eventual metadata that should be associated to the event.

    queue?: string

    MessageQueue

    recipient: T

    Recipient

    Settings

    Member Visibility

    On This Page

    Properties