Create an external storage item

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.

Headers

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

Authorization scopes supported:

Parameters

The endpoint accepts the following body parameters:

name

External storage name.

storageProvider

Storage provider. Currently supported storage providers: 

• AWS_S3

credentials

{
  "roleArn": "arn:aws:iam::account:role/role-name-with-path",
  "region": "us-east-1",
  "bucketName": "customer-bucket"
}

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:

{
  "roleArn": "string",
  "region": "string",
  "bucketName": "string"
}

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

{
  "name": "External storage",
  "storageProvider": "AWS_S3",
  "credentials": {
    "roleArn": "arn:aws:iam::account:role/role-name-with-path",
    "region": "us-east-1",
    "bucketName": "customer-bucket"
  }
}

Responses

The following responses are specific to this endpoint. For information about all possible responses from the API, see Responses (Interaction Content Export API).

Success response

Successful responses to the endpoint return the ID of the created storage item.

Example success response

{
  "externalStorageId": "74137e23-9716-4e5c-ad92-36343c248282"
}

where:

• externalStorageId. The unique identifier of the external storage item.

Error response

After creating the storage item, the API uploads a zero-byte file to verify that the storage item was created successfully and is ready for use. If the upload fails, the API returns a 400 Bad Request error.

{
  "message": "External storage validation failed. Please verify storage configuration settings."
}