zendesk-messaging-client
    Preparing search index...

    Type Alias Client

    type Client = {
        avatarUrl?: string | null;
        displayName?: string | null;
        externalId?: string | null;
        id?: string;
        info?: { [key: string]: unknown } | null;
        integrationId?: string | null;
        lastSeen?: string | null;
        linkedAt?: string | null;
        raw?: { [key: string]: unknown } | null;
        status?: "active" | "blocked" | "inactive" | "pending";
        type?: ClientType;
    }
    Index

    Properties

    avatarUrl? displayName? externalId? id? info? integrationId? lastSeen? linkedAt? raw? status? type?

    Properties

    avatarUrl?: string | null

    The URL for the user's avatar on the channel.

    displayName?: string | null

    The user's display name on the channel.

    externalId?: string | null

    The ID of the user on an external channel. For example, the user’s phone number for Twilio, or their page-scoped user ID for Facebook Messenger. Applies only to non-SDK clients.

    id?: string

    The unique ID of the client.

    info?: { [key: string]: unknown } | null

    A flat curated object with properties that vary for each client platform. All keys are optional and not guaranteed to be available.

    integrationId?: string | null

    The ID of the integration that the client was created for. Unused for clients of type sdk, as they incorporate multiple integrations.

    lastSeen?: string | null

    A datetime string with the format YYYY-MM-DDThh:mm:ss.SSSZ representing the last time the user interacted with this client.

    linkedAt?: string | null

    A timestamp signifying when the client was added to the user. Formatted as YYYY-MM-DDThh:mm:ss.SSSZ.

    raw?: { [key: string]: unknown } | null

    An object with raw properties that vary for each client platform. All keys are optional and not guaranteed to be available.

    status?: "active" | "blocked" | "inactive" | "pending"

    The client status. Indicates if the client is able to receive messages or not. Can be pending, inactive, active, or blocked.

    type?: ClientType

    Settings

    Member Visibility

    On This Page

    Properties