Insert excerpt _ExcerptBetaAPI _ExcerptBetaAPI nopanel true
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 jobs will be repeated every hour, transferring interaction content data created longer than 12 hours before the job is run.
...
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.
filters
Type | Required | Example | |||||
---|---|---|---|---|---|---|---|
Object | True |
|
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 all 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-recurring-job" \ -H "Authorization: Bearer <ACCESS_TOKEN>" \ -H "Accept: application/vnd.newvoicemedia.v1+json" \ --data-raw "<JSON BODY>" |
...