Retrieve voice recording playback URL or redirect

GET

/api/needs/{id}/recordings/{interaction_id}

const url = 'https://example.com/api/needs/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/recordings/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://example.com/api/needs/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/recordings/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
  --header 'Authorization: Bearer <token>'

Authorizations

BearerAuth

Parameters

Path Parameters

required

string format: uuid

interaction_id

required

string format: uuid

Query Parameters

format

string

Pass “json” to receive signed URL payload instead of 302 redirect

Responses

200

Signed media URL response

application/json

object

url

required

string

duration_seconds

integer

nullable

storage_type

required

string

Allowed values: archived ephemeral

Example

{
  "storage_type": "archived"
}

302

Redirect directly to audio media stream

401

Unauthorized

403

Forbidden (requires recordings:read)

404

Recording or need not found