0% found this document useful (0 votes)
18 views19 pages

Recording Deletion Using Genesys Cloud Developer Tools

Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as DOCX, PDF, TXT or read online on Scribd
0% found this document useful (0 votes)
18 views19 pages

Recording Deletion Using Genesys Cloud Developer Tools

Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as DOCX, PDF, TXT or read online on Scribd
You are on page 1/ 19

Recording Deletion using Genesys Cloud Developer Tools

API List:

1) Creating a Deletion Job.


Use the Analytics Query Builder tool to frame your query and test the outcome. Once you are
satisfied with the results, use the same query in the deletion job creation.

The time mentioned in the query will be in GMT timezone format.


Use the Genesys Cloud tool, do the similar query search and monitor the network logs to capture the
JSON query. You can use this as reference to build your query.
Web Service Configuration
URL Endpoint Web Service Verb Header
/api/v2/recording/jobs POST *optional

Input:
{
"action": "DELETE",
"actionDate": "2021-02-15T16:45:00.000Z",
"includeScreenRecordings": true,
"conversationQuery": {
"interval": "2020-11-16T00:00:00.000Z/2021-02-15T00:00:00.000Z",
"order": "desc",
"orderBy": "conversationStart",
"segmentFilters": [
{
"type": "or",
"predicates": [
{
"type": "dimension",
"dimension": "mediaType",
"operator": "matches",
"value": "voice"
}
]
},
{
"type": "or",
"predicates": [
{
"type": "dimension",
"dimension": "queueId",
"operator": "matches",
"value": "03d4edff-a657-43a8-851a-61a13892119f"
},
{
"type": "dimension",
"dimension": "queueId",
"operator": "matches",
"value": "a4a7b434-8065-48c2-9d9a-1b8706c8317c"
},
{
"type": "dimension",
"dimension": "queueId",
"operator": "matches",
"value": "630d854a-32aa-491e-8633-7b4394affcd4"
},
{
"type": "dimension",
"dimension": "queueId",
"operator": "matches",
"value": "ce642194-1333-47c8-87dd-966b09507c18"
},
{
"type": "dimension",
"dimension": "queueId",
"operator": "matches",
"value": "615b852c-92a6-49d6-9c85-99eecf781468"
},
{
"type": "dimension",
"dimension": "queueId",
"operator": "matches",
"value": "a6d9b881-5bbe-4380-869a-2d867e1ad3d7"
}
]
}
]
}
}

Output:
{
"id": "64cb3524-128d-46ec-9661-612ac0819816",
"state": "PENDING",
"recordingJobsQuery": {
"action": "DELETE",
"actionDate": "2021-02-15T16:45:00Z",
"includeScreenRecordings": true,
"conversationQuery": {
"segmentFilters": [
{
"type": "or",
"predicates": [
{
"type": "dimension",
"dimension": "mediaType",
"operator": "matches",
"value": "voice"
}
]
},
{
"type": "or",
"predicates": [
{
"type": "dimension",
"dimension": "queueId",
"operator": "matches",
"value": "03d4edff-a657-43a8-851a-61a13892119f"
},
{
"type": "dimension",
"dimension": "queueId",
"operator": "matches",
"value": "a4a7b434-8065-48c2-9d9a-1b8706c8317c"
},
{
"type": "dimension",
"dimension": "queueId",
"operator": "matches",
"value": "630d854a-32aa-491e-8633-7b4394affcd4"
},
{
"type": "dimension",
"dimension": "queueId",
"operator": "matches",
"value": "ce642194-1333-47c8-87dd-966b09507c18"
},
{
"type": "dimension",
"dimension": "queueId",
"operator": "matches",
"value": "615b852c-92a6-49d6-9c85-99eecf781468"
},
{
"type": "dimension",
"dimension": "queueId",
"operator": "matches",
"value": "a6d9b881-5bbe-4380-869a-2d867e1ad3d7"
}
]
}
],
"order": "desc",
"orderBy": "conversationStart",
"interval": "2020-11-16T00:00:00.000Z/2021-02-15T00:00:00.000Z",
"startOfDayIntervalMatching": false
}
},
"dateCreated": "2021-02-15T16:43:34.457Z",
"totalConversations": 0,
"totalRecordings": 0,
"totalProcessedRecordings": 0,
"percentProgress": 0,
"selfUri": "/api/v2/recording/jobs/64cb3524-128d-46ec-9661-612ac0819816",
"user": {
"id": "1b7b2ec6-a6dd-4b85-b5e0-91d0c5ddda6d",
"selfUri": "/api/v2/users/1b7b2ec6-a6dd-4b85-b5e0-91d0c5ddda6d"
}
}
2) Checking the Status of Job. (READY)

Web Service Configuration


URL Endpoint Web Service Verb Header
/api/v2/recording/jobs/{jobId} GET *optional

Input:
jobId : 64cb3524-128d-46ec-9661-612ac0819816

