Versions Compared

Key

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

Insert excerpt
_ExcerptBetaAPI
_ExcerptBetaAPI
nopaneltrue

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. 

...

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.

filters

Type

Required

Example

ObjectTrue


Code Block
languagejs
{
"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.  contentTypes can have Any of the following values assigned in arraycan 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-batch-export" \
-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",
  "endDate": "2024-06-01T18:35:24.00Z"
  "filters": {
    "contentTypes": [],
    "initialDirection": []
  },
  "externalStorageId": "fe4b9c24-d305-492e-90e2-ddbdd7a36555"
}

...