zendesk-messaging-client
    Preparing search index...

    Type Alias AuthorReadable

    The author of the message.

    type AuthorReadable = {
        avatarUrl?: Icon;
        displayName?: string;
        subtypes?: ("AI" | "activity")[];
        type: "business" | "user";
        userId?: string;
    }
    Index

    Properties

    avatarUrl? displayName? subtypes? type userId?

    Properties

    avatarUrl?: Icon

    A custom message icon URL. The image must be JPG, PNG, or GIF format.

    displayName?: string

    The display name of the message author.

    subtypes?: ("AI" | "activity")[]

    A string array that indicates the author's subtypes. Messages from "business" type with an "AI" subtype are generated by AI and a disclaimer is appended to the text of the message sent to the customer. For third-party channels, the disclaimer is applied for image, file, and text message types. Message with an "activity" subtype are generated by system activities.

    type: "business" | "user"

    The author type. Either "user" (representing the end user) or "business" (sent on behalf of the business).

    userId?: string

    The id of the user. Only supported when type is user.

    Settings

    Member Visibility

    On This Page

    Properties