Versions Compared

Key

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

Insert excerpt
_ExcerptBetaAPI
_ExcerptBetaAPI
nopaneltrue

The GET/interactions/external-storage endpoint enables you to list external storage items 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 no parameters.

Request

Request to list external storage items

Code Block
languagepowershell
themeMidnight
curl -L -X GET "https://***.api.cc.vonage.com/interaction-content-export/external-storage" \
-H "Authorization: Bearer <ACCESS_TOKEN>" \
-H "Accept: application/vnd.newvoicemedia.v1+json"

Responses

Responses to the endpoint return the list of all external storage items within the account.

Successful response

For information about successful responses, see Success response code and parameters in Responses (Interaction Content Export API).

Example responses

Code Block
languagejs
themeMidnight
{
  "externalStorages": [
    {
      "externalStorageId": "74137e23-9716-4e5c-ad92-36343c248282",
      "storageProvider": "S3",
      "credentials": {
        "roleArn": "arn:aws:iam::account:role/role-name-with-path",
        "region": "us-east-1",
        "bucketName": "customer bucket"
      }
    }
  ]
}

where:

  • externalStorageId. The unique identifier of the external storage item.
  • storageProvider. External storage provider.
  • credentials. Used to authenticate Vonage Contact Center to transfer data to the external storage provider. The format of this object varies between different storage providers. For information, see Create an external storage item.

Insert excerpt
_ExcerptRunInPostman
_ExcerptRunInPostman
nopaneltrue