Центр поддержкиИнтеграции

Для: Администраторы

Добавляйте публикации и комментарии с помощью ключа хаба.

Добавляйте сообщения в ленту обращения, отвечайте комментариями, читайте, редактируйте или удаляйте их с помощью собственного программного обеспечения, выступая в роли виртуального помощника.

В этой статье11 разделов

Прежде чем начать

На этой странице рассказывается о добавлении и прочтении сообщений и комментариев в данном случае, используя ключ hub. Пути для доступа к этим данным указаны под https://prd-api-app.caseactive.com/v1/<hub id>/<case id>.

Звонки

ВызовЧто это делает
GET /postsПеречислены сообщения по данному делу; самые последние сообщения расположены в начале списка.
POST /postsДобавляет пост.
GET /posts/<post_id>Читает один пост.
PUT /posts/<post_id>Изменяется пост; ключ добавляется.
DELETE /posts/<post_id>Удаляет любой пост, включая соответствующие комментарии к нему.
GET /posts/templatesПеречислены шаблоны вашего обзора; они уже заполнены для данного случая.
GET /posts/<post_id>/commentsПредставляет список комментариев к сообщению; самые последние комментарии выводятся первыми.
POST /posts/<post_id>/commentsКомментарии к посту
GET /posts/<post_id>/comments/<comment_id>Читает один из комментариев.
PUT /posts/<post_id>/comments/<comment_id>Изменяется комментарий, который написал этот человек.
DELETE /posts/<post_id>/comments/<comment_id>Удаляет любые комментарии.

Все ключевые посты отображаются в разделе FeedКорм Хронология публикаций по делу, где фирма делится новостями, и все участники дела могут оставлять комментарии. вашего хаба, под названием Виртуальный помощникВиртуальный помощник Автоматизированный член команды, который публикует приветственные сообщения, проводит проверки и организует публикации для компании; его публикации отмечены значком виртуального помощника.. Эти посты выглядят как часть вашего бизнеса, с эмблемой виртуального помощника. Чтобы прикрепить файлы, смотрите инструкцию Загрузка и прикрепление файлов с помощью ключа хаба. Просьбы о помощи по техническим вопросам предназначены для людей, находящихся в портале. При использовании ключа возникает ошибка 403 BotNotAllowedException.

Добавление поста

ПолеЧто это делаетНеобходимыйПо умолчанию
messageТекст сообщения может достигать 20 000 символов. Пробелы между строк сохраняются.Да.—
permissionsЭто… РолиРоль Набор разрешений, определяющий, что может видеть и делать тот или иной пользователь в рамках дела, например, сотрудники или клиенты. Те, кто может это увидеть… ["role::staff"]. Не указывайте его имени для всех, кто занимается этим делом.Нет.Все
templateШаблон для загрузки файлов из: {"owner": "host", "template_id": "<asset_id>"}Нет.Ничего.
curl -X POST https://prd-api-app.caseactive.com/v1/ca-7e6d5c4b3a2f10/cc-1a2b3c4d5e6f70/posts \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"message": "Hi <@cu-4f1c2a9e8b7d60>, the insurer has acknowledged your claim. We expect their estimate within two weeks."}'

Это ответ на вопрос 201 с использованием ID сообщения.

