Adathozzáférési eszközök

Listázd és kérd le a szervezeted bármelyik erőforrását — widgetek, chatbotok, beszélgetések, névjegyek és még sok más.

Áttekintés

Az adathozzáférési eszközök minden munkafolyamat alapját képezik. Mielőtt frissíthetnél egy widgetet, szerkeszthetnél egy chatbotot vagy ellenőrizhetnéd a kampány statisztikákat, általában először meg kell találnod az erőforrást. Ez a két eszköz csak olvasási hozzáférést biztosít a szervezeted minden erőforrás típusához.

Szükséges jogosultság: Minden erőforrás típushoz ugyanaz a jogosultság szükséges, mint amivel az irányítópulton megtekintenéd — csak azokat az erőforrásokat listázhatod vagy kérheted le, amelyek funkciójához hozzáférésed van.

list_records

Listázza egy adott erőforrás típus rekordjait a szervezetedben. Minden rekordhoz összefoglaló nézetet ad vissza (nem teljes részleteket — arra a get_record való).

Paraméterek

ParaméterTípusKötelezőLeírás
tablestringIgenA listázni kívánt erőforrás típusa. Lásd az elérhető típusokat alább.
limitnumberNemHány rekordot adjon vissza. Alapértelmezés: 50, max: 300.
fromnumberNemLapozási eltolás (beszélgetések, látogatók, hibajegyek, műszakok és feliratkozók). Alapértelmezés: 0.
chatbotIdstringFeltételesSzükséges chatbot dokumentumok vagy beszélgetésindítók listázásához.
knowledgebaseIdstringFeltételesSzükséges KB cikkek vagy kategóriák listázásához.
documentationIdstringFeltételesSzükséges dokumentáció kategóriák vagy oldalak listázásához.
boardIdstringFeltételesSzükséges hibajegyek listázásához.
categorystringNemSzűrő a beszélgetéseknél: "all", "my-inbox", "unassigned", vagy "calls" (hanghívások).
channelsarrayNemSzűrő a beszélgetéseknél — csak ezekre a csatornákra. Bármelyik: "widget", "facebook", "instagram", "voice".
widgetIdstringNemSzűrő a beszélgetéseknél — csak egyetlen widgetre korlátoz.
updatedSincestringNemSzűrő a beszélgetéseknél — ISO időbélyeg. Csak az azóta frissült beszélgetéseket adja vissza. Ezt használd lekérdezéshez.
includeAnonymousbooleanNemSzűrő a látogatóknál — azokat a látogatókat is beleveszi, akik soha nem beszélgettek (nyers oldalforgalom).
publishedOnlybooleanNemSzűrő cikkekhez és dokumentációs oldalakhoz — csak közzétett elemeket ad vissza.
boardColIdstringNemSzűrő hibajegyekhez — csak az adott oszlopban lévő jegyek.
archivedbooleanNemSzűrő hibajegyekhez — true csak az archivált, false csak az élő jegyeket adja vissza. Hagyd el mindkettőhöz.
assignedUserIdstringNemSzűrő hibajegyekhez — csak az adott személyhez rendelt jegyek.
prioritystringNemSzűrő hibajegyekhez — LOW, MEDIUM vagy HIGH.
userIdstringNemSzűrő műszakokhoz — egy ügynök műszakjai. Az Összes műszak jogosultság kell hozzá; enélkül mindig a sajátjaidat kapod.
shiftTypeIdstringNemSzűrő műszakokhoz — csak az adott műszaktípus.
runningbooleanNemSzűrő műszakokhoz — true a még be nem fejezett (nyitott) műszakokhoz, false a lezártakhoz.
finalizedbooleanNemSzűrő műszakokhoz — bérszámfejtésre lezárt állapot.
editedbooleanNemSzűrő műszakokhoz — csak a kézzel javított műszakok.
startedAfter / startedBeforestringNemSzűrő műszakokhoz — ISO időbélyegek, amelyek a műszak kezdési idejét határolják.
emailstringNemSzűrő a feliratkozóknál — pontos e-mail cím keresés.
searchstringNemKis- és nagybetűtől független részleges egyezés — a feliratkozóknál névre vagy e-mailre, a termékszabályoknál a szabály szövegére, a termékeknél a címre.
statestringNemSzűrő a feliratkozóknál — feliratkozói állapot (VERIFIED = küldhető; továbbá NEW, UNVERIFIED, UNSUBSCRIBED, REMOVED, BOUNCED, COMPLAINT).
groupIdstringNemSzűrő a feliratkozóknál — csak az adott névjegycsoport tagjai. A segmentId-vel együtt nem használható.
segmentIdstringNemSzűrő a feliratkozóknál — csak az adott szegmens mentett szűrőire illeszkedő névjegyek. A groupId-vel együtt nem használható.
engagementMin / engagementMaxnumberNemSzűrő a feliratkozóknál — aktivitási pontszám tartomány.
brandIdstringNemSzűrő a termékforrásoknál, termékszabályoknál és termékeknél — egyetlen márka rekordjai.
sourceIdstringNemSzűrő a termékeknél — csak az adott forrás által szállított termékek.
ruleStatusstringNemSzűrő a termékszabályoknál — draft vagy active.
ruleModestringNemSzűrő a termékszabályoknál — always vagy when_relevant.
importIdstringNemSzűrő a termékszabályoknál — csak az egyetlen dokumentumimport által létrehozott szabályok.
keystringNemSzűrő a termékszabályoknál és a termékeknél — a normalizált kulcs, amin a kettő illeszkedik. Az ékezetek, a kis- és nagybetűk és az írásjelek nem számítanak.

