Consents - Create

Serviço:: Azure AI Services

Versão da API:: 2026-01-01

Cria um novo consentimento para o talento de voz com a URL de áudio fornecida.

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

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
endpoint	path	True	string (uri)	Pontos de extremidade de Serviços Cognitivos suportados (protocolo e nome do host, por exemplo: 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]$	ID do recurso
api-version	query	True	string minLength: 1	A versão da API a utilizar para esta operação.

Cabeçalho do Pedido

Name	Necessário	Tipo	Description
Operation-Id		string minLength: 3 maxLength: 64 pattern: ^[a-zA-Z0-9][a-zA-Z0-9._-]{1,62}[a-zA-Z0-9]$	ID do monitor de estado da operação. Se o cabeçalho Operation-Id corresponder a uma operação existente e o pedido não for idêntico ao pedido anterior, falhará com um pedido 400 Bad Request.

Corpo do Pedido

Name	Necessário	Tipo	Description
companyName	True	string minLength: 1	Nome da empresa. Deve corresponder ao nome da empresa no ficheiro áudio de consentimento.
locale	True	string	O local deste consentimento. O código local segue o BCP-47. Pode encontrar a lista de locais de texto para fala aqui https://learn.microsoft.com/azure/ai-services/speech-service/language-support?tabs=tts.
projectId	True	string minLength: 3 maxLength: 64 pattern: ^[a-zA-Z0-9][a-zA-Z0-9._-]{1,62}[a-zA-Z0-9]$	ID do recurso
voiceTalentName	True	string minLength: 1	Nome do talento de voz. Deve corresponder ao nome do talento de voz no ficheiro de áudio de consentimento.
audioUrl		string (uri)	O URL público acessível do ficheiro de áudio de consentimento. Recomenda-se ser um URL de blob Azure com SAS. Esta propriedade está disponível apenas mediante pedido.
description		string	Descrição do consentimento.
displayName		string minLength: 1	Nome do consentimento.
properties		ConsentProperties	Propriedades consentidas
status		Status	Estado de um recurso.

Respostas

Name	Tipo	Description
200 OK	Consent	O pedido foi bem-sucedido. Cabeçalhos Operation-Location: string
201 Created	Consent	O pedido foi bem-sucedido e, como resultado, foi criado um novo recurso. Cabeçalhos Operation-Location: string
Other Status Codes	Azure.Core.Foundations.ErrorResponse	Uma resposta de erro inesperada. Cabeçalhos x-ms-error-code: string

Name

Tipo

Description

200 OK

Consent

O pedido foi bem-sucedido.

Cabeçalhos

Operation-Location: string

201 Created

Consent

O pedido foi bem-sucedido e, como resultado, foi criado um novo recurso.

Cabeçalhos

Operation-Location: string

Other Status Codes

Azure.Core.Foundations.ErrorResponse

Uma resposta de erro inesperada.

Cabeçalhos

x-ms-error-code: string

Segurança

Ocp-Apim-Subscription-Key

Tipo: apiKey
Em: header

OAuth2Auth

Tipo: oauth2
Fluxo: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Âmbitos

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

Exemplos

Pedido de amostra

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"
}

Resposta da amostra

Código de estado:: 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"
}

Código de estado:: 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"
}

Definições

Name	Description
Azure.Core.Foundations.Error	O objeto de erro.
Azure.Core.Foundations.ErrorResponse	Uma resposta contendo detalhes do erro.
Azure.Core.Foundations.InnerError	Um objeto que contém informações mais específicas sobre o erro. De acordo com Azure diretrizes da API REST - https://aka.ms/AzureRestApiGuidelines#handling-errors.
Consent	Objeto de consentimento
ConsentFailureReason	Razão da falha na criação do consentimento
ConsentProperties	Propriedades consentidas
Status	Estado de um recurso.

Azure.Core.Foundations.Error

Object

O objeto de erro.

