List external storage items
- Helen Griffith
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.
Most URLs in the example code use the following values:
- ***. To access the API for your region, replace *** with the correct subdomain for your region:
Region URL subdomain Base URL EMEA emea https://emea.api.cc.vonage.com USA nam https://nam.api.cc.vonage.com APAC apac https://apac.api.cc.vonage.com - <ACCESS_TOKEN>. The value represents a bearer access token which you must use to validate every request. Replace <ACCESS_TOKEN> where used with your bearer access token. For information about getting a bearer access token, see How to authenticate with a Vonage Contact Center (VCC) API.
Headers
Header parameters in Requests (Interaction Content Export API) apply to this endpoint.
Authorization scopes supported:
| Scope | Access granted |
|---|---|
interaction-content:read | Entire 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": [
{
"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.
For information, see Trying out Vonage Contact Center APIs.