Tukipyynnöt
Jaettu saapuneet-kansio, lomakkeet ja automaatiot asiakaspyynnöille.
Tiketti-API antaa Xudan ulkopuolisen ohjelmiston hoitaa työpöytää: avata tiketin, listata ja lukea tikettejä, vastata, osoittaa, siirtää tiketin vaiheiden välillä ja sulkea sen sekä lukea aiheet ja tiimin. Lomakkeet, työnkulut, tekoälyagentit, sisäiset muistiinpanot ja asetukset pysyvät kojelaudassa.
Jokainen kutsu on POST osoitteeseen https://xuda.ai/cpi/<method> JSON-rungolla, joka sisältää tilisi API-avaimen kentässä api_key. Kutsu toimii avaimen omistavan tilin työpöydällä sen paketin mukaisesti, eikä se voi nimetä toista työpöytää. Luo avain kojelaudassa kohdassa Developers ja pidä se poissa sivuilta ja julkisesta koodista.
Vastaus on { "code": ..., "data": ... }. Positiivinen code on onnistuminen. Kieltäytyminen on negatiivinen koodi, ja data sisältää lauseen.
name ja details ovat pakollisia. Yhteystieto luodaan tai käytetään uudelleen email-kentän perusteella, tiketti kirjataan lähteellä api, ja vastaus on suppea näkymä: numero, tunnus, tila, vaihe, otsikko, aihe, pyytäjä, vastuuhenkilön tunnus ja aikaleimat. Sisäisiä tunnuksia ja automaation tilaa ei koskaan palauteta.
email on valinnainen, kun integraatio tai agentti kirjaa tiketin itselleen: lähetä vain name, jolloin yhteystietoa ei luoda eikä pyytäjälle lähetetä mitään sähköpostia.
Valinnaiset kentät antavat tiketille subject-otsikon, phone, company, työpöydän aiheista topic_id ja subtopic_id, oman reference_id:si, priority-arvon väliltä 1 (korkein) - 4, type-arvon (issue, bug, feature tai task) ja attachments.
Antaaksesi uuden tiketin jollekulle nimeä hänet kentällä assignee_uid tai assignee_email, jompikumpi. Hänen täytyy kuulua työpöydän työtilan tiimiin, eli sen omistajaan ja työtilan hyväksyttyihin jäseniin. Evätty vastuuhenkilö ei kirjaa tikettiä.
Etsi ja lue tikettejä
ticket_api_list listaa tikettejä samoilla suodattimilla kuin kojelaudassa: status (open tai closed), source, topic_id, type, assignee_uid, reference_id, vapaatekstinen search otsikosta, tiedoista ja tikettinumerosta sekä created_from- ja created_to-väli. Lajittele kentällä sort (date_created_ts, last_activity_ts, status_ts tai priority) ja dir, ja sivuta kentillä limit (enintään 500) ja edellisen vastauksen bookmark.
ticket_api_get lukee yhden tiketin kentällä ticket_id julkisine vuorovaikutuksineen. Sisäisiä muistiinpanoja ja tekoälyn luonnoksia ei koskaan palauteta.
ticket_api_topics palauttaa työpöydän aiheet ja alaaiheet, jotta oma lomakkeesi voi näyttää saman valitsimen kuin isännöity lomake. ticket_api_team palauttaa ihmiset, joille tiketin voi osoittaa, kukin uid-tunnuksen, nimen ja sähköpostin kanssa.
ticket_api_replyjulkaisee aina julkisen vastauksen, ei koskaan sisäistä muistiinpanoa. Se on työpöydän vastaus, ellet annaas_requester: true, jolloin se julkaistaan pyytäjän omana viestinä. Siinä tapauksessa vastuuhenkilölle tai työpöydän omistajalle ilmoitetaan, eikä se lasketa työpöydän ensimmäiseksi vastaukseksi.ticket_api_set_stagesiirtää avoimen tiketin vaiheeseennew,in_progress,waiting_customertairesolved. Suljettu tiketti evätään, ellet annareopen: true, joka avaa sen uudelleen siinä vaiheessa. Tiketin nykyisen vaiheen nimeäminen ei muuta mitään.ticket_api_assignantaa tiketin tiimin jäsenelle kentälläassignee_uidtaiassignee_email. Nykyisen vastuuhenkilön nimeäminen ei muuta mitään. Jos useammalla kuin yhdellä tiimin jäsenellä on kyseinen sähköposti, kutsu evätään koodilla-409ja anna uid sen sijaan.ticket_api_closesulkee tiketin. Valinnainenreasonnäytetään asiakkaalle. Asiakkaan vastaus uudelleenavausikkunan sisällä palauttaa tiketin.
Lue työpöydän oma lista
get_support_tickets lukee tiketit takaisin kirjautuneelle tilille, joka omistaa työpöydän, ja sen voi rajata yhteen tikettiin kentällä _id. Sen muoto on eri kuin ticket_api_*-näkymän, joka on tehty Xudan ulkopuoliselle kutsujalle.
Paketit ja rajat
Paketti päättää, mitä avain saa tehdä. Lukeminen (ticket_api_list, ticket_api_get, ticket_api_topics, ticket_api_team) vaatii lukuoikeuden ja kirjoittaminen (ticket_api_submit, ticket_api_reply, ticket_api_set_stage, ticket_api_assign, ticket_api_close) täyden pääsyn. Paketti ilman sitä vastaa -402. Jokaisella paketilla on myös kutsumäärä minuutissa, ja sen ylittyessä kutsuun vastataan -429 seuraavaan minuuttiin asti. Historia seuraa paketin säilytysaikaa, joten sitä vanhempaa tikettiä ei voi lukea. Pakettien sivulla on luvut.
Uusi tiketti lasketaan kuukauden kiintiöön, kuten mistä tahansa muusta tulotavasta.