Delete up to 1000 interactions

Owned by Helen Griffith
Last updated: Aug 06, 2024

The POST /interactions/delete-batch endpoint deletes up to 1000 interactions together with their interaction content (call recordings, transcripts, and categorization results). Specify the interactions to delete using a list of interaction GUIDs. Send deletion requests individually. Concurrent deletions result in 429 Too Many Requests errors.

In this page


Most URLs in the example code use the following values:

Headers

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

Authorization scopes supported:

ScopeAccess granted

interaction-content:delete

Entire endpoint

Parameters

The endpoint accepts the following body parameters:

guids

Type

Required

Example

Array of stringsTrue{
  "guids": [
    "1870c11f-a216-4967-9f84-e5f39aff17f1",
    "ba11953e-dfdf-4f98-a53b-49ad6c31df58"
  ]
}

An array of unique identifiers (GUIDs) of the interactions to be deleted.

Request

Delete a batch of interactions

curl -L -X POST "https://***.api.newvoicemedia.com/interaction-content/interactions/delete-batch" \
-H "Accept: application/vnd.newvoicemedia.v3+json" \
-H "Authorization: Bearer <ACCESS_TOKEN>" \
-H "Content-Type: application/json" \
--data-raw "{
  \"guids\": [
    \"1870c11f-a216-4967-9f84-e5f39aff17f1\",
    \"ba11953e-dfdf-4f98-a53b-49ad6c31df58\"
  ]
}"

Body:

{
  "guids": [
    "1870c11f-a216-4967-9f84-e5f39aff17f1",
    "ba11953e-dfdf-4f98-a53b-49ad6c31df58"
  ]
}

Responses

Successful response

Successful request returns a 200 OK code with a list of failures. Failures indicate problems with specified GUIDs. If any interactions specified in the request do not exist, the request is still considered valid and results in a successful response. For information about successful responses, see Success response code and parameters in Responses (Interaction Content API).

Example responses

No failures

{
  "failures": []
}

Failures

{
  "failures": [
    {
      "guid": "e2ee5247-525e-4621-a031-f6da964b2ecc",
      "message": "Not authorized to remove GUID",
      "statusCode": 401
    }
  ]
}

where:

  • failures. A array of failed deletions messages.
    • guid. The unique identifier of the interaction that was not deleted.
    • message. Error message that describes what went wrong during deletion.
    • statusCode. HTTP response code for the error


Try it out

  

For information, see Trying out Vonage Contact Center APIs.