Interface ListChatConversationsOptions

interface ListChatConversationsOptions {
    after?: string;
    assignee_id?: string;
    flag?: "hidden" | "spam" | "none";
    limit?: number;
    q?: string;
    site_id?: string;
    status?: ChatConversationStatus | ChatConversationStatus[];
    unanswered?: boolean;
    visitor_id?: string;
}

Index

Properties

after? assignee_id? flag? limit? q? site_id? status? unanswered? visitor_id?

Properties

`Optional`after

after?: string

`Optional`assignee_id

assignee_id?: string

`Optional`flag

flag?: "hidden" | "spam" | "none"

Default: only unflagged conversations.

`Optional`limit

limit?: number

`Optional`q

q?: string

`Optional`site_id

site_id?: string

`Optional`status

status?: ChatConversationStatus | ChatConversationStatus[]

One or more of open, pending, resolved, closed.

`Optional`unanswered

unanswered?: boolean

Only conversations where the visitor sent the last message.

`Optional`visitor_id

visitor_id?: string