Sign in

v4

latestSwagger 2.02026-07-1333110154.1 KB

Retrieves an existing job by Id.

Retrieves an existing job by Id.

get/routing/jobs/{jobId}

Path parameters

jobIdstring required

Id of a job.

Query parameters

api-versionstring required

The API version to use for this operation.

Response

The request has succeeded.

etagstring required

The ETag (or entity tag) HTTP response header is an identifier for a specific version of a resource. It lets caches be more efficient and save bandwidth, as a web server does not need to resend a full response if the content was not changed.

It is a string of ASCII characters placed between double quotes, like "675af34563dc-tr34".

idstring required

Id of a job.

channelReferencestring

Reference to an external parent context, eg. call ID.

status'pendingClassification' | 'queued' | 'assigned' | 'completed' | 'closed' | 'cancelled' | 'classificationFailed' | 'created' | 'pendingSchedule' | 'scheduled' | 'scheduleFailed' | 'waitingForActivation'

Describes the various status of a job.

enqueuedAtstring date-time

Timestamp a job was queued in UTC.

channelIdstring

The channel identifier. eg. voice, chat, etc.

classificationPolicyIdstring

Id of a classification policy used for classifying this job.

queueIdstring

Id of a queue that this job is queued to.

priorityinteger

Priority of this job. Value must be between -100 to 100.

dispositionCodestring

Reason code for cancelled or closed jobs.

labelsobject

A set of key/value pairs that are identifying attributes used by the rules engines to make decisions. Values must be primitive values - number, string, boolean.

assignmentsobject

A collection of the assignments of the job. Key is AssignmentId.

tagsobject

A set of non-identifying attributes attached to this job. Values must be primitive values - number, string, boolean.

scheduledAtstring date-time

If set, job will be scheduled to be enqueued at a given time.