Окрім оцінки чату клієнтом у віджеті чату, чати можна оцінювати за допомогою запиту API. Читайте більше про оцінку чату.
➡️ Request
URL | https://api.helpcrunch.com/v1/chats/rate |
Метод | PUT |
Headers | Authorization: Bearer <your_api_key> |
Дізнайтеся більше про authorization header тут.
Додаткові параметри
Укажіть chat id (обов'язково) та rating (обов'язково) в тілі вашого PUT-запиту.
{
"id": 5208,
"rating": "poor"
}
id - це ідентифікатор чату, наданий HelpCrunch.
rating відображає якість чату і може бути одним з наступних: perfect
, great
, average
, poor
, або very poor
.
Ці внутрішні назви оцінок відповідають цим оцінкам у чаті:
- 😃 Excellent
- 🙂 Good
- 😐 Average
- 😕 Poor
- 😔 Very poor
✅ Відповідь на успішний запит
Якщо ваш запит успішний, ви отримаєте статус-код 200 OK разом з інформацією про чат у тілі відповіді.
{
"id": 542335,
"closedBy": "string",
"lastCustomerMessageAt": "1603885746",
"status": "new",
"closedAt": "1603885746",
"rating": "perfect",
"createdAt": "1603885746",
"lastMessageAt": "1603885746",
"createdWith": "string",
"snoozedUntil": "1603885746",
"lastMessageText": "string",
"lastMessageId": 542335,
"applicationId": 542335,
"lastCommunicatedAgentId": 542335,
"agents": [
{
"id": 542335,
"name": "string",
"email": "string",
"role": "string"
}
],
"customer": {
"id": 542335,
"name": "string",
"email": "string",
"userId": "string"
},
"assignee": {
"id": 542335,
"name": "string",
"email": "string",
"role": "string"
},
"department": {
"id": 542335,
"name": "string"
}
}
Ви можете отримати деталі про кожне поле об'єкта чату в статті Модель даних чату
Це приклад відображення оцінки в чаті:
🛑 Відповіді з помилками
Ви можете отримати один з наступних статус-кодiв помилки та відповідей. Більше інформації про помилки тут.
{
"errors": [
{
"code": "invalid_request",
"message": "Chat must me closed to rate"
}
]
}
400 Bad Request
{
"errors": [
{
"code": "invalid_rating_value",
"message": "The value you selected is not a valid choice. Valid rating: 'perfect', 'great', 'average', 'poor', 'very poor'"
}
]
}
401 Unauthorized
{
"errors": [
{
"code": "invalid_request",
"message": "Invalid request"
},
{
"code": "unauthorized",
"message": "Unauthorized"
}
]
}
{
"errors": [
{
"code": "invalid_request",
"message": "Invalid request"
},
{
"code": "conflict",
"message": "Chat is already rated"
}
]
}
{
"errors": [
{
"code": "invalid_request",
"message": "Invalid request"
},
{
"code": "conflict",
"message": "Cannot rate chat without agent communication"
}
]
}
429 Too Many Requests
{
"errors": [
{
"code": "invalid_request",
"message": "Invalid request"
},
{
"code": "too_many_requests",
"message": "Too many requests"
}
]
}
Якщо у вас є будь-які запитання щодо REST API, не соромтеся звертатися до нас у будь-який час.
👩💻 Щасливого кодування! 👨💻