Dieser Artikel beschreibt sowohl die Erstellung von Vorlagen über eine API als auch das Versenden von Bewertungsanfragen an Ihre Kunden.

Erstellung einer Vorlage für eine Überprüfungsanfrage

https://uberall.com/api/customer-engagement/swagger/review-generation-service-1.1.yml

Schritt 1 – Erstellung einer Vorlage

Anfrage

POST /api/customer-engagement/review-template

Nutzlast

{
  "name": "string",
  "locationIds": [
    0
  ],
  "bodyText": "string",
  "senderName": "string",
  "email": {
    "senderEmailId": "user@example.com",
    "footerText": "string",
    "subject": "string",
    "actionButtonColor": "#A7a",
    "privacyLink": "https://?:~Ei;cIlzZKbqn||hjX@EM",
    "mediaIds": [
      0
    ]
  },
  "reviewLinks": [
    {
      "url": "http://wG:UNbW=tSZqof.wFRxZoi;P/%VmBnhlMu:_88Z0NvyCK410Q7vm9cjOKqSPzzsibs!#L+",
      "label": "string"
    }
  ]
}

Antwort

{
  "id": 0,
  "type": "string",
  "name": "string",
  "locationIds": [
    0
  ],
  "bodyText": "string",
  "senderName": "string",
  "email": {
    "senderEmailId": "string",
    "footerText": "string",
    "subject": "string",
    "actionButtonColor": "string",
    "privacyLink": "string",
    "media": [
      {
        "mediaId": 0,
        "message": "string",
        "uploadUrl": "string"
      }
    ]
  },
  "reviewLinks": [
    {
      "url": "string",
      "label": "string"
    }
  ],
  "createdAt": "string",
  "updatedAt": "string",
  "errors": [
    "string"
  ],
  "message": "string"
}

Schritt 2 – Bestätigung Ihrer E-Mail-Identität (falls noch nicht bestätigt)

Anfrage

POST /api/customer-engagement/identities

Nutzlast

{
  "emailAddress": "user@example.com"
}

Antwort

{
  "emailAddress": "string",
  "identityType": "string",
  "verificationStatus": "string",
  "message": "string"
}

Anmerkungen:

• Nach der Anforderung einer Identität erhalten Sie eine E-Mail von AWS, um die Authentizität der Inhaberschaft der angeforderten E-Mail-Identität zu bestätigen.

Senden von Bewertungsanfragen an Ihre Kunden

https://uberall.com/api/customer-management/swagger/review-generation-customer-service-1.0.yml

Schritt 1 – Hochladen einer Liste der Kunden, die die Anfrage erhalten sollen

Anfrage

POST /api/customer-management/customers

Nutzlast

{
  "customerRequests": [
    {
      "businessId": 0,
      "email": "string",
      "locationId": 0,
      "name": "string",
      "phone": "string"
    }
  ]
}

Antwort

{
  "customerLocationIds": [
    0
  ],
  "message": "string"
}

Schritt 2 – Eine Anfrage an Ihre Kunden senden

Anfrage

POST /api/review-template/job

Erwartete Nutzlast

{
  "customerLocationIds": [
    0
  ],
  "reviewTemplateId": 0,
  "scheduledDateTimeUtc": "string"
}

Antwort

{
  "jobs": [
    {
      "batchId": 0,
      "reviewTemplate": {
        "name": "string",
        "bodyText": "string",
        "senderEmailId": "user@example.com",
        "senderName": "string",
        "type": "SMS",
        "createdAt": "2023-03-29T12:35:06.721Z",
        "updatedAt": "2023-03-29T12:35:06.721Z",
        "id": 0,
        "version": 0
      },
      "customerLocationId": 0,
      "status": "IN_PROGRESS",
      "createdAt": "2023-03-29T12:35:06.721Z",
      "scheduledDateTimeUtc": "2023-03-29T12:35:06.721Z",
      "id": 0,
      "version": 0
    }
  ],
  "message": "string"
}

Anmerkungen:

• Für alle Anfragen ist eine Authentifizierung erforderlich. Bitte verwenden Sie Ihren privaten API-Schlüssel.
• Wenn Sie eine Bewertungsanfrage senden, müssen Sie sowohl die Standort-ID (locationId) jedes Kunden als auch die gewünschte Bewertungsvorlagen-ID (reviewTemplateId) angeben.