Web Hooks - Get

  • Referens
Tjänst:
Azure AI Services
API-version:
3.2

Hämtar webbkroken som identifieras av det angivna ID:t.

GET {endpoint}/speechtotext/v3.2/webhooks/{id}

URI-parametrar

Name I Obligatorisk Typ Description
endpoint
 path True

string

Cognitive Services-slutpunkter som stöds (protokoll och värdnamn, till exempel: https://westus.api.cognitive.microsoft.com).
id
 path True

string

uuid

Identifieraren för webbkroken.

Svar

Name Typ Description
200 OK

WebHook

OK

Sidhuvuden

Retry-After: integer
Other Status Codes

Error

Ett fel inträffade.

Säkerhet

Ocp-Apim-Subscription-Key

Ange din cognitive services-kontonyckel här.

Typ: apiKey
I: header

Authorization

Ange en åtkomsttoken från JWT som returneras av STS i den här regionen. Se till att lägga till hanteringsomfånget i token genom att lägga till följande frågesträng i STS-URL:en: ?scope=speechservicesmanagement

Typ: apiKey
I: header

Exempel

Get a web hook

Exempelbegäran

GET {endpoint}/speechtotext/v3.2/webhooks/2e856efe-ef53-465a-a632-6a084c1d349d

Exempelsvar

Statuskod:
200 
{
  "displayName": "TranscriptionCompletionWebHook",
  "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/webhooks/2e856efe-ef53-465a-a632-6a084c1d349d",
  "links": {
    "ping": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/webhooks/2e856efe-ef53-465a-a632-6a084c1d349d:test",
    "test": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/webhooks/2e856efe-ef53-465a-a632-6a084c1d349d:ping"
  },
  "properties": {
    "apiVersion": "v3.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": "Succeeded"
}

Definitioner

Name Description
DetailedErrorCode

DetailedErrorCode
EntityError

EntityError
Error

Fel
ErrorCode

Felkod
InnerError

InnerError
Status

Status
WebHook

WebHook
WebHookEvents

WebHookEvents
WebHookLinks

WebHookLinks
WebHookProperties

WebHookProperties

DetailedErrorCode

DetailedErrorCode

Name Typ Description
DataImportFailed

string

Dataimporten misslyckades.
DeleteNotAllowed

string

Ta bort tillåts inte.
DeployNotAllowed

string

Distribution tillåts inte.
DeployingFailedModel

string

Distributionen av en misslyckad modell.
EmptyRequest

string

Tom begäran.
EndpointCannotBeDefault

string

Slutpunkten kan inte vara standard.
EndpointNotUpdatable

string

Slutpunkten kan inte uppdateras.
EndpointWithoutLogging

string

Slutpunkt utan loggning.
ExceededNumberOfRecordingsUris

string

Överskred antalet inspelningar uris.
FailedDataset

string

Datauppsättningen misslyckades.
Forbidden

string

Förbjudet.
InUseViolation

string

Vid användningsöverträdelse.
InaccessibleCustomerStorage

string

Otillgänglig kundlagring.
InvalidAdaptationMapping

string

Ogiltig anpassningsmappning.
InvalidBaseModel

string

Ogiltig basmodell.
InvalidCallbackUri

string

Ogiltig återanrops-uri.
InvalidChannels

string

Ogiltiga kanaler.
InvalidCollection

string

Ogiltig samling.
InvalidDataset

string

Ogiltig datauppsättning.
InvalidDocument

string

Ogiltigt dokument.
InvalidDocumentBatch

string

Ogiltig dokumentbatch.
InvalidLocale

string

Ogiltigt språk.
InvalidLogDate

string

Ogiltigt loggdatum.
InvalidLogEndTime

string

Ogiltig loggsluttid.
InvalidLogId

string

Ogiltigt logg-ID.
InvalidLogStartTime

string

Ogiltig starttid för loggen.
InvalidModel

string

Ogiltig modell.
InvalidModelUri

string

Ogiltig modell-URI.
InvalidParameter

string

Ogiltig parameter.
InvalidParameterValue

string

Ogiltigt parametervärde.
InvalidPayload

string

Ogiltig nyttolast.
InvalidPermissions

string

Ogiltiga behörigheter.
InvalidPrerequisite

string

Ogiltig förutsättning.
InvalidProductId

string

Ogiltigt produkt-ID.
InvalidProject

string

Ogiltigt projekt.
InvalidProjectKind

string

Ogiltig projekttyp.
InvalidRecordingsUri

string

Ogiltig inspelnings-URI.
InvalidRequestBodyFormat

string

Ogiltigt brödtextformat för begäran.
InvalidSasValidityDuration

string

Ogiltig varaktighet för sas-giltighet.
InvalidSkipTokenForLogs

string

Ogiltig hopptoken för loggar.
InvalidSourceAzureResourceId

string

Ogiltigt käll-Azure-resurs-ID.
InvalidSubscription

string

Ogiltig prenumeration.
InvalidTest

string

Ogiltigt test.
InvalidTimeToLive

string

Ogiltig tid att leva.
InvalidTopForLogs

string

Ogiltig överkant för loggar.
InvalidTranscription

string

Ogiltig transkription.
InvalidWebHookEventKind

string

Ogiltig webbhookhändelsetyp.
MissingInputRecords

string

Indataposter saknas.
ModelCopyAuthorizationExpired

string

ModelCopyAuthorization har upphört att gälla.
ModelDeploymentNotCompleteState

string

Modelldistributionen är inte fullständigt.
ModelDeprecated

string

Modellen är inaktuell.
ModelExists

string

Modellen finns.
ModelMismatch

string

Modellmatchningsfel.
ModelNotDeployable

string

Modellen kan inte distribueras.
ModelVersionIncorrect

string

Modellversionen är felaktig.
NoUtf8WithBom

string

Ingen utf8 med bom.
OnlyOneOfUrlsOrContainerOrDataset

string

Endast en av URL:erna eller containern eller datauppsättningen.
ProjectGenderMismatch

string

Matchningsfel för projektkön.
QuotaViolation

string

Kvotöverträdelse.
SingleDefaultEndpoint

string

Enskild standardslutpunkt.
SkuLimitsExist

string

Det finns SKU-gränser.
SubscriptionNotFound

string

Det går inte att hitta prenumerationen.
UnexpectedError

string

Oväntat fel.
UnsupportedClassBasedAdaptation

string

Klassbaserad anpassning stöds inte.
UnsupportedDelta

string

Delta stöds inte.
UnsupportedDynamicConfiguration

string

Dynamisk konfiguration stöds inte.
UnsupportedFilter

string

Filter som inte stöds.
UnsupportedLanguageCode

string

Språkkod som inte stöds.
UnsupportedOrderBy

string

Order som inte stöds av.
UnsupportedPagination

string

Sidnumrering stöds inte.
UnsupportedTimeRange

string

Tidsintervallet stöds inte.

EntityError

EntityError

Name Typ Description
code

string

Koden för det här felet.
message

string

Meddelandet för det här felet.

Error

Fel

Name Typ Description
code

ErrorCode

Felkod
Felkoder på hög nivå.
details

Error[]

Ytterligare stödjande information om fel- och/eller förväntade principer.
innerError

InnerError

InnerError
Nytt format för inre fel som överensstämmer med Cognitive Services API Guidelines som finns på https://microsoft.sharepoint.com/%3Aw%3A/t/CognitiveServicesPMO/EUoytcrjuJdKpeOKIK_QRC8BPtUYQpKBi8JsWyeDMRsWlQ?e=CPq8ow. Detta innehåller nödvändiga egenskaper ErrorCode, meddelande och valfria egenskaper mål, information (nyckelvärdepar), inre fel (detta kan kapslas).
message

string

Felmeddelande på hög nivå.
target

string

Källan till felet. Det skulle till exempel vara "dokument" eller "dokument-ID" om dokumentet är ogiltigt.

ErrorCode

Felkod

Name Typ Description
Conflict

string

Representerar konfliktfelkoden.
Forbidden

string

Representerar den otillåtna felkoden.
InternalCommunicationFailed

string

Det gick inte att representera felkoden för intern kommunikation.
InternalServerError

string

Representerar felkoden för den interna servern.
InvalidArgument

string

Representerar den ogiltiga argumentfelkoden.
InvalidRequest

string

Representerar felkoden för ogiltig begäran.
NotAllowed

string

Representerar den felkod som inte tillåts.
NotFound

string

Representerar felkoden som inte hittades.
PipelineError

string

Representerar felkoden för pipelinefel.
ServiceUnavailable

string

Representerar felkoden för tjänsten som inte är tillgänglig.
TooManyRequests

string

Representerar felkoden för många begäranden.
Unauthorized

string

Representerar den otillåtna felkoden.
UnprocessableEntity

string

Representerar felkoden för entiteten som inte kan bearbetas.
UnsupportedMediaType

string

Representerar felkoden för medietypen som inte stöds.

InnerError

InnerError

Name Typ Description
code

DetailedErrorCode

DetailedErrorCode
Detaljerad felkodsuppräkning.
details

object

Ytterligare stödjande information om fel- och/eller förväntade principer.
innerError

InnerError

InnerError
Nytt format för inre fel som överensstämmer med Cognitive Services API Guidelines som finns på https://microsoft.sharepoint.com/%3Aw%3A/t/CognitiveServicesPMO/EUoytcrjuJdKpeOKIK_QRC8BPtUYQpKBi8JsWyeDMRsWlQ?e=CPq8ow. Detta innehåller nödvändiga egenskaper ErrorCode, meddelande och valfria egenskaper mål, information (nyckelvärdepar), inre fel (detta kan kapslas).
message

string

Felmeddelande på hög nivå.
target

string

Källan till felet. Det skulle till exempel vara "dokument" eller "dokument-ID" om dokumentet är ogiltigt.

Status

Status

Name Typ Description
Failed

string

Den långvariga åtgärden misslyckades.
NotStarted

string

Den långvariga åtgärden har ännu inte startats.
Running

string

Den tidskrävande åtgärden bearbetas för närvarande.
Succeeded

string

Den långvariga åtgärden har slutförts.

WebHook

WebHook

Name Typ Description
createdDateTime

string

Tidsstämpeln när objektet skapades. Tidsstämpeln är kodad som ISO 8601 datum- och tidsformat ("ÅÅÅÅÅ-MM-DDThh:mm:ssZ", se https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).
customProperties

object

De anpassade egenskaperna för den här entiteten. Den maximala tillåtna nyckellängden är 64 tecken, den maximala tillåtna värdelängden är 256 tecken och antalet tillåtna poster är 10.
description

string

Beskrivningen av objektet.
displayName

string

Visningsnamnet för objektet.
events

WebHookEvents

WebHookEvents
lastActionDateTime

string

Tidsstämpeln när den aktuella statusen angavs. Tidsstämpeln är kodad som ISO 8601 datum- och tidsformat ("ÅÅÅÅÅ-MM-DDThh:mm:ssZ", se https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).
links

WebHookLinks

WebHookLinks
properties

WebHookProperties

WebHookProperties
self

string

Platsen för den här entiteten.
status

Status

Status
Beskriv API:ets aktuella tillstånd.
webUrl

string

Den registrerade URL:en som ska användas för att skicka POST-begäranden för de registrerade händelserna till.

WebHookEvents

WebHookEvents

Name Typ Description
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

Name Typ Description
ping

string

Den URL som kan användas för att utlösa sändning av en ping-händelse till den registrerade URL:en för en web hook-registrering. Mer information finns i åtgärden "WebHooks_Ping".
test

string

Den URL som kan användas för att skicka testhändelser till den registrerade URL:en för en web hook-registrering. Mer information finns i åtgärden "WebHooks_Test".

WebHookProperties

WebHookProperties

Name Typ Description
apiVersion

string

API-versionen som webbkroken skapades i. Detta definierar formen på nyttolasten i återanropen. Om nyttolasttypen inte stöds längre, eftersom formen har ändrats och API-versionen som använder den tas bort (efter utfasningen), inaktiveras webbkroken.
error

EntityError

EntityError
secret

string

En hemlighet som ska användas för att skapa en SHA256-hash för nyttolasten med hemligheten som HMAC-nyckel. Denna hash anges som X-MicrosoftSpeechServices-Signature-rubrik när du anropar tillbaka till den registrerade URL:en.