Elérhető erőforrás típusok

TípusMit listáz
widgetsChat widgetek
chatbotsAI chatbotok
knowledgebaseTudásbázisok
chatsBeszélgetések
visitorsWeboldal látogatók
documentsChatbot tudás dokumentumok (chatbotId szükséges)
conversation_startersChatbot beszélgetésindítók (chatbotId szükséges)
articlesKB cikkek (knowledgebaseId szükséges)
categoriesKB kategóriák (knowledgebaseId szükséges)
documentationDokumentációs portálok
doc_categoriesDokumentáció kategóriák (documentationId szükséges)
doc_pagesDokumentációs oldalak (documentationId szükséges)
contact_groupsNévjegycsoportok feliratkozó számokkal
contact_segmentsNévjegy szegmensek
email_templatesE-mail sablonok
campaignsE-mail kampányok
subscribersHírlevél feliratkozók
outreachÖsszes elérési terjesztési elem (szalagcímek, üzenetek, felmérések, bemutatók, hírek)
boardsHibajegy-, visszajelzés- és ütemterv-táblák
ticketsEgy tábla hibajegyei (boardId szükséges)
shiftsMunkaműszakok számított bérrel (a sajátjaid; mindenkié az Összes műszak jogosultsággal)
shift_typesMűszaktípusok bérszorzóval és az ügyeleti (chat) jelzővel
product_sourcesA katalógusok, ahonnan a termékek érkeznek, a beolvasási ütemezésükkel és a legutóbbi futásukkal
product_rulesA kötelező érvényű szöveg, amit az AI-nak követnie kell egy termékről — kulcsok és szöveg, piszkozat vagy aktív
productsMaga a katalógus, minden termék kulcsaival és saját szabálymondataival

Táblák és hibajegyek

Csak azokat a táblákat látod, amelyekhez hozzáférésed van. A táblákat személyenként adjuk oda, így a táblák listázása csak a tieidet adja vissza, és ha egy ezeken kívüli táblát vagy jegyet kérdezel le, pontosan ugyanazt a választ kapod, mint egy nem létezőre. Ez alól egyedül a szervezet tulajdonosa kivétel — az adminok ugyanúgy tábla-hozzáféréssel rendelkeznek, mint bárki más.
Az „archivált” azt jelenti, hogy a jegy egyik oszlopban sincs. A tábla oszlopai az állapotok, és az a jegy, amelyik egyikhez sem tartozik, maga az archívum — ez a teljes mechanizmus. Nem kell ismerned ezt a szabályt az eszközök használatához: minden jegy egy archived jelzővel érkezik vissza, és közvetlenül szűrhetsz rá.

