Для: Администраторы
Найдите дела с ключом от центрального узла.
Составьте список дел в вашем центре, открытых или закрытых, выполните поиск по идентификатору тега или названию, а также найдите идентификатор дела в своем собственном программном обеспечении.
В этой статье7 разделов
Прежде чем начать
На этой странице описывается, как ключи хаба используются для поиска соответствующих случаев. Пути обхода указаны под https://prd-api-app.caseactive.com/v1/<hub id>.
Звонки
| Вызов | Что это делает |
|---|---|
GET /cases | Список открытых или закрытых дел вашего центра обработки заказов. |
GET /cases/search | Поиск случаев с использованием идентификатора тегов или названий. |
GET /whoami | Читает настройки вашего хаба, такие как типы коробок и страницы с данными о полях. |
GET /roles | Список ролей вашего хаба |
GET /stages | Список этапов работы вашего хаба. |
GET /schemas | Прочитает информацию о случаях, связанных с вашим хабом, а также персональные данные пользователей. |
Ключ “hub” выполняет функцию центра управления вашего устройства. Виртуальный помощникВиртуальный помощник Автоматизированный член команды, который публикует приветственные сообщения, проводит проверки и организует публикации для компании; его публикации отмечены значком виртуального помощника., Это происходит в любом случае. Следовательно, все эти вызовы достигают всех пунктов обслуживания в вашем центре. Включены два примера таких случаев.
Ключ hub не может создавать случаи обработки данных: ответ от системы POST /cases имеет номер 403 HostCreateCaseNotEnabledException. Чтобы создавать случаи обработки данных с помощью вашего программного обеспечения, используйте ключ для управления случаями; см. раздел Создание и обновление случаев обработки данных с помощью ключа для управления.
Список дел
| Параметр | Что это делает | Необходимый | По умолчанию |
|---|---|---|---|
status | 1 – для открытых случаев; 0 – для закрытых случаев. | Нет. | 1 |
limit | Сколько случаев может содержать одна страница – до 1000. | Нет. | 20 |
start_key | startKey из предыдущей страницы | Нет. | Первая страница |
curl "https://prd-api-app.caseactive.com/v1/ca-7e6d5c4b3a2f10/cases?status=1" \
-H "Authorization: Bearer YOUR_API_KEY"
{
"data": {
"items": [
{
"case_id": "cc-1a2b3c4d5e6f70",
"case_ref_id": "ca-7e6d5c4b3a2f10::rear-end-2026",
"title": "Jane Sample auto accident",
"team": {
"cu-7e6d5c4b3a2f10": "role::bots",
"cu-4f1c2a9e8b7d60": "role::clients",
"cu-9d8c7b6a5f4e30": "role::staff"
}
}
],
"currentItemCount": 1,
"selfLink": "https://prd-api-app.caseactive.com/v1/ca-7e6d5c4b3a2f10/cases?status=1"
}
}
- Данные располагаются в порядке ID теговИдентификатор метки Постоянная метка, которую вы присваиваете делу, например, rear-end-2026, также отображается в качестве идентификатора ссылки и используется при импорте., от Z до A, а не по дате.
case_ref_id– это идентификатор вашего хаба; две точки с запятой – это идентификатор тегов изделия.teamКаждому человеку в данном случае присваивается соответствующая рольРоль Набор разрешений, определяющий, что может видеть и делать тот или иной пользователь в рамках дела, например, сотрудники или клиенты.. Имена людей не указаны. Чтобы узнать имена участников команды, ознакомьтесь с информацией о данном случае в разделе Чтение и обновление деталей случая с использованием хабового ключа.- Хотя количество таких случаев ещё не превышает определенного предела, на этой странице также имеется значение
nextLink– полная адресация следующей страницы. Также имеется значениеstartKey. Нужно вызвать значениеnextLinkили отправить значениеstartKeyвместе с значениемstart_key, пока не появится страница, на которой эти значения отсутствуют. - Удаляемые случаи не учитываются, поэтому страница может содержать менее
limitслучаев, при этом все еще остается достаточно случаев для отображения. Следует руководствоваться значениемnextLink, а не количеством случаев. - Название и статус дела могут изменяться на несколько секунд.
Поиск дел
GET /cases/search может совпадать с какими-либо словами в любом месте ID тегов данного случая. Также он может совпадать со началом слова в заголовке. Это позволяет выявлять небольшие ошибки при написании текста. Однако он не обрабатывает описания объектов.
| Параметр | Что это делает | Необходимый | По умолчанию |
|---|---|---|---|
query | Слова, которые необходимо обратить внимание на. Отправьте * для каждого случая. | Да. | — |
status | 1 – для открытых случаев; 0 – для закрытых случаев. | Нет. | 1 |
limit | Сколько результатов может содержать страница – до 250. | Нет. | 20 |
page | К какой странице результатов относится число 1? | Нет. | 1 |
sort_by | Числовое поле и направление, например created_on:desc. Необходимо указать значения для created_on, date_opened, last_activity, updated_on, users_ct и case_status. | Нет. | Поэксплицитно первый вариант. |
curl "https://prd-api-app.caseactive.com/v1/ca-7e6d5c4b3a2f10/cases/search?query=rear-end-2026" \
-H "Authorization: Bearer YOUR_API_KEY"
{
"data": {
"found": 1,
"page": 1,
"hits": [
{
"document": {
"case_id": "cc-1a2b3c4d5e6f70",
"ref_id": "rear-end-2026",
"title": "Jane Sample auto accident",
"case_status": 1,
"case_type": "general",
"case_stage": "stage::20260927120000_8c1f0e2d3b4a59",
"date_opened": 1772668800,
"created_on": 1791043509,
"last_activity": 1791050112,
"users_ct": 3
}
}
],
"selfLink": "https://prd-api-app.caseactive.com/v1/ca-7e6d5c4b3a2f10/cases/search?query=rear-end-2026"
}
}
- Каждый элемент массива
documentсодержит идентификатор дела, простое имя делу, название дела, статус дела, тип дела (case typeТип дела Категория для конкретных случаев, например, «общие», используется для того, чтобы автоматизация выполнялась в нужных случаях.), стадия дела (stageЭтап Этап, через который проходит дело, например, прием заявки или отправка запроса, который фирма обозначает и описывает и который отображается на странице дела.), количество участников дела, а также даты дела в единицах времени Unix в UTC. foundпоказывает количество случаев, когда данные соответствуют друг другу. Просматривайте их с помощьюpage. Не используйтеnextLink.- Данный случай можно проверить в течение нескольких секунд после произошедших изменений.
Поиск дела по его идентификатору тега.
Не существует точного способа поиска по идентификатору тегов. Необходимо провести поиск самостоятельно. Затем сохраните результаты поиска, в которых значение document.ref_id совпадает с идентификатором тегов. Ведь при поиске также могут быть найдены схожие значения, такие как rear-end-2025. Для учета всех возможных случаев можно использовать значения status=1 и status=0.
Как только у вас есть идентификационный номер дела, любые звонки, связанные с этим делом, будут использовать этот номер. См. раздел Чтение и обновление информации о деле с помощью ключа хаба.
Настройки вашего хаба
| Вызов | На какие вопросы это отвечает |
|---|---|
GET /whoami | Идентификационный номер пользователя, название вашего хаба, типы его функций, а также те разделы, которые он может обслуживать. host_default_schemas, Страницы случаев использования и полей для указания пользователей |
GET /roles | Каждая роль, включая роль Виртуального помощника, имеет соответствующие параметры: role::bots, role_id, name, description, color и reads_notes. Не имеет значения, может ли эта роль читать записи. |
GET /stages | Каждый этап, от начала до конца, с использованием значений stage_id, name, description и order. |
GET /schemas | default_schemas. Страницы, связанные с случаем вашего хаба, а также страницы с пользовательскими полями. На каждой из этих страниц указаны ключи полей, их названия и типы. |
Ни одна из этих страниц не отвечает на все вопросы сразу.
Если звонок отклонен
| Статус | message | Почему |
|---|---|---|
| 400 | SchemaFieldsException | Параметр отсутствует или является некорректным. Например, может быть пустой значение для параметра query, или значение для параметра status не будет равно 0 или 1. Значение для параметра errors также может быть некорректным. |
| 400 | InvalidStartKeyException | Элемент start_key происходит из другого списка. |
| 400 | SearchParameterException | Поиск отказался использовать такие параметры, как sort_by для текстовых полей, или параметр limit для значений, превышающих 250. Параметр reason указывает на то, какой именно значение необходимо использовать. |
| 403 | HostCreateCaseNotEnabledException | Хаб-ключ пытался создать определенный случай. |
Что касается текста ошибок и остальных кодов, см. раздел Управление ошибками API и статусными кодами.