Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 4 Current »


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 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:

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:

size

Type

Required

Example

Default
IntegerFalse1001000

Size of the requested page with jobs.

page

Type

Required

Example

Default
IntegerFalse41

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.
  • startDateThe start date and time for interaction content export (inclusive).
  • endDateThe 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.


Try it out

  

For information, see Trying out Vonage Contact Center APIs.

  • No labels