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:

storageProvider

Storage provider. Currently supported storage providers: 

• S3

credentials

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

{
  "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.