/api/v4/locations/reviews/respondResponder a uma interação
Publica uma resposta pública a uma avaliação ou interação na plataforma de origem.
Parâmetros
Corpo
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| interactionId | string | obrigatório | UUID of the interaction to respond to. Take it from an interaction's `id` or `interactionId`, which are the same value. It is a plain UUID, with no numeric or Base64 Relay form. |
| responseContent | string | obrigatório | Text content of the response to post. |
| respondedWith | string | opcional | Response-template ID to attribute the reply to, if it was generated from a template. |
Exemplo de requisição
Corpo pronto para colar. Substitua os IDs e valores de exemplo pelos seus.
{ "interactionId": "9e26d2a8-a6ed-42ea-8454-47d1c92ea841", "responseContent": "Thank you for visiting Jenny Home: we're glad you enjoyed your experience!"}Respostas
200Response accepted and queued for posting. `data.respondToInteraction.interaction` holds the created response.
{ "data": { "respondToInteraction": { "interaction": { "id": "2090753a-ece6-4837-8336-8494ad308523", "interactionId": "9e26d2a8-a6ed-42ea-8454-47d1c92ea841", "content": "Thank you for visiting Jenny Home: we're glad you enjoyed your experience!", "interactionStatus": "CREATED", "editedResponse": false }, "errors": null } }}401Unauthenticated, missing or invalid API key.
Erros comuns
- SY50121: Google Reviews accept only a single owner reply per review; a second response is rejected.
Publica uma resposta a uma avaliação ou interação na plataforma de origem (e.g. Google, Facebook). A resposta é enviada de forma assíncrona: interactionStatus é definido como CREATED imediatamente e muda para COMPLETED ou CONFIRMED assim que a plataforma confirma o recebimento (ou FAILED, consulte o fluxo de status da resposta).
Nem todas as plataformas aceitam respostas de proprietários. Verifique canRespond no objeto da interação antes de fazer a chamada. As avaliações do Google aceitam apenas uma resposta por avaliação (uma nova tentativa retorna SY50121); use Editar uma resposta para alterar uma resposta existente em vez de publicar uma nova.
Caso de uso: responder automaticamente a novas avaliações de 5 estrelas
Para agradecer automaticamente às pessoas que deixaram avaliações positivas, consulte periodicamente Listar interações com ratingFilters=[5] e responseStatus=["PENDING"] e, para cada node retornado cujo canRespond seja true, use POST para enviar seu id como interactionId com seu responseContent:
{ "interactionId": "9e26d2a8-a6ed-42ea-8454-47d1c92ea841", "responseContent": "Thank you for visiting Jenny Home: we're glad you enjoyed your experience!"}Como a publicação é assíncrona, busque novamente a interação por meio de Obter interações por IDs para confirmar que a resposta atingiu COMPLETED/CONFIRMED, em vez de presumir o sucesso com base em 200.
curl -X POST 'https://listingsapi.com/api/v4/locations/reviews/respond' \ -H "Authorization: API $LISTINGSAPI_KEY" \ -H 'Content-Type: application/json' \ -d '{ "interactionId": "9e26d2a8-a6ed-42ea-8454-47d1c92ea841", "responseContent": "Thank you for visiting Jenny Home: we're glad you enjoyed your experience!" }'