Перейти до змісту

Оператори (Operators)

Керуйте операторами чатів у межах ваших організацій. Оператори — це ваші менеджери чи агенти підтримки, які працюють з клієнтами.

Огляд

Оператори в ChatHub:

  • Обробляють розмови з клієнтами (чати).
  • Належать до конкретних організацій (відділів).
  • Мають статус: активний, неактивний або видалений.
  • Можуть отримувати індивідуальні токени авторизації для обробки та інтеграції в систему.
  • Приймають та надсилають повідомлення.

Список Операторів

Отримайте всіх операторів для вказаної організації.

Ендпоінт

GET /api/operator?organizationId={id}

Запит

curl -X GET "https://chatapi.smsbat.com/api/operator?organizationId=24" \
  -H "Authorization: Bearer {company-token}" \
  -H "Accept: text/plain"

Параметри

Параметр Тип Розташування Обов'язково Опис
organizationId integer Query Так ID Організації

Заголовки

Заголовок Значення Обов'язково
Authorization Bearer Так
Accept text/plain Так

Відповідь (Response)

[
  {
    "id": 101,
    "name": "Іванна Іванова",
    "status": 0,
    "organization": {
      "id": 24,
      "name": "Служба підтримки"
    }
  },
  {
    "id": 102,
    "name": "Олександр Сидоров",
    "status": 1,
    "organization": {
      "id": 24,
      "name": "Служба підтримки"
    }
  }
]

Поля відповіді

Поле Тип Опис
id integer Унікальний ідентифікатор оператора
name string Відображуване ім'я оператора
status integer Статус оператора (0=Активний, 1=Неактивний, 2=Видалений)
organization object Деталі батьківської організації
organization.id integer ID організації
organization.name string Назва організації

Статус Оператора

Статус Значення Опис
Активний (Active) 0 Оператор зараз працює і може приймати чати.
Неактивний (Inactive) 1 Оператор тимчасово відключений.
Видалений (Deleted) 2 Оператора видалено із системи.

Додавання Операторів

Додавайте нових операторів до організацій через ендпоінт синхронізації (synchronize).

Ендпоінт

POST /api/operator/synchronize

Запит

curl -X POST https://chatapi.smsbat.com/api/operator/synchronize \
  -H "Authorization: Bearer {company-token}" \
  -H "Content-Type: application/json" \
  -d '[
    {
      "organizationId": 24,
      "name": "Олексій Петров"
    },
    {
      "organizationId": 24,
      "name": "Дарина Василенко"
    }
  ]'

Тіло Запиту

Масив об'єктів операторів:

[
  {
    "organizationId": 24,
    "name": "Олексій Петров"
  },
  {
    "organizationId": 24,
    "name": "Дарина Василенко"
  }
]

Поля Запиту

Поле Тип Обов'язково Опис
organizationId integer Так Цільовий ID організації
name string Так Відображуване ім'я

Відповідь

[
  {
    "id": 104,
    "name": "Олексій Петров",
    "status": 0
  },
  {
    "id": 105,
    "name": "Дарина Василенко",
    "status": 0
  }
]

Зміна Статусу Оператора

Оновлюйте статус оператора (Активний/Неактивний/Видалений).

Ендпоінт

POST /api/operator/status

Запит

curl -X POST https://chatapi.smsbat.com/api/operator/status \
  -H "Authorization: Bearer {company-token}" \
  -H "Content-Type: application/json" \
  -d '{
    "id": 104,
    "status": 1
  }'

Тіло Запиту

{
  "id": 0,
  "status": 0
}

Поля Запиту

Поле Тип Обов'язково Опис
id integer Так ID Оператора
status integer Так Новий статус (0=Активний, 1=Неактивний, 2=Видалений)

Відповідь

200 OK

Успіх повертає HTTP статус 200 без тіла відповіді.

Приклад: Деактивація оператора

curl -X POST https://chatapi.smsbat.com/api/operator/status \
  -H "Authorization: Bearer {company-token}" \
  -H "Content-Type: application/json" \
  -d '{
    "id": 104,
    "status": 1
  }'

Приклад: Повернення до активного статусу

curl -X POST https://chatapi.smsbat.com/api/operator/status \
  -H "Authorization: Bearer {company-token}" \
  -H "Content-Type: application/json" \
  -d '{
    "id": 104,
    "status": 0
  }'

Приклад: Видалення оператора

curl -X POST https://chatapi.smsbat.com/api/operator/status \
  -H "Authorization: Bearer {company-token}" \
  -H "Content-Type: application/json" \
  -d '{
    "id": 104,
    "status": 2
  }'

Вирішення Проблем

Помилка "List is empty" або Оператори не знайдено

  • Перевірте, чи правильний ідентифікатор організації (organizationId).
  • Перевірте, чи існують в базі даної організації оператори взагалі.
  • Переконайтеся, що токен компанії дає доступ до цієї конкретної організації.

Помилка 401 Unauthorized

  • Перевірте, чи токен компанії дійсний та чи не скінчився його термін дії.
  • У разі потреби запитайте новий токен компанії.

Дублювання Операторів

Ендпоінт синхронізації дозволяє операторів із однаковими іменами. Завжди перевіряйте ім'я перед відправленням запиту, щоб уникнути створення дублікатів.

Наступні Кроки