Consents - Create

Служба:: Azure AI Services

Версия API:: 2026-01-01

Создаёт новое согласие на голосовое мастерство с указанным аудиоадресом.

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

Параметры URI

Имя	В	Обязательно	Тип	Описание
endpoint	path	True	string (uri)	Поддерживаемые конечные точки Cognitive Services (протокол и имя узла, например: 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]$	Идентификатор ресурса
api-version	query	True	string minLength: 1	Версия API, используемая для данной операции.

Заголовок запроса

Имя	Обязательно	Тип	Описание
Operation-Id		string minLength: 3 maxLength: 64 pattern: ^[a-zA-Z0-9][a-zA-Z0-9._-]{1,62}[a-zA-Z0-9]$	ID мониторинга состояния операции. Если заголовок Operation-Id совпадает с существующей операцией, а запрос не идентичен предыдущему, он провалится с ошибочным запросом 400.

Текст запроса

Имя	Обязательно	Тип	Описание
companyName	True	string minLength: 1	Название компании. Должно совпадать с названием компании в аудиофайле согласия.
locale	True	string	Место этого согласия. Код локации соответствует BCP-47. Вы можете найти список местоположения для превращения текста в речь здесь 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]$	Идентификатор ресурса
voiceTalentName	True	string minLength: 1	Имя озвучивания. Должно совпадать с именем голоса в аудиофайле согласия.
audioUrl		string (uri)	Общедоступный URL аудиофайла согласия. Рекомендуется использовать URL Azure blob с SAS. Эта недвижимость доступна только по запросу.
description		string	Описание согласия.
displayName		string minLength: 1	Имя согласия.
properties		ConsentProperties	Свойства согласия
status		Status	Статус ресурса.

Ответы

Имя	Тип	Описание
200 OK	Consent	Запрос выполнен успешно. Заголовки Operation-Location: string
201 Created	Consent	Запрос успешно выполнен, и в результате был создан новый ресурс. Заголовки Operation-Location: string
Other Status Codes	Azure.Core.Foundations.ErrorResponse	Непредвиденное сообщение об ошибке. Заголовки x-ms-error-code: string

Имя

Тип

Описание

200 OK

Consent

Запрос выполнен успешно.

Заголовки

Operation-Location: string

201 Created

Consent

Запрос успешно выполнен, и в результате был создан новый ресурс.

Заголовки

Operation-Location: string

Other Status Codes

Azure.Core.Foundations.ErrorResponse

Непредвиденное сообщение об ошибке.

Заголовки

x-ms-error-code: string

Безопасность

Ocp-Apim-Subscription-Key

Тип: apiKey
В: header

OAuth2Auth

Тип: oauth2
Flow: implicit
URL-адрес авторизации: https://login.microsoftonline.com/common/oauth2/authorize

Области

Имя	Описание
https://cognitiveservices.azure.com/.default

Примеры

Образец запроса

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

Пример ответа

Код состояния:: 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"
}

Код состояния:: 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"
}

Определения

Имя	Описание
Azure.Core.Foundations.Error	Объект ошибки.
Azure.Core.Foundations.ErrorResponse	Ответ, содержащий сведения об ошибке.
Azure.Core.Foundations.InnerError	Объект, содержащий более конкретные сведения об ошибке. Согласно Azure рекомендациям REST API — https://aka.ms/AzureRestApiGuidelines#handling-errors.
Consent	Объект согласия
ConsentFailureReason	Причина неудачи при создании согласия
ConsentProperties	Свойства согласия
Status	Статус ресурса.

Azure.Core.Foundations.Error

Объект

Объект ошибки.

Имя	Тип	Описание
code	string	Один из определяемых сервером кодов ошибок.
details	Azure.Core.Foundations.Error[]	Массив сведений об определенных ошибках, которые привели к этой сообщаемой ошибке.
innererror	Azure.Core.Foundations.InnerError	Объект, содержащий более конкретные сведения, чем текущий объект об ошибке.
message	string	Читаемое пользователем представление ошибки.
target	string	Целевой объект ошибки.

Azure.Core.Foundations.ErrorResponse

Объект

Ответ, содержащий сведения об ошибке.

Имя	Тип	Описание
error	Azure.Core.Foundations.Error	Объект ошибки.

Azure.Core.Foundations.InnerError

Объект

Объект, содержащий более конкретные сведения об ошибке. Согласно Azure рекомендациям REST API — https://aka.ms/AzureRestApiGuidelines#handling-errors.

Имя	Тип	Описание
code	string	Один из определяемых сервером кодов ошибок.
innererror	Azure.Core.Foundations.InnerError	Внутренняя ошибка.

Объект

Объект согласия

Имя	Тип	Описание
audioUrl	string (uri)	Общедоступный URL аудиофайла согласия. Рекомендуется использовать URL Azure blob с SAS. Эта недвижимость доступна только по запросу.
companyName	string minLength: 1	Название компании. Должно совпадать с названием компании в аудиофайле согласия.
createdDateTime	string (date-time)	Временная метка, когда объект был создан. Временная метка кодируется в формате даты и времени ISO 8601 («YYYY-MM-DDThh:mm:ssZ», см. https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations)
description	string	Описание согласия.
displayName	string minLength: 1	Имя согласия.
id	string minLength: 3 maxLength: 64 pattern: ^[a-zA-Z0-9][a-zA-Z0-9._-]{1,62}[a-zA-Z0-9]$	Идентификатор ресурса
lastActionDateTime	string (date-time)	Отметка времени ввода текущего статуса. Метка времени кодируется в формате даты и времени ISO 8601 («YYYY-MM-DDThh:mm:ssZ», см. https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).
locale	string	Место этого согласия. Код локации соответствует BCP-47. Вы можете найти список местоположения для превращения текста в речь здесь 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]$	Идентификатор ресурса
properties	ConsentProperties	Свойства согласия
status	Status	Статус ресурса.
voiceTalentName	string minLength: 1	Имя озвучивания. Должно совпадать с именем голоса в аудиофайле согласия.

ConsentFailureReason

Перечисление

Причина неудачи при создании согласия

Значение	Описание
AudioAndScriptNotMatch	Несовпадение аудио согласия с устным заявлением. Пожалуйста, проверьте verbal-statement.
Internal	Ошибка пользовательского голосового сервиса.

ConsentProperties

Объект

Свойства согласия

Имя	Тип	Описание
failureReason	ConsentFailureReason	Причина неудачи при создании согласия

Status

Перечисление

Статус ресурса.

Значение	Описание
NotStarted	Не начато
Running	Бег
Succeeded	Succeeded
Failed	Неудача
Disabling	Отключение
Disabled	Disabled

Consents - Create

Параметры URI

Заголовок запроса

Текст запроса

Ответы

Безопасность

Ocp-Apim-Subscription-Key

OAuth2Auth

Области

Примеры

Create a consent

Образец запроса

Пример ответа

Определения

Azure.Core.Foundations.Error

Azure.Core.Foundations.ErrorResponse

Azure.Core.Foundations.InnerError

Consent

ConsentFailureReason

ConsentProperties

Status