Retrieve a voice consent recording

1 parameter

consent_idstringrequired

The identifier of the voice consent recording to retrieve.

1 status code

200Returns the voice consent object with its identifier, name, BCP 47 `language` tag, and Unix creation timestamp.

objectstringrequired

The object type, which is always `audio.voice_consent`.

Allowed:audio.voice_consent

idstringrequired

The consent recording identifier.

namestringrequired

The label provided when the consent recording was uploaded.

languagestringrequired

The BCP 47 language tag for the consent phrase (for example, `en-US`).

created_atintegerrequired

The Unix timestamp (in seconds) for when the consent recording was created.

Error handling

consent_id must identify the voice consent recording to retrieve.

import { Client } from "acme-sdk";

const client = new Client({
  baseUrl: "https://api.acme.com",
  auth: { bearer: process.env.API_TOKEN },
  retry: {
    maxAttempts: 3,
    retryOn: [
      408,
      425,
      429,
      500,
      502,
      503,
      504,
    ],
    backoffMs: 500,
    maxBackoffMs: 8000,
  },
  timeoutMs: 30000,
});

const result = await client.voiceConsents.get({ consentId: "9b2f1c10-7a3e-4d54-8c2a-1f6b9e0d4a21" });

{
  "object": "audio.voice_consent",
  "id": "cons_1234",
  "name": "Example Name",
  "language": "example_value",
  "created_at": 1
}

Request

Response

Errors