OleonDocs
Esc
    Open workspace
    OleonDocs
    Open workspace

    Tools

    Conversations

    Who is waiting, what was said, and whether messages arrived.

    Conversation tools return metadata by default: who, when, which direction, delivery status and failure reasons. Message text is replaced with [redacted] (N chars) unless a tool is asked for it with include_message_text. See Privacy and redaction.

    Customers are identified by a user_id, which list_conversations and search_messages return.

    list_conversations

    Conversations in a project, most recently active first. Each row is one customer: who they are, when they last wrote, how many messages are unread, their labels and who the conversation is assigned to. Message text is not included.

    Use it to answer "who is waiting" or "what is my team looking at".

    project_slugstringrequired

    The project to read.

    unreadboolean

    Only conversations with unread messages.

    labelsstring

    Comma-separated label names, such as VIP,Refund.

    assigned_tostring

    The agent user id the conversation is assigned to.

    window_monthsinteger

    How far back to look, from 1 to 24 months. Defaults to the recent window; raise it to reach older conversations.

    limitintegerdefault: 25

    Rows to return, from 1 to 100.

    Ask it things like

    • "Who has been waiting longest for a reply in acme-support?"
    • "How many unread conversations are labelled VIP?"

    search_messages

    Full-text search across a project's message history. Returns the conversations and messages that match.

    Use it to find a conversation when you know roughly what was said but not who said it.

    project_slugstringrequired

    The project to search.

    qstringrequired

    What to search for.

    user_idstring

    Restrict the search to one customer. A UUID.

    window_monthsinteger

    How far back to search, from 1 to 24 months.

    include_message_textbooleandefault: false

    Return the words themselves. Only when the question cannot be answered without them: each such call is recorded in the audit log.

    limitintegerdefault: 25

    Rows to return, from 1 to 100.

    Ask it things like

    • "Find the customer who asked about a bulk discount last month."
    • "Has anyone mentioned a damaged delivery this week?"

    get_conversation

    One customer's message history in a project: direction, timestamps, delivery status and failure reasons.

    Use it after list_conversations or search_messages has identified the customer.

    project_slugstringrequired

    The project the conversation belongs to.

    user_idstringrequired

    The customer, from list_conversations or search_messages.

    include_message_textbooleandefault: false

    Return the words themselves. Each such call is recorded in the audit log.

    limitintegerdefault: 25

    Messages to return, from 1 to 100.

    get_message_status

    Delivery status for messages in a project: sent, delivered, read or failed, with the provider's reason for a failure.

    This is the tool for "did it arrive" and "why not".

    project_slugstringrequired

    The project to read.

    limitintegerdefault: 25

    Rows to return, from 1 to 100.

    list_pinned_conversations

    Conversations your team has pinned in a project, and who pinned each one.

    Pinned usually means someone wanted it followed up, so this answers "what is the team keeping an eye on".

    project_slugstringrequired

    The project to read.

    limitintegerdefault: 25

    Rows to return, from 1 to 100.