Share via

Ping Hook - Ping Hook

  • Reference
Service:
Azure AI Services
API Version:
v3.0

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/v3.0/webhooks/{id}/ping

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.

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

Authorization

Provide an access token from the JWT returned by the STS of this region. Make sure to add the management scope to the token by adding the following query string to the STS URL: ?scope=speechservicesmanagement

Type: apiKey
In: header

Examples

Ping a web hook

Sample request

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

Sample response

Status code:
202

Definitions

Name Description
DetailedErrorCode

DetailedErrorCode
Error

Error
ErrorCode

ErrorCode
InnerError

InnerError

DetailedErrorCode

DetailedErrorCode

Name Type Description
DataImportFailed

string

Data import failed.
DeleteNotAllowed

string

Delete not allowed.
DeployNotAllowed

string

Deploy not allowed.
DeployingFailedModel

string

Deploying failed model.
EmptyRequest

string

Empty Request.
EndpointCannotBeDefault

string

Endpoint cannot be default.
EndpointNotUpdatable

string

Endpoint not updatable.
EndpointWithoutLogging

string

Endpoint without logging.
ExceededNumberOfRecordingsUris

string

Exceeded number of recordings uris.
FailedDataset

string

Failed dataset.
Forbidden

string

Forbidden.
InUseViolation

string

In use violation.
InaccessibleCustomerStorage

string

Inaccessible customer storage.
InvalidAdaptationMapping

string

Invalid adaptation mapping.
InvalidBaseModel

string

Invalid base model.
InvalidCallbackUri

string

Invalid callback uri.
InvalidCollection

string

Invalid collection.
InvalidDataset

string

Invalid dataset.
InvalidDocument

string

Invalid Document.
InvalidDocumentBatch

string

Invalid Document Batch.
InvalidLocale

string

Invalid locale.
InvalidLogDate

string

Invalid log date.
InvalidLogEndTime

string

Invalid log end time.
InvalidLogId

string

Invalid log id.
InvalidLogStartTime

string

Invalid log start time.
InvalidModel

string

Invalid model.
InvalidModelUri

string

Invalid model uri.
InvalidParameter

string

Invalid parameter.
InvalidParameterValue

string

Invalid parameter value.
InvalidPayload

string

Invalid payload.
InvalidPermissions

string

Invalid permissions.
InvalidPrerequisite

string

Invalid prerequisite.
InvalidProductId

string

Invalid product id.
InvalidProject

string

Invalid project.
InvalidProjectKind

string

Invalid project kind.
InvalidRecordingsUri

string

Invalid recordings uri.
InvalidRequestBodyFormat

string

Invalid request body format.
InvalidSasValidityDuration

string

Invalid sas validity duration.
InvalidSkipTokenForLogs

string

Invalid skip token for logs.
InvalidSubscription

string

Invalid subscription.
InvalidTest

string

Invalid test.
InvalidTimeToLive

string

Invalid time to live.
InvalidTopForLogs

string

Invalid top for logs.
InvalidTranscription

string

Invalid transcription.
InvalidWebHookEventKind

string

Invalid web hook event kind.
MissingInputRecords

string

Missing Input Records.
ModelDeploymentNotCompleteState

string

Model deployment not complete state.
ModelDeprecated

string

Model deprecated.
ModelExists

string

Model exists.
ModelMismatch

string

Model mismatch.
ModelNotDeployable

string

Model not deployable.
ModelVersionIncorrect

string

Model Version Incorrect.
NoUtf8WithBom

string

No utf8 with bom.
OnlyOneOfUrlsOrContainerOrDataset

string

Only one of urls or container or dataset.
ProjectGenderMismatch

string

Project gender mismatch.
QuotaViolation

string

Quota violation.
SingleDefaultEndpoint

string

Single default endpoint.
SkuLimitsExist

string

Sku limits exist.
SubscriptionNotFound

string

Subscription not found.
UnexpectedError

string

Unexpected error.
UnsupportedClassBasedAdaptation

string

Unsupported class based adaptation.
UnsupportedDelta

string

Unsupported delta.
UnsupportedDynamicConfiguration

string

Unsupported dynamic configuration.
UnsupportedFilter

string

Unsupported filter.
UnsupportedLanguageCode

string

Unsupported language code.
UnsupportedOrderBy

string

Unsupported order by.
UnsupportedPagination

string

Unsupported pagination.
UnsupportedTimeRange

string

Unsupported time range.

Error

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

ErrorCode

Name Type Description
Conflict

string

Representing the conflict error code.
Forbidden

string

Representing the forbidden error code.
InternalCommunicationFailed

string

Representing the internal communication failed error code.
InternalServerError

string

Representing the internal server error error code.
InvalidArgument

string

Representing the invalid argument error code.
InvalidRequest

string

Representing the invalid request error code.
NotAllowed

string

Representing the not allowed error code.
NotFound

string

Representing the not found error code.
PipelineError

string

Representing the pipeline error error code.
ServiceUnavailable

string

Representing the service unavailable error code.
TooManyRequests

string

Representing the too many requests error code.
Unauthorized

string

Representing the unauthorized error code.
UnprocessableEntity

string

Representing the unprocessable entity error code.
UnsupportedMediaType

string

Representing the unsupported media type error code.

InnerError

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.