API Групп

Управляйте группами контактов для ваших кампаний.

POST /api/groups

Создайте новую группу контактов.

Тело запроса

json
{
  "name": "VIP Customers",
  "description": "High-value clients"
}

Ответ

json
{
  "id": "group-uuid",
  "name": "VIP Customers",
  "description": "High-value clients",
  "clientCount": 0,
  "createdAt": "2024-01-15T10:00:00Z"
}
GET /api/groups

Получите список всех групп с пагинацией.

bash
curl -H "Authorization: Bearer $TOKEN" \
  "https://api.xabarchi.live/api/groups?page=1&limit=20"
POST /api/groups/:id/clients

Добавьте клиента в группу.

Тело запроса

json
{
  "phoneNumber": "+998901234567",
  "name": "John Doe"
}
Примечание: Номер телефона должен быть в формате +998XXXXXXXXX
POST /api/groups/:id/import

Массовый импорт клиентов из Excel файла.

Запрос

bash
curl -X POST \
  -H "Authorization: Bearer $TOKEN" \
  -F "file=@contacts.xlsx" \
  https://api.xabarchi.live/api/groups/group-123/import

Формат Excel

phoneNumber name
+998901234567 John Doe

Ответ

json
{
  "jobId": "import-xyz",
  "message": "Import started"
}
GET /api/groups/import/:jobId

Отслеживайте прогресс импорта.

Ответ

json
{
  "jobId": "import-xyz",
  "status": "completed",
  "totalRows": 1000,
  "importedCount": 985,
  "skippedCount": 10,
  "errorCount": 5
}
DELETE /api/groups/:id

Удалите группу и всех её клиентов.

bash
curl -X DELETE \
  -H "Authorization: Bearer $TOKEN" \
  https://api.xabarchi.live/api/groups/group-123