Csak valódi beszélgetések

Csak a tényleges beszélgetéseket kapod meg. A chat widget minden új látogatóhoz létrehoz egy beszélgetés rekordot, aki betölti az oldaladat, és ezek túlnyomó többsége soha nem kap egyetlen üzenetet sem — ezek üres helyfoglalók, nem beszélgetések. A chats listázása csak azokat a beszélgetéseket adja vissza, amelyekben legalább egy üzenet van, pontosan úgy, ahogy a Beérkezett üzenetekben látod. Az üres rekordok beemelésére nincs lehetőség.

Ugyanez a logika érvényes a látogatókra is. A visitors listázása azokat az embereket adja vissza, akik ténylegesen beszélgettek veled, a legutóbbi beszélgetésük szerint rendezve. Állítsd be az includeAnonymous: true értéket, ha valóban a nyers oldalforgalomra van szükséged — ez a helyes választás közönség- és analitikai kérdésekhez, és utolsó aktivitás szerint rendez.

Mit kapsz vissza

A beszélgetések a legutóbbi frissítés szerint rendezve érkeznek, és minden válasz két számlálót is tartalmaz:

  • total — összesen hány beszélgetés felel meg a szűrőidnek
  • returned — hány szerepel ebben az oldalban

Minden beszélgetés rekord tartalmazza a látogató nevét, e-mail címét és országát, az utolsó üzenet szövegét, a csatornát, amelyen érkezett, a widget nevét, az e-mail tárgyát (e-mail beszélgetéseknél), a létrehozási és frissítési időbélyeget, valamint a hozzárendelt ügyintézőt — így ritkán van szükséged további lekérésre csak azért, hogy kiderítsd, kivel folyik a beszélgetés.

Új aktivitás figyelése

Ha úgy szeretnéd szemmel tartani a beérkezett üzeneteket, hogy ne kelljen minden alkalommal az egész listát újraolvasnod, jegyezd meg a legfrissebb updated_at értéket, amit láttál, és add vissza updatedSince paraméterként a következő híváskor. Csak azt kapod meg, ami ténylegesen változott.

A különbség drámai egy forgalmas szervezetnél: a teljes beszélgetéslista több tízezer rekord is lehet, míg ugyanaz a hívás egy órával ezelőttre állított updatedSince értékkel jellemzően csak néhányat ad vissza.

Hogyan működik

  • A rekordok létrehozási dátum szerint rendezve kerülnek visszaadásra (legújabb először), kivéve a beszélgetéseket (utolsó frissítés szerint), a műszakokat (kezdési idő szerint), a termékforrásokat (legrégebbi először), a termékeket (utolsó módosítás szerint), valamint a saját sorrenddel rendelkező típusokat — tudásbázis kategóriák, dokumentáció kategóriák és oldalak, beszélgetésindítók és műszaktípusok —, amelyek abban a sorrendben érkeznek, ahogy a vezérlőpult mutatja őket.
  • Az outreach típus az összes elérési terjesztési elemet altípusonként csoportosítva adja vissza (szalagcímek, üzenetek, felmérések, bemutatók, hírek).
  • A lapozás a from paraméterrel a beszélgetéseknél, látogatóknál, hibajegyeknél, műszakoknál, feliratkozóknál, termékforrásoknál, termékszabályoknál és termékeknél támogatott. A többi típusnál egyszerűen a limit paraméter kerül alkalmazásra.
  • Ha a fiókod csak bizonyos widgetekre korlátozódik, csak azoknak a widgeteknek a beszélgetéseit látod — ugyanaz a korlátozás, ami a Beérkezett üzenetekben is érvényes. A tulajdonosokra és adminokra ez nem vonatkozik, a hanghívások pedig mindig láthatók, mivel nem tartoznak widgethez.

