Supovia Customer Support

GetRead documenta help-center article

Fetch oneUse supportthis documentwhen ownedsomeone byneeds the authenticated Supoviatext organization,of includingone itshelp-center article text (capped at 20000, characters)to andquote theit contentFormator naminganswer whicha syntaxcustomer thatfrom textit. isReturns writtenthe inarticle's (htmltitle, markdownslug, plain-text). A documentlanguage, ownedpublished byflag anotherand organizationtext returnsup theto same20000 boundedcharacters, "notwith found"the result.text's Organizationformat ids(html, translator idsmarkdown, deprecated slugs,plain-text). embeddings,Not andfor arbitraryfinding metadataarticles areon nevera returned.topic.

 ⟨5 unchanged words⟩ ,"properties":{"documentId":{"description":"DocumentArticle id.id; Preferredtakes precedence over slug.slug","maxLength":200,"minLength":1,"type":"string"},"locale":{"description":"LocaleLanguage code for the slug lookup, (e.g. en, it, fr).or Defaultsfr; defaults to en.en","maxLength":20,"minLength":1,"type":"string"},"slug":{"description":"DocumentArticle slug.slug, 

 ⟨23 unchanged words⟩ :"string"},{"type":"null"}],"description":"Syntax the content is written in; null for an empty article"},"contentTruncated":{"description":"True when the content was cut at 20000 characters","type":"boolean"},"creationTime":{"anyOf" ⟨73 unchanged words⟩ :"object"},{"type":"null"}],"description":"The article; null when it is missing or belongs to another organization. Organization ids, translator ids, deprecated slugs, embeddings and arbitrary metadata are never returned."},"status":{"enum":["found", ⟨8 unchanged words⟩ 

 ⟨4 unchanged words⟩ openWorldHint":false,"readOnlyHint":true,"title":"GetRead documenta help-center article"}

Get unresolvedCount conversationopen countsconversations

CountUse everythis unresolvedwhen conversationsomeone inasks thehow authenticatedmany Supoviacustomer organization,conversations groupedare bystill website.open Totalsor coverunresolved, allin returnedtotal countor groups;per website. Returns the sortedtotal per-websiteplus previewa isper-website cappedcount, atlargest 100first, andlisting reportsup truncation.to Customer100 identifiers,websites staff(no ids,customer or message text,data). andNot organizationfor idsfinding arewhich neverconversations returned.are open.

 ⟨7 unchanged words⟩ {"type":"boolean"},"totalUnresolved":{"description":"Unresolved conversations across every website, listed or not","maximum":9007199254740991,"minimum":0,"type":" ⟨6 unchanged words⟩ ,"type":"integer"},"websites":{"description":"Up to 100 websites with the most unresolved conversations, largest first. Customer identifiers, staff ids, message text and organization ids are never returned.","items":{"additionalProperties":false,"properties":{" ⟨29 unchanged words⟩ 100,"type":"array"},"websitesTruncated":{"description":"True when more than 100 websites have unresolved conversations","type":"boolean"}},"required":[" ⟨7 unchanged words⟩ 

 ⟨4 unchanged words⟩ openWorldHint":false,"readOnlyHint":true,"title":"Get unresolvedCount conversationopen countsconversations"}

Get support website details

FetchUse safethis metadatawhen forsomeone asks about one websiteof ownedtheir Supovia websites by thename authenticatedor Supoviaid, organization.such Organizationas ids,whether its AI customer agent prompts,is credentialson. Returns the website's id, integrationname, configurationdomain, AI-agent status and arbitrarycreated metadataand areedited nevertimes, returned.or not-found. Not for the help articles published on it.

 ⟨7 unchanged words⟩ :{"description":"Website id, exact vanity ID,id (its lowercase public address) or exact display name","maxLength":200, ⟨8 unchanged words⟩ 

 ⟨68 unchanged words⟩ :"object"},{"type":"null"}],"description":"Safe website metadata; null when not found. Organization ids, agent prompts, credentials, integration configuration and arbitrary metadata are never returned."}},"required":["status","website"] ⟨2 unchanged words⟩ 

 ⟨5 unchanged words⟩ :false,"readOnlyHint":true,"title":"Get support website details"}

List email campaigns

