Listák — lists
| Művelet | Mit tesz | Jog |
|---|---|---|
GET /lists/list |
lista | lists:read |
GET /lists/get |
egy lista, id vagy code szerint, az oszlop-definícióval |
lists:read |
GET /lists/schema |
a mezők leírása | lists:read |
POST /lists/new |
új lista | lists:write |
POST /lists/upsert |
code szerint felvesz vagy módosít |
lists:write |
POST /lists/update |
módosítás — csak a küldött mező, updateMask-kal a felsorolt változik |
lists:write |
POST /lists/disable |
tiltás | lists:delete |
POST /lists/enable |
feloldás | lists:delete |
Lista az API-n nem törölhető.
A mezők
Szekció neve “A mezők”| Mező | Régi | Típus | Listában | Leírás | |
|---|---|---|---|---|---|
id |
lsid |
integer |
csak olvasható | ✓ | belső azonosító |
code |
string(40) |
✓ | külső azonosító (id és code). Az API-n foglalt kódot más lista nem kaphat. |
||
name |
string(120) |
kötelező | ✓ | a lista neve, egyedi | |
test |
boolean |
✓ | teszt-lista-e: a tételei az éles statisztikába nem számítanak | ||
date |
string |
✓ | a lista napja, 2026-10-17; felvételkor alapból a mai nap |
||
expirationDate |
expiration_date |
string |
✓ | a lejárat napja, 2026-10-17; üresen nem jár le |
|
disabled |
boolean |
✓ | tiltott-e a lista · jog: lists:delete |
||
status |
— | string |
csak olvasható | ✓ | az állapot: active, disabled vagy expired — a lejárt a lejárat napja után |
updatedAt |
— | string |
csak olvasható | ✓ | az utolsó módosítás ideje, eltolással — a nem látható adat változására is nő |
headerColumn1 |
spec_header1 |
integer |
az adatlap elsődleges fejlécének oszlopa, sorszámmal 1-től; ha nincs, a válaszban üres, a kérésben 0 |
||
headerColumn2 |
spec_header2 |
integer |
a másodlagos fejléc oszlopa, ugyanígy | ||
codeColumn |
spec_extcode |
integer |
a tétel külső azonosítójának oszlopa, ugyanígy | ||
parentColumn |
— | integer |
a szülő tétel külső azonosítójának oszlopa, ugyanígy | ||
addressOrderColumn |
— | integer |
a címek sorrendjének oszlopa a szülőn belül, ugyanígy | ||
interviewerCodeColumn |
— | integer |
CAPI-címlistán a tétel kérdezőjének felhasználó-kódja ebben az oszlopban áll, ugyanígy | ||
priorityColumn |
— | integer |
bejövő hívásnál a hívó tételének prioritása (1–3) ebben az oszlopban áll, ugyanígy | ||
routingColumn |
— | integer |
bejövő hívásnál a hívás célja (sor, mellék vagy szám) ebben az oszlopban áll, ugyanígy | ||
visibleOrder |
— | array |
a főoldali (visible) oszlopok sorrendje, oszlop-sorszámok tömbje — A sorrend |
||
highlightOrder |
— | array |
a kiemelt (highlighted) oszlopok sorrendje, ugyanígy |
||
note |
— | string |
megjegyzés | ||
columns |
headers |
array |
az oszlop-definíció — Az oszlopok | ||
extraColumns |
plusinfo_headers |
array |
az egyéb adatok oszlopainak neve, szövegek tömbje |
Az oszlop-sorszám csak létező oszlopra mutathat. A parentColumn csak codeColumn-nal, az addressOrderColumn csak
parentColumn-nal adható meg. A priorityColumn és a routingColumn csak bejövő listán állítható be — azon, amelyből
a rendszer a bejövő hívót azonosítja —; a már beállított bármely listán 0-ra állítható.
Az oszlopok
Szekció neve “Az oszlopok”A columns oszloponként egy objektum, a tételek adata ebben a sorrendben áll:
| Mező | Régi | Típus | Leírás |
|---|---|---|---|
name |
headers |
string |
az oszlop neve — kötelező, nem üres, ; nélkül |
numeric |
— | boolean |
szám-e az oszlop |
visible |
col_visible |
boolean |
az adatlap főoldalán látszik-e |
editable |
col_editable |
boolean |
írhatja-e az operátor |
hidden |
col_hidden |
boolean |
rejtett-e a tartalma az operátor elől |
highlighted |
— | boolean |
kiemelt-e: a hívás-ajánlaton, az interjú fejlécében és az ügyfélszolgálaton látszik, a highlightOrder sorrendjében |
A jelző elhagyható: a hiányzó false. Egy lista legfeljebb 50 oszlopot kap, ebből legfeljebb 4 kiemeltet. Rejtett
oszlop nem lehet kiemelt.
A sorrend
Szekció neve “A sorrend”A visibleOrder és a highlightOrder csak a sorrendet adja meg. Hogy melyik oszlop főoldali, illetve kiemelt, azt a
columns visible és highlighted jelzője mondja.
- A felsorolt oszlopok ebben a sorrendben állnak, a többi főoldali (kiemelt) oszlop utánuk, oszlop-sorrendben.
- A nem főoldali (nem kiemelt) oszlop sorszáma kimarad.
- Ha a kérésben nincs sorrend, a tárolt marad, és az újonnan jelölt oszlop a végére kerül. Üres tömbbel az oszlop-sorrend áll be.
- A válaszban a teljes sorrend áll, minden főoldali (kiemelt) oszlop sorszámával.
GET /lists/list Lista
Szekció neve “GET /lists/list Lista”A listák, lapozva (A lapozás). Alapból az aktívak, a 7 napon belül lejártakkal együtt.
| Paraméter | Régi | Típus | Mit szűr |
|---|---|---|---|
allowDisabled |
allow_disabled |
boolean |
a tiltottak és a régen lejártak is (true); alapból csak az aktívak |
{ "lists": [ { "id": 12, "code": "KAMP-2026-10", "name": "Októberi kampány", "test": false, "date": "2026-10-01", "expirationDate": "2026-12-31", "disabled": false, "status": "active" } ], "hasMore": false}curl "$BASE/lists/list?allowDisabled=true" -H "X-API-Key: $API_KEY"GET /lists/get Egy lista
Szekció neve “GET /lists/get Egy lista”A list mezői mellett a fejlécek, a megjegyzés és az oszlop-definíció.
curl "$BASE/lists/get?code=KAMP-2026-10" -H "X-API-Key: $API_KEY"{ "id": 12, "code": "KAMP-2026-10", "name": "Októberi kampány", "test": false, "date": "2026-10-01", "expirationDate": "2026-12-31", "disabled": false, "status": "active", "headerColumn1": 1, "headerColumn2": null, "codeColumn": 3, "parentColumn": null, "addressOrderColumn": null, "interviewerCodeColumn": null, "priorityColumn": null, "routingColumn": null, "visibleOrder": [2, 1], "highlightOrder": [3, 1], "note": null, "columns": [ { "name": "Név", "numeric": false, "visible": true, "editable": false, "hidden": false, "highlighted": true }, { "name": "Telefon", "numeric": false, "visible": true, "editable": true, "hidden": false, "highlighted": false }, { "name": "Ügyfélszám", "numeric": true, "visible": false, "editable": false, "hidden": false, "highlighted": true } ], "extraColumns": ["Megjegyzés a hívóról"]}GET /lists/schema A mezők leírása
Szekció neve “GET /lists/schema A mezők leírása”A columns elemeit is leírja. A válasz alakja: A mezők leírása.
curl "$BASE/lists/schema" -H "X-API-Key: $API_KEY"POST /lists/new Új lista
Szekció neve “POST /lists/new Új lista”Kötelező a name.
{ "code": "KAMP-2026-10", "name": "Októberi kampány", "expirationDate": "2026-12-31", "headerColumn1": 1, "codeColumn": 3, "columns": [ { "name": "Név", "visible": true, "highlighted": true }, { "name": "Telefon", "visible": true, "editable": true }, { "name": "Ügyfélszám", "numeric": true, "highlighted": true } ]}| HTTP | code |
Mikor |
|---|---|---|
400 |
INVALID_ARGUMENT |
nem tömb vagy nem objektum a columns-ban · nem egész szám a priorityColumn-ban vagy a routingColumn-ban · a visibleOrder vagy a highlightOrder nem egész számok tömbje |
422 |
VALIDATION_FAILED |
mezőhiba (fields): nem létező oszlopra mutató oszlop-sorszám (NO_SUCH_COLUMN), egy oszlop kétszer a sorrendben (ORDER_TWICE), üres oszlopnév (EMPTY_COLUMN_NAME), túl sok oszlop (TOO_MANY_COLUMNS), túl sok kiemelt oszlop (TOO_MANY_HIGHLIGHTS), kiemelt rejtett oszlop (HIGHLIGHT_HIDDEN), parentColumn codeColumn nélkül (PARENT_NEEDS_CODE), addressOrderColumn parentColumn nélkül (ORDER_NEEDS_PARENT), priorityColumn vagy routingColumn nem bejövő listán (INCOMING_ONLY) |
422 |
VALIDATION_FAILED |
a name foglalt (DUPLICATE_NAME) · a code foglalt (CODE_TAKEN_NEW) — a lists/upsert módosítja |
curl "$BASE/lists/new" -H "X-API-Key: $API_KEY" -H "Content-Type: application/json" \ -d '{"code": "KAMP-2026-10", "name": "Októberi kampány", "columns": [{"name": "Név", "visible": true}]}'POST /lists/upsert Felvétel vagy módosítás
Szekció neve “POST /lists/upsert Felvétel vagy módosítás”A code keresi a listát: ha megvan, a küldött mezőit módosítja, mint az update; ha nincs, felveszi, mint
a new. A code kötelező.
{ "code": "KAMP-2026-10", "name": "Októberi kampány", "expirationDate": "2027-01-31" }| HTTP | code |
Mikor |
|---|---|---|
400 |
INVALID_ARGUMENT |
hiányzik a code · hibás columns, mint a new-nál |
422 |
VALIDATION_FAILED |
mezőhiba (fields), mint a new-nál · a name foglalt (DUPLICATE_NAME) |
curl "$BASE/lists/upsert" -H "X-API-Key: $API_KEY" -H "Content-Type: application/json" \ -d '{"code": "KAMP-2026-10", "name": "Októberi kampány"}'POST /lists/update Módosítás
Szekció neve “POST /lists/update Módosítás”{ "code": "KAMP-2026-10", "columns": [ { "name": "Név", "visible": true }, { "name": "Mobil", "visible": true, "editable": true }, { "name": "Ügyfélszám", "numeric": true }, { "name": "Város", "visible": true } ], "visibleOrder": [4, 1, 2]}| HTTP | code |
Mikor |
|---|---|---|
400 |
INVALID_ARGUMENT |
hibás columns, mint a new-nál |
422 |
VALIDATION_FAILED |
mezőhiba (fields), mint a new-nál · kevesebb oszlop, mint a tárolt (COLUMN_NOT_DELETABLE) · a name foglalt (DUPLICATE_NAME) · a code egy másik listáé (CODE_TAKEN) |
curl "$BASE/lists/update" -H "X-API-Key: $API_KEY" -H "Content-Type: application/json" \ -d '{"code": "KAMP-2026-10", "expirationDate": "2027-01-31"}'POST /lists/disable Tiltás
Szekció neve “POST /lists/disable Tiltás”Tiltja a listát.
{ "code": "KAMP-2026-10" }curl "$BASE/lists/disable" -H "X-API-Key: $API_KEY" -H "Content-Type: application/json" -d '{"code": "KAMP-2026-10"}'POST /lists/enable Feloldás
Szekció neve “POST /lists/enable Feloldás”Feloldja a tiltott listát.
{ "code": "KAMP-2026-10" }curl "$BASE/lists/enable" -H "X-API-Key: $API_KEY" -H "Content-Type: application/json" -d '{"code": "KAMP-2026-10"}'A régi API-ból
Szekció neve “A régi API-ból”| Cím | Kérés | Válasz | Működés |
|---|---|---|---|
list/list → GET /lists/list |
— | a codeColumn csak a get-ben |
— |
list/get → GET /lists/get |
a lista keresése: lsid / lscode → id / code |
a headers, col_visible, col_editable és col_hidden tömb helyett oszloponként egy objektum (Az oszlopok) |
— |
list/new → POST /lists/upsert · POST /lists/new |
update_keyduplicate nincs: a két alakja két művelet |
lsid → id |
az alapértéke (true: a meglévő code-ot módosítja) most az upsert, a false (a meglévő code-ra hiba) a new |
list/update → POST /lists/update |
a keresés, mint a get-nél; a code átírásához az id kell |
— | tiltott listát csak a feloldással együtt módosít; a disabled-hez külön jog kell |
| — | — | — | csak az újban: lists/schema, lists/disable, lists/enable |