The POST /interactions/external-storage endpoint enables you to create an external storage item that will be used to authenticate Vonage Contact Center to transfer data from VCC to the storage provider.
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 the following body parameters:
storageProvider
Type | Required | Example |
|---|---|---|
| String | True | S3 |
Storage provider. Currently supported storage providers:
- S3
credentials
| Type | Required | Example |
|---|---|---|
| Object | True |
|
Credentials to the external storage that allow VCC to transfer data to it. The format of the object depends on the selected provider. For more information see the following table:
| Provider | Format |
|---|---|
| S3 | { |
Requests
Example request
curl -L -X POST "https://***.api.cc.vonage.com/interaction-content-export/external-storage" \ -H "Authorization: Bearer <ACCESS_TOKEN>" \ -H "Accept: application/vnd.newvoicemedia.v1+json" \ --data-raw "<JSON BODY>"
Required parameters for S3 storage provider
{
"storageProvider": "S3",
"credentials": {
"roleArn": "arn:aws:iam::account:role/role-name-with-path",
"region": "us-east-1",
"bucketName": "customer-bucket"
}
}
Responses
Responses to the endpoint return the ID of the created storage item.
Successful response
For information about successful responses, see Success response code and parameters in Responses (Interaction Content Export API).
Example responses
{
"jobId": "74137e23-9716-4e5c-ad92-36343c248282"
}
where:
jobId. The unique identifier of the external storage item.
For information, see Trying out Vonage Contact Center APIs.