@webitel/api-services
    Preparing search index...

    Type Alias CatalogGetMembersParams

    Generated by orval v8.5.3 🍺 Do not edit manually. Webitel API OpenAPI spec version: 24.04.0

    type CatalogGetMembersParams = {
        dateSince?: string;
        dateUntil?: string;
        fields?: string[];
        id?: string[];
        joined?: boolean;
        online?: boolean;
        page?: number;
        peerId?: string;
        peerName?: string;
        peerType?: string;
        q?: string;
        size?: number;
        sort?: string[];
        viaId?: string;
        viaName?: string;
        viaType?: string;
    }
    Index

    Properties

    dateSince? dateUntil? fields? id? joined? online? page? peerId? peerName? peerType? q? size? sort? viaId? viaName? viaType?

    Properties

    dateSince?: string

    Since epochtime (milli). Match*: greater than ..

    dateUntil?: string

    Until epochtime (milli). Match*: less or equal ..

    fields?: string[]

    Fields [Q]uery to build result dataset record.

    id?: string[]

    Set of unique chat member ID.

    joined?: boolean

    Participants ONLY who have [not] been connected to the chat. ( join: ( 0 ? [request|abandoned] : connected ) )

    online?: boolean

    Participants ONLY who are currently [not] connected to the chat. ( left: ( 0 ? online : offline ) )

    Optionalpage

    page?: number

    Page number to return. default: 1.

    peerId?: string

    Contact unique IDentifier. Contact type-specific string.

    peerName?: string

    Contact display name.

    peerType?: string

    Contact type provider.

    q?: string

    Search term: peer(type;name)

    size?: number

    Page records limit. default: 16.

    sort?: string[]

    Sort records by { fields } specification.

    viaId?: string

    Contact unique IDentifier. Contact type-specific string.

    viaName?: string

    Contact display name.

    viaType?: string

    Contact type provider.

    Settings

    Member Visibility

    On This Page

    Properties