ListUse athis boundedwhen pagesomeone ofasks campaignwhich identitiesemail forcampaigns one website ownedof bytheir thewebsites authenticatedhas. SupoviaReturns organization.each Recipientcampaign's listsid, subjects,name messageand content,created userand idsedited times, organization20 ids,per andpage arbitraryby metadatadefault are(no excludedrecipients, andsubject campaignsor cannotcontent). beNot sentfor fromsending thisa tool.campaign.

 ⟨5 unchanged words⟩ ,"properties":{"cursor":{"description":"Opaque paginationThe cursorpage.nextCursor fromof athe previous callpage for the same website; absent for the first page","maxLength":4096,"type":"string"},"limit":{"description":"Maximum campaignsCampaigns per page, (defaultfrom 1 to 50; defaults to 20)","exclusiveMinimum":0,"maximum":50,"type":"integer"},"websiteId":{"description":"Organization-owned website idWebsite whose campaigns to list","pattern":"^ ⟨9 unchanged words⟩ 

 ⟨3 unchanged words⟩ additionalProperties":false,"properties":{"campaigns":{"description":"Campaign identity only. Recipient lists, subjects, message content, user ids, organization ids and arbitrary metadata are excluded.","items":{"additionalProperties":false,"properties":{" ⟨54 unchanged words⟩ :"array"},"page":{"additionalProperties":false,"description":"hasMore is true when more campaigns follow; pass nextCursor as cursor to get them","properties":{"count":{"maximum":50 ⟨26 unchanged words⟩ 

 ⟨5 unchanged words⟩ :false,"readOnlyHint":true,"title":"List email campaigns"}

List customer conversations

List aUse boundedthis newest-firstwhen pagesomeone ofasks conversationwhich activitycustomer inconversations theare authenticatedopen, Supoviaunread organization.or Returnsrecently onlyactive, theoptionally conversationfor idone neededwebsite. forReturns anconversation explicitids follow-up,with website id, channel, resolved stateflag, unread count, and timestamps.times, Messagemost bodies,recent messageactivity idsfirst, customer20 identifiers,per internalpage notes,by arbitrarydefault metadata,(no andmessage organizationtext idsor arecustomer excluded.details). Not for open-conversation totals.

 ⟨5 unchanged words⟩ ,"properties":{"cursor":{"description":"Opaque paginationThe cursorpage.nextCursor fromof athe previous callpage with the same filters; absent for the first page","maxLength":2048,"type":"string"},"limit":{"description":"Maximum conversationsConversations per page, (defaultfrom 1 to 50; defaults to 20)","exclusiveMinimum":0,"maximum":50,"type":"integer"},"resolved":{"description":"Filter by resolved status (true =for resolved conversations, false =for open) ones; omit for both

 ⟨3 unchanged words⟩ additionalProperties":false,"properties":{"conversations":{"description":"Most recent activity first: the id needed for a follow-up call, website id, channel, resolved state, unread count and timestamps. Message bodies, message ids, customer identifiers, internal notes, arbitrary metadata and organization ids are excluded.","items":{"additionalProperties":false,"properties":{" ⟨60 unchanged words⟩ :"array"},"page":{"additionalProperties":false,"description":"hasMore is true when more conversations follow; pass nextCursor as cursor to get them","properties":{"count":{"maximum":50 ⟨26 unchanged words⟩ 

 ⟨5 unchanged words⟩ :false,"readOnlyHint":true,"title":"List customer conversations"}

List documentshelp-center articles

ListUse athis boundedwhen newest-firstsomeone pageasks ofwhich safehelp support-documentarticles metadataor insupport thedocs authenticatedexist, Supoviaoptionally organization.for Documentone contentwebsite, embeddingslanguage or article. Returns each article's id, promptstitle, organizationslug, idslanguage, website and arbitrarypublished metadataflag, aremost excluded.recently edited first, 20 per page by default, without the article text. Not for finding articles about a topic.

 ⟨5 unchanged words⟩ ,"properties":{"cursor":{"description":"Opaque paginationThe cursorpage.nextCursor fromof athe previous callpage with the same filters; absent for the first page","maxLength":4096,"type":"string"},"limit":{"description":"Articles per page, from 1 to 50; defaults to 20","exclusiveMinimum":0,"maximum":50,"type":"integer"},"locale":{"description":"FilterOnly byarticles localein (this language code, e.g. en, it, fr)or fr; every language when absent","maxLength":20,"minLength":1,"type":"string"},"slugOriginal":{"description":"FilterOnly by

 ⟨3 unchanged words⟩ additionalProperties":false,"properties":{"documents":{"description":"Article metadata, most recently edited first. Document content, embeddings, prompts, organization ids and arbitrary metadata are excluded.","items":{"additionalProperties":false,"properties":{" ⟨76 unchanged words⟩ :"array"},"page":{"additionalProperties":false,"description":"hasMore is true when more articles follow; pass nextCursor as cursor to get them","properties":{"count":{"maximum":50 ⟨26 unchanged words⟩ 

 ⟨5 unchanged words⟩ :false,"readOnlyHint":true,"title":"List documentshelp-center articles"}

List your support websites

ListUse athis boundedwhen pagesomeone ofasks which websites intheir theSupovia authenticatedsupport Supoviachat organization.runs Onlyon, safeor websitea identitywebsite's andid statusis fieldsneeded. areReturns returned;each promptswebsite's id, credentialsname, integrationdomain configurationand whether its AI customer agent is on, organizationmost idsrecently edited first, and20 arbitraryper metadatapage areby excluded.default. Not for customer conversations.

 ⟨5 unchanged words⟩ ,"properties":{"cursor":{"description":"Opaque paginationThe cursorpage.nextCursor fromof athe previous callpage; absent for the first page","maxLength":4096,"type":"string"},"limit":{"description":"Websites per page, from 1 to 50; defaults to 20","exclusiveMinimum":0,"maximum":50,"type": ⟨3 unchanged words⟩ 

 ⟨5 unchanged words⟩ properties":{"page":{"additionalProperties":false,"description":"hasMore is true when more websites follow; pass nextCursor as cursor to get them","properties":{"count":{"maximum":50," ⟨19 unchanged words⟩ ],"type":"object"},"websites":{"description":"Websites in the signed-in organization, most recently edited first. Prompts, credentials, integration configuration, organization ids and arbitrary metadata are excluded.","items":{"additionalProperties":false,"properties":{ ⟨61 unchanged words⟩ 

 ⟨5 unchanged words⟩ :false,"readOnlyHint":true,"title":"List your support websites"}

Open a conversation activityfrom the inbox

Refresh safeUse activitythis metadatawhen forthe oneembedded conversationSupovia selectedinbox inopens thea embeddedconversation Supoviathe inbox.user Thisselected. app-onlyReturns toolwhether readsit nowas threadfound and returnsgives nothe messageview bodyits channel, previewstatus, unread count and times (no message id,text or customer detail,details). orNot internalfor note.questions asked in chat.

{"$schema":"https://json-schema.org/draft/2020-12/schema","properties":{"conversationId":{"description":"Conversation id the user selected in the inbox view","maxLength":200,"minLength":1,"type":" ⟨5 unchanged words⟩ 

{"destructiveHint":false,"idempotentHint":true,"openWorldHint":false,"readOnlyHint":true,"title":"Open a conversation from the inbox"}

Resolve or reopen a conversation

MarkUse onethis organization-ownedwhen Supoviasomeone wants to mark a customer conversation resolved or done, or reopen it. This is idempotent: re-sendingReturns the same state is aconversation no-opid, write.resolved Itstate broadcastsand alast conversation-updatededit eventtime, toand the operator dashboard. No other conversation field candashboard beupdates changedlive. throughRepeating thisthe tool,same andstate customerhas identifiers,no stafffurther ids,effect. andNot organizationfor idsreplying areto neverthe returned.customer.

 ⟨5 unchanged words⟩ properties":{"conversationId":{"description":"Conversation id to mark resolved or reopenedupdate","maxLength":200,"minLength":1,"type":"string"},"resolved":{"description":"true marksto themark conversationit resolved (the default), false reopensto reopen it","type":"boolean"}},"required": ⟨3 unchanged words⟩ 

 ⟨32 unchanged words⟩ :"object"},{"type":"null"}],"description":"Only the id, resolved state and last edit time; null when not found. Customer identifiers, staff ids and organization ids are never returned."},"status":{"enum":["updated", ⟨8 unchanged words⟩ 

 ⟨5 unchanged words⟩ :false,"readOnlyHint":false,"title":"Resolve or reopen a conversation"}

Search documentshelp-center articles

SearchUse publishedthis supportwhen documentssomeone forasks which help article covers a topic or question on one organization-ownedof Supoviatheir website.websites. Returns atup mostto 5 safematching documentpublished identities;articles contentwith chunksid, embeddingstitle, scores,slug promptsand language, andmatched arbitraryby metadatameaning arein excluded.one language (English by default). Not for reading an article's text.

 ⟨5 unchanged words⟩ ,"properties":{"locale":{"description":"FilterLanguage bycode localeto (search in, e.g. en, it, fr)or fr; defaults to en","maxLength":20,"minLength":1,"type":"string"},"query":{"description":"SemanticWhat searchthe queryarticle should cover, in natural language, up to 500 characters","maxLength":500,"minLength":1,"type":"string"},"websiteId":{"description":"Organization-ownedWebsite websitewhose idhelp center to search","pattern":"^[0-9a-f]{ ⟨9 unchanged words⟩ 

 ⟨3 unchanged words⟩ additionalProperties":false,"properties":{"documents":{"description":"Closest matches first. Content chunks, embeddings, scores, prompts and arbitrary metadata are excluded.","items":{"additionalProperties":false,"properties":{" ⟨47 unchanged words⟩ 

 ⟨5 unchanged words⟩ :false,"readOnlyHint":true,"title":"Search documentshelp-center articles"}

SendReply messageto a customer

IdempotentlyUse sendthis onewhen exactthe operatoruser approves an exact reply into ansend organization-ownedto a customer in one Supovia conversation. ReuseReturns the sameconversation idempotencyKeyid onlyand whensend retryingtime. The reply reaches the samecustomer conversationon andthe text.conversation's Theown resultchannels confirms(chat, theemail, targetWhatsApp andor timeMessenger); withoutreplies returningto aapp-store messagereviews idare public. Not for internal notes or echoingclosing the message body.conversation.

 ⟨5 unchanged words⟩ ,"properties":{"content":{"description":"MessageExact reply text contentthe user approved, 1 to 4,000 characters","maxLength":4000,"minLength":1,"type":"string"},"conversationId":{"description":"Conversation id to send the messagereply in","maxLength":200,"minLength":1,"type":"string"},"idempotencyKey":{"description":"StableUnique uniquekey retryyou keygenerate for this exact conversation and reply text, up to 255 characters; reuse it only to retry the same send","maxLength":255,"minLength":1,"type ⟨7 unchanged words⟩ 

 ⟨3 unchanged words⟩ additionalProperties":false,"properties":{"conversationId":{"description":"Conversation the reply was added to","maxLength":200,"type":"string"},"creationTime ⟨4 unchanged words⟩ :"string"},{"type":"null"}],"description":"When the reply was recorded; no message id or text is echoed"},"status":{"const":"sent"," ⟨8 unchanged words⟩ 

 ⟨4 unchanged words⟩ openWorldHint":false,"readOnlyHint":false,"title":"SendReply messageto a customer"}

Show inboxunread activityconversations

OpenUse athis metadata-onlywhen Supoviasomeone inboxwants andto reportsee onlytheir unread customer conversations in an inbox view. Returns how many conversationsof havethe unread50 activity.most Therecently embeddedactive viewconversations receiveshave conversationunread idsmessages; neededthe forview anlists explicitup follow-upto plus20 with channel, status, unread count, and timestamps. It nevertimes receives(no message bodies, previews, messagetext ids,or customer details,). orNot internalfor notes.complete open-conversation totals.

 ⟨3 unchanged words⟩ additionalProperties":false,"properties":{"conversationsHaveMore":{"description":"True when conversations exist beyond the 50 sampled or the 20 the view lists","type":"boolean"},"unreadConversationCount":{"description":"Conversations with unread messages among the 50 most recently active","maximum":50,"minimum":0,"type": ⟨6 unchanged words⟩ 

{"destructiveHint":false,"idempotentHint":true,"openWorldHint":false,"readOnlyHint":true,"title":"Show unread conversations"}

Show Supovia support overview

RenderUse this when someone wants a boundedquick organization-scopedvisual snapshotsummary of Supoviatheir customer support. Returns a card with up to 20 websites (name, domain, AI agent on or off) and recentthe conversations.20 Customermost identifiers,recently internalactive recordconversations ids(channel, messageopen bodies,or promptsresolved, credentialstimes), internaloptionally notes,for organizationone ids,website. andNot arbitraryfor metadatacomplete areopen-conversation excluded.totals.

 ⟨3 unchanged words⟩ ,"properties":{"websiteId":{"description":"Optionally limitOnly thethis overviewwebsite; toevery onewebsite organization-ownedwhen websiteabsent","maxLength":200,"minLength":1,"type ⟨3 unchanged words⟩ 

 ⟨3 unchanged words⟩ additionalProperties":false,"properties":{"conversations":{"description":"The 20 most recently active conversations: channel, resolved state and timestamps. Customer identifiers, internal record ids, message bodies, prompts, credentials, internal notes, organization ids and arbitrary metadata are excluded.","items":{"additionalProperties":false,"properties":{" ⟨39 unchanged words⟩ {"type":"boolean"},"openConversationCount":{"description":"Open conversations among the 20 shown, not the organization total","maximum":20,"minimum":0,"type":"integer"},"websites":{"description":"Up to 20 websites: name, domain and AI-agent status only","items":{"additionalProperties":false,"properties":{ ⟨40 unchanged words⟩ 

{"destructiveHint":false,"idempotentHint":true,"openWorldHint":false,"readOnlyHint":true,"title":"Show support overview"}

{"$schema":"httphttps://json-schema.org/draft-07/schema#//json-schema.org/draft/2020-12/schema","properties":{},"type":"object"}

{"$schema":"httphttps://json-schema.org/draft-07/schema#//json-schema.org/draft/2020-12/schema","additionalProperties":false,"properties":{"conversationsHaveMore" ⟨14 unchanged words⟩ 

{"$schema":"httphttps://json-schema.org/draft-07/schema#","additionalProperties//json-schema.org/draft/2020-12/schema":false,"properties":{"websiteId":{"description":" ⟨16 unchanged words⟩ 

{"$schema":"httphttps://json-schema.org/draft-07/schema#//json-schema.org/draft/2020-12/schema","additionalProperties":false,"properties":{"conversations" ⟨97 unchanged words⟩