Change job status

Owned by Helen Griffith
Last updated: Dec 17, 2024


Beta/Early Access Program

This API is in the Beta/Early Access Program and is still under development. If you are interested in using this API, please contact your Customer Success Manager or Account Manager. Participation in this pilot program is at the discretion of Product Management and not guaranteed.

Use of this API outside of the program is prohibited.

The POST /interactions/jobs/{id}/{action} endpoint enables you to change the status of a job. The action can be executed against a job that is in the correct status. These are available actions on corresponding statuses:

  • A cancel action can be run on a Scheduled, Running, or Paused job, resulting in a Cancelled status
  • A restart action can be run on a Failed or Paused job, resulting in a Scheduled status
  • A pause action can be run on a Scheduled or Running job, resulting in a Paused status
In this page


Most URLs in the example code use the following values:

Headers

Header parameters in Requests (Interaction Content Export API) apply to this endpoint.

Authorization scopes supported:

ScopeAccess granted
interaction-content:readEntire endpoint

Parameters

The endpoint accepts the following path parameters:

id

Type

Required

Example

StringTruefe4b9c24-d305-492e-90e2-ddbdd7a36555

Unique identifier of a job.

action

Type

Required

Example

StringTrue
restart

An action to be taken on a job. Supported actions:

  • cancel
  • restart
  • pause

Request

Schedule recurring job 

curl -L -X POST "https://***.api.cc.vonage.com/interaction-content-export/interactions/jobs/fe4b9c24-d305-492e-90e2-ddbdd7a36555/restart" \
-H "Authorization: Bearer <ACCESS_TOKEN>" \
-H "Accept: application/vnd.newvoicemedia.v1+json" \

Responses

Responses to the endpoint return no content.

Successful response

For information about successful responses, see Success response code and parameters in Responses (Interaction Content Export API).


Try it out

  

For information, see Trying out Vonage Contact Center APIs.