Output:
{
"id": "64cb3524-128d-46ec-9661-612ac0819816",
"state": "READY",
"recordingJobsQuery": {
"action": "DELETE",
"actionDate": "2021-02-15T16:45:00Z",
"includeScreenRecordings": true,
"conversationQuery": {
"segmentFilters": [
{
"type": "or",
"predicates": [
{
"type": "dimension",
"dimension": "mediaType",
"operator": "matches",
"value": "voice"
}
]
},
{
"type": "or",
"predicates": [
{
"type": "dimension",
"dimension": "queueId",
"operator": "matches",
"value": "03d4edff-a657-43a8-851a-61a13892119f"
},
{
"type": "dimension",
"dimension": "queueId",
"operator": "matches",
"value": "a4a7b434-8065-48c2-9d9a-1b8706c8317c"
},
{
"type": "dimension",
"dimension": "queueId",
"operator": "matches",
"value": "630d854a-32aa-491e-8633-7b4394affcd4"
},
{
"type": "dimension",
"dimension": "queueId",
"operator": "matches",
"value": "ce642194-1333-47c8-87dd-966b09507c18"
},
{
"type": "dimension",
"dimension": "queueId",
"operator": "matches",
"value": "615b852c-92a6-49d6-9c85-99eecf781468"
},
{
"type": "dimension",
"dimension": "queueId",
"operator": "matches",
"value": "a6d9b881-5bbe-4380-869a-2d867e1ad3d7"
}
]
}
],
"order": "desc",
"orderBy": "conversationStart",
"interval": "2020-11-16T00:00:00.000Z/2021-02-15T00:00:00.000Z",
"startOfDayIntervalMatching": false
}
},
"dateCreated": "2021-02-15T16:43:34.457Z",
"totalConversations": 1112,
"totalRecordings": 1421,
"totalProcessedRecordings": 0,
"percentProgress": 0,
"selfUri": "/api/v2/recording/jobs/64cb3524-128d-46ec-9661-612ac0819816",
"user": {
"id": "1b7b2ec6-a6dd-4b85-b5e0-91d0c5ddda6d",
"selfUri": "/api/v2/users/1b7b2ec6-a6dd-4b85-b5e0-91d0c5ddda6d"
}
}
3) Executing Deletion Job.
Web Service Configuration
URL Endpoint Web Service Verb Header
/api/v2/recording/jobs/{jobId} PUT *optional

Input:
jobId : 64cb3524-128d-46ec-9661-612ac0819816
{
"state": "PROCESSING"
}

Output:
4) Checking the Status of Job. (COMPLETED)

Web Service Configuration


URL Endpoint Web Service Verb Header
/api/v2/recording/jobs/{jobId} GET *optional

Input:
jobId : 64cb3524-128d-46ec-9661-612ac0819816

Output:
{
"id": "64cb3524-128d-46ec-9661-612ac0819816",
"state": "FULFILLED",
"recordingJobsQuery": {
"action": "DELETE",
"actionDate": "2021-02-15T16:45:00Z",
"includeScreenRecordings": true,
"conversationQuery": {
"segmentFilters": [
{
"type": "or",
"predicates": [
{
"type": "dimension",
"dimension": "mediaType",
"operator": "matches",
"value": "voice"
}
]
},
{
"type": "or",
"predicates": [
{
"type": "dimension",
"dimension": "queueId",
"operator": "matches",
"value": "03d4edff-a657-43a8-851a-61a13892119f"
},
{
"type": "dimension",
"dimension": "queueId",
"operator": "matches",
"value": "a4a7b434-8065-48c2-9d9a-1b8706c8317c"
},
{
"type": "dimension",
"dimension": "queueId",
"operator": "matches",
"value": "630d854a-32aa-491e-8633-7b4394affcd4"
},
{
"type": "dimension",
"dimension": "queueId",
"operator": "matches",
"value": "ce642194-1333-47c8-87dd-966b09507c18"
},
{
"type": "dimension",
"dimension": "queueId",
"operator": "matches",
"value": "615b852c-92a6-49d6-9c85-99eecf781468"
},
{
"type": "dimension",
"dimension": "queueId",
"operator": "matches",
"value": "a6d9b881-5bbe-4380-869a-2d867e1ad3d7"
}
]
}
],
"order": "desc",
"orderBy": "conversationStart",
"interval": "2020-11-16T00:00:00.000Z/2021-02-15T00:00:00.000Z",
"startOfDayIntervalMatching": false
}
},
"dateCreated": "2021-02-15T16:43:34.457Z",
"totalConversations": 1112,
"totalRecordings": 1421,
"totalProcessedRecordings": 1421,
"percentProgress": 100,
"selfUri": "/api/v2/recording/jobs/64cb3524-128d-46ec-9661-612ac0819816",
"user": {
"id": "1b7b2ec6-a6dd-4b85-b5e0-91d0c5ddda6d",
"selfUri": "/api/v2/users/1b7b2ec6-a6dd-4b85-b5e0-91d0c5ddda6d"
}
}
Overall Result:
Deletion Job ID: 64cb3524-128d-46ec-9661-612ac0819816
Date Range: 16th Nov 2020 – 15th Feb 2021 UTC
Total Recordings Deleted: 1421 records
Call Type: Inbound and Outbound
Recording Deleted: Voice and Screen

You might also like