Példa promptok

  • „Mutasd meg az összes widgetemet.”
  • „Listázd a chatbotjaimat.”
  • „Jelenleg milyen hozzá nem rendelt beszélgetések vannak?”
  • „Mutasd meg a 9 óta érkezett beszélgetéseket.” (az updatedSince paramétert használja)
  • „Mutasd csak az Instagram beszélgetéseimet.” (a channels paramétert használja)
  • „Mutasd meg a Szupport Bot chatbotomban lévő dokumentumokat.” (először megtalálja a chatbotot, majd listázza a dokumentumokat)
  • „Listázd az összes közzétett cikket a Támogatás tudásbázisomban.” (megtalálja a KB-t, majd publishedOnly: true-val listázza a cikkeket)
  • „Mutasd meg a hírlevél névjegycsoportjaimat és az egyes csoportok feliratkozóinak számát.”
  • „Keresd meg a [email protected] feliratkozót.” (az email szűrőt használja)
  • „Listázd a VIP csoportom tagjait.” (megkeresi a csoportot, majd a groupId-vel listáz)
  • „Mutasd a leiratkozott névjegyeket.” (a state szűrőt használja)
  • „Milyen kampányokat küldtem nemrég?”
  • „Listázd az összes elérési terjesztési elemet — szalagcímeket, felméréseket, bemutatókat, mindent.”
  • „Mutasd meg a legutóbbi 100 beszélgetésemet.”

get_record

Egyes rekordot kér le azonosító szerint teljes részletekkel. Több információt ad vissza, mint a list_records — például teljes konfigurációs objektumokat, tartalom mezőket és kapcsolódó adatokat.

Paraméterek

ParaméterTípusKötelezőLeírás
tablestringIgenAz erőforrás típusa. Lásd az elérhető táblákat alább.
idstringIgenA lekérendő rekord egyedi azonosítója.

Elérhető erőforrás típusok

Ugyanazok a típusok, mint a list_records-nál, és ezenkívül az egyedi elemek lekéréséhez meghatározott elérési terjesztés altípusok:

TípusMit kapsz
widgetsTeljes konfiguráció, téma színek és kapcsolt erőforrások
chatbotsTeljes AI beállítások és konfiguráció
knowledgebasePortál részletek kategóriákkal
documentationPortál részletek kategóriákkal
doc_categoriesKategória részletek, beleértve a leírást és közzétett státuszt
doc_pagesTeljes Markdown tartalom és oldal hierarchia
chatsTeljes beszélgetési részletek, beleértve a channel és has_messages mezőt (lásd lentebb)
visitorsTeljes látogató profil
documentsTeljes dokumentum tartalom
conversation_startersIndító felirat és prompt
articlesTeljes HTML tartalom
categoriesKategória részletek és hierarchia
campaignsTeljes kampány részletek, beleértve az e-mail tartalmat és címzetteket
subscribersFeliratkozó profil egyéni mezőkkel, aktivitási pontszámmal és csoporttagságokkal
email_templatesTeljes sablon tartalom
bannersTartalom, stílus és aktiválási szabályok
messagesTartalom és aktiválási szabályok
surveysFelmérési folyamat és aktiválási szabályok
toursBemutató lépések és aktiválási szabályok
newsTeljes tartalom, borítókép és nyelv
boardsMinden a tábláról — lásd lentebb
ticketsTeljes hibajegy részletek, a címkéivel, hozzászólásaival és a bejelentőjével együtt
shiftsTeljes műszak részletek számított bérrel — az Összes műszak jogosultsággal a naplóval együtt
shift_typesMűszaktípus részletek bérszorzóval és ügyeleti (chat) jelzővel
product_sourcesTeljes forrás részletek — a titkot soha, csak a has_secret értéket, az egyedi fejlécek nevét és a küldési címet
product_rulesTeljes szabály részletek, plusz a matched_products_count — hány termékhez jut el ma
productsTeljes termék részletek, plusz a matched_rules — minden rá vonatkozó szabály, a piszkozatokkal együtt
Megjegyzés: Az elérési terjesztésnél használd a specifikus típus nevet (banners, messages, surveys, tours, news) — nem az összesített outreach típust, amelyet a list_records használ.
Egy tábla lekérdezése mindent a kezedbe ad, ami egy jegy módosításához kell. Magán a táblán túl megkapod az oszlopait, a címkepalettáját, azokat a személyeket, akikhez a jegy hozzárendelhető, az ellenőrzött címeket, ahonnan a bejelentőnek e-mailt küldhetsz, és az elérhető prioritásokat — minden értéket, amit a Jegy eszközök elfogadnak, egyetlen hívásban, így soha nem kell azonosítót találgatnod. Egyetlen jegy lekérdezése hasonlóképpen visszaadja a bejelentőjét (a beküldő személyt az e-mail címével együtt) és azt, hogy archiválva van-e.

