Versions Compared

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. 

...

Authorization scopes supported:

ScopeAccess granted
interaction-content:readEntire endpoint

Parameters

The endpoint accepts the following query parameters:

...

limit

Type

Required

Example

Default
IntegerFalse10001001000

Size of the requested page with jobsThe 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?page=2&sizelimit=200" \
-H "Authorization: Bearer <ACCESS_TOKEN>" \
-H "Accept: application/vnd.newvoicemedia.v1+json" \

...

  • 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. 

...