POST/api/v4/locations/reviews/respond

Auf eine Interaktion antworten

Veröffentlicht eine öffentliche Antwort auf eine Bewertung oder Interaktion auf deren Ursprungsplattform.

Erfordert einen API-Schlüssel. Format des Headers und Schlüsselrotation finden Sie unter Authentifizierung.

Parameter

Body

NameTypErforderlichBeschreibung
interactionIdstringerforderlichUUID 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.
responseContentstringerforderlichText content of the response to post.
respondedWithstringoptionalResponse-template ID to attribute the reply to, if it was generated from a template.

Beispielanfrage

Body zum direkten Einfügen. Ersetzen Sie Platzhalter-IDs und -Werte durch Ihre eigenen.

Request body
{  "interactionId": "9e26d2a8-a6ed-42ea-8454-47d1c92ea841",  "responseContent": "Thank you for visiting Jenny Home: we're glad you enjoyed your experience!"}

Antworten

200Response accepted and queued for posting. `data.respondToInteraction.interaction` holds the created response.
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.

Häufige Fehler

  • SY50121: Google Reviews accept only a single owner reply per review; a second response is rejected.

Veröffentlicht eine Antwort auf eine Bewertung oder Interaktion auf deren Ursprungsplattform (e.g. Google, Facebook). Die Antwort wird asynchron übermittelt: interactionStatus ist zunächst CREATED und wechselt zu COMPLETED oder CONFIRMED, sobald die Plattform die Antwort bestätigt (oder zu FAILED, siehe Statusablauf einer Antwort).

Nicht jede Plattform unterstützt Antworten von Inhabern. Prüfen Sie vor dem Aufruf canRespond am Interaktionsobjekt. Bei Google-Bewertungen ist nur eine Antwort pro Bewertung zulässig (ein erneuter Versuch gibt SY50121 zurück); verwenden Sie Antwort bearbeiten, um eine bestehende Antwort zu ändern, statt eine neue zu veröffentlichen.

Anwendungsfall: automatisch auf neue 5-Sterne-Bewertungen antworten

Um zufriedenen Bewertenden automatisch zu danken, rufen Sie Interaktionen auflisten regelmäßig mit ratingFilters=[5] und responseStatus=["PENDING"] ab und übermitteln Sie dann für jedes zurückgegebene node, dessen canRespond den Wert true hat, dessen id per POST als interactionId zusammen mit Ihrem responseContent:

JSON
{  "interactionId": "9e26d2a8-a6ed-42ea-8454-47d1c92ea841",  "responseContent": "Thank you for visiting Jenny Home: we're glad you enjoyed your experience!"}

Da die Veröffentlichung asynchron erfolgt, rufen Sie die Interaktion über Interaktionen anhand von IDs abrufen erneut ab, um zu bestätigen, dass die Antwort COMPLETED/CONFIRMED erreicht hat, statt anhand von 200 von einem Erfolg auszugehen.

Request
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!"  }'