Αιτήματα
Κοινόχρηστα εισερχόμενα, φόρμες και αυτοματισμοί για αιτήματα πελατών.
Το API αιτημάτων επιτρέπει σε λογισμικό εκτός Xuda να δουλέψει ένα γραφείο: να ανοίξει ένα αίτημα, να απαριθμήσει και να διαβάσει αιτήματα, να απαντήσει, να αναθέσει, να μετακινήσει ένα αίτημα ανάμεσα σε στάδια και να το κλείσει, και να διαβάσει τα θέματα και την ομάδα. Οι φόρμες, οι ροές εργασίας, οι πράκτορες AI, οι εσωτερικές σημειώσεις και οι ρυθμίσεις παραμένουν στον πίνακα ελέγχου.
Κάθε κλήση είναι ένα POST στο https://xuda.ai/cpi/<method> με σώμα JSON που φέρει το κλειδί API του λογαριασμού σας ως api_key. Μια κλήση δουλεύει στο γραφείο του λογαριασμού που κατέχει το κλειδί, με το πλάνο αυτού του γραφείου, και δεν μπορεί να ονομάσει άλλο γραφείο. Δημιουργήστε το κλειδί στον πίνακα ελέγχου στους Προγραμματιστές, και κρατήστε το έξω από σελίδες και δημόσιο κώδικα.
Η απάντηση είναι { "code": ..., "data": ... }. Ένας θετικός code σημαίνει επιτυχία. Μια απόρριψη είναι ένας αρνητικός κωδικός με μια πρόταση στο data.
Τα name και details είναι υποχρεωτικά. Μια επαφή δημιουργείται ή επαναχρησιμοποιείται από το email, το αίτημα καταχωρίζεται με πηγή api, και η απάντηση είναι μια περιορισμένη όψη: αριθμός, id, κατάσταση, στάδιο, θέμα (subject), θέμα (topic), αιτών, το id του υπεύθυνου και οι χρονοσημάνσεις. Εσωτερικά id και η κατάσταση αυτοματισμών δεν επιστρέφονται ποτέ.
Το email είναι προαιρετικό όταν μια ενσωμάτωση ή ένας πράκτορας καταχωρίζει το αίτημα για τον εαυτό του: στείλτε μόνο ένα name, και δεν δημιουργείται επαφή και δεν αποστέλλεται τίποτα στον αιτούντα.
Τα προαιρετικά πεδία δίνουν στο αίτημα ένα subject, phone, company, ένα topic_id και subtopic_id από τα θέματα του γραφείου, το δικό σας reference_id, μια priority από 1 (η υψηλότερη) έως 4, έναν type (issue, bug, feature ή task) και attachments.
Για να αναθέσετε το νέο αίτημα σε κάποιον, ονομάστε τον με assignee_uid ή assignee_email, ένα από τα δύο. Πρέπει να ανήκει στην ομάδα του χώρου εργασίας του γραφείου, δηλαδή στον κάτοχό του και στα αποδεκτά μέλη του χώρου εργασίας. Ένας υπεύθυνος που απορρίπτεται δεν καταχωρίζει κανένα αίτημα.
Βρείτε και διαβάστε αιτήματα
Η ticket_api_list απαριθμεί αιτήματα με τα φίλτρα που έχει ο πίνακας ελέγχου: status (open ή closed), source, topic_id, type, assignee_uid, reference_id, μια αναζήτηση ελεύθερου κειμένου search στο θέμα, τις λεπτομέρειες και τον αριθμό του αιτήματος, και ένα εύρος created_from και created_to. Ταξινομήστε με το sort (date_created_ts, last_activity_ts, status_ts ή priority) και το dir, και σελιδοποιήστε με το limit (έως 500) και το bookmark από την προηγούμενη απάντηση.
Η ticket_api_get διαβάζει ένα αίτημα με το ticket_id, με τις δημόσιες αλληλεπιδράσεις του. Οι εσωτερικές σημειώσεις και τα προσχέδια AI δεν επιστρέφονται ποτέ.
Η ticket_api_topics επιστρέφει τα θέματα και τα υποθέματα του γραφείου, ώστε η δική σας φόρμα να δείχνει τον ίδιο επιλογέα με τη φιλοξενούμενη φόρμα. Η ticket_api_team επιστρέφει τα άτομα στα οποία μπορεί να ανατεθεί ένα αίτημα, το καθένα με uid, όνομα και email.
- Η
ticket_api_replyδημοσιεύει πάντα δημόσια απάντηση, ποτέ εσωτερική σημείωση. Είναι το γραφείο που απαντά, εκτός αν περάσετεas_requester: true, που τη δημοσιεύει ως δικό μήνυμα του αιτούντος. Σε αυτή την περίπτωση ειδοποιείται ο υπεύθυνος, ή ο κάτοχος του γραφείου, και δεν προσμετράται ως η πρώτη απάντηση του γραφείου. - Η
ticket_api_set_stageμετακινεί ένα ανοιχτό αίτημα σεnew,in_progress,waiting_customerήresolved. Ένα κλειστό αίτημα απορρίπτεται εκτός αν περάσετεreopen: true, που το ανοίγει ξανά σε αυτό το στάδιο. Η αναφορά του σταδίου που ήδη έχει το αίτημα δεν αλλάζει τίποτα. - Η
ticket_api_assignδίνει ένα αίτημα σε ένα άτομο της ομάδας μεassignee_uidήassignee_email. Η αναφορά του τρέχοντος υπεύθυνου δεν αλλάζει τίποτα. Αν περισσότερα από ένα μέλη της ομάδας έχουν αυτό το email, η κλήση απορρίπτεται με-409και περνάτε το uid αντί γι' αυτό. - Η
ticket_api_closeκλείνει το αίτημα. Ο προαιρετικός λόγοςreasonεμφανίζεται στον πελάτη. Μια απάντηση του πελάτη μέσα στο παράθυρο επαναφοράς φέρνει το αίτημα πίσω.
Διαβάστε τη δική σας λίστα του γραφείου
Η get_support_tickets διαβάζει αιτήματα προς τον συνδεδεμένο λογαριασμό που κατέχει το γραφείο, και μπορεί να περιοριστεί σε ένα αίτημα με το _id. Έχει διαφορετική μορφή από την όψη ticket_api_*, που είναι φτιαγμένη για καλούντα εκτός Xuda.
Πλάνα και όρια
Το πλάνο αποφασίζει τι μπορεί να κάνει ένα κλειδί. Η ανάγνωση (ticket_api_list, ticket_api_get, ticket_api_topics, ticket_api_team) απαιτεί πρόσβαση ανάγνωσης, και η εγγραφή (ticket_api_submit, ticket_api_reply, ticket_api_set_stage, ticket_api_assign, ticket_api_close) απαιτεί πλήρη πρόσβαση. Ένα πλάνο χωρίς αυτήν απαντά -402. Κάθε πλάνο έχει επίσης έναν αριθμό κλήσεων το λεπτό, και πέρα από αυτόν μια κλήση απαντάται με -429 μέχρι το επόμενο λεπτό. Το ιστορικό ακολουθεί το παράθυρο διατήρησης του πλάνου, οπότε ένα αίτημα παλαιότερο από αυτό δεν μπορεί να διαβαστεί. Η σελίδα πλάνων έχει τα νούμερα.
Ένα νέο αίτημα προσμετράται στο όριο του μήνα, όπως από οποιονδήποτε άλλο τρόπο εισόδου.