Saker
Delt innboks, skjemaer og automatiseringer for kundehenvendelser.
Sak-API-et lar programvare utenfor Xuda jobbe på et skrivebord: åpne en sak, liste og lese saker, svare, tildele, flytte en sak mellom faser og lukke den, og lese emnene og teamet. Skjemaer, arbeidsflyter, AI-agenter, interne notater og innstillingene blir i dashbordet.
Hvert kall er en POST til https://xuda.ai/cpi/<method> med en JSON-kropp som har API-nøkkelen til kontoen din som api_key. Et kall virker på skrivebordet til kontoen som eier nøkkelen, under planen til det skrivebordet, og kan ikke nevne et annet skrivebord. Lag nøkkelen i dashbordet under Developers, og hold den unna sider og offentlig kode.
Svaret er { "code": ..., "data": ... }. En positiv code er suksess. En avvisning er en negativ kode med en setning i data.
name og details er påkrevd. En kontakt opprettes eller gjenbrukes ut fra email, saken registreres med kilden api, og svaret er en smal visning: nummer, id, status, fase, emne, tema, den som sendte, ansvarliges id og tidsstemplene. Interne id-er og automatiseringstilstand returneres aldri.
email er valgfri når en integrasjon eller en agent registrerer saken for seg selv: send bare et name, så lages ingen kontakt og ingenting sendes til den som sendte.
Valgfrie felt gir saken et subject, phone, company, en topic_id og subtopic_id fra skrivebordets emner, din egen reference_id, en priority fra 1 (høyest) til 4, en type (issue, bug, feature eller task) og attachments.
For å gi den nye saken til noen, nevn dem med assignee_uid eller assignee_email, en av de to. De må være i arbeidsområdeteamet til skrivebordet, som er eieren og de godkjente medlemmene av arbeidsområdet. En avvist ansvarlig registrerer ingen sak.
Finn og les saker
ticket_api_list lister saker med filtrene dashbordet har: status (open eller closed), source, topic_id, type, assignee_uid, reference_id, et fritekst-search over emne, detaljer og saksnummer, og et område med created_from og created_to. Sorter med sort (date_created_ts, last_activity_ts, status_ts eller priority) og dir, og bla med limit (opptil 500) og bookmark fra forrige svar.
ticket_api_get leser én sak etter ticket_id, med de offentlige hendelsene. Interne notater og AI-utkast returneres aldri.
ticket_api_topics returnerer skrivebordets emner og underemner, så ditt eget skjema kan vise den samme velgeren som det vertsbaserte skjemaet. ticket_api_team returnerer folkene en sak kan tildeles, hver med en uid, et navn og en e-postadresse.
ticket_api_replylegger alltid ut et offentlig svar, aldri et internt notat. Det er skrivebordet som svarer, med mindre du senderas_requester: true, som legger det ut som avsenderens egen melding. I så fall får den ansvarlige, eller skrivebordets eier, et varsel, og det teller ikke som skrivebordets første svar.ticket_api_set_stageflytter en åpen sak tilnew,in_progress,waiting_customerellerresolved. En lukket sak blir avvist med mindre du senderreopen: true, som åpner den igjen i den fasen. Å nevne fasen saken allerede har, endrer ingenting.ticket_api_assigngir en sak til en person i teamet medassignee_uidellerassignee_email. Å nevne den nåværende ansvarlige endrer ingenting. Hvis mer enn ett teammedlem har den e-postadressen, blir kallet avvist med-409, og du sender uid i stedet.ticket_api_closelukker saken. Den valgfriereasonvises for kunden. Et svar fra kunden innenfor gjenåpningsvinduet henter saken tilbake.
Les skrivebordets egen liste
get_support_tickets leser saker tilbake til den innloggede kontoen som eier skrivebordet, og kan begrenses til én sak med _id. Den har en annen form enn ticket_api_*-visningen, som er bygget for en som ringer utenfra Xuda.
Planer og grenser
Planen bestemmer hva en nøkkel kan gjøre. Lesing (ticket_api_list, ticket_api_get, ticket_api_topics, ticket_api_team) krever lesetilgang, og skriving (ticket_api_submit, ticket_api_reply, ticket_api_set_stage, ticket_api_assign, ticket_api_close) krever full tilgang. En plan uten det svarer -402. Hver plan har også et antall kall per minutt, og over det blir et kall besvart med -429 til neste minutt. Historikken følger planens oppbevaringsvindu, så en sak som er eldre enn det, kan ikke leses. Siden om planer har tallene.
En ny sak teller mot månedens kvote, som fra enhver annen vei inn.