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.
Most URLs in the example code use the following values:
- ***. To access the API for your region, replace *** with the correct subdomain for your region:
Region URL subdomain Base URL EMEA emea https://emea.api.cc.vonage.com USA nam https://nam.api.cc.vonage.com APAC apac https://apac.api.cc.vonage.com - <ACCESS_TOKEN>. The value represents a bearer access token which you must use to validate every request. Replace <ACCESS_TOKEN> where used with your bearer access token. For information about getting a bearer access token, see How to authenticate with a Vonage Contact Center (VCC) API.
Headers
Header parameters in Requests (Interaction Content Export API) apply to this endpoint.
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 | {
"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 all content will be exported. Any of the following values can be included in the contentTypes array:
callRecordingscreenRecordingvoicemailtranscriptchatTranscriptcategorizationResultattachmentivrAudioRecordingconversationSummarysentimentSummaryinteractionLog
Any of the following values can be included in the initialDirection array:
inboundoutbound
externalStorageId
| Type | Required | Example |
|---|---|---|
| String | True | 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.
For information, see Trying out Vonage Contact Center APIs.