Insert excerpt _ExcerptBetaAPI _ExcerptBetaAPI nopanel true
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:
Scope | Access granted |
---|---|
interaction-content:read | Entire endpoint |
Parameters
The endpoint accepts the following body parameters:
startDate
Type | Required | Example |
---|---|---|
String | True | 2021-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 |
---|---|---|
String | True | 2022-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 | |||||
---|---|---|---|---|---|---|---|
Object | True |
|
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 |
---|---|---|
String | True | fe4b9c24-d305-492e-90e2-ddbdd7a36555 |
External storage ID in UUID format.
Requests
Example request
Code Block | ||||
---|---|---|---|---|
| ||||
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>" |
...