This article provides the properties and schema for communication services job router events. For an introduction to event schemas, see Azure Event Grid event schema. These events are emitted for Azure Communication Services throughout the job and worker lifecycles.
Events types
Azure Communication Services emits the following job router event types:
Event responses
When an event is triggered, the Event Grid service sends data about that event to subscribing endpoints.
This section contains an example of what that data would look like for each event.
Microsoft.Communication.RouterJobReceived
Back to Event Catalog
{
"id": "acdf8fa5-8ab4-4a65-874a-c1d2a4a97f2e",
"topic": "/subscriptions/{subscription-id}/resourceGroups/{group-name}/providers/Microsoft.Communication/communicationServices/{communication-services-resource-name}",
"subject": "job/{job-id}/channel/{channel-id}",
"data": {
"jobId": "7f1df17b-570b-4ae5-9cf5-fe6ff64cc712",
"channelReference": "test-abc",
"jobStatus": "PendingClassification",
"channelId": "FooVoiceChannelId",
"classificationPolicyId": "test-policy",
"queueId": "queue-id",
"priority": 0,
"labels": {
"Locale": "en-us",
"Segment": "Enterprise",
"Token": "FooToken"
},
"tags": {
"Locale": "en-us",
"Segment": "Enterprise",
"Token": "FooToken"
},
"requestedWorkerSelectors": [
{
"key": "string",
"labelOperator": "equal",
"value": 5,
"ttlSeconds": 50,
"expirationTime": "2022-02-17T00:58:25.1736293Z"
}
],
"scheduledOn": "3/28/2007 7:13:50 PM +00:00",
"unavailableForMatching": false
},
"eventType": "Microsoft.Communication.RouterJobReceived",
"dataVersion": "1.0",
"metadataVersion": "1",
"eventTime": "2022-02-17T00:55:25.1736293Z"
}
Attribute list
Attribute |
Type |
Nullable |
Description |
Notes |
jobId |
string |
❌ |
|
|
channelReference |
string |
❌ |
|
|
jobStatus |
enum |
❌ |
Possible values PendingClassification, Queued |
When this event is sent out, classification process is yet to have been executed or job was created with an associated queueId. |
channelId |
string |
❌ |
|
|
classificationPolicyId |
string |
✔️ |
|
null when queueId is specified for a job |
queueId |
string |
✔️ |
|
null when classificationPolicyId is specified for a job |
priority |
int |
✔️ |
|
Null when classificationPolicyId is specified. Non-null value in case of direct queue assignment. |
labels |
Dictionary<string, object> |
✔️ |
|
Based on user input |
tags |
Dictionary<string, object> |
✔️ |
|
Based on user input |
requestedWorkerSelectors |
List<WorkerSelector> |
✔️ |
|
Based on user input |
scheduledOn |
DateTimeOffset |
✔️ |
|
Based on user input |
unavailableForMatching |
bool |
✔️ |
|
Based on user input |
Microsoft.Communication.RouterJobClassified
Back to Event Catalog
{
"id": "b6d8687a-5a1a-42ae-b8b5-ff7ec338c872",
"topic": "/subscriptions/{subscription-id}/resourceGroups/{group-name}/providers/Microsoft.Communication/communicationServices/{communication-services-resource-name}",
"subject": "job/{job-id}/channel/{channel-id}/queue/{queue-id}",
"data": {
"queueDetails": {
"id": "625fec06-ab81-4e60-b780-f364ed96ade1",
"name": "Queue 1",
"labels": {
"Language": "en",
"Product": "Office",
"Geo": "NA"
}
},
"jobId": "7f1df17b-570b-4ae5-9cf5-fe6ff64cc712",
"channelReference": "test-abc",
"channelId": "FooVoiceChannelId",
"classificationPolicyId": "test-policy",
"queueId": "625fec06-ab81-4e60-b780-f364ed96ade1",
"priority": 5,
"labels": {
"Locale": "en-us",
"Segment": "Enterprise",
"Token": "FooToken"
},
"tags": {
"Locale": "en-us",
"Segment": "Enterprise",
"Token": "FooToken"
},
"attachedWorkerSelectors": [
{
"key": "string",
"labelOperator": "equal",
"value": 5,
"ttl": "P3Y6M4DT12H30M5S"
}
]
},
"eventType": "Microsoft.Communication.RouterJobClassified",
"dataVersion": "1.0",
"metadataVersion": "1",
"eventTime": "2022-02-17T00:55:25.1736293Z"
}
Attribute list
Attribute |
Type |
Nullable |
Description |
Notes |
queueDetails |
QueueDetails |
❌ |
|
|
jobId |
string |
❌ |
|
|
channelReference |
string |
❌ |
|
|
channelId |
string |
❌ |
|
|
classificationPolicyId |
string |
❌ |
|
|
queueId |
string |
✔️ |
|
null when classificationPolicy is not used for queue selection |
priority |
int |
✔️ |
|
null when classificationPolicy is not used for applying priority on job |
labels |
Dictionary<string, object> |
✔️ |
|
Based on user input |
tags |
Dictionary<string, object> |
✔️ |
|
Based on user input |
attachedWorkerSelectors |
List<WorkerSelector> |
✔️ |
|
List of worker selectors attached by a classification policy |
Microsoft.Communication.RouterJobQueued
Back to Event Catalog
{
"id": "b6d8687a-5a1a-42ae-b8b5-ff7ec338c872",
"topic": "/subscriptions/{subscription-id}/resourceGroups/{group-name}/providers/Microsoft.Communication/communicationServices/{communication-services-resource-name}",
"subject": "job/{job-id}/channel/{channel-id}/queue/{queue-id}",
"data": {
"jobId": "7f1df17b-570b-4ae5-9cf5-fe6ff64cc712",
"channelReference": "test-abc",
"channelId": "FooVoiceChannelId",
"queueId": "625fec06-ab81-4e60-b780-f364ed96ade1",
"priority": 1,
"labels": {
"Locale": "en-us",
"Segment": "Enterprise",
"Token": "FooToken"
},
"tags": {
"Locale": "en-us",
"Segment": "Enterprise",
"Token": "FooToken"
},
"requestedWorkerSelectors": [
{
"key": "string",
"labelOperator": "equal",
"value": 5,
"ttl": "P3Y6M4DT12H30M5S"
}
],
"attachedWorkerSelectors": [
{
"key": "string",
"labelOperator": "equal",
"value": 5,
"ttl": "P3Y6M4DT12H30M5S"
}
]
},
"eventType": "Microsoft.Communication.RouterJobQueued",
"dataVersion": "1.0",
"metadataVersion": "1",
"eventTime": "2022-02-17T00:55:25.1736293Z"
}
Attribute list
Attribute |
Type |
Nullable |
Description |
Notes |
jobId |
string |
❌ |
|
|
channelReference |
string |
✔️ |
|
|
channelId |
string |
❌ |
|
|
queueId |
string |
❌ |
|
|
priority |
int |
❌ |
|
|
labels |
Dictionary<string, object> |
✔️ |
|
Based on user input |
tags |
Dictionary<string, object> |
✔️ |
|
Based on user input |
requestedWorkerSelectors |
List<WorkerSelector> |
✔️ |
|
Based on user input while creating job |
attachedWorkerSelectors |
List<WorkerSelector> |
✔️ |
|
List of worker selectors attached by a classification policy |
Microsoft.Communication.RouterJobClassificationFailed
Back to Event Catalog
{
"id": "b6d8687a-5a1a-42ae-b8b5-ff7ec338c872",
"topic": "/subscriptions/{subscription-id}/resourceGroups/{group-name}/providers/Microsoft.Communication/communicationServices/{communication-services-resource-name}",
"subject": "job/{job-id}/channel/{channel-id}/classificationpolicy/{classificationpolicy-id}",
"data": {
"errors": [
{
"code": null,
"message": "Classification failed due to <reason>",
"target": null,
"innerError": null,
"details": null
}
],
"jobId": "7f1df17b-570b-4ae5-9cf5-fe6ff64cc712",
"channelReference": "test-abc",
"channelId": "FooVoiceChannelId",
"classificationPolicyId": "test-policy",
"labels": {
"Locale": "en-us",
"Segment": "Enterprise",
"Token": "FooToken"
},
"tags": {
"Locale": "en-us",
"Segment": "Enterprise",
"Token": "FooToken"
}
},
"eventType": "Microsoft.Communication.RouterJobClassificationFailed",
"dataVersion": "1.0",
"metadataVersion": "1",
"eventTime": "2022-02-17T00:55:25.1736293Z"
}
Attribute list
Attribute |
Type |
Nullable |
Description |
Notes |
errors |
List<CommunicationError> |
❌ |
|
|
jobId |
string |
❌ |
|
|
channelReference |
string |
❌ |
|
|
channelId |
string |
❌ |
|
|
classificationPolicyId |
string |
❌ |
|
|
labels |
Dictionary<string, object> |
✔️ |
|
Based on user input |
tags |
Dictionary<string, object> |
✔️ |
|
Based on user input |
Microsoft.Communication.RouterJobCompleted
Back to Event Catalog
{
"id": "b6d8687a-5a1a-42ae-b8b5-ff7ec338c872",
"topic": "/subscriptions/{subscription-id}/resourceGroups/{group-name}/providers/Microsoft.Communication/communicationServices/{communication-services-resource-name}",
"subject": "job/{job-id}/channel/{channel-id}/assignment/{assignment-id}",
"data": {
"jobId": "7f1df17b-570b-4ae5-9cf5-fe6ff64cc712",
"channelReference": "test-abc",
"channelId": "FooVoiceChannelId",
"queueId": "queue-id",
"assignmentId": "6f1df17b-570b-4ae5-9cf5-fe6ff64cc712",
"labels": {
"Locale": "en-us",
"Segment": "Enterprise",
"Token": "FooToken"
},
"tags": {
"Locale": "en-us",
"Segment": "Enterprise",
"Token": "FooToken"
},
"workerId": "e3a3f2f9-3582-4bfe-9c5a-aa57831a0f88"
},
"eventType": "Microsoft.Communication.RouterJobCompleted",
"dataVersion": "1.0",
"metadataVersion": "1",
"eventTime": "2022-02-17T00:55:25.1736293Z"
}
Attribute list
Attribute |
Type |
Nullable |
Description |
Notes |
jobId |
string |
❌ |
|
|
channelReference |
string |
❌ |
|
|
channelId |
string |
❌ |
|
|
queueId |
string |
❌ |
|
|
labels |
Dictionary<string, object> |
✔️ |
|
Based on user input |
tags |
Dictionary<string, object> |
✔️ |
|
Based on user input |
assignmentId |
string |
❌ |
|
|
workerId |
string |
❌ |
|
|
Microsoft.Communication.RouterJobClosed
Back to Event Catalog
{
"id": "b6d8687a-5a1a-42ae-b8b5-ff7ec338c872",
"topic": "/subscriptions/{subscription-id}/resourceGroups/{group-name}/providers/Microsoft.Communication/communicationServices/{communication-services-resource-name}",
"subject": "job/{job-id}/channel/{channel-id}/assignment/{assignment-id}",
"data": {
"jobId": "7f1df17b-570b-4ae5-9cf5-fe6ff64cc712",
"channelReference": "test-abc",
"channelId": "FooVoiceChannelId",
"queueId": "",
"dispositionCode": "",
"workerId": "",
"assignmentId": "",
"labels": {
"Locale": "en-us",
"Segment": "Enterprise",
"Token": "FooToken"
},
"tags": {
"Locale": "en-us",
"Segment": "Enterprise",
"Token": "FooToken"
}
},
"eventType": "Microsoft.Communication.RouterJobClosed",
"dataVersion": "1.0",
"metadataVersion": "1",
"eventTime": "2022-02-17T00:55:25.1736293Z"
}
Attribute list
Attribute |
Type |
Nullable |
Description |
Notes |
jobId |
string |
❌ |
|
|
channelReference |
string |
❌ |
|
|
channelId |
string |
❌ |
|
|
queueId |
string |
❌ |
|
|
labels |
Dictionary<string, object> |
✔️ |
|
Based on user input |
tags |
Dictionary<string, object> |
✔️ |
|
Based on user input |
dispositionCode |
string |
✔️ |
|
Based on user input |
workerId |
string |
❌ |
|
|
assignmentId |
string |
❌ |
|
|
Microsoft.Communication.RouterJobCancelled
Back to Event Catalog
{
"id": "b6d8687a-5a1a-42ae-b8b5-ff7ec338c872",
"topic": "/subscriptions/{subscription-id}/resourceGroups/{group-name}/providers/Microsoft.Communication/communicationServices/{communication-services-resource-name}",
"subject": "job/{job-id}/channel/{channel-id}/disposition/{disposition-code}",
"data": {
"note": "Cancelled due to <reason>",
"dispositionCode": "100",
"jobId": "7f1df17b-570b-4ae5-9cf5-fe6ff64cc712",
"channelReference": "test-abc",
"channelId": "FooVoiceChannelId",
"labels": {
"Locale": "en-us",
"Segment": "Enterprise",
"Token": "FooToken"
},
"tags": {
"Locale": "en-us",
"Segment": "Enterprise",
"Token": "FooToken"
},
"queueId": ""
},
"eventType": "Microsoft.Communication.RouterJobCancelled",
"dataVersion": "1.0",
"metadataVersion": "1",
"eventTime": "2022-02-17T00:55:25.1736293Z"
}
Attribute list
Attribute |
Type |
Nullable |
Description |
Notes |
note |
string |
✔️ |
|
Based on user input |
dispositionCode |
string |
❌ |
|
|
jobId |
string |
❌ |
|
|
channelReference |
string |
❌ |
|
|
channelId |
string |
❌ |
|
|
labels |
Dictionary<string, object> |
✔️ |
|
Based on user input |
tags |
Dictionary<string, object> |
✔️ |
|
Based on user input |
queueId |
string |
✔️ |
|
|
Microsoft.Communication.RouterJobExceptionTriggered
Back to Event Catalog
{
"id": "1027db4a-17fe-4a7f-ae67-276c3120a29f",
"topic": "/subscriptions/{subscription-id}/resourceGroups/{group-name}/providers/Microsoft.Communication/communicationServices/{communication-services-resource-name}",
"subject": "job/{job-id}/channel/{channel-id}/exceptionrule/{rulekey}",
"data": {
"ruleKey": "r100",
"exceptionRuleId": "7f1df17b-570b-4ae5-9cf5-fe6ff64cc712",
"jobId": "7f1df17b-570b-4ae5-9cf5-fe6ff64cc712",
"channelReference": "test-abc",
"channelId": "FooVoiceChannelId",
"labels": {
"Locale": "en-us",
"Segment": "Enterprise",
"Token": "FooToken"
},
"tags": {
"Locale": "en-us",
"Segment": "Enterprise",
"Token": "FooToken"
}
},
"eventType": "Microsoft.Communication.RouterJobExceptionTriggered",
"dataVersion": "1.0",
"metadataVersion": "1",
"eventTime": "2022-02-17T00:55:25.1736293Z"
}
Attribute list
Attribute |
Type |
Nullable |
Description |
Notes |
ruleKey |
string |
❌ |
|
|
exceptionRuleId |
string |
❌ |
|
|
jobId |
string |
❌ |
|
|
channelReference |
string |
❌ |
|
|
channelId |
string |
❌ |
|
|
labels |
Dictionary<string, object> |
✔️ |
|
Based on user input |
tags |
Dictionary<string, object> |
✔️ |
|
Based on user input |
Microsoft.Communication.RouterJobWorkerSelectorsExpired
Back to Event Catalog
{
"id": "b6d8687a-5a1a-42ae-b8b5-ff7ec338c872",
"topic": "/subscriptions/{subscription-id}/resourceGroups/{group-name}/providers/Microsoft.Communication/communicationServices/{communication-services-resource-name}",
"subject": "job/{job-id}/channel/{channel-id}/queue/{queue-id}",
"data": {
"jobId": "7f1df17b-570b-4ae5-9cf5-fe6ff64cc712",
"channelReference": "test-abc",
"channelId": "FooVoiceChannelId",
"queueId": "625fec06-ab81-4e60-b780-f364ed96ade1",
"labels": {
"Locale": "en-us",
"Segment": "Enterprise",
"Token": "FooToken"
},
"tags": {
"Locale": "en-us",
"Segment": "Enterprise",
"Token": "FooToken"
},
"requestedWorkerSelectorsExpired": [
{
"key": "string",
"labelOperator": "equal",
"value": 5,
"ttl": "P3Y6M4DT12H30M5S"
}
],
"attachedWorkerSelectorsExpired": [
{
"key": "string",
"labelOperator": "equal",
"value": 5,
"ttl": "P3Y6M4DT12H30M5S"
}
]
},
"eventType": "Microsoft.Communication.RouterJobWorkerSelectorsExpired",
"dataVersion": "1.0",
"metadataVersion": "1",
"eventTime": "2022-02-17T00:55:25.1736293Z"
}
Attribute list
Attribute |
Type |
Nullable |
Description |
Notes |
jobId |
string |
❌ |
|
|
channelReference |
string |
✔️ |
|
|
queueId |
string |
❌ |
|
|
channelId |
string |
❌ |
|
|
labels |
Dictionary<string, object> |
✔️ |
|
Based on user input |
tags |
Dictionary<string, object> |
✔️ |
|
Based on user input |
requestedWorkerSelectorsExpired |
List<WorkerSelector> |
✔️ |
|
Based on user input while creating a job |
attachedWorkerSelectorsExpired |
List<WorkerSelector> |
✔️ |
|
List of worker selectors attached by a classification policy |
Microsoft.Communication.RouterJobUnassigned
Back to Event Catalog
{
"id": "acdf8fa5-8ab4-4a65-874a-c1d2a4a97f2e",
"topic": "/subscriptions/{subscription-id}/resourceGroups/{group-name}/providers/Microsoft.Communication/communicationServices/{communication-services-resource-name}",
"subject": "job/{job-id}/channel/{channel-id}/assignment/{assignment-id}",
"data": {
"jobId": "7f1df17b-570b-4ae5-9cf5-fe6ff64cc712",
"assignmentId": "",
"workerId": "",
"channelId": "FooVoiceChannelId",
"channelReference": "test-abc",
"queueId": "queue-id",
"labels": {
"Locale": "en-us",
"Segment": "Enterprise",
"Token": "FooToken"
},
"tags": {
"Locale": "en-us",
"Segment": "Enterprise",
"Token": "FooToken"
}
},
"eventType": "Microsoft.Communication.RouterJobUnassigned",
"dataVersion": "1.0",
"metadataVersion": "1",
"eventTime": "2022-02-17T00:55:25.1736293Z"
}
Attribute list
Attribute |
Type |
Nullable |
Description |
Notes |
jobId |
string |
❌ |
|
|
assignmentId |
string |
❌ |
|
|
workerId |
string |
❌ |
|
|
channelId |
string |
❌ |
|
|
channelReference |
string |
❌ |
|
|
queueId |
string |
✔️ |
|
null when classificationPolicyId is specified for a job |
labels |
Dictionary<string, object> |
✔️ |
|
Based on user input |
tags |
Dictionary<string, object> |
✔️ |
|
Based on user input |
Microsoft.Communication.RouterJobWaitingForActivation
Back to Event Catalog
{
"id": "acdf8fa5-8ab4-4a65-874a-c1d2a4a97f2e",
"topic": "/subscriptions/{subscription-id}/resourceGroups/{group-name}/providers/Microsoft.Communication/communicationServices/{communication-services-resource-name}",
"subject": "job/{job-id}/channel/{channel-id}",
"data": {
"jobId": "7f1df17b-570b-4ae5-9cf5-fe6ff64cc712",
"channelId": "FooVoiceChannelId",
"channelReference": "test-abc",
"queueId": "queue-id",
"priority": 1,
"labels": {
"Locale": "en-us",
"Segment": "Enterprise",
"Token": "FooToken"
},
"tags": {
"Locale": "en-us",
"Segment": "Enterprise",
"Token": "FooToken"
},
"requestedWorkerSelectors": [
{
"key": "string",
"labelOperator": "equal",
"value": 5,
"ttl": "P3Y6M4DT12H30M5S"
}
],
"attachedWorkerSelectors": [
{
"key": "string",
"labelOperator": "equal",
"value": 5,
"ttl": "P3Y6M4DT12H30M5S"
}
],
"scheduledOn": "2022-02-17T00:55:25.1736293Z",
"unavailableForMatching": false
},
"eventType": "Microsoft.Communication.RouterJobWaitingForActivation",
"dataVersion": "1.0",
"metadataVersion": "1",
"eventTime": "2022-02-17T00:55:25.1736293Z"
}
Attribute list
Attribute |
Type |
Nullable |
Description |
Notes |
jobId |
string |
❌ |
|
|
channelId |
string |
❌ |
|
|
channelReference |
string |
❌ |
|
|
queueId |
string |
✔️ |
|
null when classificationPolicyId is specified for a job |
labels |
Dictionary<string, object> |
✔️ |
|
Based on user input |
tags |
Dictionary<string, object> |
✔️ |
|
Based on user input |
requestedWorkerSelectorsExpired |
List<WorkerSelector> |
✔️ |
|
Based on user input while creating a job |
attachedWorkerSelectorsExpired |
List<WorkerSelector> |
✔️ |
|
List of worker selectors attached by a classification policy |
scheduledOn |
DateTimeOffset |
✔️ |
|
Based on user input while creating a job |
unavailableForMatching |
bool |
✔️ |
|
Based on user input while creating a job |
priority |
int |
❌ |
|
Based on user input while creating a job |
Microsoft.Communication.RouterJobSchedulingFailed
Back to Event Catalog
{
"id": "acdf8fa5-8ab4-4a65-874a-c1d2a4a97f2e",
"topic": "/subscriptions/{subscription-id}/resourceGroups/{group-name}/providers/Microsoft.Communication/communicationServices/{communication-services-resource-name}",
"subject": "job/{job-id}/channel/{channel-id}",
"data": {
"jobId": "7f1df17b-570b-4ae5-9cf5-fe6ff64cc712",
"channelId": "FooVoiceChannelId",
"channelReference": "test-abc",
"queueId": "queue-id",
"priority": 1,
"labels": {
"Locale": "en-us",
"Segment": "Enterprise",
"Token": "FooToken"
},
"tags": {
"Locale": "en-us",
"Segment": "Enterprise",
"Token": "FooToken"
},
"requestedWorkerSelectors": [
{
"key": "string",
"labelOperator": "equal",
"value": 5,
"ttl": "P3Y6M4DT12H30M5S"
}
],
"attachedWorkerSelectors": [
{
"key": "string",
"labelOperator": "equal",
"value": 5,
"ttl": "P3Y6M4DT12H30M5S"
}
],
"scheduledOn": "2022-02-17T00:55:25.1736293Z",
"failureReason": "Error"
},
"eventType": "Microsoft.Communication.RouterJobSchedulingFailed",
"dataVersion": "1.0",
"metadataVersion": "1",
"eventTime": "2022-02-17T00:55:25.1736293Z"
}
Attribute list
Attribute |
Type |
Nullable |
Description |
Notes |
jobId |
string |
❌ |
|
|
channelId |
string |
❌ |
|
|
channelReference |
string |
❌ |
|
|
queueId |
string |
✔️ |
|
null when classificationPolicyId is specified for a job |
labels |
Dictionary<string, object> |
✔️ |
|
Based on user input |
tags |
Dictionary<string, object> |
✔️ |
|
Based on user input |
requestedWorkerSelectorsExpired |
List<WorkerSelector> |
✔️ |
|
Based on user input while creating a job |
attachedWorkerSelectorsExpired |
List<WorkerSelector> |
✔️ |
|
List of worker selectors attached by a classification policy |
scheduledOn |
DateTimeOffset |
✔️ |
|
Based on user input while creating a job |
failureReason |
string |
✔️ |
|
System determined |
priority |
int |
❌ |
|
Based on user input while creating a job |
Microsoft.Communication.RouterJobDeleted
Back to Event Catalog
{
"id": "acdf8fa5-8ab4-4a65-874a-c1d2a4a97f2e",
"topic": "/subscriptions/{subscription-id}/resourceGroups/{group-name}/providers/Microsoft.Communication/communicationServices/{communication-services-resource-name}",
"subject": "job/{job-id}/channel/{channel-id}",
"data": {
"jobId": "7f1df17b-570b-4ae5-9cf5-fe6ff64cc712",
"channelReference": "test-abc",
"channelId": "FooVoiceChannelId",
"labels": {
"Locale": "en-us",
"Segment": "Enterprise",
"Token": "FooToken"
},
"tags": {
"Locale": "en-us",
"Segment": "Enterprise",
"Token": "FooToken"
},
"queueId": ""
},
"eventType": "Microsoft.Communication.RouterJobDeleted",
"dataVersion": "1.0",
"metadataVersion": "1",
"eventTime": "2022-02-17T00:55:25.1736293Z"
}
Attribute list
Attribute |
Type |
Nullable |
Description |
Notes |
jobId |
string |
❌ |
|
|
Worker Events
Microsoft.Communication.RouterWorkerOfferIssued
Back to Event Catalog
{
"id": "1027db4a-17fe-4a7f-ae67-276c3120a29f",
"topic": "/subscriptions/{subscription-id}/resourceGroups/{group-name}/providers/Microsoft.Communication/communicationServices/{communication-services-resource-name}",
"subject": "worker/{worker-id}/job/{job-id}",
"data": {
"workerId": "w100",
"jobId": "7f1df17b-570b-4ae5-9cf5-fe6ff64cc712",
"channelReference": "test-abc",
"channelId": "FooVoiceChannelId",
"queueId": "625fec06-ab81-4e60-b780-f364ed96ade1",
"offerId": "525fec06-ab81-4e60-b780-f364ed96ade1",
"offeredOn": "2021-06-23T02:43:30.3847144Z",
"expiresOn": "2021-06-23T02:44:30.3847674Z",
"jobPriority": 5,
"jobLabels": {
"Locale": "en-us",
"Segment": "Enterprise",
"Token": "FooToken"
},
"jobTags": {
"Locale": "en-us",
"Segment": "Enterprise",
"Token": "FooToken"
}
},
"eventType": "Microsoft.Communication.RouterWorkerOfferIssued",
"dataVersion": "1.0",
"metadataVersion": "1",
"eventTime": "2022-02-17T00:55:25.1736293Z"
}
Attribute list
Attribute |
Type |
Nullable |
Description |
Notes |
workerId |
string |
❌ |
|
|
jobId |
string |
❌ |
|
|
channelReference |
string |
❌ |
|
|
channelId |
string |
❌ |
|
|
queueId |
string |
❌ |
|
|
offerId |
string |
❌ |
|
|
offeredOn |
DateTimeOffset |
❌ |
|
|
expiresOn |
DateTimeOffset |
❌ |
|
|
jobPriority |
int |
❌ |
|
|
jobLabels |
Dictionary<string, object> |
✔️ |
|
Based on user input |
jobTags |
Dictionary<string, object> |
✔️ |
|
Based on user input |
Microsoft.Communication.RouterWorkerOfferAccepted
Back to Event Catalog
{
"id": "1027db4a-17fe-4a7f-ae67-276c3120a29f",
"topic": "/subscriptions/{subscription-id}/resourceGroups/{group-name}/providers/Microsoft.Communication/communicationServices/{communication-services-resource-name}",
"subject": "worker/{worker-id}/job/{job-id}",
"data": {
"workerId": "w100",
"jobId": "7f1df17b-570b-4ae5-9cf5-fe6ff64cc712",
"jobPriority": 5,
"jobLabels": {
"Locale": "en-us",
"Segment": "Enterprise",
"Token": "FooToken"
},
"jobTags": {
"Locale": "en-us",
"Segment": "Enterprise",
"Token": "FooToken"
},
"channelReference": "test-abc",
"channelId": "FooVoiceChannelId",
"queueId": "625fec06-ab81-4e60-b780-f364ed96ade1",
"offerId": "565fec06-ab81-4e60-b780-f364ed96ade1",
"assignmentId": "765fec06-ab81-4e60-b780-f364ed96ade1"
},
"eventType": "Microsoft.Communication.RouterWorkerOfferAccepted",
"dataVersion": "1.0",
"metadataVersion": "1",
"eventTime": "2022-02-17T00:55:25.1736293Z"
}
Attribute list
Attribute |
Type |
Nullable |
Description |
Notes |
workerId |
string |
❌ |
|
|
jobId |
string |
❌ |
|
|
jobPriority |
int |
❌ |
|
|
jobLabels |
Dictionary<string, object> |
✔️ |
|
Based on user input |
jobTags |
Dictionary<string, object> |
✔️ |
|
Based on user input |
channelReference |
string |
❌ |
|
|
channelId |
string |
❌ |
|
|
queueId |
string |
❌ |
|
|
offerId |
string |
❌ |
|
|
assignmentId |
string |
❌ |
|
|
Microsoft.Communication.RouterWorkerOfferDeclined
Back to Event Catalog
{
"id": "1027db4a-17fe-4a7f-ae67-276c3120a29f",
"topic": "/subscriptions/{subscription-id}/resourceGroups/{group-name}/providers/Microsoft.Communication/communicationServices/{communication-services-resource-name}",
"subject": "worker/{worker-id}/job/{job-id}",
"data": {
"workerId": "w100",
"jobId": "7f1df17b-570b-4ae5-9cf5-fe6ff64cc712",
"channelReference": "test-abc",
"channelId": "FooVoiceChannelId",
"queueId": "625fec06-ab81-4e60-b780-f364ed96ade1",
"offerId": "565fec06-ab81-4e60-b780-f364ed96ade1",
},
"eventType": "Microsoft.Communication.RouterWorkerOfferDeclined",
"dataVersion": "1.0",
"metadataVersion": "1",
"eventTime": "2022-02-17T00:55:25.1736293Z"
}
Attribute list
Attribute |
Type |
Nullable |
Description |
Notes |
workerId |
string |
❌ |
|
|
jobId |
string |
❌ |
|
|
channelReference |
string |
❌ |
|
|
channelId |
string |
❌ |
|
|
queueId |
string |
❌ |
|
|
offerId |
string |
❌ |
|
|
Microsoft.Communication.RouterWorkerOfferRevoked
Back to Event Catalog
{
"id": "1027db4a-17fe-4a7f-ae67-276c3120a29f",
"topic": "/subscriptions/{subscription-id}/resourceGroups/{group-name}/providers/Microsoft.Communication/communicationServices/{communication-services-resource-name}",
"subject": "worker/{worker-id}/job/{job-id}",
"data": {
"offerId": "565fec06-ab81-4e60-b780-f364ed96ade1",
"workerId": "w100",
"jobId": "7f1df17b-570b-4ae5-9cf5-fe6ff64cc712",
"channelReference": "test-abc",
"channelId": "FooVoiceChannelId",
"queueId": "625fec06-ab81-4e60-b780-f364ed96ade1"
},
"eventType": "Microsoft.Communication.RouterWorkerOfferRevoked",
"dataVersion": "1.0",
"metadataVersion": "1",
"eventTime": "2022-02-17T00:55:25.1736293Z"
}
Attribute list
Attribute |
Type |
Nullable |
Description |
Notes |
offerId |
string |
❌ |
|
|
workerId |
string |
❌ |
|
|
jobId |
string |
❌ |
|
|
channelReference |
string |
❌ |
|
|
channelId |
string |
❌ |
|
|
queueId |
string |
❌ |
|
|
Microsoft.Communication.RouterWorkerOfferExpired
Back to Event Catalog
{
"id": "1027db4a-17fe-4a7f-ae67-276c3120a29f",
"topic": "/subscriptions/{subscription-id}/resourceGroups/{group-name}/providers/Microsoft.Communication/communicationServices/{communication-services-resource-name}",
"subject": "worker/{worker-id}/job/{job-id}",
"data": {
"offerId": "565fec06-ab81-4e60-b780-f364ed96ade1",
"workerId": "w100",
"jobId": "7f1df17b-570b-4ae5-9cf5-fe6ff64cc712",
"channelReference": "test-abc",
"channelId": "FooVoiceChannelId",
"queueId": "625fec06-ab81-4e60-b780-f364ed96ade1"
},
"eventType": "Microsoft.Communication.RouterWorkerOfferExpired",
"dataVersion": "1.0",
"metadataVersion": "1",
"eventTime": "2022-02-17T00:55:25.1736293Z"
}
Attribute list
Attribute |
Type |
Nullable |
Description |
Notes |
workerId |
string |
❌ |
|
|
offerId |
string |
❌ |
|
|
jobId |
string |
❌ |
|
|
channelReference |
string |
❌ |
|
|
channelId |
string |
❌ |
|
|
queueId |
string |
❌ |
|
|
Microsoft.Communication.RouterWorkerRegistered
Back to Event Catalog
{
"id": "1027db4a-17fe-4a7f-ae67-276c3120a29f",
"topic": "/subscriptions/{subscription-id}/resourceGroups/{group-name}/providers/Microsoft.Communication/communicationServices/{communication-services-resource-name}",
"subject": "worker/{worker-id}",
"data": {
"workerId": "worker3",
"totalCapacity": 100,
"queueAssignments": [
{
"id": "MyQueueId2",
"name": "Queue 3",
"labels": {
"Language": "en",
"Product": "Office",
"Geo": "NA"
}
}
],
"labels": {
"x": "111",
"y": "111"
},
"channelConfigurations": [
{
"channelId": "FooVoiceChannelId",
"capacityCostPerJob": 10,
"maxNumberOfJobs": 5
}
],
"tags": {
"Locale": "en-us",
"Segment": "Enterprise",
"Token": "FooToken"
}
},
"eventType": "Microsoft.Communication.RouterWorkerRegistered",
"dataVersion": "1.0",
"metadataVersion": "1",
"eventTime": "2022-02-17T00:55:25.1736293Z"
}
Attribute list
Attribute |
Type |
Nullable |
Description |
Notes |
workerId |
string |
❌ |
|
|
totalCapacity |
int |
❌ |
|
|
queueAssignments |
List<QueueDetails> |
❌ |
|
|
labels |
Dictionary<string, object> |
✔️ |
|
Based on user input |
channelConfigurations |
List<ChannelConfiguration> |
❌ |
|
|
tags |
Dictionary<string, object> |
✔️ |
|
Based on user input |
Microsoft.Communication.RouterWorkerDeregistered
Back to Event Catalog
{
"id": "1027db4a-17fe-4a7f-ae67-276c3120a29f",
"topic": "/subscriptions/{subscription-id}/resourceGroups/{group-name}/providers/Microsoft.Communication/communicationServices/{communication-services-resource-name}",
"subject": "worker/{worker-id}",
"data": {
"workerId": "worker3"
},
"eventType": "Microsoft.Communication.RouterWorkerDeregistered",
"dataVersion": "1.0",
"metadataVersion": "1",
"eventTime": "2022-02-17T00:55:25.1736293Z"
}
Attribute list
Attribute |
Type |
Nullable |
Description |
Notes |
workerId |
string |
❌ |
|
|
Microsoft.Communication.RouterWorkerDeleted
Back to Event Catalog
{
"id": "1027db4a-17fe-4a7f-ae67-276c3120a29f",
"topic": "/subscriptions/{subscription-id}/resourceGroups/{group-name}/providers/Microsoft.Communication/communicationServices/{communication-services-resource-name}",
"subject": "worker/{worker-id}",
"data": {
"workerId": "worker3",
"totalCapacity": 100,
"queueAssignments": [
{
"id": "MyQueueId2",
"name": "Queue 3",
"labels": {
"Language": "en",
"Product": "Office",
"Geo": "NA"
}
}
],
"labels": {
"x": "111",
"y": "111"
},
"channelConfigurations": [
{
"channelId": "FooVoiceChannelId",
"capacityCostPerJob": 10,
"maxNumberOfJobs": 5
}
],
"tags": {
"Locale": "en-us",
"Segment": "Enterprise",
"Token": "FooToken"
}
},
"eventType": "Microsoft.Communication.RouterWorkerDeleted",
"dataVersion": "1.0",
"metadataVersion": "1",
"eventTime": "2022-02-17T00:55:25.1736293Z"
}
Attribute list
Attribute |
Type |
Nullable |
Description |
Notes |
workerId |
string |
❌ |
|
|
totalCapacity |
int |
❌ |
|
|
queueAssignments |
List<QueueDetails> |
❌ |
|
|
labels |
Dictionary<string, object> |
✔️ |
|
Based on user input |
channelConfigurations |
List<ChannelConfiguration> |
❌ |
|
|
tags |
Dictionary<string, object> |
✔️ |
|
Based on user input |
Model Definitions
QueueDetails
public class QueueDetails
{
public string Id { get; set; }
public string Name { get; set; }
public Dictionary<string, object>? Labels { get; set; }
}
CommunicationError
public class CommunicationError
{
public string? Code { get; init; }
public string Message { get; init; }
public string? Target { get; init; }
public CommunicationError? InnerError { get; init; }
public IEnumerable<CommunicationError>? Details { get; init; }
}
ChannelConfiguration
public class ChannelConfiguration
{
public string ChannelId { get; set; }
public int CapacityCostPerJob { get; set; }
public int? MaxNumberOfJobs { get; set; }
}
WorkerSelector
public class WorkerSelector
{
public string Key { get; set; }
public LabelOperator LabelOperator { get; set; }
public object Value { get; set; }
public double? TTLSeconds { get; set; }
public WorkerSelectorState State { get; set; }
public DateTimeOffset? ExpireTime { get; set; }
}
public enum WorkerSelectorState
{
Active = 0,
Expired = 1
}
public enum LabelOperator
{
Equal,
NotEqual,
LessThan,
LessThanEqual,
GreaterThan,
GreaterThanEqual,
}