Web Hooks - List

Referentie

Service:: Azure AI Services

API-versie:: v3.2-preview.2

Hiermee haalt u de lijst met webhook voor het geverifieerde abonnement op.

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

Met optionele parameters:

GET {endpoint}/speechtotext/v3.2-preview.2/webhooks?skip={skip}&top={top}&filter={filter}

URI-parameters

Name	In	Vereist	Type	Description
endpoint	path	True	string	Ondersteunde Cognitive Services-eindpunten (protocol en hostnaam, bijvoorbeeld: https://westus.api.cognitive.microsoft.com).
filter	query		string	Een filterexpressie voor het selecteren van een subset van de beschikbare hooks. `Supported properties: displayName, description, createdDateTime, lastActionDateTime, status and webUrl. - Operators: - eq, ne are supported for all properties. - gt, ge, lt, le are supported for createdDateTime and lastActionDateTime. - and, or, not are supported. - Example: filter=displayName eq 'test'`
skip	query		integer (int32)	Aantal gegevenssets dat wordt overgeslagen.
top	query		integer (int32)	Het aantal gegevenssets dat wordt opgenomen na het overslaan.

Antwoorden

Name	Type	Description
200 OK	PaginatedWebHooks	OK Kopteksten Retry-After: integer
Other Status Codes	Error	Er is een fout opgetreden.

Name

Type

Description

200 OK

PaginatedWebHooks

Kopteksten

Retry-After: integer

Other Status Codes

Error

Er is een fout opgetreden.

Beveiliging

Ocp-Apim-Subscription-Key

Geef hier de sleutel van uw Cognitive Services-account op.

Type: apiKey
In: header

Authorization

Geef een toegangstoken op van de JWT die wordt geretourneerd door de STS van deze regio. Zorg ervoor dat u het beheerbereik aan het token toevoegt door de volgende querytekenreeks toe te voegen aan de STS-URL: ?scope=speechservicesmanagement

Type: apiKey
In: header

Voorbeelden

Get all web hooks

Get all web hooks created in 03/2020 ordered by their name

Get all web hooks

Voorbeeldaanvraag

HTTP

GET {endpoint}/speechtotext/v3.2-preview.2/webhooks?skip=0&top=2&filter=createdDateTime%20ge%202018-01-24T09:54:39Z

Voorbeeldrespons

Statuscode:: 200

{
  "values": [
    {
      "displayName": "TranscriptionCompletionWebHook",
      "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/webhooks/aff13a6e-17c4-4247-862f-70e99469c553",
      "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": "2019-02-11T00:00:00Z",
      "lastActionDateTime": "2019-02-28T00:00:00Z",
      "status": "Succeeded"
    },
    {
      "displayName": "TranscriptionCompletionWebHook",
      "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/webhooks/9db10a08-189e-4de4-b31a-38b39d993b37",
      "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": "Succeeded"
    }
  ],
  "@nextLink": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/webhooks?skip=2&top=2&filter=createdDateTime%20ge%202018-01-24T09:54:39Z"
}

Get all web hooks created in 03/2020 ordered by their name

Voorbeeldaanvraag

HTTP

GET {endpoint}/speechtotext/v3.2-preview.2/webhooks?skip=0&top=2&filter=createdDateTime%20ge%202020-03-011T00:00:00Z%20and%20createdDateTime%20lt%202020-04-01T00:00:00Z

Voorbeeldrespons

Statuscode:: 200

{
  "values": [
    {
      "displayName": "A test web hook",
      "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/webhooks/aff13a6e-17c4-4247-862f-70e99469c553",
      "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": "2020-03-11T14:13:12Z",
      "lastActionDateTime": "2020-03-11T14:13:12Z",
      "status": "Succeeded"
    },
    {
      "displayName": "Beta version web hook",
      "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/webhooks/9db10a08-189e-4de4-b31a-38b39d993b37",
      "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": "2020-03-21T09:07:43Z",
      "lastActionDateTime": "2020-03-21T09:07:43Z",
      "status": "Succeeded"
    }
  ],
  "@nextLink": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/webhooks?skip=2&top=2&filter=createdDateTime%20ge%202020-03-011T00:00:00Z%20and%20createdDateTime%20lt%202020-04-01T00:00:00Z"
}

Definities

Name	Description
DetailedErrorCode	DetailedErrorCode
EntityError	EntityError
Error	Fout
ErrorCode	Foutcode
InnerError	InnerError
PaginatedWebHooks	PaginatedWebHooks
Status	Status
WebHook	WebHook
WebHookEvents	WebHookEvents
WebHookLinks	WebHookLinks
WebHookProperties	WebHookProperties

DetailedErrorCode

Inventarisatie

DetailedErrorCode

Waarde	Description
DataImportFailed	Het importeren van gegevens is mislukt.
DeleteNotAllowed	Verwijderen is niet toegestaan.
DeployNotAllowed	Implementeren is niet toegestaan.
DeployingFailedModel	Het implementeren van een mislukt model.
EmptyRequest	Lege aanvraag.
EndpointCannotBeDefault	Eindpunt kan niet standaard zijn.
EndpointNotUpdatable	Eindpunt kan niet worden bijgewerkt.
EndpointWithoutLogging	Eindpunt zonder logboekregistratie.
ExceededNumberOfRecordingsUris	Het aantal opnamen is overschreden.
FailedDataset	Mislukte gegevensset.
Forbidden	Verboden.
InUseViolation	Schending van gebruik.
InaccessibleCustomerStorage	Niet-toegankelijke opslag van klanten.
InvalidAdaptationMapping	Ongeldige aanpassingstoewijzing.
InvalidBaseModel	Ongeldig basismodel.
InvalidCallbackUri	Ongeldige callback-URI.
InvalidCollection	Ongeldige verzameling.
InvalidDataset	Ongeldige gegevensset.
InvalidDocument	Ongeldig document.
InvalidDocumentBatch	Ongeldige documentbatch.
InvalidLocale	Ongeldige landinstelling.
InvalidLogDate	Ongeldige logboekdatum.
InvalidLogEndTime	Ongeldige eindtijd van logboek.
InvalidLogId	Ongeldige logboek-id.
InvalidLogStartTime	Ongeldige begintijd voor logboeken.
InvalidModel	Ongeldig model.
InvalidModelUri	Ongeldige model-URI.
InvalidParameter	Ongeldige parameter.
InvalidParameterValue	Ongeldige parameterwaarde.
InvalidPayload	Ongeldige nettolading.
InvalidPermissions	Ongeldige machtigingen.
InvalidPrerequisite	Ongeldige vereiste.
InvalidProductId	Ongeldige product-id.
InvalidProject	Ongeldig project.
InvalidProjectKind	Ongeldig projecttype.
InvalidRecordingsUri	Ongeldige opnamen-URI.
InvalidRequestBodyFormat	Ongeldige indeling voor de hoofdtekst van de aanvraag.
InvalidSasValidityDuration	Ongeldige geldigheidsduur van SAS.
InvalidSkipTokenForLogs	Ongeldig skip-token voor logboeken.
InvalidSourceAzureResourceId	Ongeldige azure-bronresource-id.
InvalidSubscription	Ongeldig abonnement.
InvalidTest	Ongeldige test.
InvalidTimeToLive	Ongeldige time to live.
InvalidTopForLogs	Ongeldig bovenaan voor logboeken.
InvalidTranscription	Ongeldige transcriptie.
InvalidWebHookEventKind	Ongeldig gebeurtenistype webhook.
MissingInputRecords	Ontbrekende invoerrecords.
ModelCopyOperationExists	Er bestaat een modelkopiebewerking.
ModelDeploymentNotCompleteState	Modelimplementatie is niet voltooid.
ModelDeprecated	Model afgeschaft.
ModelExists	Het model bestaat.
ModelMismatch	Model komt niet overeen.
ModelNotDeployable	Model kan niet worden geïmplementeerd.
ModelVersionIncorrect	Modelversie onjuist.
NoUtf8WithBom	Geen utf8 met bom.
OnlyOneOfUrlsOrContainerOrDataset	Slechts één van url's of containers of gegevenssets.
ProjectGenderMismatch	Project geslacht komt niet overeen.
QuotaViolation	Quotumschending.
SingleDefaultEndpoint	Eén standaardeindpunt.
SkuLimitsExist	Er bestaan SKU-limieten.
SubscriptionNotFound	Abonnement is niet gevonden.
UnexpectedError	Onverwachte fout.
UnsupportedClassBasedAdaptation	Niet-ondersteunde aanpassing op basis van klassen.
UnsupportedDelta	Niet-ondersteunde delta.
UnsupportedDynamicConfiguration	Niet-ondersteunde dynamische configuratie.
UnsupportedFilter	Niet-ondersteund filter.
UnsupportedLanguageCode	Niet-ondersteunde taalcode.
UnsupportedOrderBy	Niet-ondersteunde volgorde door.
UnsupportedPagination	Niet-ondersteunde paginering.
UnsupportedTimeRange	Niet-ondersteund tijdsbereik.

EntityError

Object

EntityError

Name	Type	Description
code	string	De code van deze fout.
message	string	Het bericht voor deze fout.

Error

Object

Fout

Name	Type	Description
code	ErrorCode	Foutcode Foutcodes op hoog niveau.
details	Error[]	Aanvullende ondersteunende informatie over de fout en/of het verwachte beleid.
innerError	InnerError	InnerError Nieuwe indeling voor interne fouten die voldoet aan de Richtlijnen voor de Cognitive Services-API die beschikbaar zijn op https://microsoft.sharepoint.com/%3Aw%3A/t/CognitiveServicesPMO/EUoytcrjuJdKpeOKIK_QRC8BPtUYQpKBi8JsWyeDMRsWlQ?e=CPq8ow. Dit bevat vereiste eigenschappen ErrorCode, bericht en optionele eigenschappendoel, details (sleutelwaardepaar), interne fout (dit kan worden genest).
message	string	Foutbericht op hoog niveau.
target	string	De bron van de fout. Dit is bijvoorbeeld 'documenten' of 'document-id' in het geval van een ongeldig document.

ErrorCode

Inventarisatie

Foutcode

Waarde	Description
Conflict	Vertegenwoordiging van de conflictfoutcode.
Forbidden	Vertegenwoordiging van de verboden foutcode.
InternalCommunicationFailed	De foutcode voor de interne communicatie is mislukt.
InternalServerError	De foutcode van de interne server vertegenwoordigt.
InvalidArgument	De foutcode van het ongeldige argument vertegenwoordigt.
InvalidRequest	De foutcode van de ongeldige aanvraag vertegenwoordigt.
NotAllowed	Vertegenwoordiging van de niet-toegestane foutcode.
NotFound	De foutcode wordt niet gevonden.
PipelineError	De foutcode van de pijplijnfout weergeven.
ServiceUnavailable	Vertegenwoordiging van de service niet-beschikbare foutcode.
TooManyRequests	De foutcode voor te veel aanvragen vertegenwoordigt.
Unauthorized	Vertegenwoordiging van de niet-geautoriseerde foutcode.
UnprocessableEntity	De foutcode van de niet-verwerkte entiteit vertegenwoordigt.
UnsupportedMediaType	De foutcode van het niet-ondersteunde mediatype vertegenwoordigt.

InnerError

Object

InnerError

Name	Type	Description
code	DetailedErrorCode	DetailedErrorCode Gedetailleerde opsomming van foutcodes.
details	object	Aanvullende ondersteunende informatie over de fout en/of het verwachte beleid.
innerError	InnerError	InnerError Nieuwe indeling voor interne fouten die voldoet aan de Richtlijnen voor de Cognitive Services-API die beschikbaar zijn op https://microsoft.sharepoint.com/%3Aw%3A/t/CognitiveServicesPMO/EUoytcrjuJdKpeOKIK_QRC8BPtUYQpKBi8JsWyeDMRsWlQ?e=CPq8ow. Dit bevat vereiste eigenschappen ErrorCode, bericht en optionele eigenschappendoel, details (sleutelwaardepaar), interne fout (dit kan worden genest).
message	string	Foutbericht op hoog niveau.
target	string	De bron van de fout. Dit is bijvoorbeeld 'documenten' of 'document-id' in het geval van een ongeldig document.

PaginatedWebHooks

Object

PaginatedWebHooks

Name	Type	Description
@nextLink	string (uri)	Een koppeling naar de volgende set gepagineerde resultaten als er meer entiteiten beschikbaar zijn; anders null.
values	WebHook[]	Een lijst met entiteiten die worden beperkt door de doorgegeven queryparameters 'skip' en 'top' of de bijbehorende standaardwaarden. Wanneer u een lijst doorloopt met behulp van paginering en het parallel verwijderen van entiteiten, worden sommige entiteiten overgeslagen in de resultaten. Het is raadzaam om een lijst op de client te maken en te verwijderen na het ophalen van de volledige lijst.

Name

Type

Description

@nextLink

string (uri)

Een koppeling naar de volgende set gepagineerde resultaten als er meer entiteiten beschikbaar zijn; anders null.

values

WebHook[]

Een lijst met entiteiten die worden beperkt door de doorgegeven queryparameters 'skip' en 'top' of de bijbehorende standaardwaarden.

Wanneer u een lijst doorloopt met behulp van paginering en het parallel verwijderen van entiteiten, worden sommige entiteiten overgeslagen in de resultaten. Het is raadzaam om een lijst op de client te maken en te verwijderen na het ophalen van de volledige lijst.

Status

Inventarisatie

Status

Waarde	Description
Failed	De langdurige bewerking is mislukt.
NotStarted	De langdurige bewerking is nog niet gestart.
Running	De langdurige bewerking wordt momenteel verwerkt.
Succeeded	De langdurige bewerking is voltooid.

WebHook

Object

WebHook

Name	Type	Description
createdDateTime	string (date-time)	Het tijdstempel waarop het object is gemaakt. De tijdstempel wordt gecodeerd als ISO 8601-datum- en tijdnotatie ('JJJJ-MM-DDThh:mm:ssZ', zie https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).
customProperties	object	De aangepaste eigenschappen van deze entiteit. De maximaal toegestane sleutellengte is 64 tekens, de maximale toegestane waardelengte is 256 tekens en het aantal toegestane vermeldingen is 10.
description	string	De beschrijving van het object.
displayName	string minLength: 1	De weergavenaam van het object.
events	WebHookEvents	WebHookEvents
lastActionDateTime	string (date-time)	Het tijdstempel waarop de huidige status is ingevoerd. De tijdstempel wordt gecodeerd als ISO 8601-datum- en tijdnotatie ('JJJJ-MM-DDThh:mm:ssZ', zie https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).
links	WebHookLinks	WebHookLinks
properties	WebHookProperties	WebHookProperties
self	string (uri)	De locatie van deze entiteit.
status	Status	Status De huidige status van de API beschrijven
webUrl	string (uri)	De geregistreerde URL die wordt gebruikt om de POST-aanvragen voor de geregistreerde gebeurtenissen naar te verzenden.

WebHookEvents

Object

WebHookEvents

Name	Type	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

Object

WebHookLinks

Name	Type	Description
ping	string (uri)	De URL die kan worden gebruikt om het verzenden van een ping-gebeurtenis te activeren naar de geregistreerde URL van een webhookregistratie. Zie de bewerking 'WebHooks_Ping' voor meer informatie.
test	string (uri)	De URL die kan worden gebruikt voor het verzenden van test gebeurtenissen naar de geregistreerde URL van een webhookregistratie. Zie de bewerking 'WebHooks_Test' voor meer informatie.

WebHookProperties

Object

WebHookProperties

Name	Type	Description
apiVersion	string	De API-versie waarin de webhook is gemaakt. Hiermee definieert u de vorm van de nettolading in de callbacks. Als het payloadtype niet meer wordt ondersteund, omdat de shape is gewijzigd en de API-versie die deze gebruikt, wordt verwijderd (na afschaffing), wordt de webhook uitgeschakeld.
error	EntityError	EntityError
secret	string	Een geheim dat wordt gebruikt voor het maken van een SHA256-hash van de nettolading met het geheim als HMAC-sleutel. Deze hash wordt ingesteld als X-MicrosoftSpeechServices-Signature header bij het terugroepen naar de geregistreerde URL.

Delen via

Web Hooks - List

URI-parameters

Antwoorden

Beveiliging

Ocp-Apim-Subscription-Key

Authorization

Voorbeelden

Get all web hooks

Voorbeeldaanvraag

Voorbeeldrespons

Get all web hooks created in 03/2020 ordered by their name

Voorbeeldaanvraag

Voorbeeldrespons

Definities

DetailedErrorCode

EntityError

Error

ErrorCode

InnerError

PaginatedWebHooks

Status

WebHook

WebHookEvents

WebHookLinks

WebHookProperties

Aanvullende resources