Job Router Operations - Get Job

Hizmet:

Communication

API Sürümü:

2023-11-01

Kimliğine göre var olan bir işi alır.

GET {endpoint}/routing/jobs/{jobId}?api-version=2023-11-01

URI Parametreleri

Name	İçinde	Gerekli	Tür	Description
endpoint	path	True	string	İletişim kaynağınızın Uri'si
jobId	path	True	string	İşin kimliği.
api-version	query	True	string	Bu işlem için kullanılacak API sürümü.

Yanıtlar

Name	Tür	Description
200 OK	RouterJob	İstek başarılı oldu. Üst Bilgiler ETag: string Last-Modified: string
Other Status Codes	Azure.Core.Foundations.ErrorResponse	Beklenmeyen bir hata yanıtı. Üst Bilgiler x-ms-error-code: string

Örnekler

Retrieves an existing job by Id

Örnek isteği

HTTP

GET https://contoso.westus.communications.azure.com/routing/jobs/8780b28c-7079-4de1-9143-4d369289e958?api-version=2023-11-01

Örnek yanıt

Durum kodu:

200

{
  "id": "8780b28c-7079-4de1-9143-4d369289e958",
  "channelReference": "1d5896f3-8b54-40be-82d3-910323f5e2af",
  "status": "queued",
  "enqueuedAt": "2021-09-30T23:59:04.5311999+00:00",
  "channelId": "CustomVoiceChannel",
  "classificationPolicyId": null,
  "queueId": "MainQueue",
  "priority": 5,
  "dispositionCode": null,
  "requestedWorkerSelectors": [
    {
      "key": "Sales",
      "labelOperator": "equal",
      "value": true,
      "expiresAfterSeconds": null
    }
  ],
  "attachedWorkerSelectors": [],
  "labels": {},
  "assignments": {},
  "notes": [],
  "matchingMode": {
    "kind": "queueAndMatch"
  },
  "etag": "etag"
}

Tanımlar

Name	Description
Azure.Core.Foundations.Error	Hata nesnesi.
Azure.Core.Foundations.ErrorResponse	Hata ayrıntılarını içeren bir yanıt.
Azure.Core.Foundations.InnerError	Hata hakkında daha ayrıntılı bilgi içeren bir nesne. Microsoft One API yönergelerine göre - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
JobMatchingModeKind	Desteklenen eşleştirme modu türleri için ayırıcılar.
LabelOperator	Etiket değerlerinde desteklenen işlemleri açıklar.
QueueAndMatchMode	İş başarıyla kuyruğa alındıktan sonra çalışan eşleştirme işleminin otomatik olarak başlatıldığı eşleştirme modunu açıklar.
RouterJob	Yönlendirilecek bir çalışma birimi
RouterJobAssignment	Bir işin çalışana atama ayrıntıları.
RouterJobNote	İşe eklenmiş bir not.
RouterJobStatus	Bir işin çeşitli durumunu açıklar.
RouterWorkerSelector	Çalışan seçimi için bir etiket kümesine karşı karşı karşılanması gereken bir koşulu açıklar.
RouterWorkerSelectorStatus	Çalışan seçicinin durumunu açıklar.
ScheduleAndSuspendMode	gelecekteki bir zamanda kuyruğa alınacak işleri zamanlamak için kullanılan eşleştirme modunu açıklar. Belirtilen zamanda, çalışanla bir iş eşleştirme otomatik olarak başlatılmaz.
SuspendMode	Çalışanı bir işle eşleştirmenin askıya alındığı eşleştirme modunu açıklar.

Azure.Core.Foundations.Error

Hata nesnesi.

Name	Tür	Description
code	string	Sunucu tanımlı hata kodları kümesinden biri.
details	Azure.Core.Foundations.Error[]	Bu bildirilen hataya yol açan belirli hatalarla ilgili bir dizi ayrıntı.
innererror	Azure.Core.Foundations.InnerError	Hatayla ilgili geçerli nesneden daha belirli bilgiler içeren bir nesne.
message	string	Hatanın insanlar tarafından okunabilir bir gösterimi.
target	string	Hatanın hedefi.

Azure.Core.Foundations.ErrorResponse

Hata ayrıntılarını içeren bir yanıt.

Name	Tür	Description
error	Azure.Core.Foundations.Error	Hata nesnesi.

Azure.Core.Foundations.InnerError

Hata hakkında daha ayrıntılı bilgi içeren bir nesne. Microsoft One API yönergelerine göre - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Name	Tür	Description
code	string	Sunucu tanımlı hata kodları kümesinden biri.
innererror	Azure.Core.Foundations.InnerError	İç hata.

JobMatchingModeKind

Desteklenen eşleştirme modu türleri için ayırıcılar.

Name	Tür	Description
queueAndMatch	string	QueueAndMatchMode için ayrımcı değer.
scheduleAndSuspend	string	ScheduleAndSuspendMode için ayırıcı değer.
suspend	string	SuspendMode için ayrımcı değer.

LabelOperator

Etiket değerlerinde desteklenen işlemleri açıklar.

Name	Tür	Description
equal	string	Eşit.
greaterThan	string	Büyüktür.
greaterThanOrEqual	string	Büyüktür veya eşittir.
lessThan	string	Küçüktür.
lessThanOrEqual	string	Küçük veya eşit.
notEqual	string	Eşit değil.

QueueAndMatchMode

İş başarıyla kuyruğa alındıktan sonra çalışan eşleştirme işleminin otomatik olarak başlatıldığı eşleştirme modunu açıklar.

Name	Tür	Description
kind	string: queueAndMatch	JobMatchingMode'un alt türünü açıklayan tür ayrıştırıcısı.

RouterJob

Yönlendirilecek bir çalışma birimi