{"data": {"case_id": "cc-1a2b3c4d5e6f70", "post_id": "post::20261002154134_b0accfaac139a9", "selfLink": "https://prd-api-app.caseactive.com/v1/ca-7e6d5c4b3a2f10/cc-1a2b3c4d5e6f70/posts"}}
  • Текст. Отправьте простой текст. На портале отображаются символы **bold**, [a link](https://example.com), а также простые веб-адреса в правильном формате. В электронных письмах текст отображается таким же образом, как и в реальности.
  • Упоминания/Замечания. Напишите <@user_id> Необходимо упомянуть кого-то в связи с данным делом, используя соответствующие идентификационные номера. GET /team, Или код обозначения, например: <@clients.primary>, Это место заполняется соответствующей личностью. Портал отображает каждую из них. @ И их имя. Упоминание о человеке, который не участвует в расследовании, или о коде, который не соответствует никакому из имеющихся кодов, также игнорируется. Сообщения, содержащие только одно слово после того, как человек отказывается от участия в расследовании, также отклоняются. 400 сообщений… FieldRequiredException на месте message, И ничего не сохраняется.
  • Кто может это увидеть? С помощью permissions, Это видят только люди, занимающие такие должности, а также все те, чья роль заключается в модерировании постов. Это, по сути, то же самое, что и обязанности сотрудников по умолчанию.

Кому сообщают

Как только сообщение будет добавлено:

  • Без упоминаний – все, кто может увидеть этот текст, получают информацию. С упоминаниями – только те люди, которые действительно упомянуты в тексте.
  • Каждый из участников получает сообщение по электронной почте, или текстовое сообщение, если у него нет подтвержденной электронной почты. Также участники получают уведомления через портал. Участники, чьи функции отслеживания новостей отключены, не получают таких уведомлений.
  • В ответе на электронное письмо отправляется комментарий от того человека, который ответил на сообщение.
  • Ваши вебхокы получают значение add_post.

Приложенные файлы учитываются в количестве полученных электронных писем.

Публикация из шаблона

GET /posts/templates Перечисляет вашу опубликованную информацию/данные. ШаблоныШаблон Многоразовая запись в ленте новостей, форма, электронная подпись, заметка или задание, хранящиеся в библиотеке и копируемые на витрины., Старшие по возрасту первыми, каждый из них… asset_id, title и message. Коды обозначений message Все поля уже заполнены именами людей, связанных с этим делом.

Чтобы опубликовать один из шаблонов, необходимо отправить его в формате message – в том виде, в котором он находится, или после соответствующих изменений. Также необходимо отправить template вместе с asset_id, чтобы привести файлы шаблона в соответствие с требованиями. Шаблон не имеет своих собственных ролей; для указания этих ролей необходимо отправить permissions самостоятельно.

Чтение постов

GET /posts принимает значения limit (по умолчанию 20, но может достигать 1000), а также start_key. Страницы содержат значения nextLink и startKey, как и в любом списке. Каждый пост содержит:

ПолеЧто в нём содержится
post_id, case_idЕго идентификационные номера
user_idКто это сделал? Идентификационный номер виртуального помощника – cu-. А 14 символов, которые составляют идентификационный номер вашего хаба…
messageЕго текст с упоминаниями в формате <@user_id>
permissionsРоли, которые могут возникнуть в такой ситуации, когда ограничения имеются.
media, media_ctЕго файлы, сколько их там?
comments_ct, commenters, last_replyЕго комментарии: сколько их было, кто их написал, и когда последний из них был опубликован.
systemtrue Для поста используется автоматизация или процесс импорта.
languageЯзык, на котором был написан текст, когда он фиксировался в письменной форме…
created_on, updated_onКогда этот текст был опубликован и последний раз изменен – в UTC.

Ключник прочитывает все сообщения по этой теме, включая те, которые имеют ограниченное значение.

Редактирование и удаление

  • Функция PUT /posts/<post_id> принимает значения message и permissions, и изменяет только те посты, которые вы отправляете. Ключевые слова могут изменяться только в тех постах, которые создает сам Виртуальный помощник; а также в постах с приветствиями, информацией о прогрессе и другими сообщениями, создаваемыми вашей автоматикой. Никому не сообщается об этом; вашим вебхоукам приходит значение modify_post, когда происходят изменения в тексте постов.
  • Чтобы изменить того, кто может видеть сообщение, отправьте полный список ролей. Пустой список будет отклонен. Чтобы сообщение снова показалось всем, отправьте список ролей, которые будут добавлены позже. "permissions": null; Список всех ролей не включает те роли, которые были добавлены позже.
  • DELETE /posts/<post_id> удаляет все сообщения по данному случаю, включая комментарии и файлы. Никому не сообщается об этом; вашим вебхокнам приходит сообщение с ID delete_post.

Комментарии

POST /posts/<post_id>/comments брать message, При этом действуют те же правила, что и при опубликовании сообщений, а также при ответах на них. 201 С теми, кто… comment_id. Всем, кто может увидеть этот пост, сообщается о нем, а также о тех людях, которые упоминаются в этом посте. GET Список представлен в порядке убывания возраста. comment_id, user_id, message, media И их времена.

Ключ может изменить только свои собственные комментарии, используя символы PUT и новый символ message. Также ключ может удалять любые комментарии.

Вебхуки

Ваши вебхокены получают информацию о любых изменениях в постах и комментариях. Ключевые слова, используемые для обозначения этих изменений, — это add_post, modify_post, delete_post, add_post_media и delete_post_media. Для комментариев также используются те же ключевые слова. who.user_id в каждом событии обозначает автора поста или комментария. Следовательно, в этих ключевых словах содержится ID виртуального помощника. Если вы не проверите это значение, ваша система будет считать все посты новыми. См. раздел События и данные, передаваемые через вебхокены.

Язык

В постах и комментариях не указывается язык, поэтому они отображаются в написанном виде, без перевода. Исключение составляют посты, созданные с использованием шаблонов, имеющих определенный язык. Такие посты отмечены языком шаблона, и они переводятся для читателей, использующих другой язык. См. раздел Как происходит перевод постов и комментариев.

Если звонок отклонен

СтатусmessageПочему
400SchemaFieldsExceptionПропущен или некорректный поле; например, пустое поле. message, Пусто. permissions Список или роль, которой ваше хаб не имеет. errors Его можно назвать иначе. Изменение, связанное с изменением имени поля, также будет отклонено.
400SchemaFieldsException, при условии, что ItemCopyNotAllowedException находится в пределах templateШаблон еще не опубликован, он не доступен для использования роботами, или его файлы все еще обрабатываются.
403ItemAuthorOnlyExceptionКлючевая фраза пытается изменить пост или комментарий, написанный кем-то другим.
403CaseClosedExceptionДело закрыто.
403BotNotAllowedExceptionКлюч соответствует одному из алгоритмов автоматического проектирования.
404ItemNotFoundExceptionЭтот пост или комментарий не существует, или он принадлежит к другому случаю.

Что касается текста ошибок и остальных кодов, см. раздел Управление ошибками API и статусными кодами.

Статьи по теме

Разберитесь, что может делать API.Узнайте, к чему могут иметь доступ ключ управления и ключ концентратора, почему каждый ключ действует как виртуальный помощник и где находится полный технический паспорт.ИнтеграцииЗагружайте и прикрепляйте файлы с помощью ключа хаба.Получите адрес для загрузки, загрузите файл, прикрепите его к сообщению, заметке, заданию, форме или электронной подписи, а также скачайте файлы дела.ИнтеграцииНайдите информацию о событиях и полезных нагрузках веб-хуков.Что отправляет каждое из десяти событий ленты, как шифруется сообщение и как его расшифровать с помощью вашего секретного ключа.ИнтеграцииОбработка ошибок и кодов состояния API.Прочитайте текст ошибки, что означают коды 400, 401, 403, 404, 500 и 503, и почему элемент, который ваш ключ не видит, выдает ошибку 404.Интеграции