Share via

Job Router Operations - Cancel Job

  • Reference
Service:
Communication
API Version:
2023-11-01

Submits request to cancel an existing job by Id while supplying free-form cancellation reason.

POST {endpoint}/routing/jobs/{jobId}:cancel?api-version=2023-11-01

URI Parameters

Name In Required Type Description
endpoint
 path True

string

Uri of your Communication resource
jobId
 path True

string

Id of a job.
api-version
 query True

string

The API version to use for this operation.

Request Body

Name Type Description
dispositionCode

string

Indicates the outcome of a job, populate this field with your own custom values. If not provided, default value of "Cancelled" is set.
note

string

A note that will be appended to a job's Notes collection with the current timestamp.

Responses

Name Type Description
200 OK

object

The request has succeeded.
Other Status Codes

Azure.Core.Foundations.ErrorResponse

An unexpected error response.

Headers

x-ms-error-code: string

Examples

Cancels a job
Submits request to cancel an existing job

Cancels a job

Sample request

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

{}

Sample response

Status code:
200 
{}

Submits request to cancel an existing job

Sample request

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

Sample response

Status code:
200 
{}

Definitions

Name Description
Azure.Core.Foundations.Error

The error object.
Azure.Core.Foundations.ErrorResponse

A response containing error details.
Azure.Core.Foundations.InnerError

An object containing more specific information about the error. As per Microsoft One API guidelines - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
CancelJobOptions

Request payload for cancelling a job.

Azure.Core.Foundations.Error

The error object.

Name Type Description
code

string

One of a server-defined set of error codes.
details

Azure.Core.Foundations.Error[]

An array of details about specific errors that led to this reported error.
innererror

Azure.Core.Foundations.InnerError

An object containing more specific information than the current object about the error.
message

string

A human-readable representation of the error.
target

string

The target of the error.

Azure.Core.Foundations.ErrorResponse

A response containing error details.

Name Type Description
error

Azure.Core.Foundations.Error

The error object.

Azure.Core.Foundations.InnerError

An object containing more specific information about the error. As per Microsoft One API guidelines - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Name Type Description
code

string

One of a server-defined set of error codes.
innererror

Azure.Core.Foundations.InnerError

Inner error.

CancelJobOptions

Request payload for cancelling a job.

Name Type Description
dispositionCode

string

Indicates the outcome of a job, populate this field with your own custom values. If not provided, default value of "Cancelled" is set.
note

string

A note that will be appended to a job's Notes collection with the current timestamp.