Name	Tür	Description
assignments	<string,  RouterJobAssignment>	İşin atamaları koleksiyonu. Anahtar, AssignmentId değeridir.
attachedWorkerSelectors	RouterWorkerSelector[]	Bir sınıflandırma ilkesi tarafından eklenen ve bir çalışanın bu işi işlemek için karşılaması gereken çalışan seçicileri koleksiyonu.
channelId	string	Kanal tanımlayıcısı. Örneğin. ses, sohbet vb.
channelReference	string	Dış üst bağlama başvuru, örneğin. arama kimliği.
classificationPolicyId	string	Bu işi sınıflandırmak için kullanılan sınıflandırma ilkesinin kimliği.
dispositionCode	string	İptal edilen veya kapatılan işler için neden kodu.
enqueuedAt	string	Bir işin UTC'de kuyruğa alındığı zaman damgası.
etag	string	Bu kaynağın varlık etiketi.
id	string	İşin kimliği.
labels		Kural altyapıları tarafından karar almak için kullanılan öznitelikleri tanımlayan bir dizi anahtar/değer çifti. Değerler ilkel değerler olmalıdır: sayı, dize, boole.
matchingMode	JobMatchingMode: QueueAndMatchMode ScheduleAndSuspendMode SuspendMode	Sağlanırsa, iş eşleştirmenin nasıl gerçekleştirileceğini belirler. Varsayılan mod: QueueAndMatchMode.
notes	RouterJobNote[]	Bir işe eklenmiş, zaman damgasına göre sıralanmış notlar.
priority	integer	Bu işin önceliği. Değer -100 ile 100 arasında olmalıdır.
queueId	string	Bu işin kuyruğa alındığını bir kuyruğun kimliği.
requestedWorkerSelectors	RouterWorkerSelector[]	Bu işi işlemek için bir çalışanın karşılaması gereken, el ile belirtilen çalışan seçicileri koleksiyonu.
scheduledAt	string	Ayarlanırsa, iş belirli bir zamanda sıralanacak şekilde zamanlanır.
status	RouterJobStatus	İşin durumu.
tags		Bu işe eklenmiş, tanımlayıcı olmayan öznitelik kümesi. Değerler ilkel değerler olmalıdır: sayı, dize, boole.

RouterJobAssignment

Bir işin çalışana atama ayrıntıları.

Name	Tür	Description
assignedAt	string	İşin UTC'de bir çalışana atandığı zaman damgası.
assignmentId	string	İş atamasının kimliği.
closedAt	string	UTC'de tamamlandıktan sonra işin kapalı olarak işaretlendiği zaman damgası.
completedAt	string	UTC'de atandıktan sonra işin tamamlandı olarak işaretlendiği zaman damgası.
workerId	string	İşe atanan Çalışanın kimliği.

RouterJobNote

İşe eklenmiş bir not.

Name	Tür	Description
addedAt	string	Notunun UTC olarak eklendiği saat. Sağlanmadıysa, varsayılan olarak geçerli saate ayarlanır.
message	string	Notta yer alan ileti.

RouterJobStatus

Bir işin çeşitli durumunu açıklar.

Name	Tür	Description
assigned	string	İş bir çalışana atandı.
cancelled	string	İş iptal edildi.
classificationFailed	string	Sınıflandırma işlemi iş için başarısız oldu.
closed	string	İş bir çalışan tarafından kapatıldı.
completed	string	İş bir çalışan tarafından tamamlandı.
created	string	İş oluşturuldu.
pendingClassification	string	İş sınıflandırılmayı bekliyor.
pendingSchedule	string	İş oluşturuldu ancak henüz zamanlanmadı.
queued	string	İş sıraya alındı.
scheduleFailed	string	İş zamanlaması başarısız oldu.
scheduled	string	İş başarıyla zamanlandı.
waitingForActivation	string	İş askıya alınmış durumda ve güncelleştirme bekliyor.

RouterWorkerSelector

Çalışan seçimi için bir etiket kümesine karşı karşı karşılanması gereken bir koşulu açıklar.

Name	Tür	Description
expedite	boolean	Bu seçici etkin olduğu sürece bir işi kuyruğun önüne gönderir.
expiresAfterSeconds	number	Bu etiket seçicinin ne kadar süreyle geçerli olduğunu saniyeler içinde açıklar.
expiresAt	string	Bu çalışan seçicinin süresinin UTC olarak doldığı saat.
key	string	Sorgu için etiket anahtarı.
labelOperator	LabelOperator	Etiketin değerinin çalışan seçicide tanımlanan değerle karşılaştırılmasını açıklar.
status	RouterWorkerSelectorStatus	Çalışan seçicinin durumu.
value		Verilen işleçle gerçek etiket değeriyle karşılaştıracak değer. Değerler ilkel değerler olmalıdır: sayı, dize, boole.

RouterWorkerSelectorStatus

Çalışan seçicinin durumunu açıklar.

Name	Tür	Description
active	string	Çalışan seçici geçerli.
expired	string	Çalışan seçici geçerli değil.

ScheduleAndSuspendMode

gelecekteki bir zamanda kuyruğa alınacak işleri zamanlamak için kullanılan eşleştirme modunu açıklar. Belirtilen zamanda, çalışanla bir iş eşleştirme otomatik olarak başlatılmaz.

Name	Tür	Description
kind	string: scheduleAndSuspend	JobMatchingMode'un alt türünü açıklayan tür ayrıştırıcısı.
scheduleAt	string	İstenen zamanlama süresi.

SuspendMode

Çalışanı bir işle eşleştirmenin askıya alındığı eşleştirme modunu açıklar.

Name	Tür	Description
kind	string: suspend	JobMatchingMode'un alt türünü açıklayan tür ayrıştırıcısı.