Versions Compared

Old Version 1

changes.mady.by.user Helen Griffith

Saved on

compared with

New Version Current

changes.mady.by.user Helen Griffith

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Insert excerpt
_ExcerptBetaAPI
_ExcerptBetaAPI
nopaneltrue
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. 

Panel
borderColor#eeeeee
bgColorwhite
titleColorwhite
borderWidth1
titleBGColor#D34204
borderStylesolid
titleIn this page

Table of Contents

Insert excerpt
_ExcerptAPICloudNextGen
_ExcerptAPICloudNextGen
nopaneltrue

Headers

Header parameters in Requests (Interaction Content Export API) apply to this endpoint.

Authorization scopes supported:

ScopeAccess granted
interaction-content:readEntire endpoint

Parameters

The endpoint accepts the following query parameters:

limit

Type

Required

Example

Default
IntegerFalse1000100

The required size (number of items) per page returned in response, with a minimum of 1 and a maximum of 1000.

page

Type

Required

Example

Default
IntegerFalse41

Page number of requested page with jobs.

Request

Request jobs with default paging 

Code Block
languagepowershell
themeMidnight
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 

Code Block
languagepowershell
themeMidnight
curl -L -X GET "https://***.api.cc.vonage.com/interaction-content-export/interactions/jobs?page=2&limit=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

Code Block
languagejs
themeMidnight
{
  "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

Code Block
languagejs
themeMidnight
{
  "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 export
    • contentTypes. 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:
      • callRecording
      • screenRecording
      • voicemail
      • transcript
      • chatTranscript
      • categorizationResult
      • attachment
      • ivrAudioRecording
      • conversationSummary
      • sentimentSummary
      • interactionLog
    • 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.

Insert excerpt
_ExcerptRunInPostman
_ExcerptRunInPostman
nopaneltrue