Web Hooks - Ping

Service:

Azure AI Services

API Version:

2024-11-15

Sends a ping event to the registered URL.
The request body of the POST request sent to the registered web hook URL is of the same shape as in the GET request for a specific hook. The Swagger Schema ID of the model is WebHookV3.

The request will contain a X-MicrosoftSpeechServices-Event header with the value ping. If the web hook was registered with a secret it will contain a X-MicrosoftSpeechServices-Signature header with an SHA256 hash of the payload with the secret as HMAC key. The hash is base64 encoded.

POST {endpoint}/speechtotext/webhooks/{id}:ping?api-version=2024-11-15

URI Parameters

Name	In	Required	Type	Description
endpoint	path	True	string	Supported Cognitive Services endpoints (protocol and hostname, for example: https://westus.api.cognitive.microsoft.com).
id	path	True	string (uuid)	The identifier of the web hook to ping.
api-version	query	True	string	The requested api version.

Request Header

Name	Required	Type	Description
Ocp-Apim-Subscription-Key	True	string	Provide your cognitive services account key here.

Responses

Name	Type	Description
202 Accepted		Started trying to send a ping request to the web hook. Headers Retry-After: integer
Other Status Codes	Error	An error occurred.

Security

Ocp-Apim-Subscription-Key

Provide your cognitive services account key here.

Type: apiKey
In: header

Examples

Ping a web hook

Sample request

HTTP

POST {endpoint}/speechtotext/webhooks/2e856efe-ef53-465a-a632-6a084c1d349d:ping?api-version=2024-11-15

Sample response

Status code:

202

Definitions

Name	Description
DetailedErrorCode	DetailedErrorCode
Error	Error
ErrorCode	ErrorCode
InnerError	InnerError

DetailedErrorCode

Enumeration

DetailedErrorCode

Value	Description
AudioLengthLimitExceeded	The audio file is longer than the maximum allowed duration.
BadChannelConfiguration	There is a mismatch between audio channels in the data, in the configuration, or the requirements of the application.
DataImportFailed	Data import failed.
DeleteNotAllowed	Delete not allowed.
DeployNotAllowed	Deploy not allowed.
DeployingFailedModel	Deploying failed model.
EmptyAudioFile	The audio file is empty.
EmptyRequest	Empty Request.
EndpointCannotBeDefault	Endpoint cannot be default.
EndpointLoggingNotSupported	Endpoint logging not supported.
EndpointNotUpdatable	Endpoint not updatable.
EndpointWithoutLogging	Endpoint without logging.
ExceededNumberOfRecordingsUris	Exceeded number of recordings uris.
FailedDataset	Failed dataset.
Forbidden	Forbidden.
InUseViolation	In use violation.
InaccessibleCustomerStorage	Inaccessible customer storage.
InvalidAdaptationMapping	Invalid adaptation mapping.
InvalidAudioFormat	The format of input audio is not supported.
InvalidBaseModel	Invalid base model.
InvalidCallbackUri	Invalid callback uri.
InvalidChannelSpecification	The selection of channels in the transcription request is not supported (e.g., neither 0 nor 1 have been selected.)
InvalidChannels	Invalid channels.
InvalidCollection	Invalid collection.
InvalidDataset	Invalid dataset.
InvalidDocument	Invalid Document.
InvalidDocumentBatch	Invalid Document Batch.
InvalidLocale	Invalid locale.
InvalidLogDate	Invalid log date.
InvalidLogEndTime	Invalid log end time.
InvalidLogId	Invalid log id.
InvalidLogStartTime	Invalid log start time.
InvalidModel	Invalid model.
InvalidModelUri	Invalid model uri.
InvalidParameter	Invalid parameter.
InvalidParameterValue	Invalid parameter value.
InvalidPayload	Invalid payload.
InvalidPermissions	Invalid permissions.
InvalidPrerequisite	Invalid prerequisite.
InvalidProductId	Invalid product id.
InvalidProject	Invalid project.
InvalidProjectKind	Invalid project kind.
InvalidRecordingsUri	Invalid recordings uri.
InvalidRequestBodyFormat	Invalid request body format.
InvalidSasValidityDuration	Invalid sas validity duration.
InvalidSkipTokenForLogs	Invalid skip token for logs.
InvalidSourceAzureResourceId	Invalid source Azure resource ID.
InvalidSubscription	Invalid subscription.
InvalidTest	Invalid test.
InvalidTimeToLive	Invalid time to live.
InvalidTopForLogs	Invalid top for logs.
InvalidTranscription	Invalid transcription.
InvalidWebHookEventKind	Invalid web hook event kind.
MissingInputRecords	Missing Input Records.
ModelCopyAuthorizationExpired	Expired ModelCopyAuthorization.
ModelDeploymentNotCompleteState	Model deployment not complete state.
ModelDeprecated	Model deprecated.
ModelExists	Model exists.
ModelMismatch	Model mismatch.
ModelNotDeployable	Model not deployable.
ModelVersionIncorrect	Model Version Incorrect.
MultipleLanguagesIdentified	Language Identification recognized multiple languages. No dominant language could be determined.
NoLanguageIdentified	Language Identification did not recognize any language.
NoUtf8WithBom	No utf8 with bom.
OnlyOneOfUrlsOrContainerOrDataset	Only one of urls or container or dataset.
ProjectGenderMismatch	Project gender mismatch.
QuotaViolation	Quota violation.
SingleDefaultEndpoint	Single default endpoint.
SkuLimitsExist	Sku limits exist.
SubscriptionNotFound	Subscription not found.
UnexpectedError	Unexpected error.
UnsupportedClassBasedAdaptation	Unsupported class based adaptation.
UnsupportedDelta	Unsupported delta.
UnsupportedDynamicConfiguration	Unsupported dynamic configuration.
UnsupportedFilter	Unsupported filter.
UnsupportedLanguageCode	Unsupported language code.
UnsupportedOrderBy	Unsupported order by.
UnsupportedPagination	Unsupported pagination.
UnsupportedTimeRange	Unsupported time range.

Error

Object

Error

Name	Type	Description
code	ErrorCode	ErrorCode High level error codes.
details	Error[]	Additional supportive details regarding the error and/or expected policies.
innerError	InnerError	InnerError New Inner Error format which conforms to Cognitive Services API Guidelines which is available at https://microsoft.sharepoint.com/%3Aw%3A/t/CognitiveServicesPMO/EUoytcrjuJdKpeOKIK_QRC8BPtUYQpKBi8JsWyeDMRsWlQ?e=CPq8ow. This contains required properties ErrorCode, message and optional properties target, details(key value pair), inner error(this can be nested).
message	string	High level error message.
target	string	The source of the error. For example it would be "documents" or "document id" in case of invalid document.

ErrorCode

Enumeration

ErrorCode

Value	Description
Conflict	Representing the conflict error code.
Forbidden	Representing the forbidden error code.
InternalCommunicationFailed	Representing the internal communication failed error code.
InternalServerError	Representing the internal server error error code.
InvalidArgument	Representing the invalid argument error code.
InvalidRequest	Representing the invalid request error code.
NotAllowed	Representing the not allowed error code.
NotFound	Representing the not found error code.
PipelineError	Representing the pipeline error error code.
ServiceUnavailable	Representing the service unavailable error code.
TooManyRequests	Representing the too many requests error code.
Unauthorized	Representing the unauthorized error code.
UnprocessableEntity	Representing the unprocessable entity error code.
UnsupportedMediaType	Representing the unsupported media type error code.

InnerError

Object

InnerError

Name	Type	Description
code	DetailedErrorCode	DetailedErrorCode Detailed error code enum.
details	object	Additional supportive details regarding the error and/or expected policies.
innerError	InnerError	InnerError New Inner Error format which conforms to Cognitive Services API Guidelines which is available at https://microsoft.sharepoint.com/%3Aw%3A/t/CognitiveServicesPMO/EUoytcrjuJdKpeOKIK_QRC8BPtUYQpKBi8JsWyeDMRsWlQ?e=CPq8ow. This contains required properties ErrorCode, message and optional properties target, details(key value pair), inner error(this can be nested).
message	string	High level error message.
target	string	The source of the error. For example it would be "documents" or "document id" in case of invalid document.