Schedule one-time job export
- Helen Griffith
Beta/Early Access Program
This API is in the Beta/Early Access Program and is still under development. If you are interested in using this API, please contact your Customer Success Manager or Account Manager. Participation in this pilot program is at the discretion of Product Management and not guaranteed.
Use of this API outside of the program is prohibited.
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.
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.
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 | {
"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. 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-batch-export" \ -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",
"endDate": "2024-06-01T18:35:24.00Z"
"filters": {
"contentTypes": [],
"initialDirection": []
},
"externalStorageId": "fe4b9c24-d305-492e-90e2-ddbdd7a36555"
}
Responses
Responses to the endpoint return the ID of the created job.
Successful response
For information about successful responses, see Success response code and parameters in Responses (Interaction Content Export API).
Example responses
{
"jobId": "74137e23-9716-4e5c-ad92-36343c248282"
}
where:
jobId. The unique identifier of the job.
For information, see Trying out Vonage Contact Center APIs.