Створити чат

Створіть один чат від імені конкретного контакту
Написано Микола
Оновлено 6 місяців тому

Ви можете створити чат від імені контакту за допомогою цього методу. Для додавання повідомлення у створений чат скористайтеся методом Створити повідомлення.

Не рекомендується створювати порожні чати без повідомлень.

➡️ Запит

URL https://api.helpcrunch.com/v1/chats
Метод POST
Headers Authorization: Bearer <your_api_key>

Щоб створити чат, ви повинні вказати ID контакту (обов’язково) у тілі запиту POST.

Ви також можете вказати відповідального за чат (необов’язково), відділ (необов’язково) і застосунок (обовʼязково):

{
    "customer": 8738438,
    "assignee": 4188,
    "department": 233048,
    "application": 3838
}

Як отримати ID усіх учасників команди
Як отримати ID усіх відділів
Як отримати ID усіх застосунків

✅ Відповідь на успішний запит

Якщо ваш запит пройшов успішно, ви отримаєте код статусу успішного виконання 201 Created разом із наведеним нижче тілом відповіді.

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

Ви можете отримати деталі по кожному полю обʼєкту чату у статті Модель даних чату.

🛑 Відповіді з помилками

Ви можете отримати один із наведених нижче кодів статусу помилки та відповіді. Детальніше про коди помилок ви можете прочитати за посиланням.

400 Bad Request

{
  "errors": [
    {
      "code": "invalid_request",
      "message": "Invalid request"
    },
    {
      "code": "customer",
      "message": "This value should be of type numeric."
    },
    {
      "code": "filter[0].field",
      "message": "This value should not be blank."
    }
  ]
}

401 Unauthorized

{
  "errors": [
    {
      "code": "invalid_request",
      "message": "Invalid request"
    },
    {
      "code": "unauthorized",
      "message": "Unauthorized"
    }
  ]
}

409 Conflict

{
  "errors": [
    {
      "code": "invalid_request",
      "message": "Invalid request"
    },
    {
      "code": "conflict",
      "message": "Snooze chat is not allowed for closed chat"
    }
  ]
}

429 Too Many Requests

{
  "errors": [
    {
      "code": "invalid_request",
      "message": "Invalid request"
    },
    {
      "code": "too_many_requests",
      "message": "Too many requests"
    }
  ]
}
Чи була наша стаття корисною?