GET/api/v4/locations/photos/requests/{requestId}

Consultar o status do upload de fotos em lote

Retorna o status atual do processamento de uma solicitação de upload de fotos em lote.

Requer uma chave de API. Consulte Autenticação para ver o formato do cabeçalho e a rotação de chaves.

Parâmetros

Caminho

NomeTipoObrigatórioDescrição
requestIdstringobrigatórioUUID request ID returned in the `request` object by the add-photos endpoint when it queues a batch instead of uploading it inline.

Respostas

200Current status of the bulk upload request, with per-photo results once available.
Response
{  "data": {    "getLocationPhotosUploadStatus": {      "requestId": "e6c2d9d9-9a18-4015-88cf-9a4e19a6f49a",      "status": "SUCCESS",      "photos": [        {          "mediaId": "TWVkaWFGaWxlOjkxODI3",          "locationId": "TG9jYXRpb246MTgwMDI4OQ==",          "status": "SUCCESS",          "errorMessage": null        },        {          "mediaId": null,          "locationId": "TG9jYXRpb246MTgwMDI4OQ==",          "status": "ERROR",          "errorMessage": "Image dimensions below the minimum 250x250."        }      ]    }  }}
401Unauthenticated, missing or invalid API key.
429Rate limit exceeded. Retry after the `Retry-After` header value.

Consulta o status de um upload assíncrono de fotos em lote. Quando um lote é grande o suficiente, adicionar fotos do local o processa em segundo plano e retorna um requestId no objeto request em vez da mídia finalizada. O tamanho do lote que aciona esse comportamento é uma configuração do servidor, e não uma constante publicada, portanto, determine qual fluxo está sendo usado verificando se request.requestId foi retornado, e não contando suas próprias imagens. Consulte este endpoint periodicamente com esse requestId até que a tarefa chegue a um estado final.

Caso de uso: atualizar uma barra de progresso do upload. Após o upload de um lote grande, consulte o status a cada poucos segundos enquanto status for PROCESSING. Quando mudar para SUCCESS ou ERROR, leia o array photos para obter o resultado de cada imagem: cada entrada contém o mediaId resultante (em caso de sucesso) e um par status/errorMessage para que você possa mostrar exatamente quais arquivos foram rejeitados e por quê (dimensões incorretas, formato não compatível etc.), em vez de tratar o lote inteiro como uma falha.

Valores de status: PROCESSING (ainda em processamento: consulte novamente), SUCCESS (a tarefa terminou o processamento), ERROR (a própria tarefa falhou; inspecione photos[].errorMessage).

O status status da tarefa indica apenas que o processamento terminou, não que todas as imagens foram processadas com sucesso. Uma tarefa com status SUCCESS ainda pode conter fotos rejeitadas, como no exemplo acima. Quando a tarefa sair de PROCESSING, percorra photos[] e leia os valores de status e errorMessage de cada entrada para descobrir quais imagens foram adicionadas.

Cuidado com as consultas periódicas: aguarde entre as consultas: um loop sem intervalo neste endpoint pode rapidamente resultar em 429. Respeite o cabeçalho Retry-After e prefira um intervalo de alguns segundos. Um requestId desconhecido ou expirado não será resolvido, portanto, consulte apenas IDs retornados por uma chamada recente de upload.

Request
curl -X GET 'https://listingsapi.com/api/v4/locations/photos/requests/<requestId>' \  -H "Authorization: API $LISTINGSAPI_KEY"