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.
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éter | Típus | Kötelező | Leírás |
|---|---|---|---|
table | string | Igen | A listázni kívánt erőforrás típusa. Lásd az elérhető típusokat alább. |
limit | number | Nem | Hány rekordot adjon vissza. Alapértelmezés: 50, max: 300. |
from | number | Nem | Lapozási eltolás (beszélgetések, látogatók, hibajegyek, műszakok és feliratkozók). Alapértelmezés: 0. |
chatbotId | string | Feltételes | Szükséges chatbot dokumentumok vagy beszélgetésindítók listázásához. |
knowledgebaseId | string | Feltételes | Szükséges KB cikkek vagy kategóriák listázásához. |
documentationId | string | Feltételes | Szükséges dokumentáció kategóriák vagy oldalak listázásához. |
boardId | string | Feltételes | Szükséges hibajegyek listázásához. |
category | string | Nem | Szűrő a beszélgetéseknél: "all", "my-inbox", "unassigned", vagy "calls" (hanghívások). |
channels | array | Nem | Szűrő a beszélgetéseknél — csak ezekre a csatornákra. Bármelyik: "widget", "facebook", "instagram", "voice". |
widgetId | string | Nem | Szűrő a beszélgetéseknél — csak egyetlen widgetre korlátoz. |
updatedSince | string | Nem | Szű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. |
includeAnonymous | boolean | Nem | Szűrő a látogatóknál — azokat a látogatókat is beleveszi, akik soha nem beszélgettek (nyers oldalforgalom). |
publishedOnly | boolean | Nem | Szűrő cikkekhez és dokumentációs oldalakhoz — csak közzétett elemeket ad vissza. |
boardColId | string | Nem | Szűrő hibajegyekhez — csak az adott oszlopban lévő jegyek. |
archived | boolean | Nem | Szűrő hibajegyekhez — true csak az archivált, false csak az élő jegyeket adja vissza. Hagyd el mindkettőhöz. |
assignedUserId | string | Nem | Szűrő hibajegyekhez — csak az adott személyhez rendelt jegyek. |
priority | string | Nem | Szűrő hibajegyekhez — LOW, MEDIUM vagy HIGH. |
userId | string | Nem | Szűrő műszakokhoz — egy ügynök műszakjai. Az Összes műszak jogosultság kell hozzá; enélkül mindig a sajátjaidat kapod. |
shiftTypeId | string | Nem | Szűrő műszakokhoz — csak az adott műszaktípus. |
running | boolean | Nem | Szűrő műszakokhoz — true a még be nem fejezett (nyitott) műszakokhoz, false a lezártakhoz. |
finalized | boolean | Nem | Szűrő műszakokhoz — bérszámfejtésre lezárt állapot. |
edited | boolean | Nem | Szűrő műszakokhoz — csak a kézzel javított műszakok. |
startedAfter / startedBefore | string | Nem | Szűrő műszakokhoz — ISO időbélyegek, amelyek a műszak kezdési idejét határolják. |
email | string | Nem | Szűrő a feliratkozóknál — pontos e-mail cím keresés. |
search | string | Nem | Kis- é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. |
state | string | Nem | Szűrő a feliratkozóknál — feliratkozói állapot (VERIFIED = küldhető; továbbá NEW, UNVERIFIED, UNSUBSCRIBED, REMOVED, BOUNCED, COMPLAINT). |
groupId | string | Nem | Szűrő a feliratkozóknál — csak az adott névjegycsoport tagjai. A segmentId-vel együtt nem használható. |
segmentId | string | Nem | Szű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 / engagementMax | number | Nem | Szűrő a feliratkozóknál — aktivitási pontszám tartomány. |
brandId | string | Nem | Szűrő a termékforrásoknál, termékszabályoknál és termékeknél — egyetlen márka rekordjai. |
sourceId | string | Nem | Szűrő a termékeknél — csak az adott forrás által szállított termékek. |
ruleStatus | string | Nem | Szűrő a termékszabályoknál — draft vagy active. |
ruleMode | string | Nem | Szűrő a termékszabályoknál — always vagy when_relevant. |
importId | string | Nem | Szűrő a termékszabályoknál — csak az egyetlen dokumentumimport által létrehozott szabályok. |
key | string | Nem | Szű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ípus | Mit listáz |
|---|---|
widgets | Chat widgetek |
chatbots | AI chatbotok |
knowledgebase | Tudásbázisok |
chats | Beszélgetések |
visitors | Weboldal látogatók |
documents | Chatbot tudás dokumentumok (chatbotId szükséges) |
conversation_starters | Chatbot beszélgetésindítók (chatbotId szükséges) |
articles | KB cikkek (knowledgebaseId szükséges) |
categories | KB kategóriák (knowledgebaseId szükséges) |
documentation | Dokumentációs portálok |
doc_categories | Dokumentáció kategóriák (documentationId szükséges) |
doc_pages | Dokumentációs oldalak (documentationId szükséges) |
contact_groups | Névjegycsoportok feliratkozó számokkal |
contact_segments | Névjegy szegmensek |
email_templates | E-mail sablonok |
campaigns | E-mail kampányok |
subscribers | Hírlevél feliratkozók |
outreach | Összes elérési terjesztési elem (szalagcímek, üzenetek, felmérések, bemutatók, hírek) |
boards | Hibajegy-, visszajelzés- és ütemterv-táblák |
tickets | Egy tábla hibajegyei (boardId szükséges) |
shifts | Munkaműszakok számított bérrel (a sajátjaid; mindenkié az Összes műszak jogosultsággal) |
shift_types | Műszaktípusok bérszorzóval és az ügyeleti (chat) jelzővel |
product_sources | A katalógusok, ahonnan a termékek érkeznek, a beolvasási ütemezésükkel és a legutóbbi futásukkal |
product_rules | A 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 |
products | Maga a katalógus, minden termék kulcsaival és saját szabálymondataival |
Táblák és hibajegyek
archived jelzővel érkezik vissza, és közvetlenül szűrhetsz rá.Csak valódi beszélgetések
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őidnekreturned— 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
outreachtí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
fromparamé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 alimitparamé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
updatedSinceparamétert használja) - „Mutasd csak az Instagram beszélgetéseimet.” (a
channelsparamé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
emailszű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
stateszű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éter | Típus | Kötelező | Leírás |
|---|---|---|---|
table | string | Igen | Az erőforrás típusa. Lásd az elérhető táblákat alább. |
id | string | Igen | A 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ípus | Mit kapsz |
|---|---|
widgets | Teljes konfiguráció, téma színek és kapcsolt erőforrások |
chatbots | Teljes AI beállítások és konfiguráció |
knowledgebase | Portál részletek kategóriákkal |
documentation | Portál részletek kategóriákkal |
doc_categories | Kategória részletek, beleértve a leírást és közzétett státuszt |
doc_pages | Teljes Markdown tartalom és oldal hierarchia |
chats | Teljes beszélgetési részletek, beleértve a channel és has_messages mezőt (lásd lentebb) |
visitors | Teljes látogató profil |
documents | Teljes dokumentum tartalom |
conversation_starters | Indító felirat és prompt |
articles | Teljes HTML tartalom |
categories | Kategória részletek és hierarchia |
campaigns | Teljes kampány részletek, beleértve az e-mail tartalmat és címzetteket |
subscribers | Feliratkozó profil egyéni mezőkkel, aktivitási pontszámmal és csoporttagságokkal |
email_templates | Teljes sablon tartalom |
banners | Tartalom, stílus és aktiválási szabályok |
messages | Tartalom és aktiválási szabályok |
surveys | Felmérési folyamat és aktiválási szabályok |
tours | Bemutató lépések és aktiválási szabályok |
news | Teljes tartalom, borítókép és nyelv |
boards | Minden a tábláról — lásd lentebb |
tickets | Teljes hibajegy részletek, a címkéivel, hozzászólásaival és a bejelentőjével együtt |
shifts | Teljes műszak részletek számított bérrel — az Összes műszak jogosultsággal a naplóval együtt |
shift_types | Műszaktípus részletek bérszorzóval és ügyeleti (chat) jelzővel |
product_sources | Teljes 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_rules | Teljes szabály részletek, plusz a matched_products_count — hány termékhez jut el ma |
products | Teljes termék részletek, plusz a matched_rules — minden rá vonatkozó szabály, a piszkozatokkal együtt |
banners, messages, surveys, tours, news) — nem az összesített outreach típust, amelyet a list_records használ.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. Alist_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:
- Listázd az erőforrásokat, hogy megtudd, mi létezik →
list_records - Vizsgáld meg az adott erőforrást az állapotának megértéséhez →
get_record - Módosítsd a megfelelő kezelő eszközzel →
manage_widget,manage_chatbotstb.
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:
- Listázd a beszélgetéseket egyszer →
list_recordsatable: "chats"paraméterrel - Jegyezd meg a legfrissebb
updated_atértéket az eredményekben - A következő ellenőrzésnél add át
updatedSinceparamé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.”