Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

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 the ID of the created job. Recurring job jobs will be repeated every hour, transferring the interaction content data created older longer than 12 hours from the point of current executionbefore the job is run.

Panel
borderColor#eeeeee
bgColorwhite
titleColorwhite
borderWidth1
titleBGColor#D34204
borderStylesolid
titleIn this page

Table of Contents

...

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.

filters

Type

Required

Example

ObjectTrue


Code Block
languagejs
{
"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 all content will be exported.  contentTypes can have Any of the following values assigned in can be included in the contentTypes array:

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

initialDirection can have Any of the following values assigned in arraycan 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

Code Block
languagepowershell
themeMidnight
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

Code Block
languagepowershell
themeMidnight
 {
  "startDate": "2024-05-01T18:35:24.00Z",
  "filters": {
    "contentTypes": [],
    "initialDirection": []
  },
  "externalStorageId": "fe4b9c24-d305-492e-90e2-ddbdd7a36555"
}

...