Ugrás a tartalomhoz

Jegyek

Közös postafiók, űrlapok és automatizálások az ügyfélkérésekhez.

Jegyek megnyitása
Az irányítópulttal összevetve ekkor: 2026. november 18.

A jegy-API lehetővé teszi, hogy a Xudán kívüli szoftver egy íróasztalon dolgozzon: jegyet nyisson, jegyeket listázzon és olvasson, válaszoljon, kiossza, szakaszok között áthelyezze és lezárja a jegyet, valamint olvassa a témákat és a csapatot. Az űrlapok, munkafolyamatok, AI-ügynökök, belső megjegyzések és a beállítások az irányítópulton maradnak.

Minden hívás egy POST a https://xuda.ai/cpi/<method> címre, JSON törzzsel, amely api_key néven viszi a fiókja API-kulcsát. A hívás a kulcsot birtokló fiók íróasztalán működik, az íróasztal csomagja szerint, és nem nevezhet meg másik íróasztalt. Hozza létre a kulcsot az irányítópulton a Developers alatt, és tartsa távol oldalaktól és nyilvános kódtól.

A válasz { "code": ..., "data": ... }. A pozitív code siker. Az elutasítás negatív kód, a data mezőben egy mondattal.

curl -s https://xuda.ai/cpi/ticket_api_submit \
  -H 'content-type: application/json' \
  -d '{"api_key":"YOUR_API_KEY","name":"Jordan Lee","email":"[email protected]","subject":"Export fails","details":"The export button returns a 500."}'
const res = await fetch('https://xuda.ai/cpi/ticket_api_submit', {
  method: 'POST',
  headers: { 'content-type': 'application/json' },
  body: JSON.stringify({
    api_key: 'YOUR_API_KEY',
    name: 'Jordan Lee',
    email: '[email protected]',
    subject: 'Export fails',
    details: 'The export button returns a 500.',
  }),
});
const { code, data } = await res.json();
import requests

res = requests.post(
    'https://xuda.ai/cpi/ticket_api_submit',
    json={
        'api_key': 'YOUR_API_KEY',
        'name': 'Jordan Lee',
        'email': '[email protected]',
        'subject': 'Export fails',
        'details': 'The export button returns a 500.',
    },
)

A name és a details kötelező. Az email alapján létrejön vagy újrahasznosul egy névjegy, a jegy api forrással kerül felvételre, és a válasz egy szűk nézet: szám, azonosító, állapot, szakasz, tárgy, téma, kérelmező, a felelős azonosítója és az időbélyegek. Belső azonosítókat és az automatizálás állapotát soha nem adjuk vissza.

Az email opcionális, ha egy integráció vagy ügynök saját magának veszi fel a jegyet: küldjön csak name értéket, és nem jön létre névjegy, és a kérelmezőnek semmit nem küldünk e-mailben.

Az opcionális mezők a jegynek subject (tárgy), phone, company, az íróasztal témáiból topic_id és subtopic_id, saját reference_id, 1 (legmagasabb) és 4 közötti priority, type (issue, bug, feature vagy task) és attachments értéket adnak.

Ha az új jegyet valakinek át akarja adni, nevezze meg az assignee_uid vagy az assignee_email mezővel, a kettő közül az egyiket. Az illetőnek az íróasztal munkaterületi csapatában kell lennie, ami a tulajdonosa és a munkaterület elfogadott tagjai. Az elutasított felelős mellett nem jön létre jegy.

Jegyek keresése és olvasása

A ticket_api_list az irányítópulton is meglévő szűrőkkel listáz jegyeket: status (open vagy closed), source, topic_id, type, assignee_uid, reference_id, szabad szöveges search a tárgyon, a részleteken és a jegyszámon, valamint created_from és created_to tartomány. Rendezzen a sort (date_created_ts, last_activity_ts, status_ts vagy priority) és a dir mezővel, és lapozzon a limit (legfeljebb 500) és az előző válaszból kapott bookmark mezővel.

A ticket_api_get egy jegyet olvas a ticket_id alapján, a nyilvános interakcióival együtt. A belső megjegyzéseket és az AI-piszkozatokat soha nem adjuk vissza.

A ticket_api_topics az íróasztal témáit és altémáit adja vissza, hogy a saját űrlapja ugyanazt a választót mutathassa, mint a tárolt űrlap. A ticket_api_team azokat az embereket adja vissza, akiknek jegy osztható ki, mindegyiket uid-vel, névvel és e-mail-címmel.

curl -s https://xuda.ai/cpi/ticket_api_reply \
  -H 'content-type: application/json' \
  -d '{"api_key":"YOUR_API_KEY","ticket_id":"TICKET_ID","body":"Thanks, we are looking into it."}'
curl -s https://xuda.ai/cpi/ticket_api_set_stage \
  -H 'content-type: application/json' \
  -d '{"api_key":"YOUR_API_KEY","ticket_id":"TICKET_ID","status_stage":"in_progress"}'
curl -s https://xuda.ai/cpi/ticket_api_close \
  -H 'content-type: application/json' \
  -d '{"api_key":"YOUR_API_KEY","ticket_id":"TICKET_ID","reason":"Fixed in the latest release."}'
  • A ticket_api_reply mindig nyilvános választ küld, soha nem belső megjegyzést. Az íróasztal válaszol, hacsak nem ad meg as_requester: true értéket, amely a kérelmező saját üzeneteként küldi el. Ebben az esetben a felelőst vagy az íróasztal tulajdonosát értesítjük, és nem számít az íróasztal első válaszának.
  • A ticket_api_set_stage egy nyitott jegyet a new, in_progress, waiting_customer vagy resolved szakaszba helyez. A lezárt jegyet elutasítjuk, hacsak nem ad meg reopen: true értéket, amely újra megnyitja az adott szakaszban. Ha azt a szakaszt nevezi meg, amelyben a jegy már van, semmi nem változik.
  • A ticket_api_assign a csapat egy tagjának adja a jegyet az assignee_uid vagy az assignee_email alapján. Ha az aktuális felelőst nevezi meg, semmi nem változik. Ha egynél több csapattagnak van az az e-mail-címe, a hívást -409 kóddal elutasítjuk, és helyette az uid-t adja meg.
  • A ticket_api_close lezárja a jegyet. Az opcionális reason értéket az ügyfél látja. Az újranyitási időn belüli ügyfélválasz visszahozza a jegyet.

Az íróasztal saját listájának olvasása

A get_support_tickets a jegyeket annak a bejelentkezett fióknak adja vissza, amely az íróasztalt birtokolja, és az _id mezővel egy jegyre szűkíthető. Más alakú, mint a ticket_api_* nézet, amelyet a Xudán kívüli hívónak építettünk.

Csomagok és korlátok

A csomag dönti el, mit tehet egy kulcs. Az olvasáshoz (ticket_api_list, ticket_api_get, ticket_api_topics, ticket_api_team) olvasási hozzáférés kell, az íráshoz (ticket_api_submit, ticket_api_reply, ticket_api_set_stage, ticket_api_assign, ticket_api_close) teljes hozzáférés. Az ezt nem tartalmazó csomag -402 kóddal válaszol. Minden csomagnak van percenkénti hívásszáma is, és ezen túl a hívásra -429 a válasz a következő percig. Az előzmények a csomag megőrzési ablakát követik, így az annál régebbi jegy nem olvasható. A csomagok oldalon vannak a számok.

Az új jegy a hónap keretébe számít, mint bármely más úton érkező.

Metódusok

Milyen ez az útmutató?

Utoljára frissítve: 2026. november 20.