Partager via

Web Hooks - List

  • Référence
Service:
Azure AI Services
Version d'API:
2024-11-15

Obtient la liste des hooks web pour l’abonnement authentifié.

GET {endpoint}/speechtotext/webhooks?api-version=2024-11-15
Avec des paramètres facultatifs: 
GET {endpoint}/speechtotext/webhooks?skip={skip}&top={top}&filter={filter}&api-version=2024-11-15

Paramètres URI

Nom Dans Obligatoire Type Description
endpoint
 path True

string

Points de terminaison Cognitive Services pris en charge (protocole et nom d’hôte, par exemple : https://westus.api.cognitive.microsoft.com).
api-version
 query True

string

Version de l’API demandée.
filter
 query

string

Expression de filtrage permettant de sélectionner un sous-ensemble des hooks disponibles.

        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

Nombre de jeux de données ignorés.
top
 query

integer

int32

Nombre de jeux de données qui seront inclus après l’ignorer.

En-tête de la demande

Nom Obligatoire Type Description
Ocp-Apim-Subscription-Key True

string

Fournissez ici votre clé de compte Cognitive Services.

Réponses

Nom Type Description
200 OK

PaginatedWebHooks

D’ACCORD

En-têtes

Retry-After: integer
Other Status Codes

Error

Une erreur s’est produite.

Sécurité

Ocp-Apim-Subscription-Key

Fournissez ici votre clé de compte Cognitive Services.

Type: apiKey
Dans: header

Exemples

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

Get all web hooks

Exemple de requête

GET {endpoint}/speechtotext/webhooks?skip=0&top=2&filter=createdDateTime%20ge%202018-01-24T09:54:39Z&api-version=2024-11-15

Exemple de réponse

Code d’état:
200 
{
  "values": [
    {
      "self": "https://westus.api.cognitive.microsoft.com/speechtotext/webhooks/aff13a6e-17c4-4247-862f-70e99469c553?api-version=2024-11-15",
      "displayName": "TranscriptionCompletionWebHook",
      "description": "I registered this URL to get a POST request for each completed transcription.",
      "properties": {
        "apiVersion": "2024-11-15",
        "secret": "$CREDENTIAL_PLACEHOLDER$"
      },
      "webUrl": "https://contoso.com/call/me/back",
      "events": {
        "transcriptionCompletion": true
      },
      "createdDateTime": "2019-02-11T00:00:00Z",
      "lastActionDateTime": "2019-02-28T00:00:00Z",
      "status": "Succeeded",
      "links": {
        "test": "https://westus.api.cognitive.microsoft.com/speechtotext/webhooks/2e856efe-ef53-465a-a632-6a084c1d349d:ping?api-version=2024-11-15",
        "ping": "https://westus.api.cognitive.microsoft.com/speechtotext/webhooks/2e856efe-ef53-465a-a632-6a084c1d349d:test?api-version=2024-11-15"
      }
    },
    {
      "self": "https://westus.api.cognitive.microsoft.com/speechtotext/webhooks/9db10a08-189e-4de4-b31a-38b39d993b37?api-version=2024-11-15",
      "displayName": "TranscriptionCompletionWebHook",
      "description": "I registered this URL to get a POST request for each completed transcription.",
      "properties": {
        "apiVersion": "2024-11-15",
        "secret": "$CREDENTIAL_PLACEHOLDER$"
      },
      "webUrl": "https://contoso.com/call/me/back",
      "events": {
        "transcriptionCompletion": true
      },
      "createdDateTime": "2018-11-11T00:00:00Z",
      "lastActionDateTime": "2018-11-28T00:00:00Z",
      "status": "Succeeded",
      "links": {
        "test": "https://westus.api.cognitive.microsoft.com/speechtotext/webhooks/2e856efe-ef53-465a-a632-6a084c1d349d:ping?api-version=2024-11-15",
        "ping": "https://westus.api.cognitive.microsoft.com/speechtotext/webhooks/2e856efe-ef53-465a-a632-6a084c1d349d:test?api-version=2024-11-15"
      }
    }
  ],
  "@nextLink": "https://westus.api.cognitive.microsoft.com/speechtotext/webhooks?skip=2&top=2&filter=createdDateTime%20ge%202018-01-24T09:54:39Z&api-version=2024-11-15"
}

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

Exemple de requête

GET {endpoint}/speechtotext/webhooks?skip=0&top=2&filter=createdDateTime%20ge%202020-03-011T00:00:00Z%20and%20createdDateTime%20lt%202020-04-01T00:00:00Z&api-version=2024-11-15

Exemple de réponse

Code d’état:
200 
{
  "values": [
    {
      "self": "https://westus.api.cognitive.microsoft.com/speechtotext/webhooks/aff13a6e-17c4-4247-862f-70e99469c553?api-version=2024-11-15",
      "displayName": "A test web hook",
      "description": "I registered this URL to get a POST request for each completed transcription.",
      "properties": {
        "apiVersion": "2024-11-15",
        "secret": "$CREDENTIAL_PLACEHOLDER$"
      },
      "webUrl": "https://contoso.com/call/me/back",
      "events": {
        "transcriptionCompletion": true
      },
      "createdDateTime": "2020-03-11T14:13:12Z",
      "lastActionDateTime": "2020-03-11T14:13:12Z",
      "status": "Succeeded",
      "links": {
        "test": "https://westus.api.cognitive.microsoft.com/speechtotext/webhooks/2e856efe-ef53-465a-a632-6a084c1d349d:ping?api-version=2024-11-15",
        "ping": "https://westus.api.cognitive.microsoft.com/speechtotext/webhooks/2e856efe-ef53-465a-a632-6a084c1d349d:test?api-version=2024-11-15"
      }
    },
    {
      "self": "https://westus.api.cognitive.microsoft.com/speechtotext/webhooks/9db10a08-189e-4de4-b31a-38b39d993b37?api-version=2024-11-15",
      "displayName": "Beta version web hook",
      "description": "I registered this URL to get a POST request for each completed transcription.",
      "properties": {
        "apiVersion": "2024-11-15",
        "secret": "$CREDENTIAL_PLACEHOLDER$"
      },
      "webUrl": "https://contoso.com/call/me/back",
      "events": {
        "transcriptionCompletion": true
      },
      "createdDateTime": "2020-03-21T09:07:43Z",
      "lastActionDateTime": "2020-03-21T09:07:43Z",
      "status": "Succeeded",
      "links": {
        "test": "https://westus.api.cognitive.microsoft.com/speechtotext/webhooks/2e856efe-ef53-465a-a632-6a084c1d349d:ping?api-version=2024-11-15",
        "ping": "https://westus.api.cognitive.microsoft.com/speechtotext/webhooks/2e856efe-ef53-465a-a632-6a084c1d349d:test?api-version=2024-11-15"
      }
    }
  ],
  "@nextLink": "https://westus.api.cognitive.microsoft.com/speechtotext/webhooks?skip=2&top=2&filter=createdDateTime%20ge%202020-03-011T00:00:00Z%20and%20createdDateTime%20lt%202020-04-01T00:00:00Z&api-version=2024-11-15"
}

Définitions

Nom Description
DetailedErrorCode

DetailedErrorCode
EntityError

EntityError
Error

Erreur
ErrorCode

ErrorCode
InnerError

InnerError
PaginatedWebHooks

PaginésWebHooks
Status

Statut
WebHook

WebHook
WebHookEvents

WebHookEvents
WebHookLinks

WebHookLinks
WebHookProperties

WebHookProperties

DetailedErrorCode

DetailedErrorCode

Nom Type Description
AudioLengthLimitExceeded

string

Le fichier audio est plus long que la durée maximale autorisée.
BadChannelConfiguration

string

Il existe une incompatibilité entre les canaux audio dans les données, dans la configuration ou les exigences de l’application.
DataImportFailed

string

Échec de l’importation de données.
DeleteNotAllowed

string

Supprimer non autorisé.
DeployNotAllowed

string

Déployer non autorisé.
DeployingFailedModel

string

Déploiement d’un modèle ayant échoué.
EmptyAudioFile

string

Le fichier audio est vide.
EmptyRequest

string

Requête vide.
EndpointCannotBeDefault

string

Le point de terminaison ne peut pas être par défaut.
EndpointLoggingNotSupported

string

La journalisation des points de terminaison n’est pas prise en charge.
EndpointNotUpdatable

string

Point de terminaison non modifiable.
EndpointWithoutLogging

string

Point de terminaison sans journalisation.
ExceededNumberOfRecordingsUris

string

Nombre dépassé d’uris d’enregistrement.
FailedDataset

string

Jeu de données ayant échoué.
Forbidden

string

Interdit.
InUseViolation

string

En cas de violation d’utilisation.
InaccessibleCustomerStorage

string

Stockage client inaccessible.
InvalidAdaptationMapping

string

Mappage d’adaptation non valide.
InvalidAudioFormat

string

Le format audio d’entrée n’est pas pris en charge.
InvalidBaseModel

string

Modèle de base non valide.
InvalidCallbackUri

string

URI de rappel non valide.
InvalidChannelSpecification

string

La sélection de canaux dans la demande de transcription n’est pas prise en charge (par exemple, ni 0 ni 1 n’ont été sélectionnés.)
InvalidChannels

string

Canaux non valides.
InvalidCollection

string

Collection non valide.
InvalidDataset

string

Jeu de données non valide.
InvalidDocument

string

Document non valide.
InvalidDocumentBatch

string

Lot de documents non valide.
InvalidLocale

string

Paramètres régionaux non valides.
InvalidLogDate

string

Date de journal non valide.
InvalidLogEndTime

string

Heure de fin du journal non valide.
InvalidLogId

string

ID de journal non valide.
InvalidLogStartTime

string

Heure de début du journal non valide.
InvalidModel

string

Modèle non valide.
InvalidModelUri

string

URI de modèle non valide.
InvalidParameter

string

Paramètre non valide.
InvalidParameterValue

string

Valeur de paramètre non valide.
InvalidPayload

string

Charge utile non valide.
InvalidPermissions

string

Autorisations non valides.
InvalidPrerequisite

string

Prérequis non valides.
InvalidProductId

string

ID de produit non valide.
InvalidProject

string

Projet non valide.
InvalidProjectKind

string

Type de projet non valide.
InvalidRecordingsUri

string

Uri des enregistrements non valides.
InvalidRequestBodyFormat

string

Format du corps de la demande non valide.
InvalidSasValidityDuration

string

Durée de validité de sas non valide.
InvalidSkipTokenForLogs

string

Jeton d’ignorer non valide pour les journaux d’activité.
InvalidSourceAzureResourceId

string

ID de ressource Azure source non valide.
InvalidSubscription

string

Abonnement non valide.
InvalidTest

string

Test non valide.
InvalidTimeToLive

string

Heure de vie non valide.
InvalidTopForLogs

string

Top non valide pour les journaux d’activité.
InvalidTranscription

string

Transcription non valide.
InvalidWebHookEventKind

string

Type d’événement web hook non valide.
MissingInputRecords

string

Enregistrements d’entrée manquants.
ModelCopyAuthorizationExpired

string

ModelCopyAuthorization expiré.
ModelDeploymentNotCompleteState

string

Le déploiement du modèle n’est pas terminé.
ModelDeprecated

string

Modèle déconseillé.
ModelExists

string

Le modèle existe.
ModelMismatch

string

Incompatibilité du modèle.
ModelNotDeployable

string

Modèle non déployable.
ModelVersionIncorrect

string

Version du modèle incorrecte.
MultipleLanguagesIdentified

string

L’identification linguistique a reconnu plusieurs langues. Aucune langue dominante ne peut être déterminée.
NoLanguageIdentified

string

L’identification linguistique n’a reconnu aucune langue.
NoUtf8WithBom

string

Pas d’utf8 avec bom.
OnlyOneOfUrlsOrContainerOrDataset

string

Une seule URL ou conteneur ou jeu de données.
ProjectGenderMismatch

string

Incompatibilité entre les sexes du projet.
QuotaViolation

string

Violation de quota.
SingleDefaultEndpoint

string

Point de terminaison par défaut unique.
SkuLimitsExist

string

Les limites de référence SKU existent.
SubscriptionNotFound

string

Abonnement introuvable.
UnexpectedError

string

Erreur inattendue.
UnsupportedClassBasedAdaptation

string

Adaptation basée sur des classes non prise en charge.
UnsupportedDelta

string

Delta non pris en charge.
UnsupportedDynamicConfiguration

string

Configuration dynamique non prise en charge.
UnsupportedFilter

string

Filtre non pris en charge.
UnsupportedLanguageCode

string

Code de langue non pris en charge.
UnsupportedOrderBy

string

Commande non prise en charge par.
UnsupportedPagination

string

Pagination non prise en charge.
UnsupportedTimeRange

string

Intervalle de temps non pris en charge.

EntityError

EntityError

Nom Type Description
code

string

Code de cette erreur.
message

string

Message de cette erreur.

Error

Erreur

Nom Type Description
code

ErrorCode

ErrorCode
Codes d’erreur de haut niveau.
details

Error[]

Détails supplémentaires concernant l’erreur et/ou les stratégies attendues.
innerError

InnerError

InnerError
Nouveau format d’erreur interne conforme aux instructions de l’API Cognitive Services qui est disponible à https://microsoft.sharepoint.com/%3Aw%3A/t/CognitiveServicesPMO/EUoytcrjuJdKpeOKIK_QRC8BPtUYQpKBi8JsWyeDMRsWlQ?e=CPq8ow. Cela contient les propriétés requises ErrorCode, le message et la cible de propriétés facultatives, les détails (paire valeur clé), l’erreur interne (cela peut être imbriqué).
message

string

Message d’erreur de haut niveau.
target

string

Source de l’erreur. Par exemple, il s’agirait de « documents » ou d'« ID de document » en cas de document non valide.

ErrorCode

ErrorCode

Nom Type Description
Conflict

string

Représentant le code d’erreur de conflit.
Forbidden

string

Représentant le code d’erreur interdit.
InternalCommunicationFailed

string

Représentant le code d’erreur de communication interne ayant échoué.
InternalServerError

string

Représentant le code d’erreur du serveur interne.
InvalidArgument

string

Représentant le code d’erreur d’argument non valide.
InvalidRequest

string

Représentant le code d’erreur de requête non valide.
NotAllowed

string

Représentant le code d’erreur non autorisé.
NotFound

string

Représentant le code d’erreur introuvable.
PipelineError

string

Représentant le code d’erreur du pipeline.
ServiceUnavailable

string

Représentant le code d’erreur indisponible du service.
TooManyRequests

string

Représentant le code d’erreur trop grand nombre de requêtes.
Unauthorized

string

Représentant le code d’erreur non autorisé.
UnprocessableEntity

string

Représentant le code d’erreur d’entité non traité.
UnsupportedMediaType

string

Représentant le code d’erreur du type de média non pris en charge.

InnerError

InnerError

Nom Type Description
code

DetailedErrorCode

DetailedErrorCode
Énumération détaillée du code d’erreur.
details

object

Détails supplémentaires concernant l’erreur et/ou les stratégies attendues.
innerError

InnerError

InnerError
Nouveau format d’erreur interne conforme aux instructions de l’API Cognitive Services qui est disponible à https://microsoft.sharepoint.com/%3Aw%3A/t/CognitiveServicesPMO/EUoytcrjuJdKpeOKIK_QRC8BPtUYQpKBi8JsWyeDMRsWlQ?e=CPq8ow. Cela contient les propriétés requises ErrorCode, le message et la cible de propriétés facultatives, les détails (paire valeur clé), l’erreur interne (cela peut être imbriqué).
message

string

Message d’erreur de haut niveau.
target

string

Source de l’erreur. Par exemple, il s’agirait de « documents » ou d'« ID de document » en cas de document non valide.

PaginatedWebHooks

PaginésWebHooks

Nom Type Description
@nextLink

string

Lien vers l’ensemble suivant de résultats paginés s’il existe davantage d’entités disponibles ; sinon null.
values

WebHook[]

Liste des entités limitées par les paramètres de requête passés « skip » et « top » ou leurs valeurs par défaut.

Lors de l’itération dans une liste à l’aide de la pagination et de la suppression d’entités en parallèle, certaines entités sont ignorées dans les résultats. Il est recommandé de créer une liste sur le client et de supprimer après la récupération de la liste complète.

Status

Statut

Nom Type Description
Failed

string

L’opération de longue durée a échoué.
NotStarted

string

L’opération de longue durée n’a pas encore démarré.
Running

string

L’opération de longue durée est en cours de traitement.
Succeeded

string

L’opération de longue durée s’est terminée.

WebHook

WebHook

Nom Type Description
createdDateTime

string

Horodatage de la création de l’objet. L’horodatage est encodé en tant que format de date et d’heure ISO 8601 (« AAAA-MM-DDThh :mm :ssZ », voir https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).
customProperties

object

Propriétés personnalisées de cette entité. La longueur maximale de la clé autorisée est de 64 caractères, la longueur maximale de la valeur autorisée est de 256 caractères et le nombre d’entrées autorisées est de 10.
description

string

Description de l’objet.
displayName

string

Nom complet de l’objet.
events

WebHookEvents

WebHookEvents
lastActionDateTime

string

Horodatage lorsque l’état actuel a été entré. L’horodatage est encodé en tant que format de date et d’heure ISO 8601 (« AAAA-MM-DDThh :mm :ssZ », voir https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).
links

WebHookLinks

WebHookLinks
properties

WebHookProperties

WebHookProperties
self

string

Emplacement de cette entité.
status

Status

Statut
Décrire l’état actuel de l’API.
webUrl

string

URL inscrite à laquelle envoyer les demandes POST pour les événements inscrits.

WebHookEvents

WebHookEvents

Nom 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

Nom Type Description
ping

string

URL qui peut être utilisée pour déclencher l’envoi d’un événement ping à l’URL inscrite d’une inscription de hook web. Pour plus d’informations, consultez l’opération « WebHooks_Ping ».
test

string

URL qui peut être utilisée pour envoyer des événements de test à l’URL inscrite d’une inscription de hook web. Pour plus d’informations, consultez l’opération « WebHooks_Test ».

WebHookProperties

WebHookProperties

Nom Type Description
apiVersion

string

La version de l’API dans laquelle le hook web a été créé. Cela définit la forme de la charge utile dans les rappels. Si le type de charge utile n’est plus pris en charge, car la forme a changé et que la version de l’API l’utilise est supprimée (après la dépréciation), le hook web est désactivé.
error

EntityError

EntityError
secret

string

Secret qui sera utilisé pour créer un hachage SHA256 de la charge utile avec le secret en tant que clé HMAC. Ce hachage est défini en tant qu’en-tête X-MicrosoftSpeechServices-Signature lors de l’appel à l’URL inscrite.