Web Hooks - List

Referência

Serviço:: Azure AI Services

Versão da API:: 3.2

Obtém a lista de web hooks para a subscrição autenticada.

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

Com parâmetros opcionais:

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

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
endpoint	path	True	string	Pontos finais dos Serviços Cognitivos suportados (protocolo e nome do anfitrião, por exemplo: https://westus.api.cognitive.microsoft.com).
filter	query		string	Uma expressão de filtragem para selecionar um subconjunto dos ganchos disponíveis. `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	Número de conjuntos de dados que serão ignorados.
top	query		integer int32	Número de conjuntos de dados que serão incluídos após ignorar.

Respostas

Name	Tipo	Description
200 OK	PaginatedWebHooks	OK Cabeçalhos Retry-After: integer
Other Status Codes	Error	Ocorreu um erro.

Name

Tipo

Description

200 OK

PaginatedWebHooks

Cabeçalhos

Retry-After: integer

Other Status Codes

Error

Ocorreu um erro.

Segurança

Ocp-Apim-Subscription-Key

Forneça a chave da conta dos serviços cognitivos aqui.

Tipo: apiKey
Em: header

Authorization

Forneça um token de acesso do JWT devolvido pelo STS desta região. Certifique-se de que adiciona o âmbito de gestão ao token ao adicionar a seguinte cadeia de consulta ao URL de STS: ?scope=speechservicesmanagement

Tipo: apiKey
Em: header

Exemplos

Get all web hooks

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

Get all web hooks

Pedido de amostra

HTTP

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

Resposta da amostra

Código de estado:: 200

{
  "values": [
    {
      "displayName": "TranscriptionCompletionWebHook",
      "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/webhooks/aff13a6e-17c4-4247-862f-70e99469c553",
      "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": "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/webhooks/9db10a08-189e-4de4-b31a-38b39d993b37",
      "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"
    }
  ],
  "@nextLink": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.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

Pedido de amostra

HTTP

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

Resposta da amostra

Código de estado:: 200

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

Definições

Name	Description
DetailedErrorCode	DetailedErrorCode
EntityError	EntityError
Error	Erro
ErrorCode	CódigoDoErro
InnerError	InnerError
PaginatedWebHooks	PaginatedWebHooks
Status	Estado
WebHook	WebHook
WebHookEvents	WebHookEvents
WebHookLinks	WebHookLinks
WebHookProperties	WebHookProperties

DetailedErrorCode

Name	Tipo	Description
DataImportFailed	string	Falha na importação de dados.
DeleteNotAllowed	string	Eliminar não permitido.
DeployNotAllowed	string	A implementação não é permitida.
DeployingFailedModel	string	A implementação do modelo com falha.
EmptyRequest	string	Pedido Vazio.
EndpointCannotBeDefault	string	O ponto final não pode ser predefinido.
EndpointNotUpdatable	string	O ponto final não é atualizável.
EndpointWithoutLogging	string	Ponto final sem registo.
ExceededNumberOfRecordingsUris	string	Número excedido de uris de gravações.
FailedDataset	string	Conjunto de dados com falha.
Forbidden	string	Proibido.
InUseViolation	string	Violação de utilização.
InaccessibleCustomerStorage	string	Armazenamento de clientes inacessível.
InvalidAdaptationMapping	string	Mapeamento de adaptação inválido.
InvalidBaseModel	string	Modelo base inválido.
InvalidCallbackUri	string	URI de chamada de retorno inválido.
InvalidChannels	string	Canais inválidos.
InvalidCollection	string	Coleção inválida.
InvalidDataset	string	Conjunto de dados inválido.
InvalidDocument	string	Documento inválido.
InvalidDocumentBatch	string	Lote de Documentos inválido.
InvalidLocale	string	Região inválida.
InvalidLogDate	string	Data de registo inválida.
InvalidLogEndTime	string	Hora de fim do registo inválida.
InvalidLogId	string	ID de registo inválido.
InvalidLogStartTime	string	Hora de início do registo inválida.
InvalidModel	string	Modelo inválido.
InvalidModelUri	string	URI de modelo inválido.
InvalidParameter	string	Parâmetro inválido.
InvalidParameterValue	string	Valor de parâmetro inválido.
InvalidPayload	string	Payload inválido.
InvalidPermissions	string	Permissões inválidas.
InvalidPrerequisite	string	Pré-requisito inválido.
InvalidProductId	string	ID de produto inválido.
InvalidProject	string	Projeto inválido.
InvalidProjectKind	string	Tipo de projeto inválido.
InvalidRecordingsUri	string	URI de gravações inválido.
InvalidRequestBodyFormat	string	Formato do corpo do pedido inválido.
InvalidSasValidityDuration	string	Duração de validade sas inválida.
InvalidSkipTokenForLogs	string	Token de ignorar inválido para registos.
InvalidSourceAzureResourceId	string	ID de recurso do Azure de origem inválido.
InvalidSubscription	string	Subscrição inválida.
InvalidTest	string	Teste inválido.
InvalidTimeToLive	string	Tempo de vida inválido.
InvalidTopForLogs	string	Top inválido para registos.
InvalidTranscription	string	Transcrição inválida.
InvalidWebHookEventKind	string	Tipo de evento de web hook inválido.
MissingInputRecords	string	Registos de Entrada em Falta.
ModelCopyAuthorizationExpired	string	ModelCopyAuthorization expirado.
ModelDeploymentNotCompleteState	string	A implementação do modelo não está concluída.
ModelDeprecated	string	Modelo preterido.
ModelExists	string	O modelo existe.
ModelMismatch	string	Erro de correspondência do modelo.
ModelNotDeployable	string	Modelo não implementável.
ModelVersionIncorrect	string	Versão do Modelo Incorreta.
NoUtf8WithBom	string	Não utf8 com bom.
OnlyOneOfUrlsOrContainerOrDataset	string	Apenas um dos URLs, contentor ou conjunto de dados.
ProjectGenderMismatch	string	Erro de correspondência de género do projeto.
QuotaViolation	string	Violação de quota.
SingleDefaultEndpoint	string	Ponto final predefinido único.
SkuLimitsExist	string	Existem limites de SKU.
SubscriptionNotFound	string	Subscrição não encontrada.
UnexpectedError	string	Erro inesperado.
UnsupportedClassBasedAdaptation	string	Adaptação baseada em classes não suportada.
UnsupportedDelta	string	Delta não suportado.
UnsupportedDynamicConfiguration	string	Configuração dinâmica não suportada.
UnsupportedFilter	string	Filtro não suportado.
UnsupportedLanguageCode	string	Código de idioma não suportado.
UnsupportedOrderBy	string	Encomenda não suportada por.
UnsupportedPagination	string	Paginação não suportada.
UnsupportedTimeRange	string	Intervalo de tempo não suportado.

EntityError

Name	Tipo	Description
code	string	O código deste erro.
message	string	A mensagem para este erro.

Error

Erro

Name	Tipo	Description
code	ErrorCode	CódigoDoErro Códigos de erro de alto nível.
details	Error[]	Detalhes de suporte adicionais sobre o erro e/ou as políticas esperadas.
innerError	InnerError	InnerError Novo formato de Erro Interno que está em conformidade com as Diretrizes da API dos Serviços Cognitivos que estão disponíveis em https://microsoft.sharepoint.com/%3Aw%3A/t/CognitiveServicesPMO/EUoytcrjuJdKpeOKIK_QRC8BPtUYQpKBi8JsWyeDMRsWlQ?e=CPq8ow. Esta ação contém as propriedades necessárias ErrorCode, destino de mensagens e propriedades opcionais, detalhes (par de valores de chave), erro interno (isto pode ser aninhado).
message	string	Mensagem de erro de alto nível.
target	string	A origem do erro. Por exemplo, seria "documentos" ou "ID do documento" em caso de documento inválido.

ErrorCode

CódigoDoErro

Name	Tipo	Description
Conflict	string	Representando o código de erro de conflito.
Forbidden	string	Representando o código de erro proibido.
InternalCommunicationFailed	string	A representação do código de erro de comunicação interna falhou.
InternalServerError	string	Representando o código de erro interno do servidor.
InvalidArgument	string	Representando o código de erro de argumento inválido.
InvalidRequest	string	Representando o código de erro de pedido inválido.
NotAllowed	string	Representando o código de erro não permitido.
NotFound	string	Representa o código de erro não encontrado.
PipelineError	string	Representando o código de erro do pipeline.
ServiceUnavailable	string	Representando o código de erro indisponível do serviço.
TooManyRequests	string	Representando o código de erro demasiados pedidos.
Unauthorized	string	Representa o código de erro não autorizado.
UnprocessableEntity	string	Representando o código de erro de entidade não processado.
UnsupportedMediaType	string	Representando o código de erro de tipo de suporte de dados não suportado.

InnerError

Name	Tipo	Description
code	DetailedErrorCode	DetailedErrorCode Enum de código de erro detalhado.
details	object	Detalhes de suporte adicionais sobre o erro e/ou as políticas esperadas.
innerError	InnerError	InnerError Novo formato de Erro Interno que está em conformidade com as Diretrizes da API dos Serviços Cognitivos que estão disponíveis em https://microsoft.sharepoint.com/%3Aw%3A/t/CognitiveServicesPMO/EUoytcrjuJdKpeOKIK_QRC8BPtUYQpKBi8JsWyeDMRsWlQ?e=CPq8ow. Esta ação contém as propriedades necessárias ErrorCode, destino de mensagens e propriedades opcionais, detalhes (par de valores de chave), erro interno (isto pode ser aninhado).
message	string	Mensagem de erro de alto nível.
target	string	A origem do erro. Por exemplo, seria "documentos" ou "ID do documento" em caso de documento inválido.

PaginatedWebHooks

Name	Tipo	Description
@nextLink	string	Uma ligação para o próximo conjunto de resultados paginados se existirem mais entidades disponíveis; caso contrário, nulo.
values	WebHook[]	Uma lista de entidades limitada pelos parâmetros de consulta transmitidos "ignorar" e "top" ou os respetivos valores predefinidos. Ao iterar através de uma lista através da paginação e eliminação de entidades em paralelo, algumas entidades serão ignoradas nos resultados. É recomendado criar uma lista no cliente e eliminar após a obtenção da lista completa.

Name

Tipo

Description

@nextLink

string

Uma ligação para o próximo conjunto de resultados paginados se existirem mais entidades disponíveis; caso contrário, nulo.

values

WebHook[]

Uma lista de entidades limitada pelos parâmetros de consulta transmitidos "ignorar" e "top" ou os respetivos valores predefinidos.

Ao iterar através de uma lista através da paginação e eliminação de entidades em paralelo, algumas entidades serão ignoradas nos resultados. É recomendado criar uma lista no cliente e eliminar após a obtenção da lista completa.

Status

Estado

Name	Tipo	Description
Failed	string	A operação de execução prolongada falhou.
NotStarted	string	A operação de execução prolongada ainda não foi iniciada.
Running	string	A operação de execução prolongada está atualmente a ser processada.
Succeeded	string	A operação de execução prolongada foi concluída com êxito.

WebHook

Name	Tipo	Description
createdDateTime	string	O carimbo de data/hora quando o objeto foi criado. O carimbo de data e hora é codificado como formato de data e hora ISO 8601 ("YYYYY-MM-DDThh:mm:ssZ", consulte https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).
customProperties	object	As propriedades personalizadas desta entidade. O comprimento máximo permitido da chave é de 64 carateres, o comprimento máximo permitido do valor é de 256 carateres e a contagem de entradas permitidas é de 10.
description	string	A descrição do objeto.
displayName	string	O nome a apresentar do objeto.
events	WebHookEvents	WebHookEvents
lastActionDateTime	string	O carimbo de data/hora quando o estado atual foi introduzido. O carimbo de data e hora é codificado como formato de data e hora ISO 8601 ("YYYYY-MM-DDThh:mm:ssZ", consulte https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).
links	WebHookLinks	WebHookLinks
properties	WebHookProperties	WebHookProperties
self	string	A localização desta entidade.
status	Status	Estado Descreva o estado atual da API.
webUrl	string	O URL registado que será utilizado para enviar os pedidos POST para os eventos registados.

WebHookEvents

Name	Tipo	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	Tipo	Description
ping	string	O URL que pode ser utilizado para acionar o envio de um evento de ping para o URL registado de um registo de web hook. Veja a operação "WebHooks_Ping" para obter mais detalhes.
test	string	O URL que pode ser utilizado para enviar eventos de teste para o URL registado de um registo de web hook. Veja a operação "WebHooks_Test" para obter mais detalhes.

WebHookProperties

Name	Tipo	Description
apiVersion	string	A versão da API em que o web hook foi criado. Isto define a forma do payload nas chamadas de retorno. Se o tipo de payload já não for suportado, porque a forma foi alterada e a versão da API que o utiliza é removida (após a preterição), o web hook será desativado.
error	EntityError	EntityError
secret	string	Um segredo que será utilizado para criar um hash SHA256 do payload com o segredo como chave HMAC. Este hash será definido como cabeçalho X-MicrosoftSpeechServices-Signature quando voltar a ligar para o URL registado.

Partilhar via

Web Hooks - List

Parâmetros do URI

Respostas

Segurança

Ocp-Apim-Subscription-Key

Authorization

Exemplos

Get all web hooks

Pedido de amostra

Resposta da amostra

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

Pedido de amostra

Resposta da amostra

Definições

DetailedErrorCode

EntityError

Error

ErrorCode

InnerError

PaginatedWebHooks

Status

WebHook

WebHookEvents

WebHookLinks

WebHookProperties

Recursos adicionais