Skip to main content
GET
/
client
/
item-set
/
{item_set_id}
/
crm-data
cURL
curl --request GET \
  --url https://api.spellit.ai/api/client/item-set/{item_set_id}/crm-data \
  --header 'API-Access-Key: <api-key>'
{
"id_item_set": 123,
"crm_data": {
"customer_id": "CUST_001",
"customer_name": "CUST_NAME",
"contact_person": "Иван Иванов",
"phone": "+7-999-123-45-67",
"email": "[email protected]"
},
"created_at": "2024-01-15T10:30:00Z"
}
Возвращает CRM данные, связанные с указанным item_set.

Параметры

  • item_set_id (int, path, обязательный) - ID item_set

Примеры запросов

Пример 1: Базовый запрос CRM данных

curl -X GET "https://api.spellit.ai/api/client/item-set/123/crm-data" \
  -H "API-Access-Key: your access key"

Пример 2: Запрос с дополнительными заголовками

curl -X GET "https://api.spellit.ai/api/client/item-set/123/crm-data" \
  -H "API-Access-Key: your access key" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json"

Возможные ошибки

  • 401 Unauthorized - Отсутствует или неверный токен аутентификации
  • 403 Forbidden - Item_set не принадлежит текущему пользователю
  • 404 Not Found - Item_set с указанным ID не найден
  • 500 Internal Server Error - Внутренняя ошибка сервера

Описание полей ответа

  • id_item_set - ID item_set, для которого запрашивались CRM данные
  • crm_data - объект с CRM данными или null, если данные отсутствуют
    • Структура CRM данных зависит от настроек клиента
    • Может содержать любые поля, переданные при создании item_set
  • created_at - дата и время создания метаданных с CRM данными или null

Примечания

  • CRM данные извлекаются из processing_parameters.extra_processing_data.crm_data
  • Если CRM данные не были переданы при создании item_set, поле crm_data будет null
  • CRM данные могут быть любыми JSON объектами, структура определяется клиентом

Дополнительные примеры использования

Примеры обработки ошибок:

Ошибка аутентификации:

# Запрос без токена
curl -X GET "https://api.spellit.ai/api/client/item-set/123/crm-data"

# Ответ:
# HTTP/1.1 401 Unauthorized
{
  "detail": "Not authenticated"
}

Authorizations

API-Access-Key
string
header
required

API-ключ для доступа к эндпоинтам

Path Parameters

item_set_id
integer
required

ID item_set

Response

Успешный ответ

id_item_set
integer

ID item_set, для которого запрашивались CRM данные

crm_data
object

Объект с CRM данными или null, если данные отсутствуют

created_at
string<date-time> | null

Дата и время создания метаданных с CRM данными или null