Consents - Create

Service:: Azure AI Services

API-versie:: 2026-01-01

Maakt een nieuwe stemacteur aan met de verstrekte audio-URL.

PUT {endpoint}/customvoice/consents/{id}?api-version=2026-01-01

URI-parameters

Name	In	Vereist	Type	Description
endpoint	path	True	string (uri)	Ondersteunde Cognitive Services-eindpunten (protocol en hostnaam, bijvoorbeeld: https://eastus.api.cognitive.microsoft.com).
id	path	True	string minLength: 3 maxLength: 64 pattern: ^[a-zA-Z0-9][a-zA-Z0-9._-]{1,62}[a-zA-Z0-9]$	Resource-id
api-version	query	True	string minLength: 1	De API-versie die voor deze bewerking moet worden gebruikt.

Aanvraagkoptekst

Name	Vereist	Type	Description
Operation-Id		string minLength: 3 maxLength: 64 pattern: ^[a-zA-Z0-9][a-zA-Z0-9._-]{1,62}[a-zA-Z0-9]$	ID van de statusmonitor voor de operatie. Als de Operation-Id header overeenkomt met een bestaande bewerking en het verzoek niet identiek is aan het vorige verzoek, zal het falen met een 400 Bad Request.

Aanvraagbody

Name	Vereist	Type	Description
companyName	True	string minLength: 1	Bedrijfsnaam. Moet overeenkomen met de bedrijfsnaam in het toestemmingsaudiobestand.
locale	True	string	De locatie van deze toestemming. De locatiecode volgt BCP-47. Je kunt hier de tekst-naar-spraak locatielijst https://learn.microsoft.com/azure/ai-services/speech-service/language-support?tabs=ttsvinden.
projectId	True	string minLength: 3 maxLength: 64 pattern: ^[a-zA-Z0-9][a-zA-Z0-9._-]{1,62}[a-zA-Z0-9]$	Resource-id
voiceTalentName	True	string minLength: 1	Naam stemacteur. Moet overeenkomen met de naam van de stemacteur in het toestemmingsaudiobestand.
audioUrl		string (uri)	De openbaar toegankelijke URL van het toestemmingsaudiobestand. Het wordt aanbevolen om een Azure blob-URL te zijn met SAS. Dit eigendom is alleen beschikbaar op aanvraag.
description		string	Beschrijving van toestemming.
displayName		string minLength: 1	Naam van toestemming.
properties		ConsentProperties	Toestemmingswoningen
status		Status	Status van een hulpbron.

Antwoorden

Name	Type	Description
200 OK	Consent	De aanvraag is voltooid. Kopteksten Operation-Location: string
201 Created	Consent	De aanvraag is geslaagd en er is een nieuwe resource gemaakt. Kopteksten Operation-Location: string
Other Status Codes	Azure.Core.Foundations.ErrorResponse	Een onverwachte foutreactie. Kopteksten x-ms-error-code: string

Name

Type

Description

200 OK

Consent

De aanvraag is voltooid.

Kopteksten

Operation-Location: string

201 Created

Consent

De aanvraag is geslaagd en er is een nieuwe resource gemaakt.

Kopteksten

Operation-Location: string

Other Status Codes

Azure.Core.Foundations.ErrorResponse

Een onverwachte foutreactie.

Kopteksten

x-ms-error-code: string

Beveiliging

Ocp-Apim-Subscription-Key

Type: apiKey
In: header

OAuth2Auth

Type: oauth2
Stroom: implicit
Autorisatie-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiken

Name	Description
https://cognitiveservices.azure.com/.default

Voorbeelden

Voorbeeldaanvraag

HTTP

PUT {endpoint}/customvoice/consents/Jessica?api-version=2026-01-01


{
  "description": "Consent for Jessica voice",
  "audioUrl": "https://contoso.blob.core.windows.net/public/jessica-consent.wav?mySasToken",
  "companyName": "Contoso",
  "locale": "en-US",
  "projectId": "Jessica",
  "voiceTalentName": "Jessica Smith"
}

Voorbeeldrespons

Statuscode:: 200

Operation-Location: https://eastus.api.cognitive.microsoft.com/customvoice/operations/070f7986-ef17-41d0-ba2b-907f0f28e314?api-version=2026-01-01

{
  "description": "Consent for Jessica voice",
  "companyName": "Contoso",
  "createdDateTime": "2023-04-01T05:30:00.000Z",
  "id": "Jessica",
  "lastActionDateTime": "2023-04-02T10:15:30.000Z",
  "locale": "en-US",
  "projectId": "Jessica",
  "status": "NotStarted",
  "voiceTalentName": "Jessica Smith"
}

Statuscode:: 201

Operation-Location: https://eastus.api.cognitive.microsoft.com/customvoice/operations/070f7986-ef17-41d0-ba2b-907f0f28e314?api-version=2026-01-01

{
  "description": "Consent for Jessica voice",
  "companyName": "Contoso",
  "createdDateTime": "2023-04-01T05:30:00.000Z",
  "id": "Jessica",
  "lastActionDateTime": "2023-04-02T10:15:30.000Z",
  "locale": "en-US",
  "projectId": "Jessica",
  "status": "NotStarted",
  "voiceTalentName": "Jessica Smith"
}

Definities

Name	Description
Azure.Core.Foundations.Error	Het foutobject.
Azure.Core.Foundations.ErrorResponse	Een antwoord met foutdetails.
Azure.Core.Foundations.InnerError	Een object met meer specifieke informatie over de fout. Volgens Azure REST API-richtlijnen - https://aka.ms/AzureRestApiGuidelines#handling-errors.
Consent	Toestemmingsobject
ConsentFailureReason	Reden voor het mislukken van het creëren van toestemming
ConsentProperties	Toestemmingswoningen
Status	Status van een hulpbron.

Azure.Core.Foundations.Error

Object

Het foutobject.

Name	Type	Description
code	string	Een van een door de server gedefinieerde set foutcodes.
details	Azure.Core.Foundations.Error[]	Een matrix met details over specifieke fouten die hebben geleid tot deze gemelde fout.
innererror	Azure.Core.Foundations.InnerError	Een object met meer specifieke informatie dan het huidige object over de fout.
message	string	Een leesbare weergave van de fout.
target	string	Het doel van de fout.

Azure.Core.Foundations.ErrorResponse

Object

Een antwoord met foutdetails.

Name	Type	Description
error	Azure.Core.Foundations.Error	Het foutobject.

Azure.Core.Foundations.InnerError

Object

Een object met meer specifieke informatie over de fout. Volgens Azure REST API-richtlijnen - https://aka.ms/AzureRestApiGuidelines#handling-errors.

Name	Type	Description
code	string	Een van een door de server gedefinieerde set foutcodes.
innererror	Azure.Core.Foundations.InnerError	Interne fout.

Object

Toestemmingsobject

Name	Type	Description
audioUrl	string (uri)	De openbaar toegankelijke URL van het toestemmingsaudiobestand. Het wordt aanbevolen om een Azure blob-URL te zijn met SAS. Dit eigendom is alleen beschikbaar op aanvraag.
companyName	string minLength: 1	Bedrijfsnaam. Moet overeenkomen met de bedrijfsnaam in het toestemmingsaudiobestand.
createdDateTime	string (date-time)	De tijdstempel waarop het object is gemaakt. De tijdstempel wordt gecodeerd als ISO 8601 datum- en tijdformaat ("YYYY-MM-DDThh:mm:ssZ", zie https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations)
description	string	Beschrijving van toestemming.
displayName	string minLength: 1	Naam van toestemming.
id	string minLength: 3 maxLength: 64 pattern: ^[a-zA-Z0-9][a-zA-Z0-9._-]{1,62}[a-zA-Z0-9]$	Resource-id
lastActionDateTime	string (date-time)	De tijdstempel waarop de huidige status is ingevoerd. De tijdstempel wordt gecodeerd als ISO 8601-datum- en tijdnotatie ('JJJJ-MM-DDThh:mm:ssZ', zie https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).
locale	string	De locatie van deze toestemming. De locatiecode volgt BCP-47. Je kunt hier de tekst-naar-spraak locatielijst https://learn.microsoft.com/azure/ai-services/speech-service/language-support?tabs=ttsvinden.
projectId	string minLength: 3 maxLength: 64 pattern: ^[a-zA-Z0-9][a-zA-Z0-9._-]{1,62}[a-zA-Z0-9]$	Resource-id
properties	ConsentProperties	Toestemmingswoningen
status	Status	Status van een hulpbron.
voiceTalentName	string minLength: 1	Naam stemacteur. Moet overeenkomen met de naam van de stemacteur in het toestemmingsaudiobestand.

ConsentFailureReason

Opsomming

Reden voor het mislukken van het creëren van toestemming

Waarde	Description
AudioAndScriptNotMatch	De geluidsmismatch van toestemming en de mondelinge verklaring. Controleer alsjeblieft verbal-statement.
Internal	Fout bij aangepaste spraakservice.

ConsentProperties

Object

Toestemmingswoningen

Name	Type	Description
failureReason	ConsentFailureReason	Reden voor het mislukken van het creëren van toestemming

Status

Opsomming

Status van een hulpbron.

Waarde	Description
NotStarted	Niet gestart
Running	Hardlopen
Succeeded	Geslaagd
Failed	Mislukt
Disabling	Uitschakelen
Disabled	Disabled

Consents - Create

URI-parameters

Aanvraagkoptekst

Aanvraagbody

Antwoorden

Beveiliging

Ocp-Apim-Subscription-Key

OAuth2Auth

Bereiken

Voorbeelden

Create a consent

Voorbeeldaanvraag

Voorbeeldrespons

Definities

Azure.Core.Foundations.Error

Azure.Core.Foundations.ErrorResponse

Azure.Core.Foundations.InnerError

Consent

ConsentFailureReason

ConsentProperties

Status