Name	Tipo	Description
code	string	Um de um conjunto de códigos de erro definido pelo servidor.
details	Azure.Core.Foundations.Error[]	Uma matriz de detalhes sobre erros específicos que levaram a esse erro relatado.
innererror	Azure.Core.Foundations.InnerError	Um objeto que contém informações mais específicas do que o objeto atual sobre o erro.
message	string	Uma representação legível por humanos do erro.
target	string	O alvo do erro.

Azure.Core.Foundations.ErrorResponse

Object

Uma resposta contendo detalhes do erro.

Name	Tipo	Description
error	Azure.Core.Foundations.Error	O objeto de erro.

Azure.Core.Foundations.InnerError

Object

Um objeto que contém informações mais específicas sobre o erro. De acordo com Azure diretrizes da API REST - https://aka.ms/AzureRestApiGuidelines#handling-errors.

Name	Tipo	Description
code	string	Um de um conjunto de códigos de erro definido pelo servidor.
innererror	Azure.Core.Foundations.InnerError	Erro interno.

Object

Objeto de consentimento

Name	Tipo	Description
audioUrl	string (uri)	O URL público acessível do ficheiro de áudio de consentimento. Recomenda-se ser um URL de blob Azure com SAS. Esta propriedade está disponível apenas mediante pedido.
companyName	string minLength: 1	Nome da empresa. Deve corresponder ao nome da empresa no ficheiro áudio de consentimento.
createdDateTime	string (date-time)	O carimbo temporal em que o objeto foi criado. O carimbo temporal está codificado como formato de data e hora ISO 8601 ("YYYY-MM-DDThh:mm:ssZ", ver https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations)
description	string	Descrição do consentimento.
displayName	string minLength: 1	Nome do consentimento.
id	string minLength: 3 maxLength: 64 pattern: ^[a-zA-Z0-9][a-zA-Z0-9._-]{1,62}[a-zA-Z0-9]$	ID do recurso
lastActionDateTime	string (date-time)	O carimbo temporal em que o estado atual foi introduzido. O carimbo temporal está codificado como formato de data e hora ISO 8601 ("YYYY-MM-DDThh:mm:ssZ", ver https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).
locale	string	O local deste consentimento. O código local segue o BCP-47. Pode encontrar a lista de locais de texto para fala aqui https://learn.microsoft.com/azure/ai-services/speech-service/language-support?tabs=tts.
projectId	string minLength: 3 maxLength: 64 pattern: ^[a-zA-Z0-9][a-zA-Z0-9._-]{1,62}[a-zA-Z0-9]$	ID do recurso
properties	ConsentProperties	Propriedades consentidas
status	Status	Estado de um recurso.
voiceTalentName	string minLength: 1	Nome do talento de voz. Deve corresponder ao nome do talento de voz no ficheiro de áudio de consentimento.

ConsentFailureReason

Enumeração

Razão da falha na criação do consentimento

Valor	Description
AudioAndScriptNotMatch	A incompatibilidade áudio do consentimento com a declaração verbal. Por favor, verifique verbal-statement.
Internal	Erro do Serviço de Voz Personalizado.

ConsentProperties

Object

Propriedades consentidas

Name	Tipo	Description
failureReason	ConsentFailureReason	Razão da falha na criação do consentimento

Status

Enumeração

Estado de um recurso.

Valor	Description
NotStarted	Não Iniciado
Running	Running
Succeeded	Succeeded
Failed	Falha
Disabling	Desativando
Disabled	Disabled

Consents - Create

Parâmetros do URI

Cabeçalho do Pedido

Corpo do Pedido

Respostas

Segurança

Ocp-Apim-Subscription-Key

OAuth2Auth

Âmbitos

Exemplos

Create a consent

Pedido de amostra

Resposta da amostra

Definições

Azure.Core.Foundations.Error

Azure.Core.Foundations.ErrorResponse

Azure.Core.Foundations.InnerError

Consent

ConsentFailureReason

ConsentProperties

Status