Sign in

v2

latestSwagger 2.02026-07-13323879.9 KB
Consent

Gets the consent identified by the given ID.

get/consents/{id}

Path parameters

idstring required

The ID of the resource.

Query parameters

api-versionstring required

The API version to use for this operation.

Response

Success

idstring

Resource id

displayNamestring

Name of consent.

descriptionstring

Description of consent.

voiceTalentNamestring required

Voice talent name. Must match the voice talent name in the consent audio file.

companyNamestring required

Company name. Must match the company name in the consent audio file.

audioUrlstring uri

The public accessible URL of the consent audio file. It's recommended to be an Azure blob URL with SAS. This property is only available in request.

localestring required

The locale of this consent. Locale code follows BCP-47. You can find the text to speech locale list here https://learn.microsoft.com/azure/ai-services/speech-service/language-support?tabs=tts.

projectIdstring required

Resource id

status'NotStarted' | 'Running' | 'Succeeded' | 'Failed' | 'Disabling' | 'Disabled'

Status of a resource.

createdDateTimestring date-time

The timestamp when the object was created. The timestamp is encoded as ISO 8601 date and time format ("YYYY-MM-DDThh:mm:ssZ", see https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations)

lastActionDateTimestring date-time

The timestamp when the current status was entered. The timestamp is encoded as ISO 8601 date and time format ("YYYY-MM-DDThh:mm:ssZ", see https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).

Example response

{
  "locale": "en-US"
}