List external storage items

Owned by Helen Griffith
Last updated: Dec 17, 2024


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

Request

Request to list external storage items

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

{
  "externalStorages": [
    {
      "name": "External storage",
      "externalStorageId": "74137e23-9716-4e5c-ad92-36343c248282",
      "storageProvider": "AWS_S3",
      "credentials": {
        "roleArn": "arn:aws:iam::account:role/role-name-with-path",
        "region": "us-east-1",
        "bucketName": "customer bucket"
      },
	  "auditDetails": {
		"createdAt":"2024-07-08T11:55:31Z",
		"createdBy": "CustomerUser"
	  }
    }
  ]
}

where:

  • name. Name of the external storage item.
  • 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.
  • auditDetails. The JSON object containing audit data regarding the creation of the external storage item:
    • createdAt. The time date and time that the external storage item was created in ISO 8601 format.
    • createdBy. The name of the user who created external storage item.


Try it out

  

For information, see Trying out Vonage Contact Center APIs.