The GET /interactions/jobs endpoint enables you to retrieve jobs. You can search for jobs and endpoint will return list of jobs that user has access to within the account.
In this page
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 query parameters:
size
Type | Required | Example | Default |
|---|---|---|---|
| Integer | False | 100 | 1000 |
Size of the requested page with jobs.
page
| Type | Required | Example | Default |
|---|---|---|---|
| Integer | False | 4 | 1 |
Page number of requested page with jobs.
Request
Request jobs with default paging
curl -L -X GET "https://***.api.cc.vonage.com/interaction-content-export/interactions/jobs" \ -H "Authorization: Bearer <ACCESS_TOKEN>" \ -H "Accept: application/vnd.newvoicemedia.v1+json" \
Request jobs with custom paging
curl -L -X GET "https://***.api.cc.vonage.com/interaction-content-export/interactions/jobs?page=2&size=200" \ -H "Authorization: Bearer <ACCESS_TOKEN>" \ -H "Accept: application/vnd.newvoicemedia.v1+json" \
Responses
Responses to the endpoint return a pageable list of all jobs (recurring and one-time) within the account.
Successful response
For information about successful responses, see Success response code and parameters in Responses (Interaction Content Export API).
Example responses
Next page exists
{
"jobs": [
{
"jobId": "74137e23-9716-4e5c-ad92-36343c248282",
"type": "export-batch",
"startDate": "2024-05-01T18:35:24.00Z",
"endDate": "2024-05-01T19:35:24.00Z",
"status": "Completed",
"filters": {
"contentTypes": [
"callRecording"
],
"initialDirection": [
"inbound"
]
},
"externalStorageId": "fe4b9c24-d305-492e-90e2-ddbdd7a36555"
},
{
"jobId": "74137e23-9716-4e5c-ad92-36343c248283",
"type": "export-recurring",
"startDate": "2024-06-01T18:35:24.00Z",
"status": "Scheduled",
"filters": {
"contentTypes": [
"callRecording"
],
"initialDirection": [
"outbound"
]
},
"externalStorageId": "fe4b9c24-d305-492e-90e2-ddbdd7a36555"
}
],
"paging": {
"page": 1,
"count": 2,
"pageCount": 2,
"totalCount": 4
}
}
Next page does not exist
{
"jobs": [
{
"jobId": "74137e23-9716-4e5c-ad92-36343c248282",
"type": "export-batch",
"startDate": "2024-05-01T18:35:24.00Z",
"endDate": "2024-05-01T19:35:24.00Z",
"status": "Scheduled",
"filters": {
"contentTypes": [
"callRecording"
],
"initialDirection": [
"inbound"
]
},
"externalStorageId": "fe4b9c24-d305-492e-90e2-ddbdd7a36555"
}
],
"paging": {
"page": 2,
"count": 50,
"pageCount": 1,
"totalCount": 51
}
}
where:
jobId. The unique identifier of the job.type. The type of job.startDate. The start date and time for interaction content export (inclusive).endDate. The end date and time for interaction content export (inclusive).status. Status of the job.filters. A JSON object representing filters used for exportcontentTypes. A JSON array with interaction content types that are included during export process. If array is empty, export includes all interaction content types. Available interaction content types:callRecordingscreenRecordingvoicemailtranscriptchatTranscriptcategorizationResultattachmentivrAudioRecordingconversationSummarysentimentSummaryinteractionLog
initialDirection. A JSON array including interaction directions (inbound,outbound). If array is empty, export includes both interaction directions.
externalStorageId. The unique identifier of the external storage.
paging.page. The current page of pageable list of jobs.count. Count of jobs on current page.pageCount. Total number of pages available.totalCount. Total number of jobs.
Try it out
For information, see Trying out Vonage Contact Center APIs.