Schedule recurring job export

The POST /interactions/jobs/schedule-recurring-export endpoint enables you to schedule a recurring job. When you schedule a recurring job, the endpoint will return ID of the created job. Recurring job will be repeated every hour, transferring the interaction content data created older than 12 hours from the point of current execution

Headers

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

Authorization scopes supported:

Parameters

The endpoint accepts the following body parameters:

startDate

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

filters

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

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

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

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

initialDirection can have following values assigned in array:

• inbound
• outbound

externalStorageId

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-recurring-job" \
-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",
  "filters": {
    "contentTypes": [],
    "initialDirection": []
  },
  "externalStorageId": "fe4b9c24-d305-492e-90e2-ddbdd7a36555"
}

Responses

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

Successful response

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

Example response

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

where:

• jobId. The unique identifier of the job.