Este artículo explica cómo crear plantillas mediante API y cómo enviar solicitudes de revisión a sus clientes.

Creación de una plantilla de solicitud de revisión

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

Paso 1 - Creación de plantilla

Pedido

POST /api/customer-engagement/review-template

Carga útil

{
  "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"
    }
  ]
}

Respuesta

{
  "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"
}

Paso 2 - Verificar su identidad de correo electrónico (si no la ha verificado previamente)

Pedido

POST /api/customer-engagement/identities

Carga útil

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

Respuesta

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

Notas:

• Tras solicitar una identidad, recibirá un correo electrónico de AWS para verificar y autenticar la propiedad de la identidad de correo electrónico solicitada.

Envío de solicitudes de reseñas a sus clientes

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

Paso 1: Subir una lista de los clientes que desea que reciban la solicitud

Pedido

POST /api/customer-management/customers

Carga útil

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

Respuesta

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

Paso 2: Enviar una solicitud a sus clientes

Pedido

POST /api/review-template/job

Carga útil prevista

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

Respuesta

{
  "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"
}

Notas:

• Todas las solicitudes requieren autenticación. Consulte su clave API privada.
• Al enviar una solicitud de reseñas, deberá incluir tanto el locationId relacionado con cada cliente como el reviewTemplateId deseado.