/api/v4/locations/reviews/respondResponder a una interacción
Publica una respuesta pública a una reseña o interacción en su plataforma de origen.
Parámetros
Cuerpo
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
| interactionId | string | obligatorio | 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 | obligatorio | 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. |
Solicitud de ejemplo
Cuerpo listo para pegar. Sustituye los ID y valores de ejemplo por los tuyos.
{ "interactionId": "9e26d2a8-a6ed-42ea-8454-47d1c92ea841", "responseContent": "Thank you for visiting Jenny Home: we're glad you enjoyed your experience!"}Respuestas
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.
Errores habituales
- SY50121: Google Reviews accept only a single owner reply per review; a second response is rejected.
Publica una respuesta a una reseña o interacción en su plataforma de origen (e.g. Google, Facebook). La respuesta se envía de forma asíncrona: interactionStatus pasa inmediatamente a CREATED y cambia a COMPLETED o CONFIRMED cuando la plataforma confirma su recepción (o a FAILED, consulta el flujo de estados de la respuesta).
No todas las plataformas admiten respuestas del propietario. Comprueba canRespond en el objeto de interacción antes de realizar la llamada. Las reseñas de Google solo admiten una respuesta por reseña (un intento repetido devuelve SY50121); usa Editar una respuesta para modificar una respuesta existente en lugar de publicar una nueva.
Caso de uso: responder automáticamente a nuevas reseñas de 5 estrellas
Para dar las gracias automáticamente a quienes dejan reseñas positivas, consulta periódicamente Listar interacciones con ratingFilters=[5] y responseStatus=["PENDING"] y, después, por cada node devuelto cuyo canRespond sea true, envía mediante POST su id como interactionId con tu responseContent:
{ "interactionId": "9e26d2a8-a6ed-42ea-8454-47d1c92ea841", "responseContent": "Thank you for visiting Jenny Home: we're glad you enjoyed your experience!"}Como la publicación es asíncrona, vuelve a obtener la interacción mediante Obtener interacciones por IDs para confirmar que la respuesta ha alcanzado COMPLETED/CONFIRMED, en lugar de dar por hecho que se ha publicado correctamente a partir de 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!" }'