Talepler
Müşteri talepleri için ortak gelen kutusu, formlar ve otomasyonlar.
Talep API'si, Xuda dışındaki yazılımların bir masayı işletmesini sağlar: bir talep açmak, talepleri listelemek ve okumak, yanıtlamak, atamak, bir talebi aşamalar arasında taşımak ve kapatmak, ayrıca konuları ve ekibi okumak. Formlar, iş akışları, AI ajanları, dahili notlar ve ayarlar dashboard'da kalır.
Her çağrı, hesap API anahtarınızı api_key olarak taşıyan bir JSON gövdesiyle https://xuda.ai/cpi/<method> adresine yapılan bir POST isteğidir. Bir çağrı, anahtarın sahibi hesabın masasında, o masanın planı altında çalışır ve başka bir masayı adlandıramaz. Anahtarı dashboard'da Geliştiriciler altında oluşturun ve sayfalardan ve herkese açık koddan uzak tutun.
Yanıt { "code": ..., "data": ... } biçimindedir. Pozitif bir code başarıdır. Bir ret, data içinde bir cümle bulunan negatif bir koddur.
name ve details zorunludur. email ile bir kişi oluşturulur ya da yeniden kullanılır, talep api kaynağıyla açılır ve yanıt dar bir görünümdür: numara, kimlik, durum, aşama, konu başlığı, konu, talep eden, atanan kişinin kimliği ve zaman damgaları. Dahili kimlikler ve otomasyon durumu asla döndürülmez.
Bir entegrasyon ya da bir ajan talebi kendisi için açtığında email isteğe bağlıdır: yalnızca bir name gönderin; kişi oluşturulmaz ve talep edene hiçbir şey postalanmaz.
İsteğe bağlı alanlar talebe bir subject, phone, company, masanın konularından bir topic_id ve subtopic_id, kendi reference_id değerinizi, 1 (en yüksek) ile 4 arasında bir priority, bir type (issue, bug, feature ya da task) ve attachments verir.
Yeni talebi birine vermek için onu assignee_uid ya da assignee_email ile, ikisinden biriyle belirtin. Kişi masanın çalışma alanı ekibinde olmalıdır; bu, sahibi ve çalışma alanının kabul edilmiş üyeleridir. Reddedilen bir atanan kişi talep açmaz.
Talepleri bulun ve okuyun
ticket_api_list, dashboard'daki süzgeçlerle talepleri listeler: status (open ya da closed), source, topic_id, type, assignee_uid, reference_id, konu başlığı, ayrıntılar ve talep numarası üzerinde serbest metin search ve bir created_from ile created_to aralığı. sort (date_created_ts, last_activity_ts, status_ts ya da priority) ve dir ile sıralayın, limit (500'e kadar) ve önceki yanıttaki bookmark ile sayfalayın.
ticket_api_get, bir talebi ticket_id ile, herkese açık etkileşimleriyle okur. Dahili notlar ve AI taslakları asla döndürülmez.
ticket_api_topics masanın konularını ve alt konularını döndürür; böylece kendi formunuz, barındırılan formun gösterdiği seçiciyle aynısını gösterebilir. ticket_api_team, bir talebin atanabileceği kişileri, her biri bir uid, bir ad ve bir e-postayla döndürür.
ticket_api_replyher zaman herkese açık bir yanıt gönderir, asla dahili bir not değil.as_requester: truevermediğiniz sürece bu masanın yanıtıdır; verirseniz talep edenin kendi mesajı olarak gönderilir. Bu durumda atanan kişiye ya da masanın sahibine bildirim gider ve masanın ilk yanıtı sayılmaz.ticket_api_set_stage, açık bir talebinew,in_progress,waiting_customerya daresolvedaşamasına taşır. Kapalı bir talep, onu o aşamada yeniden açanreopen: truevermedikçe reddedilir. Talebin zaten bulunduğu aşamayı belirtmek hiçbir şeyi değiştirmez.ticket_api_assign, bir talebi ekipteki bir kişiyeassignee_uidya daassignee_emailile verir. Mevcut atanan kişiyi belirtmek hiçbir şeyi değiştirmez. Birden fazla ekip üyesinin e-postası aynıysa çağrı-409ile reddedilir ve bunun yerine uid verirsiniz.ticket_api_closetalebi kapatır. İsteğe bağlıreason, müşteriye gösterilir. Yeniden açma süresi içindeki bir müşteri yanıtı talebi geri getirir.
Masanın kendi listesini okuyun
get_support_tickets, talepleri masanın sahibi, oturum açmış hesaba geri okur ve _id ile tek bir talebe sınırlanabilir. Xuda dışındaki bir çağıran için oluşturulmuş ticket_api_* görünümünden farklı bir biçimdir.
Planlar ve sınırlar
Bir anahtarın neler yapabileceğini plan belirler. Okuma (ticket_api_list, ticket_api_get, ticket_api_topics, ticket_api_team) okuma erişimi, yazma (ticket_api_submit, ticket_api_reply, ticket_api_set_stage, ticket_api_assign, ticket_api_close) tam erişim gerektirir. Buna sahip olmayan bir plan -402 yanıtlar. Her planın ayrıca dakikada bir çağrı sayısı vardır ve bunu aşan bir çağrı bir sonraki dakikaya kadar -429 ile yanıtlanır. Geçmiş, planın saklama süresini izler; bu yüzden ondan eski bir talep okunamaz. Rakamlar planlar sayfasındadır.
Yeni bir talep, başka herhangi bir yoldan gelenler gibi, ayın kotasına karşı sayılır.