Sager
Delt indbakke, formularer og automatiseringer til kundehenvendelser.
Sags-API'et lader software uden for Xuda arbejde et skrivebord: åbne en sag, liste og læse sager, svare, tildele, flytte en sag mellem faser og lukke den, og læse emnerne og teamet. Formularer, workflows, AI-agenter, interne noter og indstillingerne bliver i dashboardet.
Hvert kald er et POST til https://xuda.ai/cpi/<method> med en JSON-body, der har din kontos API-nøgle som api_key. Et kald virker på skrivebordet for den konto, der ejer nøglen, under skrivebordets plan, og kan ikke nævne et andet skrivebord. Opret nøglen i dashboardet under Developers, og hold den ude af sider og offentlig kode.
Svaret er { "code": ..., "data": ... }. En positiv code er succes. En afvisning er en negativ kode med en sætning i data.
name og details er påkrævede. En kontakt oprettes eller genbruges ud fra email, sagen oprettes med kilden api, og svaret er en snæver visning: nummer, id, status, fase, emnelinje, emne, den, der spørger, den ansvarliges id og tidsstemplerne. Interne id'er og automatiseringstilstand returneres aldrig.
email er valgfri, når en integration eller en agent opretter sagen for sig selv: send kun et name, så bliver der ikke lavet nogen kontakt, og intet bliver sendt til den, der spørger.
Valgfrie felter giver sagen et subject, phone, company, et topic_id og subtopic_id fra skrivebordets emner, dit eget reference_id, en priority fra 1 (højeste) til 4, en type (issue, bug, feature eller task) og attachments.
For at give den nye sag til nogen skal du nævne dem med assignee_uid eller assignee_email, en af de to. De skal være på skrivebordets arbejdsområdeteam, som er dets ejer og arbejdsområdets accepterede medlemmer. En afvist ansvarlig giver ingen sag.
Find og læs sager
ticket_api_list lister sager med de filtre, dashboardet har: status (open eller closed), source, topic_id, type, assignee_uid, reference_id, en fri tekst search over emnelinje, detaljer og sagsnummer og et interval med created_from og created_to. Sortér med sort (date_created_ts, last_activity_ts, status_ts eller priority) og dir, og gå gennem siderne med limit (op til 500) og bookmark fra det forrige svar.
ticket_api_get læser én sag ud fra ticket_id, med dens offentlige interaktioner. Interne noter og AI-udkast returneres aldrig.
ticket_api_topics returnerer skrivebordets emner og underemner, så din egen formular kan vise den samme vælger som den hostede formular. ticket_api_team returnerer de folk, en sag kan tildeles, hver med et uid, et navn og en mailadresse.
ticket_api_replyskriver altid et offentligt svar, aldrig en intern note. Det er skrivebordet, der svarer, medmindre du senderas_requester: true, som skriver det som den, der spørger, sin egen besked. I så fald får den ansvarlige, eller skrivebordets ejer, besked, og det tæller ikke som skrivebordets første svar.ticket_api_set_stageflytter en åben sag tilnew,in_progress,waiting_customerellerresolved. En lukket sag bliver afvist, medmindre du senderreopen: true, som åbner den igen i den fase. Hvis du nævner den fase, sagen allerede har, ændres intet.ticket_api_assigngiver en sag til en person på teamet ud fraassignee_uidellerassignee_email. Hvis du nævner den nuværende ansvarlige, ændres intet. Hvis mere end ét teammedlem har den mailadresse, bliver kaldet afvist med-409, og du sender uid'et i stedet.ticket_api_closelukker sagen. Den valgfrireasonvises for kunden. Et svar fra kunden inden for genåbningsvinduet bringer sagen tilbage.
Læs skrivebordets egen liste
get_support_tickets læser sager tilbage til den indloggede konto, der ejer skrivebordet, og kan begrænses til én sag med _id. Den har en anden form end visningen ticket_api_*, som er bygget til en kalder uden for Xuda.
Planer og grænser
Planen afgør, hvad en nøgle må. At læse (ticket_api_list, ticket_api_get, ticket_api_topics, ticket_api_team) kræver læseadgang, og at skrive (ticket_api_submit, ticket_api_reply, ticket_api_set_stage, ticket_api_assign, ticket_api_close) kræver fuld adgang. En plan uden den svarer -402. Hver plan har også et antal kald i minuttet, og ud over det bliver et kald besvaret med -429 til næste minut. Historikken følger planens opbevaringsvindue, så en sag, der er ældre end det, kan ikke læses. Siden planer har tallene.
En ny sag tæller med i månedens kvote, som den gør, uanset hvordan den kommer ind.