Két mező a beszélgetéseknél külön említést érdemel:

  • has_messages — megmutatja, hogy ez egy valódi beszélgetés-e, vagy az egyik üres rekord, amelyet a widget hoz létre egy új látogatóhoz. A list_records-tól eltérően az azonosító szerinti lekérés mindkét esetben visszaadja a beszélgetést, így ebből tudod meg, melyiket kaptad.
  • channel — hogyan érkezett a beszélgetés: widget, e-mail, Facebook, Instagram vagy hanghívás.

Hogyan működik

  • A rekordnak a szervezetedhez kell tartoznia. Más szervezetek rekordjaihoz való hozzáférési kísérletek sikertelenek lesznek.
  • A beszélgetésekre a widgetenkénti hozzáférés is érvényes — ha a fiókod csak bizonyos widgetekre korlátozódik, egy másik widget beszélgetésének lekérése ugyanúgy sikertelen lesz, mint a Beérkezett üzenetekben.
  • Az erőforrás teljes részleteit adja vissza, teljes képet adva a konfigurációjáról és tartalmáról.

Példa promptok

  • „Mutasd meg az alapértelmezett widgetem teljes részleteit.” (először listázza a widgeteket, majd lekéri az alapértelmezettet)
  • „Mi az AI konfiguráció a Szupport Botomon?” (listázza a chatbotokat, majd lekéri az adott egyet)
  • „Mutasd meg a visszatérítési szabályzat dokumentum tartalmát.” (listázza a dokumentumokat, majd lekéri a teljes tartalmat)
  • „Hadd lássam az Első lépések cikk teljes HTML-jét.” (megtalálja a cikket, majd lekéri a tartalmát)
  • „Mik az aktiválási szabályok az akciós szalagcímemen?” (listázza az elérési terjesztési elemeket, majd lekéri a szalagcím részleteit)
  • „Mutasd meg a márciusi kampány e-mail tartalmát és címzettjeit.” (lekéri a kampányt teljes küldési részletekkel)

Általános munkafolyamat minták

Felfedezés majd cselekvés

A legtöbb munkafolyamat adathozzáférési eszközökkel kezdődik:

  1. Listázd az erőforrásokat, hogy megtudd, mi létezik → list_records
  2. Vizsgáld meg az adott erőforrást az állapotának megértéséhez → get_record
  3. Módosítsd a megfelelő kezelő eszközzel → manage_widget, manage_chatbot stb.

Tömeges áttekintés

Használd a list_records-t magasabb limit-tel egyszerre sok erőforrás áttekintéséhez:

  • „Mutasd meg mind a 200 hírlevél névjegyemet.”
  • „Listázd az utolsó 100 beszélgetésemet.”

Aktivitás figyelése

Nézz rá újra és újra a beérkezett üzenetekre anélkül, hogy mindent újraolvasnál:

  1. Listázd a beszélgetéseket egyszer → list_records a table: "chats" paraméterrel
  2. Jegyezd meg a legfrissebb updated_at értéket az eredményekben
  3. A következő ellenőrzésnél add át updatedSince paraméterként → csak a megváltozott beszélgetések érkeznek vissza
  • „Nézd meg időnként, hogy érkeztek-e új beszélgetések, és számolj be róluk.”

Kereszthivatkozás

Kombináld a különböző táblákból való listázást a kapcsolatok megértéséhez:

  • „Listázd a widgetjeimet és chatbotjaimat, majd mondd meg, melyik chatbot melyik widgethez van kapcsolva.”
  • „Mutasd meg az összes tudásbázisomat és cikkeik számát.”