你当前正在访问 Microsoft Azure Global Edition 技术文档网站。如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

Web Hooks - Create

参考

服务:: Azure AI Services

API 版本:: v3.2-preview.2

创建新的 Web 挂钩。
如果配置中的属性机密存在并且包含非空字符串，则它将用于创建有效负载的 SHA256 哈希，并将机密用作 HMAC 密钥。调用回注册的 URL 时，此哈希将设置为 X-MicrosoftSpeechServices-Signature 标头。

当调用回注册的 URL 时，请求将包含一个 X-MicrosoftSpeechServices-Event 标头，其中包含其中一个已注册的事件类型。每个已注册的事件类型将有一个请求。

成功注册 Web 挂钩后，在完成质询/响应之前，它将无法使用。为此，将使用名为 validationToken 的查询参数发出具有事件类型质询的请求。使用包含 validationToken 查询参数的值作为响应正文的 200 OK 来响应质询。成功完成质询/响应后，Web 挂钩将开始接收事件。

POST {endpoint}/speechtotext/v3.2-preview.2/webhooks

URI 参数

名称	在	必需	类型	说明
endpoint	path	True	string	支持的认知服务终结点 (协议和主机名，例如： https://westus.api.cognitive.microsoft.com) 。

请求正文

名称	必需	类型	说明
displayName	True	string	对象的显示名称。
events	True	WebHookEvents	WebHookEvents
webUrl	True	string	将用于向其发送已注册事件的 POST 请求的已注册 URL。
customProperties		object	此实体的自定义属性。允许的最大密钥长度为 64 个字符，允许的最大值长度为 256 个字符，允许的条目计数为 10。
description		string	对象的说明。
properties		WebHookProperties	WebHookProperties

响应

名称	类型	说明
201 Created	WebHook	响应包含有关实体作为有效负载及其作为标头的位置的信息。标头 Location: string
Other Status Codes	Error	出现了错误。

名称

类型

说明

201 Created

WebHook

响应包含有关实体作为有效负载及其作为标头的位置的信息。

标头

Location: string

Other Status Codes

Error

出现了错误。

安全性

Ocp-Apim-Subscription-Key

在此处提供认知服务帐户密钥。

类型: apiKey
在: header

Authorization

提供此区域的 STS 返回的 JWT 的访问令牌。通过将以下查询字符串添加到 STS URL，确保将管理范围添加到令牌：？scope=speechservicesmanagement

类型: apiKey
在: header

示例

Create a web hook

示例请求

HTTP

POST {endpoint}/speechtotext/v3.2-preview.2/webhooks

{
  "displayName": "TranscriptionCompletionWebHook",
  "properties": {
    "secret": "$CREDENTIAL_PLACEHOLDER$"
  },
  "webUrl": "https://contoso.com/call/me/back",
  "events": {
    "transcriptionCompletion": true
  },
  "description": "I registered this URL to get a POST request for each completed transcription."
}

示例响应

状态代码:: 201

Location: https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/webhooks/2e856efe-ef53-465a-a632-6a084c1d349d

{
  "displayName": "TranscriptionCompletionWebHook",
  "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/webhooks/2e856efe-ef53-465a-a632-6a084c1d349d",
  "links": {
    "ping": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/webhooks/2e856efe-ef53-465a-a632-6a084c1d349d:test",
    "test": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/webhooks/2e856efe-ef53-465a-a632-6a084c1d349d:ping"
  },
  "properties": {
    "apiVersion": "v3.2-preview.2",
    "secret": "$CREDENTIAL_PLACEHOLDER$"
  },
  "webUrl": "https://contoso.com/call/me/back",
  "events": {
    "transcriptionCompletion": true
  },
  "description": "I registered this URL to get a POST request for each completed transcription.",
  "createdDateTime": "2018-11-11T00:00:00Z",
  "lastActionDateTime": "2018-11-28T00:00:00Z",
  "status": "NotStarted"
}

定义

名称	说明
DetailedErrorCode	DetailedErrorCode
EntityError	EntityError
Error	错误
ErrorCode	ErrorCode
InnerError	InnerError
Status	状态
WebHook	WebHook
WebHookEvents	WebHookEvents
WebHookLinks	WebHookLinks
WebHookProperties	WebHookProperties

DetailedErrorCode

名称	类型	说明
DataImportFailed	string	数据导入失败。
DeleteNotAllowed	string	不允许删除。
DeployNotAllowed	string	不允许部署。
DeployingFailedModel	string	部署失败的模型。
EmptyRequest	string	空请求。
EndpointCannotBeDefault	string	终结点不能为默认值。
EndpointNotUpdatable	string	终结点不可更新。
EndpointWithoutLogging	string	不记录的终结点。
ExceededNumberOfRecordingsUris	string	已超出录制 URI 数。
FailedDataset	string	失败的数据集。
Forbidden	string	已禁止。
InUseViolation	string	在使用中冲突。
InaccessibleCustomerStorage	string	无法访问的客户存储。
InvalidAdaptationMapping	string	无效的适应映射。
InvalidBaseModel	string	基本模型无效。
InvalidCallbackUri	string	回调 URI 无效。
InvalidCollection	string	集合无效。
InvalidDataset	string	无效的数据集。
InvalidDocument	string	无效的文档。
InvalidDocumentBatch	string	无效的文档批处理。
InvalidLocale	string	区域设置无效。
InvalidLogDate	string	日志日期无效。
InvalidLogEndTime	string	日志结束时间无效。
InvalidLogId	string	日志 ID 无效。
InvalidLogStartTime	string	日志开始时间无效。
InvalidModel	string	无效的模型。
InvalidModelUri	string	无效的模型 URI。
InvalidParameter	string	参数无效。
InvalidParameterValue	string	参数值无效。
InvalidPayload	string	有效负载无效。
InvalidPermissions	string	权限无效。
InvalidPrerequisite	string	先决条件无效。
InvalidProductId	string	产品 ID 无效。
InvalidProject	string	无效的项目。
InvalidProjectKind	string	无效的项目类型。
InvalidRecordingsUri	string	录制 URI 无效。
InvalidRequestBodyFormat	string	请求正文格式无效。
InvalidSasValidityDuration	string	sas 有效性持续时间无效。
InvalidSkipTokenForLogs	string	日志的跳过令牌无效。
InvalidSourceAzureResourceId	string	源 Azure 资源 ID 无效。
InvalidSubscription	string	无效的订阅。
InvalidTest	string	测试无效。
InvalidTimeToLive	string	生存时间无效。
InvalidTopForLogs	string	日志顶部无效。
InvalidTranscription	string	听录无效。
InvalidWebHookEventKind	string	Web 挂钩事件类型无效。
MissingInputRecords	string	缺少输入记录。
ModelCopyOperationExists	string	模型复制操作存在。
ModelDeploymentNotCompleteState	string	模型部署未完成状态。
ModelDeprecated	string	模型已弃用。
ModelExists	string	模型存在。
ModelMismatch	string	模型不匹配。
ModelNotDeployable	string	模型不可部署。
ModelVersionIncorrect	string	模型版本不正确。
NoUtf8WithBom	string	没有带有 bom 的 utf8。
OnlyOneOfUrlsOrContainerOrDataset	string	只有一个 URL 或容器或数据集。
ProjectGenderMismatch	string	项目性别不匹配。
QuotaViolation	string	配额冲突。
SingleDefaultEndpoint	string	单个默认终结点。
SkuLimitsExist	string	存在 SKU 限制。
SubscriptionNotFound	string	找不到订阅。
UnexpectedError	string	意外错误。
UnsupportedClassBasedAdaptation	string	不支持的基于类的适应。
UnsupportedDelta	string	不支持的增量。
UnsupportedDynamicConfiguration	string	不支持的动态配置。
UnsupportedFilter	string	不支持的筛选器。
UnsupportedLanguageCode	string	不支持的语言代码。
UnsupportedOrderBy	string	不支持的订单依据。
UnsupportedPagination	string	不支持的分页。
UnsupportedTimeRange	string	不支持的时间范围。

EntityError

名称	类型	说明
code	string	此错误的代码。
message	string	此错误的消息。

Error

错误

名称	类型	说明
code	ErrorCode	ErrorCode 高级错误代码。
details	Error[]	有关错误和/或预期策略的其他支持性详细信息。
innerError	InnerError	InnerError 新的内部错误格式，符合认知服务 API 指南，可从 https://microsoft.sharepoint.com/%3Aw%3A/t/CognitiveServicesPMO/EUoytcrjuJdKpeOKIK_QRC8BPtUYQpKBi8JsWyeDMRsWlQ?e=CPq8ow获取。这包含必需的属性 ErrorCode、消息和可选属性目标、详细信息（键值对）、内部错误（可以嵌套）。
message	string	高级别错误消息。
target	string	错误的源。例如，如果文档无效，应为“文档”或“文档 ID”。

ErrorCode

名称	类型	说明
Conflict	string	表示冲突错误代码。
Forbidden	string	表示禁止的错误代码。
InternalCommunicationFailed	string	表示内部通信失败的错误代码。
InternalServerError	string	表示内部服务器错误代码。
InvalidArgument	string	表示无效参数错误代码。
InvalidRequest	string	表示无效请求错误代码。
NotAllowed	string	表示不允许的错误代码。
NotFound	string	表示“找不到”错误代码。
PipelineError	string	表示管道错误代码。
ServiceUnavailable	string	表示服务不可用错误代码。
TooManyRequests	string	表示请求过多错误代码。
Unauthorized	string	表示未经授权的错误代码。
UnprocessableEntity	string	表示不可处理的实体错误代码。
UnsupportedMediaType	string	表示不受支持的媒体类型错误代码。

InnerError

名称	类型	说明
code	DetailedErrorCode	DetailedErrorCode 详细的错误代码枚举。
details	object	有关错误和/或预期策略的其他支持性详细信息。
innerError	InnerError	InnerError 新的内部错误格式，符合认知服务 API 指南，可从 https://microsoft.sharepoint.com/%3Aw%3A/t/CognitiveServicesPMO/EUoytcrjuJdKpeOKIK_QRC8BPtUYQpKBi8JsWyeDMRsWlQ?e=CPq8ow获取。这包含必需的属性 ErrorCode、消息和可选属性目标、详细信息（键值对）、内部错误（可以嵌套）。
message	string	高级别错误消息。
target	string	错误的源。例如，如果文档无效，应为“文档”或“文档 ID”。

Status

状态

名称	类型	说明
Failed	string	长时间运行的操作失败。
NotStarted	string	长时间运行的操作尚未启动。
Running	string	长时间运行的操作当前正在处理。
Succeeded	string	长时间运行的操作已成功完成。

WebHook

名称	类型	说明
createdDateTime	string	创建对象时的时间戳。时间戳编码为 ISO 8601 日期和时间格式 (“YYYY-MM-DDThh：mm：ssZ”，请参阅 https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) 。
customProperties	object	此实体的自定义属性。允许的最大密钥长度为 64 个字符，允许的最大值长度为 256 个字符，允许的条目计数为 10。
description	string	对象的说明。
displayName	string	对象的显示名称。
events	WebHookEvents	WebHookEvents
lastActionDateTime	string	输入当前状态时的时间戳。时间戳编码为 ISO 8601 日期和时间格式 (“YYYY-MM-DDThh：mm：ssZ”，请参阅 https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) 。
links	WebHookLinks	WebHookLinks
properties	WebHookProperties	WebHookProperties
self	string	此实体的位置。
status	Status	状态描述 API 的当前状态
webUrl	string	将用于向其发送已注册事件的 POST 请求的已注册 URL。

WebHookEvents

名称	类型	说明
challenge	boolean
datasetCompletion	boolean
datasetCreation	boolean
datasetDeletion	boolean
datasetProcessing	boolean
endpointCompletion	boolean
endpointCreation	boolean
endpointDeletion	boolean
endpointProcessing	boolean
evaluationCompletion	boolean
evaluationCreation	boolean
evaluationDeletion	boolean
evaluationProcessing	boolean
modelCompletion	boolean
modelCreation	boolean
modelDeletion	boolean
modelProcessing	boolean
ping	boolean
transcriptionCompletion	boolean
transcriptionCreation	boolean
transcriptionDeletion	boolean
transcriptionProcessing	boolean

WebHookLinks

名称	类型	说明
ping	string	可用于触发将 ping 事件发送到 Web 挂钩注册的已注册 URL 的 URL。有关更多详细信息，请参阅操作“WebHooks_Ping”。
test	string	可用于将测试事件发送到 Web 挂钩注册的已注册 URL 的 URL。有关更多详细信息，请参阅操作“WebHooks_Test”。

WebHookProperties

名称	类型	说明
apiVersion	string	创建 Web 挂钩的 API 版本。这将定义回调中有效负载的形状。如果不再支持有效负载类型，因为形状已更改，且在弃用) 后 (删除了使用该类型的 API 版本，则会禁用 Web 挂钩。
error	EntityError	EntityError
secret	string	一个机密，用于创建有效负载的 SHA256 哈希，并将机密作为 HMAC 密钥。调用回已注册的 URL 时，此哈希将设置为 X-MicrosoftSpeechServices-Signature 标头。

通过

Web Hooks - Create

URI 参数

请求正文

响应

安全性

Ocp-Apim-Subscription-Key

Authorization

示例

Create a web hook

示例请求

示例响应

定义

DetailedErrorCode

EntityError

Error

ErrorCode

InnerError

Status

WebHook

WebHookEvents

WebHookLinks

WebHookProperties

其他资源