Ärenden
Delad inkorg, formulär och automatiseringar för kundförfrågningar.
Ärende-API:et låter programvara utanför Xuda arbeta med ett skrivbord: öppna ett ärende, lista och läsa ärenden, svara, tilldela, flytta ett ärende mellan faser och stänga det, och läsa ämnena och teamet. Formulär, arbetsflöden, AI-agenter, interna anteckningar och inställningar finns kvar i dashboarden.
Varje anrop är ett POST till https://xuda.ai/cpi/<method> med en JSON-body som bär din kontos API-nyckel som api_key. Ett anrop arbetar på skrivbordet för det konto som äger nyckeln, under det skrivbordets plan, och kan inte ange ett annat skrivbord. Skapa nyckeln i dashboarden under Utvecklare och håll den borta från sidor och publik kod.
Svaret är { "code": ..., "data": ... }. Ett positivt code är lyckat. Ett nekande är en negativ kod med en mening i data.
name och details är obligatoriska. En kontakt skapas eller återanvänds utifrån email, ärendet registreras med källan api, och svaret är en smal vy: nummer, id, status, fas, ämnesrad, ämne, den som ber om hjälp, den ansvariges id och tidsstämplarna. Interna id:n och automatiseringstillstånd returneras aldrig.
email är valfri när en integration eller en agent registrerar ärendet åt sig själv: skicka bara ett name, så skapas ingen kontakt och ingenting skickas till den som ber om hjälp.
Valfria fält ger ärendet en subject, phone, company, ett topic_id och subtopic_id från skrivbordets ämnen, ditt eget reference_id, en priority från 1 (högst) till 4, en type (issue, bug, feature eller task) och attachments.
För att ge det nya ärendet till någon anger du dem med assignee_uid eller assignee_email, ett av de två. De måste vara med i skrivbordets arbetsyteteam, vilket är dess ägare och de accepterade medlemmarna i arbetsytan. En nekad ansvarig ger inget registrerat ärende.
Hitta och läsa ärenden
ticket_api_list listar ärenden med de filter som dashboarden har: status (open eller closed), source, topic_id, type, assignee_uid, reference_id, en fritext-search över ämnesrad, detaljer och ärendenummer, och ett intervall med created_from och created_to. Sortera med sort (date_created_ts, last_activity_ts, status_ts eller priority) och dir, och bläddra med limit (upp till 500) och bookmark från föregående svar.
ticket_api_get läser ett ärende med ticket_id, med dess publika interaktioner. Interna anteckningar och AI-utkast returneras aldrig.
ticket_api_topics returnerar skrivbordets ämnen och underämnen, så att ditt eget formulär kan visa samma väljare som det värdade formuläret. ticket_api_team returnerar de personer som ett ärende kan tilldelas, var och en med ett uid, ett namn och en e-postadress.
ticket_api_replyskickar alltid ett publikt svar, aldrig en intern anteckning. Det är skrivbordet som svarar, om du inte angeras_requester: true, vilket skickar det som den som ber om hjälps eget meddelande. I så fall får den ansvarige, eller skrivbordets ägare, en avisering, och det räknas inte som skrivbordets första svar.ticket_api_set_stageflyttar ett öppet ärende tillnew,in_progress,waiting_customerellerresolved. Ett stängt ärende nekas om du inte angerreopen: true, vilket öppnar det igen i den fasen. Att ange den fas som ärendet redan har ändrar ingenting.ticket_api_assignger ett ärende till en person i teamet medassignee_uidellerassignee_email. Att ange den nuvarande ansvariga ändrar ingenting. Om fler än en teammedlem har den e-postadressen nekas anropet med-409och du anger uid i stället.ticket_api_closestänger ärendet. Det valfriareasonvisas för kunden. Ett kundsvar inom återöppningsfönstret för tillbaka ärendet.
Läs skrivbordets egen lista
get_support_tickets läser tillbaka ärenden till det inloggade konto som äger skrivbordet, och kan begränsas till ett ärende med _id. Den har en annan form än vyn ticket_api_*, som är byggd för en anropare utanför Xuda.
Planer och gränser
Planen avgör vad en nyckel får göra. Att läsa (ticket_api_list, ticket_api_get, ticket_api_topics, ticket_api_team) kräver läsåtkomst, och att skriva (ticket_api_submit, ticket_api_reply, ticket_api_set_stage, ticket_api_assign, ticket_api_close) kräver full åtkomst. En plan utan den svarar -402. Varje plan har också ett antal anrop per minut, och över det besvaras ett anrop med -429 till nästa minut. Historiken följer planens lagringstid, så ett ärende som är äldre än den kan inte läsas. Sidan om planer har siffrorna.
Ett nytt ärende räknas mot månadens kvot, som från varje annan väg in.