{ "system": "Vast Helpdesk", "howTo": [ "Vast Helpdesk is a help desk run by typed terminal commands. It manages Business, cPanel, Email, Go Meter, Nextcloud, Shop and Web chat for a company and its clients.", "To run commands, send them as terminal lines, one per line, each starting with \"$ \" (or inside a ``` code block). Example:", "$ list businesses", "$ add business Solar Co", "Replace the example values with the real ones (names, emails, folders). Several steps: one line each, in the order they should run.", "Several steps are run ONE AT A TIME: the help desk runs the first, sends you its result (\"Done so far: 1. $ find folder TestMe → No folder named like TestMe\"), and asks for the next. Reply with the next command only, or \"done\" when it is finished (optionally \"reply: \"). So you can decide from each result, e.g. create a folder only if it was not found.", "If you are only given the name of a docs section and do not have these commands, reply \"send docs\" and the commands are sent to you.", "Only the commands in these pages exist. Everything else in a reply is ignored by the help desk. If you are not sure, give the most likely command.", "Every command is checked by the help desk before it runs (who is asking, what they own, limits, confirmations), so suggesting a command is always safe.", "Commands that create something (a folder, a user) reuse it when it already exists, so \"create it if it is missing\" is simply the create command: no need to search or check first.", "Names do not have to be exact: clients, staff, chats, groups, businesses and mailboxes are found by part of the name, a small typo, a phone number written any way, or an earlier name. When several fit, the person is asked which one (a numbered list).", "Before something changes, the person answers yes (do it), no (not what I meant: the help desk asks again) or cancel (stop)." ], "format": "One terminal line per command, starting with \"$ \". Replace example values with real ones.", "sections": [ { "id": "console", "title": "Console", "lead": "Managing the help desk itself: clients, chats, tickets, rules, plugins and settings. Staff only.", "tips": [], "commands": [ { "id": "audit_recent", "command": "what happened today", "form": null, "title": "Recent activity", "details": [ { "name": "who", "kind": "person or people", "optional": true } ], "also": [ "what did Hadi do" ], "readOnly": true, "who": [ "admin", "owner" ], "explanation": { "id": "audit_recent", "command": "what happened today", "form": null, "title": "Recent activity", "details": [ { "name": "who", "kind": "person or people", "optional": true } ], "also": [ "what did Hadi do" ], "readOnly": true, "who": [ "admin", "owner" ], "whatItDoes": "Recent activity", "uses": "only reads (safe)", "runsThrough": [], "gates": [ "runs without confirmation (it only reads)" ], "errors": [], "related": [ "Hello", "thanks", "help", "how many tickets do I have left" ] } }, { "id": "admins_list", "command": "list admins", "form": null, "title": "List admins", "details": [], "also": [], "readOnly": true, "who": [ "admin", "owner" ], "explanation": { "id": "admins_list", "command": "list admins", "form": null, "title": "List admins", "details": [], "also": [], "readOnly": true, "who": [ "admin", "owner" ], "whatItDoes": "List admins", "uses": "only reads (safe)", "runsThrough": [], "gates": [ "runs without confirmation (it only reads)" ], "errors": [], "related": [ "Hello", "thanks", "help", "how many tickets do I have left" ] } }, { "id": "clients_list", "command": "list clients", "form": null, "title": "List clients", "details": [ { "name": "q", "kind": "name or number to find", "optional": true } ], "also": [ "how many clients do i have", "i need to know how many clients i have" ], "readOnly": true, "who": [ "admin", "owner" ], "explanation": { "id": "clients_list", "command": "list clients", "form": null, "title": "List clients", "details": [ { "name": "q", "kind": "name or number to find", "optional": true } ], "also": [ "how many clients do i have", "i need to know how many clients i have" ], "readOnly": true, "who": [ "admin", "owner" ], "whatItDoes": "List clients", "uses": "only reads (safe)", "runsThrough": [], "gates": [ "runs without confirmation (it only reads)" ], "errors": [], "related": [ "Hello", "thanks", "help", "how many tickets do I have left" ] } }, { "id": "pending_list", "command": "pending", "form": null, "title": "What is waiting for confirmation", "details": [], "also": [ "list pending" ], "readOnly": true, "who": [ "admin", "owner" ], "explanation": { "id": "pending_list", "command": "pending", "form": null, "title": "What is waiting for confirmation", "details": [], "also": [ "list pending" ], "readOnly": true, "who": [ "admin", "owner" ], "whatItDoes": "What is waiting for confirmation", "uses": "only reads (safe)", "runsThrough": [], "gates": [ "runs without confirmation (it only reads)" ], "errors": [], "related": [ "Hello", "thanks", "help", "how many tickets do I have left" ] } }, { "id": "undo_last", "command": "undo", "form": null, "title": "Undo my last action", "details": [], "also": [ "undo that" ], "readOnly": false, "who": [ "admin", "owner" ], "explanation": { "id": "undo_last", "command": "undo", "form": null, "title": "Undo my last action", "details": [], "also": [ "undo that" ], "readOnly": false, "who": [ "admin", "owner" ], "whatItDoes": "Undo my last action", "uses": "only reads (safe)", "runsThrough": [], "gates": [ "shown for a yes before it runs" ], "errors": [], "related": [ "Hello", "thanks", "help", "how many tickets do I have left" ] } }, { "id": "status", "command": "status", "form": null, "title": "Status of the assistant", "details": [], "also": [ "are you online" ], "readOnly": true, "who": [ "admin", "owner" ], "explanation": { "id": "status", "command": "status", "form": null, "title": "Status of the assistant", "details": [], "also": [ "are you online" ], "readOnly": true, "who": [ "admin", "owner" ], "whatItDoes": "Shows today's numbers, waiting confirmations, whether the brain is answering, and the outgoing-message budget.", "uses": "only reads (safe)", "runsThrough": [], "gates": [ "runs without confirmation (it only reads)" ], "errors": [], "related": [ "Hello", "thanks", "help", "how many tickets do I have left" ] } }, { "id": "brains_info", "command": "which model is with me", "form": null, "title": "Which brains (AI) are in use, their models and today's cost", "details": [], "also": [ "which brain", "show brains" ], "readOnly": true, "who": [ "admin", "owner" ], "explanation": { "id": "brains_info", "command": "which model is with me", "form": null, "title": "Which brains (AI) are in use, their models and today's cost", "details": [], "also": [ "which brain", "show brains" ], "readOnly": true, "who": [ "admin", "owner" ], "whatItDoes": "Each brain in the order it is asked, whether it answers, its model, conversations kept and today's cost against its budget.", "uses": "only reads (safe)", "runsThrough": [], "gates": [ "runs without confirmation (it only reads)" ], "errors": [], "related": [ "Hello", "thanks", "help", "how many tickets do I have left" ] } }, { "id": "pause", "command": "pause", "form": null, "title": "Pause the assistant", "details": [], "also": [], "readOnly": false, "who": [ "admin", "owner" ], "explanation": { "id": "pause", "command": "pause", "form": null, "title": "Pause the assistant", "details": [], "also": [], "readOnly": false, "who": [ "admin", "owner" ], "whatItDoes": "Pause the assistant", "uses": "only reads (safe)", "runsThrough": [], "gates": [ "shown for a yes before it runs" ], "errors": [], "related": [ "Hello", "thanks", "help", "how many tickets do I have left" ] } }, { "id": "resume", "command": "resume", "form": null, "title": "Resume the assistant", "details": [], "also": [], "readOnly": false, "who": [ "owner" ], "explanation": { "id": "resume", "command": "resume", "form": null, "title": "Resume the assistant", "details": [], "also": [], "readOnly": false, "who": [ "owner" ], "whatItDoes": "Resume the assistant", "uses": "only reads (safe)", "runsThrough": [], "gates": [ "shown for a yes before it runs" ], "errors": [], "related": [ "Hello", "thanks", "help", "how many tickets do I have left" ] } }, { "id": "rules_list", "command": "list rules", "form": null, "title": "Show global rules", "details": [], "also": [], "readOnly": true, "who": [ "admin", "owner" ], "explanation": { "id": "rules_list", "command": "list rules", "form": null, "title": "Show global rules", "details": [], "also": [], "readOnly": true, "who": [ "admin", "owner" ], "whatItDoes": "Show global rules", "uses": "only reads (safe)", "runsThrough": [], "gates": [ "runs without confirmation (it only reads)" ], "errors": [], "related": [ "Hello", "thanks", "help", "how many tickets do I have left" ] } }, { "id": "rule_global_add", "command": "add rule: never share /Legal after 10pm", "form": "add rule: ", "title": "Add a global rule", "details": [ { "name": "text", "kind": "text", "optional": false } ], "also": [ "add global rule nobody can share /Finance" ], "readOnly": false, "who": [ "owner" ], "explanation": { "id": "rule_global_add", "command": "add rule: never share /Legal after 10pm", "form": "add rule: ", "title": "Add a global rule", "details": [ { "name": "text", "kind": "text", "optional": false } ], "also": [ "add global rule nobody can share /Finance" ], "readOnly": false, "who": [ "owner" ], "whatItDoes": "Add a global rule", "uses": "only reads (safe)", "runsThrough": [], "gates": [ "shown for a yes before it runs", "changes the help desk itself (owner console)" ], "errors": [], "related": [ "Hello", "thanks", "help", "how many tickets do I have left" ] } }, { "id": "rule_global_remove", "command": "remove rule 4", "form": "remove rule ", "title": "Remove a global rule", "details": [ { "name": "num", "kind": "number", "optional": false } ], "also": [], "readOnly": false, "who": [ "owner" ], "explanation": { "id": "rule_global_remove", "command": "remove rule 4", "form": "remove rule ", "title": "Remove a global rule", "details": [ { "name": "num", "kind": "number", "optional": false } ], "also": [], "readOnly": false, "who": [ "owner" ], "whatItDoes": "Remove a global rule", "uses": "only reads (safe)", "runsThrough": [], "gates": [ "shown for a yes before it runs", "changes the help desk itself (owner console)" ], "errors": [], "related": [ "Hello", "thanks", "help", "how many tickets do I have left" ] } }, { "id": "client_add", "command": "add client Acme", "form": "add client ", "title": "Add a client", "details": [ { "name": "cname", "kind": "client name", "optional": false } ], "also": [ "register new client \"Acme Ltd\"" ], "readOnly": false, "who": [ "owner" ], "explanation": { "id": "client_add", "command": "add client Acme", "form": "add client ", "title": "Add a client", "details": [ { "name": "cname", "kind": "client name", "optional": false } ], "also": [ "register new client \"Acme Ltd\"" ], "readOnly": false, "who": [ "owner" ], "whatItDoes": "Add a client", "uses": "only reads (safe)", "runsThrough": [], "gates": [ "shown for a yes before it runs", "changes the help desk itself (owner console)" ], "errors": [], "related": [ "Hello", "thanks", "help", "how many tickets do I have left" ] } }, { "id": "client_remove", "command": "remove client Acme", "form": "remove client ", "title": "Remove a client", "details": [ { "name": "cname", "kind": "client name", "optional": false } ], "also": [], "readOnly": false, "who": [ "owner" ], "explanation": { "id": "client_remove", "command": "remove client Acme", "form": "remove client ", "title": "Remove a client", "details": [ { "name": "cname", "kind": "client name", "optional": false } ], "also": [], "readOnly": false, "who": [ "owner" ], "whatItDoes": "Remove a client", "uses": "only reads (safe)", "runsThrough": [], "gates": [ "shown for a yes before it runs", "changes the help desk itself (owner console)" ], "errors": [], "related": [ "Hello", "thanks", "help", "how many tickets do I have left" ] } }, { "id": "client_duplicates", "command": "duplicate clients", "form": null, "title": "List clients that share a phone number or email", "details": [], "also": [ "which clients share a number" ], "readOnly": true, "who": [ "admin", "owner" ], "explanation": { "id": "client_duplicates", "command": "duplicate clients", "form": null, "title": "List clients that share a phone number or email", "details": [], "also": [ "which clients share a number" ], "readOnly": true, "who": [ "admin", "owner" ], "whatItDoes": "One phone number or email belongs to one client (10.7.1). Lists numbers and emails under two clients (from before 10.7.1) and web chat leads named with another client's number, with the merge command to type.", "uses": "only reads (safe)", "runsThrough": [], "gates": [ "runs without confirmation (it only reads)", "changes the help desk itself (owner console)" ], "errors": [], "related": [ "Hello", "thanks", "help", "how many tickets do I have left" ] } }, { "id": "client_merge", "command": "merge client Rami web visitor into Rami Khoury", "form": "merge client into ", "title": "Merge one client into another (numbers, emails, chats, tickets)", "details": [ { "name": "cname", "kind": "client name", "optional": false }, { "name": "text", "kind": "text", "optional": false } ], "also": [], "readOnly": false, "who": [ "owner" ], "explanation": { "id": "client_merge", "command": "merge client Rami web visitor into Rami Khoury", "form": "merge client into ", "title": "Merge one client into another (numbers, emails, chats, tickets)", "details": [ { "name": "cname", "kind": "client name", "optional": false }, { "name": "text", "kind": "text", "optional": false } ], "also": [], "readOnly": false, "who": [ "owner" ], "whatItDoes": "The second client keeps its name and settings and gains the first one's numbers, emails, chats, allowed commands, notes and open tickets; the first is removed. Asks first; a new version of the rules document (rules rollback undoes it, the moved tickets stay).", "uses": "only reads (safe)", "runsThrough": [], "gates": [ "shown for a yes before it runs", "changes the help desk itself (owner console)" ], "errors": [], "related": [ "Hello", "thanks", "help", "how many tickets do I have left" ] } }, { "id": "client_show", "command": "show rules for Acme", "form": "show rules for ", "title": "Show one client's rules", "details": [ { "name": "cname", "kind": "client name", "optional": false } ], "also": [ "show client Acme" ], "readOnly": true, "who": [ "admin", "owner" ], "explanation": { "id": "client_show", "command": "show rules for Acme", "form": "show rules for ", "title": "Show one client's rules", "details": [ { "name": "cname", "kind": "client name", "optional": false } ], "also": [ "show client Acme" ], "readOnly": true, "who": [ "admin", "owner" ], "whatItDoes": "Show one client's rules", "uses": "only reads (safe)", "runsThrough": [], "gates": [ "runs without confirmation (it only reads)" ], "errors": [], "related": [ "Hello", "thanks", "help", "how many tickets do I have left" ] } }, { "id": "client_notes_show", "command": "show notes of client Acme", "form": "show notes of client ", "title": "Show a client's private notes", "details": [ { "name": "cname", "kind": "client name", "optional": false } ], "also": [ "list current private notes for Acme" ], "readOnly": true, "who": [ "admin", "owner" ], "explanation": { "id": "client_notes_show", "command": "show notes of client Acme", "form": "show notes of client ", "title": "Show a client's private notes", "details": [ { "name": "cname", "kind": "client name", "optional": false } ], "also": [ "list current private notes for Acme" ], "readOnly": true, "who": [ "admin", "owner" ], "whatItDoes": "Show a client's private notes", "uses": "only reads (safe)", "runsThrough": [], "gates": [ "runs without confirmation (it only reads)" ], "errors": [], "related": [ "Hello", "thanks", "help", "how many tickets do I have left" ] } }, { "id": "client_note", "command": "note for client Acme: be very polite, he is an old customer", "form": "note for client Acme: ", "title": "Set private notes for a client (they guide the AI)", "details": [ { "name": "cname", "kind": "client name", "optional": false }, { "name": "text", "kind": "text", "optional": false } ], "also": [], "readOnly": false, "who": [ "owner" ], "explanation": { "id": "client_note", "command": "note for client Acme: be very polite, he is an old customer", "form": "note for client Acme: ", "title": "Set private notes for a client (they guide the AI)", "details": [ { "name": "cname", "kind": "client name", "optional": false }, { "name": "text", "kind": "text", "optional": false } ], "also": [], "readOnly": false, "who": [ "owner" ], "whatItDoes": "Never shown to the client. Sent to the AI with that client's requests.", "uses": "only reads (safe)", "runsThrough": [], "gates": [ "shown for a yes before it runs", "changes the help desk itself (owner console)" ], "errors": [], "related": [ "Hello", "thanks", "help", "how many tickets do I have left" ] } }, { "id": "client_note_clear", "command": "clear notes for Acme", "form": "clear notes for ", "title": "Clear a client's private notes", "details": [ { "name": "cname", "kind": "client name", "optional": false } ], "also": [], "readOnly": false, "who": [ "owner" ], "explanation": { "id": "client_note_clear", "command": "clear notes for Acme", "form": "clear notes for ", "title": "Clear a client's private notes", "details": [ { "name": "cname", "kind": "client name", "optional": false } ], "also": [], "readOnly": false, "who": [ "owner" ], "whatItDoes": "Clear a client's private notes", "uses": "only reads (safe)", "runsThrough": [], "gates": [ "shown for a yes before it runs", "changes the help desk itself (owner console)" ], "errors": [], "related": [ "Hello", "thanks", "help", "how many tickets do I have left" ] } }, { "id": "client_enforce", "command": "staff only on for Acme", "form": " for ", "title": "Switch an enforced rule for a client", "details": [ { "name": "cname", "kind": "client name", "optional": false }, { "name": "cmode", "kind": "staff only, no ai or approve every change", "optional": false }, { "name": "switch", "kind": "on or off", "optional": false } ], "also": [ "turn off no ai for client Acme", "approve every change on for Acme" ], "readOnly": false, "who": [ "owner" ], "explanation": { "id": "client_enforce", "command": "staff only on for Acme", "form": " for ", "title": "Switch an enforced rule for a client", "details": [ { "name": "cname", "kind": "client name", "optional": false }, { "name": "cmode", "kind": "staff only, no ai or approve every change", "optional": false }, { "name": "switch", "kind": "on or off", "optional": false } ], "also": [ "turn off no ai for client Acme", "approve every change on for Acme" ], "readOnly": false, "who": [ "owner" ], "whatItDoes": "Enforced by the server. staff only: the router never answers, every message goes to staff. no ai: this client's messages are never sent to an AI. approve every change: each change waits for a staff yes.", "uses": "only reads (safe)", "runsThrough": [], "gates": [ "shown for a yes before it runs", "changes the help desk itself (owner console)" ], "errors": [], "related": [ "Hello", "thanks", "help", "how many tickets do I have left" ] } }, { "id": "chat_add_client", "command": "add number +96171123456 to client Acme", "form": "add number to client ", "title": "Link a chat, a group or a number to a client", "details": [ { "name": "chatref", "kind": "chat name or phone number", "optional": false }, { "name": "cname", "kind": "client name", "optional": false } ], "also": [ "add group \"Acme support\" to client Acme", "add requester +96171123456 to client Acme" ], "readOnly": false, "who": [ "owner" ], "explanation": { "id": "chat_add_client", "command": "add number +96171123456 to client Acme", "form": "add number to client ", "title": "Link a chat, a group or a number to a client", "details": [ { "name": "chatref", "kind": "chat name or phone number", "optional": false }, { "name": "cname", "kind": "client name", "optional": false } ], "also": [ "add group \"Acme support\" to client Acme", "add requester +96171123456 to client Acme" ], "readOnly": false, "who": [ "owner" ], "whatItDoes": "For a group, the router asks which members may make requests (default: only the ones you list). Nobody is ever added to a WhatsApp group by the router.", "uses": "only reads (safe)", "runsThrough": [], "gates": [ "shown for a yes before it runs", "changes the help desk itself (owner console)" ], "errors": [], "related": [ "Hello", "thanks", "help", "how many tickets do I have left" ] } }, { "id": "chat_add_admin", "command": "make group \"nextcloud ai\" an admin group", "form": "make group \"\" an admin group", "title": "Make a chat an admin chat", "details": [ { "name": "chatref", "kind": "chat name or phone number", "optional": false } ], "also": [ "add +96170111222 to admins" ], "readOnly": false, "who": [ "owner" ], "explanation": { "id": "chat_add_admin", "command": "make group \"nextcloud ai\" an admin group", "form": "make group \"\" an admin group", "title": "Make a chat an admin chat", "details": [ { "name": "chatref", "kind": "chat name or phone number", "optional": false } ], "also": [ "add +96170111222 to admins" ], "readOnly": false, "who": [ "owner" ], "whatItDoes": "Make a chat an admin chat", "uses": "only reads (safe)", "runsThrough": [], "gates": [ "shown for a yes before it runs", "changes the help desk itself (owner console)" ], "errors": [], "related": [ "Hello", "thanks", "help", "how many tickets do I have left" ] } }, { "id": "chat_remove", "command": "remove group \"Acme support\"", "form": "remove group \"\"", "title": "Stop listening to a chat", "details": [ { "name": "chatref", "kind": "chat name or phone number", "optional": false } ], "also": [ "stop listening to number +96171123456", "stop listening to +96171123456" ], "readOnly": false, "who": [ "owner" ], "explanation": { "id": "chat_remove", "command": "remove group \"Acme support\"", "form": "remove group \"\"", "title": "Stop listening to a chat", "details": [ { "name": "chatref", "kind": "chat name or phone number", "optional": false } ], "also": [ "stop listening to number +96171123456", "stop listening to +96171123456" ], "readOnly": false, "who": [ "owner" ], "whatItDoes": "Stop listening to a chat", "uses": "only reads (safe)", "runsThrough": [], "gates": [ "shown for a yes before it runs", "changes the help desk itself (owner console)" ], "errors": [], "related": [ "Hello", "thanks", "help", "how many tickets do I have left" ] } }, { "id": "never_all", "command": "never listen to all current chats", "form": null, "title": "Never listen to all the chats that exist now (not admin or client chats)", "details": [], "also": [ "make all current chats never listen", "ignore all existing chats" ], "readOnly": false, "who": [ "owner" ], "explanation": { "id": "never_all", "command": "never listen to all current chats", "form": null, "title": "Never listen to all the chats that exist now (not admin or client chats)", "details": [], "also": [ "make all current chats never listen", "ignore all existing chats" ], "readOnly": false, "who": [ "owner" ], "whatItDoes": "Every chat that exists NOW and is not an admin or client chat (and not staff or a client's own person) is set to never listen: it is not answered even when it names a business keyword or a default business is set. Chats that start after this are handled as usual. You see how many first and confirm.", "uses": "only reads (safe)", "runsThrough": [], "gates": [ "shown for a yes before it runs", "changes the help desk itself (owner console)" ], "errors": [], "related": [ "Hello", "thanks", "help", "how many tickets do I have left" ] } }, { "id": "never_add", "command": "never listen to +96171123456", "form": "never listen to ", "title": "Never listen to a chat (even with a business keyword)", "details": [ { "name": "chatref", "kind": "chat name or phone number", "optional": false } ], "also": [ "never listen to group \"Family\"", "always ignore number +96171123456" ], "readOnly": false, "who": [ "owner" ], "explanation": { "id": "never_add", "command": "never listen to +96171123456", "form": "never listen to ", "title": "Never listen to a chat (even with a business keyword)", "details": [ { "name": "chatref", "kind": "chat name or phone number", "optional": false } ], "also": [ "never listen to group \"Family\"", "always ignore number +96171123456" ], "readOnly": false, "who": [ "owner" ], "whatItDoes": "That chat is never answered, even when it names a business keyword or a default business is set. An admin or client chat must be stopped first.", "uses": "only reads (safe)", "runsThrough": [], "gates": [ "shown for a yes before it runs", "changes the help desk itself (owner console)" ], "errors": [], "related": [ "Hello", "thanks", "help", "how many tickets do I have left" ] } }, { "id": "never_remove", "command": "listen again to +96171123456", "form": "listen again to ", "title": "Listen again to a chat set to never listen", "details": [ { "name": "chatref", "kind": "chat name or phone number", "optional": false } ], "also": [ "stop ignoring group \"Family\"" ], "readOnly": false, "who": [ "owner" ], "explanation": { "id": "never_remove", "command": "listen again to +96171123456", "form": "listen again to ", "title": "Listen again to a chat set to never listen", "details": [ { "name": "chatref", "kind": "chat name or phone number", "optional": false } ], "also": [ "stop ignoring group \"Family\"" ], "readOnly": false, "who": [ "owner" ], "whatItDoes": "It is then treated like any new chat: a business keyword or the default business can answer it.", "uses": "only reads (safe)", "runsThrough": [], "gates": [ "shown for a yes before it runs", "changes the help desk itself (owner console)" ], "errors": [], "related": [ "Hello", "thanks", "help", "how many tickets do I have left" ] } }, { "id": "never_list", "command": "list never listen chats", "form": null, "title": "Chats set to never listen", "details": [], "also": [ "show ignored chats" ], "readOnly": false, "who": [ "owner" ], "explanation": { "id": "never_list", "command": "list never listen chats", "form": null, "title": "Chats set to never listen", "details": [], "also": [ "show ignored chats" ], "readOnly": false, "who": [ "owner" ], "whatItDoes": "Chats set to never listen", "uses": "only reads (safe)", "runsThrough": [], "gates": [ "shown for a yes before it runs", "changes the help desk itself (owner console)" ], "errors": [], "related": [ "Hello", "thanks", "help", "how many tickets do I have left" ] } }, { "id": "admin_add", "command": "add admin +96170111222", "form": "add admin ", "title": "Add an admin person", "details": [ { "name": "chatref", "kind": "chat name or phone number", "optional": false } ], "also": [], "readOnly": false, "who": [ "owner" ], "explanation": { "id": "admin_add", "command": "add admin +96170111222", "form": "add admin ", "title": "Add an admin person", "details": [ { "name": "chatref", "kind": "chat name or phone number", "optional": false } ], "also": [], "readOnly": false, "who": [ "owner" ], "whatItDoes": "Add an admin person", "uses": "only reads (safe)", "runsThrough": [], "gates": [ "shown for a yes before it runs", "changes the help desk itself (owner console)" ], "errors": [], "related": [ "Hello", "thanks", "help", "how many tickets do I have left" ] } }, { "id": "admin_remove", "command": "remove admin +96170111222", "form": "remove admin ", "title": "Remove an admin person", "details": [ { "name": "chatref", "kind": "chat name or phone number", "optional": false } ], "also": [], "readOnly": false, "who": [ "owner" ], "explanation": { "id": "admin_remove", "command": "remove admin +96170111222", "form": "remove admin ", "title": "Remove an admin person", "details": [ { "name": "chatref", "kind": "chat name or phone number", "optional": false } ], "also": [], "readOnly": false, "who": [ "owner" ], "whatItDoes": "Remove an admin person", "uses": "only reads (safe)", "runsThrough": [], "gates": [ "shown for a yes before it runs", "changes the help desk itself (owner console)" ], "errors": [], "related": [ "Hello", "thanks", "help", "how many tickets do I have left" ] } }, { "id": "client_owns", "command": "client Acme owns domain acme.com", "form": "client owns ", "title": "Say what a client owns", "details": [ { "name": "cname", "kind": "client name", "optional": false }, { "name": "otype", "kind": "what the client owns (e.g. a domain or a folder)", "optional": false }, { "name": "resource", "kind": "the domain, folder or account", "optional": false } ], "also": [ "give Acme folder /Clients/Acme", "client Acme owns cpanel account Main" ], "readOnly": false, "who": [ "owner" ], "explanation": { "id": "client_owns", "command": "client Acme owns domain acme.com", "form": "client owns ", "title": "Say what a client owns", "details": [ { "name": "cname", "kind": "client name", "optional": false }, { "name": "otype", "kind": "what the client owns (e.g. a domain or a folder)", "optional": false }, { "name": "resource", "kind": "the domain, folder or account", "optional": false } ], "also": [ "give Acme folder /Clients/Acme", "client Acme owns cpanel account Main" ], "readOnly": false, "who": [ "owner" ], "whatItDoes": "This is the list the server checks every client request against. Anything not listed here is refused.", "uses": "only reads (safe)", "runsThrough": [], "gates": [ "shown for a yes before it runs", "changes the help desk itself (owner console)" ], "errors": [], "related": [ "Hello", "thanks", "help", "how many tickets do I have left" ] } }, { "id": "client_disowns", "command": "remove domain old.com from Acme", "form": "remove from ", "title": "Remove something a client owns", "details": [ { "name": "otype", "kind": "what the client owns (e.g. a domain or a folder)", "optional": false }, { "name": "resource", "kind": "the domain, folder or account", "optional": false }, { "name": "cname", "kind": "client name", "optional": false } ], "also": [], "readOnly": false, "who": [ "owner" ], "explanation": { "id": "client_disowns", "command": "remove domain old.com from Acme", "form": "remove from ", "title": "Remove something a client owns", "details": [ { "name": "otype", "kind": "what the client owns (e.g. a domain or a folder)", "optional": false }, { "name": "resource", "kind": "the domain, folder or account", "optional": false }, { "name": "cname", "kind": "client name", "optional": false } ], "also": [], "readOnly": false, "who": [ "owner" ], "whatItDoes": "Remove something a client owns", "uses": "only reads (safe)", "runsThrough": [], "gates": [ "shown for a yes before it runs", "changes the help desk itself (owner console)" ], "errors": [], "related": [ "Hello", "thanks", "help", "how many tickets do I have left" ] } }, { "id": "client_allow", "command": "allow Acme to create mailboxes", "form": "allow to ", "title": "Allow a client to do something", "details": [ { "name": "cname", "kind": "client name", "optional": false }, { "name": "what", "kind": "command name", "optional": false } ], "also": [ "allow Acme to add dns records" ], "readOnly": false, "who": [ "owner" ], "explanation": { "id": "client_allow", "command": "allow Acme to create mailboxes", "form": "allow to ", "title": "Allow a client to do something", "details": [ { "name": "cname", "kind": "client name", "optional": false }, { "name": "what", "kind": "command name", "optional": false } ], "also": [ "allow Acme to add dns records" ], "readOnly": false, "who": [ "owner" ], "whatItDoes": "\"what\" is matched against the titles in this playbook. If it is unclear the router shows the closest titles and asks. Wildcards such as \"anything\" or \"everything\" are never accepted.", "uses": "only reads (safe)", "runsThrough": [], "gates": [ "shown for a yes before it runs", "changes the help desk itself (owner console)" ], "errors": [], "related": [ "Hello", "thanks", "help", "how many tickets do I have left" ] } }, { "id": "client_deny", "command": "stop Acme from adding dns records", "form": "stop from ", "title": "Stop a client from doing something", "details": [ { "name": "cname", "kind": "client name", "optional": false }, { "name": "what", "kind": "command name", "optional": false } ], "also": [], "readOnly": false, "who": [ "owner" ], "explanation": { "id": "client_deny", "command": "stop Acme from adding dns records", "form": "stop from ", "title": "Stop a client from doing something", "details": [ { "name": "cname", "kind": "client name", "optional": false }, { "name": "what", "kind": "command name", "optional": false } ], "also": [], "readOnly": false, "who": [ "owner" ], "whatItDoes": "Stop a client from doing something", "uses": "only reads (safe)", "runsThrough": [], "gates": [ "shown for a yes before it runs", "changes the help desk itself (owner console)" ], "errors": [], "related": [ "Hello", "thanks", "help", "how many tickets do I have left" ] } }, { "id": "client_files_set", "command": "allow client Acme to send files", "form": "allow client to send files", "title": "Let a client send files (photos, voice notes, documents) or not", "details": [ { "name": "cname", "kind": "client name", "optional": false }, { "name": "switch", "kind": "on or off", "optional": true } ], "also": [ "stop Acme from sending files", "files off for client Acme" ], "readOnly": false, "who": [ "owner" ], "explanation": { "id": "client_files_set", "command": "allow client Acme to send files", "form": "allow client to send files", "title": "Let a client send files (photos, voice notes, documents) or not", "details": [ { "name": "cname", "kind": "client name", "optional": false }, { "name": "switch", "kind": "on or off", "optional": true } ], "also": [ "stop Acme from sending files", "files off for client Acme" ], "readOnly": false, "who": [ "owner" ], "whatItDoes": "Their photos, voice notes and documents then reach the team (with their open ticket, if any). The AI does not look at them. Clients of a business can also be allowed all at once (allow clients of business … to send files). Settings → Files must allow receiving files too.", "uses": "only reads (safe)", "runsThrough": [], "gates": [ "shown for a yes before it runs", "changes the help desk itself (owner console)" ], "errors": [], "related": [ "Hello", "thanks", "help", "how many tickets do I have left" ] } }, { "id": "files_test", "command": "test file on whatsapp", "form": "test file on ", "title": "Test sending files (a photo and a PDF) over a channel: WhatsApp, Telegram or a mailbox", "details": [ { "name": "ch", "kind": "channel (as Files → Test lists it)", "optional": false }, { "name": "to", "kind": "to (time)", "optional": true } ], "also": [ "test files on telegram to Hadi", "test file on email sales" ], "readOnly": false, "who": [ "owner" ], "explanation": { "id": "files_test", "command": "test file on whatsapp", "form": "test file on ", "title": "Test sending files (a photo and a PDF) over a channel: WhatsApp, Telegram or a mailbox", "details": [ { "name": "ch", "kind": "channel (as Files → Test lists it)", "optional": false }, { "name": "to", "kind": "to (time)", "optional": true } ], "also": [ "test files on telegram to Hadi", "test file on email sales" ], "readOnly": false, "who": [ "owner" ], "whatItDoes": "Sends a small test photo and PDF (to your console by default, or a staff member or an admin chat named after \"to\"; a mailbox sends them to itself and checks that they arrive) and reports each step. The test files are deleted afterwards. Also in the panel: Files → Test.", "uses": "only reads (safe)", "runsThrough": [], "gates": [ "shown for a yes before it runs", "changes the help desk itself (owner console)" ], "errors": [], "related": [ "Hello", "thanks", "help", "how many tickets do I have left" ] } }, { "id": "msg_send", "command": "send a message to Yahya: your order is ready", "form": "send a message to Yahya: ", "title": "Send a message to a chat, a client, or many (all clients, the clients of a business, all chats, chats not listening, one channel)", "details": [ { "name": "target", "kind": "user or group", "optional": false }, { "name": "text", "kind": "text", "optional": false } ], "also": [ "send to all clients: we are closed tomorrow", "send to solar clients: new battery prices next week" ], "readOnly": false, "who": [ "admin", "owner" ], "explanation": { "id": "msg_send", "command": "send a message to Yahya: your order is ready", "form": "send a message to Yahya: ", "title": "Send a message to a chat, a client, or many (all clients, the clients of a business, all chats, chats not listening, one channel)", "details": [ { "name": "target", "kind": "user or group", "optional": false }, { "name": "text", "kind": "text", "optional": false } ], "also": [ "send to all clients: we are closed tomorrow", "send to solar clients: new battery prices next week" ], "readOnly": false, "who": [ "admin", "owner" ], "whatItDoes": "Shows who gets it, who is left out and why, the pace and the text, then asks for a yes. On WhatsApp only listened chats that wrote to us before, at most 30 per send and 30 a day, one every 30-60 seconds, 09:00-20:00; each message gets their name and \"Reply STOP\".", "uses": "only reads (safe)", "runsThrough": [], "gates": [ "shown for a yes before it runs", "changes the help desk itself (owner console)" ], "errors": [], "related": [ "Hello", "thanks", "help", "how many tickets do I have left" ] } }, { "id": "broadcast_status", "command": "broadcast status", "form": null, "title": "Broadcasts: sent, waiting, paused", "details": [], "also": [ "list broadcasts" ], "readOnly": true, "who": [ "admin", "owner" ], "explanation": { "id": "broadcast_status", "command": "broadcast status", "form": null, "title": "Broadcasts: sent, waiting, paused", "details": [], "also": [ "list broadcasts" ], "readOnly": true, "who": [ "admin", "owner" ], "whatItDoes": "Broadcasts: sent, waiting, paused", "uses": "only reads (safe)", "runsThrough": [], "gates": [ "runs without confirmation (it only reads)", "changes the help desk itself (owner console)" ], "errors": [], "related": [ "Hello", "thanks", "help", "how many tickets do I have left" ] } }, { "id": "broadcast_cancel", "command": "cancel broadcast", "form": null, "title": "Cancel a broadcast (what was sent stays sent)", "details": [ { "name": "value", "kind": "value", "optional": true } ], "also": [ "stop broadcast A1B2C3" ], "readOnly": false, "who": [ "admin", "owner" ], "explanation": { "id": "broadcast_cancel", "command": "cancel broadcast", "form": null, "title": "Cancel a broadcast (what was sent stays sent)", "details": [ { "name": "value", "kind": "value", "optional": true } ], "also": [ "stop broadcast A1B2C3" ], "readOnly": false, "who": [ "admin", "owner" ], "whatItDoes": "Cancel a broadcast (what was sent stays sent)", "uses": "only reads (safe)", "runsThrough": [], "gates": [ "shown for a yes before it runs", "changes the help desk itself (owner console)" ], "errors": [], "related": [ "Hello", "thanks", "help", "how many tickets do I have left" ] } }, { "id": "broadcast_resume", "command": "resume broadcast", "form": null, "title": "Resume a paused broadcast", "details": [ { "name": "value", "kind": "value", "optional": true } ], "also": [], "readOnly": false, "who": [ "admin", "owner" ], "explanation": { "id": "broadcast_resume", "command": "resume broadcast", "form": null, "title": "Resume a paused broadcast", "details": [ { "name": "value", "kind": "value", "optional": true } ], "also": [], "readOnly": false, "who": [ "admin", "owner" ], "whatItDoes": "Resume a paused broadcast", "uses": "only reads (safe)", "runsThrough": [], "gates": [ "shown for a yes before it runs", "changes the help desk itself (owner console)" ], "errors": [], "related": [ "Hello", "thanks", "help", "how many tickets do I have left" ] } }, { "id": "setting_show", "command": "setting client messages per minute", "form": "setting ", "title": "Show one setting (or all of them, with their names)", "details": [ { "name": "name", "kind": "name", "optional": true } ], "also": [ "what is the setting time zone", "list all settings" ], "readOnly": true, "who": [ "owner" ], "explanation": { "id": "setting_show", "command": "setting client messages per minute", "form": "setting ", "title": "Show one setting (or all of them, with their names)", "details": [ { "name": "name", "kind": "name", "optional": true } ], "also": [ "what is the setting time zone", "list all settings" ], "readOnly": true, "who": [ "owner" ], "whatItDoes": "Show one setting (or all of them, with their names)", "uses": "only reads (safe)", "runsThrough": [], "gates": [ "runs without confirmation (it only reads)", "changes the help desk itself (owner console)" ], "errors": [], "related": [ "Hello", "thanks", "help", "how many tickets do I have left" ] } }, { "id": "setting_set", "command": "set setting client messages per minute to 10", "form": "set setting to ", "title": "Change one setting (any core setting, by its name)", "details": [ { "name": "name", "kind": "name", "optional": false }, { "name": "value", "kind": "value", "optional": false } ], "also": [ "set setting time zone to Asia/Beirut", "turn off setting chat logs" ], "readOnly": false, "who": [ "owner" ], "explanation": { "id": "setting_set", "command": "set setting client messages per minute to 10", "form": "set setting to ", "title": "Change one setting (any core setting, by its name)", "details": [ { "name": "name", "kind": "name", "optional": false }, { "name": "value", "kind": "value", "optional": false } ], "also": [ "set setting time zone to Asia/Beirut", "turn off setting chat logs" ], "readOnly": false, "who": [ "owner" ], "whatItDoes": "Any setting listed by \"list all settings\"; it shows the change and asks for a yes. Plugin settings: \"set setting to \".", "uses": "only reads (safe)", "runsThrough": [], "gates": [ "shown for a yes before it runs", "changes the help desk itself (owner console)" ], "errors": [], "related": [ "Hello", "thanks", "help", "how many tickets do I have left" ] } }, { "id": "verify_status", "command": "verification status", "form": null, "title": "Verification codes: settings, codes waiting, numbers locked after wrong codes", "details": [], "also": [ "locked codes" ], "readOnly": true, "who": [ "owner" ], "explanation": { "id": "verify_status", "command": "verification status", "form": null, "title": "Verification codes: settings, codes waiting, numbers locked after wrong codes", "details": [], "also": [ "locked codes" ], "readOnly": true, "who": [ "owner" ], "whatItDoes": "Codes that prove someone controls a number or email the help desk knows (the panel sign-in, a client confirming it is them in the web chat). The codes themselves are never shown or logged.", "uses": "only reads (safe)", "runsThrough": [], "gates": [ "runs without confirmation (it only reads)", "changes the help desk itself (owner console)" ], "errors": [], "related": [ "Hello", "thanks", "help", "how many tickets do I have left" ] } }, { "id": "verify_unlock", "command": "unlock verification +96171123456", "form": "unlock verification ", "title": "Unlock a number or email locked after too many wrong verification codes", "details": [ { "name": "value", "kind": "value", "optional": false } ], "also": [ "unlock codes for sara@example.com", "unlock verification all" ], "readOnly": false, "who": [ "owner" ], "explanation": { "id": "verify_unlock", "command": "unlock verification +96171123456", "form": "unlock verification ", "title": "Unlock a number or email locked after too many wrong verification codes", "details": [ { "name": "value", "kind": "value", "optional": false } ], "also": [ "unlock codes for sara@example.com", "unlock verification all" ], "readOnly": false, "who": [ "owner" ], "whatItDoes": "Unlock a number or email locked after too many wrong verification codes", "uses": "only reads (safe)", "runsThrough": [], "gates": [ "shown for a yes before it runs", "changes the help desk itself (owner console)" ], "errors": [], "related": [ "Hello", "thanks", "help", "how many tickets do I have left" ] } }, { "id": "files_log", "command": "files log", "form": null, "title": "The files log (received, refused, sent, failed…)", "details": [ { "name": "q", "kind": "name or number to find", "optional": true } ], "also": [ "files log failed" ], "readOnly": true, "who": [ "owner" ], "explanation": { "id": "files_log", "command": "files log", "form": null, "title": "The files log (received, refused, sent, failed…)", "details": [ { "name": "q", "kind": "name or number to find", "optional": true } ], "also": [ "files log failed" ], "readOnly": true, "who": [ "owner" ], "whatItDoes": "The files log (received, refused, sent, failed…)", "uses": "only reads (safe)", "runsThrough": [], "gates": [ "runs without confirmation (it only reads)", "changes the help desk itself (owner console)" ], "errors": [], "related": [ "Hello", "thanks", "help", "how many tickets do I have left" ] } }, { "id": "limit_tickets", "command": "set tickets for Acme to 3 per week", "form": "set tickets for to per week", "title": "Set weekly tickets", "details": [ { "name": "cname", "kind": "client name", "optional": false }, { "name": "num", "kind": "number", "optional": false } ], "also": [], "readOnly": false, "who": [ "owner" ], "explanation": { "id": "limit_tickets", "command": "set tickets for Acme to 3 per week", "form": "set tickets for to per week", "title": "Set weekly tickets", "details": [ { "name": "cname", "kind": "client name", "optional": false }, { "name": "num", "kind": "number", "optional": false } ], "also": [], "readOnly": false, "who": [ "owner" ], "whatItDoes": "Set weekly tickets", "uses": "only reads (safe)", "runsThrough": [], "gates": [ "shown for a yes before it runs", "changes the help desk itself (owner console)" ], "errors": [], "related": [ "Hello", "thanks", "help", "how many tickets do I have left" ] } }, { "id": "limit_mailboxes", "command": "set max mailboxes for Acme to 5", "form": "set max mailboxes for to ", "title": "Set max mailboxes", "details": [ { "name": "cname", "kind": "client name", "optional": false }, { "name": "num", "kind": "number", "optional": false } ], "also": [], "readOnly": false, "who": [ "owner" ], "explanation": { "id": "limit_mailboxes", "command": "set max mailboxes for Acme to 5", "form": "set max mailboxes for to ", "title": "Set max mailboxes", "details": [ { "name": "cname", "kind": "client name", "optional": false }, { "name": "num", "kind": "number", "optional": false } ], "also": [], "readOnly": false, "who": [ "owner" ], "whatItDoes": "Set max mailboxes", "uses": "only reads (safe)", "runsThrough": [], "gates": [ "shown for a yes before it runs", "changes the help desk itself (owner console)" ], "errors": [], "related": [ "Hello", "thanks", "help", "how many tickets do I have left" ] } }, { "id": "limit_mailbox_size", "command": "set mailbox size for Acme to 1024 MB", "form": "set mailbox size for to MB", "title": "Set max mailbox size (MB)", "details": [ { "name": "cname", "kind": "client name", "optional": false }, { "name": "num", "kind": "number", "optional": false } ], "also": [], "readOnly": false, "who": [ "owner" ], "explanation": { "id": "limit_mailbox_size", "command": "set mailbox size for Acme to 1024 MB", "form": "set mailbox size for to MB", "title": "Set max mailbox size (MB)", "details": [ { "name": "cname", "kind": "client name", "optional": false }, { "name": "num", "kind": "number", "optional": false } ], "also": [], "readOnly": false, "who": [ "owner" ], "whatItDoes": "Set max mailbox size (MB)", "uses": "only reads (safe)", "runsThrough": [], "gates": [ "shown for a yes before it runs", "changes the help desk itself (owner console)" ], "errors": [], "related": [ "Hello", "thanks", "help", "how many tickets do I have left" ] } }, { "id": "limit_hours", "command": "set support hours for Acme 8-20", "form": "set support hours for 8-20", "title": "Set support hours", "details": [ { "name": "cname", "kind": "client name", "optional": false }, { "name": "from", "kind": "from (time)", "optional": false }, { "name": "to", "kind": "to (time)", "optional": false } ], "also": [ "set hours for Acme 08:00 to 18:00" ], "readOnly": false, "who": [ "owner" ], "explanation": { "id": "limit_hours", "command": "set support hours for Acme 8-20", "form": "set support hours for 8-20", "title": "Set support hours", "details": [ { "name": "cname", "kind": "client name", "optional": false }, { "name": "from", "kind": "from (time)", "optional": false }, { "name": "to", "kind": "to (time)", "optional": false } ], "also": [ "set hours for Acme 08:00 to 18:00" ], "readOnly": false, "who": [ "owner" ], "whatItDoes": "Set support hours", "uses": "only reads (safe)", "runsThrough": [], "gates": [ "shown for a yes before it runs", "changes the help desk itself (owner console)" ], "errors": [], "related": [ "Hello", "thanks", "help", "how many tickets do I have left" ] } }, { "id": "guide_show", "command": "nextcloud commands", "form": " commands", "title": "Show a command guide (a service, console or custom)", "details": [ { "name": "topic", "kind": "a service name, console or custom", "optional": false } ], "also": [ "send me nextcloud api", "list nextcloud commands" ], "readOnly": true, "who": [ "admin", "owner" ], "explanation": { "id": "guide_show", "command": "nextcloud commands", "form": " commands", "title": "Show a command guide (a service, console or custom)", "details": [ { "name": "topic", "kind": "a service name, console or custom", "optional": false } ], "also": [ "send me nextcloud api", "list nextcloud commands" ], "readOnly": true, "who": [ "admin", "owner" ], "whatItDoes": "Show a command guide (a service, console or custom)", "uses": "only reads (safe)", "runsThrough": [], "gates": [ "runs without confirmation (it only reads)" ], "errors": [], "related": [ "Hello", "thanks", "help", "how many tickets do I have left" ] } }, { "id": "docs_link", "command": "docs", "form": null, "title": "Vast Helpdesk docs link (to give an AI)", "details": [], "also": [ "send me the docs", "vast helpdesk docs" ], "readOnly": false, "who": [ "admin", "owner" ], "explanation": { "id": "docs_link", "command": "docs", "form": null, "title": "Vast Helpdesk docs link (to give an AI)", "details": [], "also": [ "send me the docs", "vast helpdesk docs" ], "readOnly": false, "who": [ "admin", "owner" ], "whatItDoes": "Vast Helpdesk docs link (to give an AI)", "uses": "only reads (safe)", "runsThrough": [], "gates": [ "shown for a yes before it runs" ], "errors": [], "related": [ "Hello", "thanks", "help", "how many tickets do I have left" ] } }, { "id": "chats_list", "command": "list chats", "form": null, "title": "List chats (number them to assign)", "details": [ { "name": "q", "kind": "name or number to find", "optional": true } ], "also": [ "list new chats", "chats" ], "readOnly": true, "who": [ "owner" ], "explanation": { "id": "chats_list", "command": "list chats", "form": null, "title": "List chats (number them to assign)", "details": [ { "name": "q", "kind": "name or number to find", "optional": true } ], "also": [ "list new chats", "chats" ], "readOnly": true, "who": [ "owner" ], "whatItDoes": "List chats (number them to assign)", "uses": "only reads (safe)", "runsThrough": [], "gates": [ "runs without confirmation (it only reads)", "changes the help desk itself (owner console)" ], "errors": [], "related": [ "Hello", "thanks", "help", "how many tickets do I have left" ] } }, { "id": "chat_assign", "command": "assign chat 3 to client Acme", "form": "assign chat to client ", "title": "Assign a listed chat to a client", "details": [ { "name": "num", "kind": "number", "optional": false }, { "name": "cname", "kind": "client name", "optional": false } ], "also": [ "chat 3 to Acme" ], "readOnly": false, "who": [ "owner" ], "explanation": { "id": "chat_assign", "command": "assign chat 3 to client Acme", "form": "assign chat to client ", "title": "Assign a listed chat to a client", "details": [ { "name": "num", "kind": "number", "optional": false }, { "name": "cname", "kind": "client name", "optional": false } ], "also": [ "chat 3 to Acme" ], "readOnly": false, "who": [ "owner" ], "whatItDoes": "Assign a listed chat to a client", "uses": "only reads (safe)", "runsThrough": [], "gates": [ "shown for a yes before it runs", "changes the help desk itself (owner console)" ], "errors": [], "related": [ "Hello", "thanks", "help", "how many tickets do I have left" ] } }, { "id": "chat_make_admin", "command": "make chat 5 admin", "form": "make chat admin", "title": "Make a listed chat an admin chat", "details": [ { "name": "num", "kind": "number", "optional": false } ], "also": [ "chat 5 admin" ], "readOnly": false, "who": [ "owner" ], "explanation": { "id": "chat_make_admin", "command": "make chat 5 admin", "form": "make chat admin", "title": "Make a listed chat an admin chat", "details": [ { "name": "num", "kind": "number", "optional": false } ], "also": [ "chat 5 admin" ], "readOnly": false, "who": [ "owner" ], "whatItDoes": "Make a listed chat an admin chat", "uses": "only reads (safe)", "runsThrough": [], "gates": [ "shown for a yes before it runs", "changes the help desk itself (owner console)" ], "errors": [], "related": [ "Hello", "thanks", "help", "how many tickets do I have left" ] } }, { "id": "chat_unassign", "command": "unassign chat 4", "form": "unassign chat ", "title": "Stop listening to a listed chat", "details": [ { "name": "num", "kind": "number", "optional": false } ], "also": [ "ignore chat 4" ], "readOnly": false, "who": [ "owner" ], "explanation": { "id": "chat_unassign", "command": "unassign chat 4", "form": "unassign chat ", "title": "Stop listening to a listed chat", "details": [ { "name": "num", "kind": "number", "optional": false } ], "also": [ "ignore chat 4" ], "readOnly": false, "who": [ "owner" ], "whatItDoes": "Stop listening to a listed chat", "uses": "only reads (safe)", "runsThrough": [], "gates": [ "shown for a yes before it runs", "changes the help desk itself (owner console)" ], "errors": [], "related": [ "Hello", "thanks", "help", "how many tickets do I have left" ] } }, { "id": "client_rename", "command": "rename client 96176316570 to Nour Store", "form": "rename client to ", "title": "Rename a client", "details": [ { "name": "cname", "kind": "client name", "optional": false }, { "name": "text", "kind": "text", "optional": false } ], "also": [ "rename Acme to Acme Ltd" ], "readOnly": false, "who": [ "owner" ], "explanation": { "id": "client_rename", "command": "rename client 96176316570 to Nour Store", "form": "rename client to ", "title": "Rename a client", "details": [ { "name": "cname", "kind": "client name", "optional": false }, { "name": "text", "kind": "text", "optional": false } ], "also": [ "rename Acme to Acme Ltd" ], "readOnly": false, "who": [ "owner" ], "whatItDoes": "Rename a client", "uses": "only reads (safe)", "runsThrough": [], "gates": [ "shown for a yes before it runs", "changes the help desk itself (owner console)" ], "errors": [], "related": [ "Hello", "thanks", "help", "how many tickets do I have left" ] } }, { "id": "plugins_list", "command": "plugins", "form": null, "title": "List plugins", "details": [], "also": [ "list plugins" ], "readOnly": true, "who": [ "owner" ], "explanation": { "id": "plugins_list", "command": "plugins", "form": null, "title": "List plugins", "details": [], "also": [ "list plugins" ], "readOnly": true, "who": [ "owner" ], "whatItDoes": "List plugins", "uses": "only reads (safe)", "runsThrough": [], "gates": [ "runs without confirmation (it only reads)", "changes the help desk itself (owner console)" ], "errors": [], "related": [ "Hello", "thanks", "help", "how many tickets do I have left" ] } }, { "id": "plugin_switch", "command": "turn on plugin telegram", "form": "turn plugin ", "title": "Turn a plugin on or off", "details": [ { "name": "switch", "kind": "on or off", "optional": false }, { "name": "word", "kind": "word", "optional": false } ], "also": [ "plugin telegram off" ], "readOnly": false, "who": [ "owner" ], "explanation": { "id": "plugin_switch", "command": "turn on plugin telegram", "form": "turn plugin ", "title": "Turn a plugin on or off", "details": [ { "name": "switch", "kind": "on or off", "optional": false }, { "name": "word", "kind": "word", "optional": false } ], "also": [ "plugin telegram off" ], "readOnly": false, "who": [ "owner" ], "whatItDoes": "Turn a plugin on or off", "uses": "only reads (safe)", "runsThrough": [], "gates": [ "shown for a yes before it runs", "changes the help desk itself (owner console)" ], "errors": [], "related": [ "Hello", "thanks", "help", "how many tickets do I have left" ] } }, { "id": "plugin_test", "command": "test plugin metaai", "form": "test plugin ", "title": "Test a plugin", "details": [ { "name": "word", "kind": "word", "optional": false } ], "also": [ "test cpanel" ], "readOnly": true, "who": [ "owner" ], "explanation": { "id": "plugin_test", "command": "test plugin metaai", "form": "test plugin ", "title": "Test a plugin", "details": [ { "name": "word", "kind": "word", "optional": false } ], "also": [ "test cpanel" ], "readOnly": true, "who": [ "owner" ], "whatItDoes": "Test a plugin", "uses": "only reads (safe)", "runsThrough": [], "gates": [ "runs without confirmation (it only reads)", "changes the help desk itself (owner console)" ], "errors": [], "related": [ "Hello", "thanks", "help", "how many tickets do I have left" ] } }, { "id": "router_restart", "command": "restart", "form": null, "title": "Restart the router", "details": [], "also": [ "restart the router" ], "readOnly": false, "who": [ "owner" ], "explanation": { "id": "router_restart", "command": "restart", "form": null, "title": "Restart the router", "details": [], "also": [ "restart the router" ], "readOnly": false, "who": [ "owner" ], "whatItDoes": "Restart the router", "uses": "only reads (safe)", "runsThrough": [], "gates": [ "shown for a yes before it runs", "changes the help desk itself (owner console)" ], "errors": [], "related": [ "Hello", "thanks", "help", "how many tickets do I have left" ] } }, { "id": "guard_resume", "command": "resume sending", "form": null, "title": "Resume sending after the ban guard stopped", "details": [], "also": [], "readOnly": false, "who": [ "owner" ], "explanation": { "id": "guard_resume", "command": "resume sending", "form": null, "title": "Resume sending after the ban guard stopped", "details": [], "also": [], "readOnly": false, "who": [ "owner" ], "whatItDoes": "Resume sending after the ban guard stopped", "uses": "only reads (safe)", "runsThrough": [], "gates": [ "shown for a yes before it runs", "changes the help desk itself (owner console)" ], "errors": [], "related": [ "Hello", "thanks", "help", "how many tickets do I have left" ] } }, { "id": "set_console_word", "command": "set console word j2d8", "form": "set console word ", "title": "Set the console word", "details": [ { "name": "word", "kind": "word", "optional": false } ], "also": [ "console word off" ], "readOnly": false, "who": [ "owner" ], "explanation": { "id": "set_console_word", "command": "set console word j2d8", "form": "set console word ", "title": "Set the console word", "details": [ { "name": "word", "kind": "word", "optional": false } ], "also": [ "console word off" ], "readOnly": false, "who": [ "owner" ], "whatItDoes": "Set the console word", "uses": "only reads (safe)", "runsThrough": [], "gates": [ "shown for a yes before it runs", "changes the help desk itself (owner console)" ], "errors": [], "related": [ "Hello", "thanks", "help", "how many tickets do I have left" ] } }, { "id": "set_free_replies", "command": "meta replies off", "form": "meta replies ", "title": "Let the AI answer in its own words (on/off)", "details": [ { "name": "switch", "kind": "on or off", "optional": false } ], "also": [ "turn on free replies" ], "readOnly": false, "who": [ "owner" ], "explanation": { "id": "set_free_replies", "command": "meta replies off", "form": "meta replies ", "title": "Let the AI answer in its own words (on/off)", "details": [ { "name": "switch", "kind": "on or off", "optional": false } ], "also": [ "turn on free replies" ], "readOnly": false, "who": [ "owner" ], "whatItDoes": "Let the AI answer in its own words (on/off)", "uses": "only reads (safe)", "runsThrough": [], "gates": [ "shown for a yes before it runs", "changes the help desk itself (owner console)" ], "errors": [], "related": [ "Hello", "thanks", "help", "how many tickets do I have left" ] } }, { "id": "set_support_hours", "command": "set support hours 8-20", "form": null, "title": "Set the general support hours", "details": [ { "name": "from", "kind": "from (time)", "optional": false }, { "name": "to", "kind": "to (time)", "optional": false } ], "also": [ "set our support hours to 09:00 to 17:00" ], "readOnly": false, "who": [ "owner" ], "explanation": { "id": "set_support_hours", "command": "set support hours 8-20", "form": null, "title": "Set the general support hours", "details": [ { "name": "from", "kind": "from (time)", "optional": false }, { "name": "to", "kind": "to (time)", "optional": false } ], "also": [ "set our support hours to 09:00 to 17:00" ], "readOnly": false, "who": [ "owner" ], "whatItDoes": "Set the general support hours", "uses": "only reads (safe)", "runsThrough": [], "gates": [ "shown for a yes before it runs", "changes the help desk itself (owner console)" ], "errors": [], "related": [ "Hello", "thanks", "help", "how many tickets do I have left" ] } }, { "id": "owner_grant", "command": "give owner permissions to Hadi", "form": "give owner permissions to ", "title": "Give owner permissions (including the shell) to a staff member or a group", "details": [ { "name": "who", "kind": "person or people", "optional": false } ], "also": [ "grant owner rights to group Ops", "make Hadi an owner" ], "readOnly": false, "who": [ "owner" ], "explanation": { "id": "owner_grant", "command": "give owner permissions to Hadi", "form": "give owner permissions to ", "title": "Give owner permissions (including the shell) to a staff member or a group", "details": [ { "name": "who", "kind": "person or people", "optional": false } ], "also": [ "grant owner rights to group Ops", "make Hadi an owner" ], "readOnly": false, "who": [ "owner" ], "whatItDoes": "Owner permissions = every owner command AND the shell (Terminal mode). For a group, EVERYONE in it gets them. Only the owner, from their own console, can give or take them away.", "uses": "only reads (safe)", "runsThrough": [], "gates": [ "shown for a yes before it runs", "changes the help desk itself (owner console)" ], "errors": [], "related": [ "Hello", "thanks", "help", "how many tickets do I have left" ] } }, { "id": "owner_revoke", "command": "remove owner permissions from Hadi", "form": "remove owner permissions from ", "title": "Take owner permissions away from a staff member or a group", "details": [ { "name": "who", "kind": "person or people", "optional": false } ], "also": [ "take owner rights from group Ops" ], "readOnly": false, "who": [ "owner" ], "explanation": { "id": "owner_revoke", "command": "remove owner permissions from Hadi", "form": "remove owner permissions from ", "title": "Take owner permissions away from a staff member or a group", "details": [ { "name": "who", "kind": "person or people", "optional": false } ], "also": [ "take owner rights from group Ops" ], "readOnly": false, "who": [ "owner" ], "whatItDoes": "Only the owner, from their own console.", "uses": "only reads (safe)", "runsThrough": [], "gates": [ "shown for a yes before it runs", "changes the help desk itself (owner console)" ], "errors": [], "related": [ "Hello", "thanks", "help", "how many tickets do I have left" ] } }, { "id": "set_terminal_word", "command": "set terminal word shell", "form": "set terminal word ", "title": "Set (or clear) the Terminal mode word", "details": [ { "name": "word", "kind": "word", "optional": false } ], "also": [ "terminal word off" ], "readOnly": false, "who": [ "owner" ], "explanation": { "id": "set_terminal_word", "command": "set terminal word shell", "form": "set terminal word ", "title": "Set (or clear) the Terminal mode word", "details": [ { "name": "word", "kind": "word", "optional": false } ], "also": [ "terminal word off" ], "readOnly": false, "who": [ "owner" ], "whatItDoes": "This word, said in your console, opens Terminal mode (a brain gets a direct line to Nextcloud, cPanel or a shell). Empty/off disables it. Owner console only, always.", "uses": "only reads (safe)", "runsThrough": [], "gates": [ "shown for a yes before it runs", "changes the help desk itself (owner console)" ], "errors": [], "related": [ "Hello", "thanks", "help", "how many tickets do I have left" ] } }, { "id": "run_selftest", "command": "self test", "form": null, "title": "Run the live self-test", "details": [ { "name": "text", "kind": "text", "optional": true } ], "also": [ "run the selftest", "selftest quick" ], "readOnly": false, "who": [ "owner" ], "explanation": { "id": "run_selftest", "command": "self test", "form": null, "title": "Run the live self-test", "details": [ { "name": "text", "kind": "text", "optional": true } ], "also": [ "run the selftest", "selftest quick" ], "readOnly": false, "who": [ "owner" ], "whatItDoes": "Sends scripted READ-ONLY messages through the real router (and the brain) and checks the answers; nothing is changed, nothing reaches staff or clients. Add \"quick\" to skip the AI questions.", "uses": "only reads (safe)", "runsThrough": [], "gates": [ "shown for a yes before it runs", "changes the help desk itself (owner console)" ], "errors": [], "related": [ "Hello", "thanks", "help", "how many tickets do I have left" ] } }, { "id": "find_group", "command": "find group gova ops", "form": "find group ", "title": "Look for a group in WhatsApp (where it is known, and why it may be missing)", "details": [ { "name": "text", "kind": "text", "optional": false } ], "also": [ "look for group Sales team" ], "readOnly": false, "who": [ "owner" ], "explanation": { "id": "find_group", "command": "find group gova ops", "form": "find group ", "title": "Look for a group in WhatsApp (where it is known, and why it may be missing)", "details": [ { "name": "text", "kind": "text", "optional": false } ], "also": [ "look for group Sales team" ], "readOnly": false, "who": [ "owner" ], "whatItDoes": "Checks every place WhatsApp Web keeps groups and says where the name was found; nothing is changed.", "uses": "only reads (safe)", "runsThrough": [], "gates": [ "shown for a yes before it runs", "changes the help desk itself (owner console)" ], "errors": [], "related": [ "Hello", "thanks", "help", "how many tickets do I have left" ] } }, { "id": "staff_add", "command": "add staff Hadi +96170111222", "form": "add staff ", "title": "Add a staff member (name, number, what they may do)", "details": [ { "name": "name", "kind": "name", "optional": false }, { "name": "chatref", "kind": "chat name or phone number", "optional": false }, { "name": "fams", "kind": "what they may do", "optional": true } ], "also": [ "add staff Sara Haddad +96170333444 can manage email, nextcloud", "add Omar +96170555666 as staff" ], "readOnly": false, "who": [ "owner" ], "explanation": { "id": "staff_add", "command": "add staff Hadi +96170111222", "form": "add staff ", "title": "Add a staff member (name, number, what they may do)", "details": [ { "name": "name", "kind": "name", "optional": false }, { "name": "chatref", "kind": "chat name or phone number", "optional": false }, { "name": "fams", "kind": "what they may do", "optional": true } ], "also": [ "add staff Sara Haddad +96170333444 can manage email, nextcloud", "add Omar +96170555666 as staff" ], "readOnly": false, "who": [ "owner" ], "whatItDoes": "Creates the person on the Staff page with their name and, optionally, only some permission families (email, domains, dns, folders, shares, nextcloud users, deleting, tickets). Without \"can manage\" they get the general admin permissions.", "uses": "only reads (safe)", "runsThrough": [], "gates": [ "shown for a yes before it runs", "changes the help desk itself (owner console)" ], "errors": [], "related": [ "Hello", "thanks", "help", "how many tickets do I have left" ] } }, { "id": "report_now", "command": "daily report", "form": null, "title": "The daily report so far (what happened, AI use and credit left)", "details": [], "also": [ "today's report", "send the daily report now" ], "readOnly": true, "who": [ "owner" ], "explanation": { "id": "report_now", "command": "daily report", "form": null, "title": "The daily report so far (what happened, AI use and credit left)", "details": [], "also": [ "today's report", "send the daily report now" ], "readOnly": true, "who": [ "owner" ], "whatItDoes": "The same report that comes by itself every day (Settings → Daily report): a few lines on what happened since the last one, written by the AI, then each brain's calls, cost, budget left today and prepaid credit left. Asking for it does not change what the next one counts.", "uses": "only reads (safe)", "runsThrough": [], "gates": [ "runs without confirmation (it only reads)", "changes the help desk itself (owner console)" ], "errors": [], "related": [ "Hello", "thanks", "help", "how many tickets do I have left" ] } }, { "id": "report_set", "command": "set daily report time to 21:00", "form": "set daily report time to