Schedule one-time job export

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/schedule-batch-export endpoint enables you to schedule a one-time batch job. When you schedule a batch job, the endpoint will return the ID of the created job. 

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 body parameters:

startDate

Type

Required

Example

StringTrue2021-01-01T00:00:00Z

The start date and time for interaction content export (inclusive). Use ISO8601 format. The date cannot be earlier than 12 hours from now.

endDate

Type

Required

Example

StringTrue2022-01-01T00:00:00Z

The end date and time for interaction content export (inclusive). Use ISO8601 format. The date cannot be earlier than 12 hours from now.

name

Type

Required

Example

StringTrueDownload on 2024-05-01 18:35

The name for job.

filters

Type

Required

Example

ObjectTrue
{
"contentTypes": ["callRecording"],
"initialDirection": ["inbound"]
}

Filters representing content types that will be exported and initial direction of interaction (inbound, outbound).  

If contentTypes and initialDirection arrays are left empty, then every content will be exported. Any of the following values can be included in the contentTypes array:

  • callRecording
  • screenRecording
  • voicemail
  • transcript
  • chatTranscript
  • categorizationResult
  • attachment
  • ivrAudioRecording
  • conversationSummary
  • sentimentSummary
  • interactionLog

Any of the following values can be included in the initialDirection array:

  • inbound
  • outbound

externalStorageId

Type

Required

Example

StringTrue
fe4b9c24-d305-492e-90e2-ddbdd7a36555

External storage ID in UUID format.

Requests

Example request

curl -L -X POST "https://***.api.cc.vonage.com/interaction-content-export/interactions/jobs/schedule-batch-export" \
-H "Authorization: Bearer <ACCESS_TOKEN>" \
-H "Accept: application/vnd.newvoicemedia.v1+json" \
--data-raw "<JSON BODY>"

Required parameters

 {
  "startDate": "2024-05-01T18:35:24.00Z",
  "endDate": "2024-06-01T18:35:24.00Z",
  "name": "Download on 2024-05-01 18:35",
  "filters": {
    "contentTypes": [],
    "initialDirection": []
  },
  "externalStorageId": "fe4b9c24-d305-492e-90e2-ddbdd7a36555"
}

Responses

Responses to the endpoint return the ID of the created job.

Successful response

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

Example responses

{
  "jobId": "74137e23-9716-4e5c-ad92-36343c248282"
}

where:

  • jobId. The unique identifier of the job.


Try it out

  

For information, see Trying out Vonage Contact Center APIs.