Создание сообщений с помощью API Соединителя Бота

  • Статья

Бот будет отправлять объекты Действие типа message для передачи информации пользователям, а также будет получать действия message от пользователей. Некоторые сообщения могут состоять из простого текста, в то время как другие могут содержать более богатое содержимое, такое как произносимый текст, предлагаемые действия, мультимедийные вложения, форматированные карточки и данные по каналу. В этой статье описаны некоторые из наиболее часто используемых свойств сообщений.

Текст сообщения и форматирование

Текст сообщения можно форматировать с помощью plain, markdown или xml. Формат по умолчанию для свойства textFormat — markdown, который интерпретирует текст с использованием стандартов форматирования Markdown. Уровень поддержки формата текста меняется в зависимости от каналов.

Совет

Сведения о том, какие функции поддерживаются в каждом канале, см. в справочной статье о каналах .

Свойство textFormat объекта Действие может использоваться для указания формата текста. Например, чтобы создать простое сообщение, которое содержит только обычный текст, задайте для свойства textFormat объекта Activity значение plain, для свойства text — значение содержимого сообщения, а для свойства locale — языковой стандарт отправителя.

Вложения

Свойство attachments объекта Действие может использоваться для отправки простых мультимедийных вложений (изображений, аудио, видео, файлов) и форматированных карточек. Дополнительные сведения см. в разделах Добавление мультимедийных вложений в сообщения и Добавление вложений в виде форматированных карточек в сообщения.

Сущности

Свойство entities объекта Действие представляет собой массив открытых объектов schema.org, который позволяет осуществлять обмен контекстно-зависимыми метаданными между каналом и ботом.

Сущности Mention

Многие каналы поддерживают способность бота или пользователя "упоминать" кого-то в контексте общения. Чтобы упомянуть пользователя в сообщении, заполните свойство entities сообщения объектом Mention.

Сущность Place

Чтобы передать сведения о расположении в сообщении, заполните свойство сообщения объектамиentities Place.

Данные канала

Свойство channelData объекта Действие может использоваться для реализации функциональных возможностей канала. Дополнительные сведения см. в разделе Реализация функциональных возможностей канала.

Преобразование текста в речь

Свойство speak объекта Действие может использоваться для указания текста, который будет произноситься ботом по каналу с поддержкой речевых функций, а свойство inputHint объекта Activity может использоваться для воздействия на состояние микрофона клиента. Дополнительные сведения см. в разделах Добавление речи в сообщения и Добавление подсказок ввода к сообщениям.

Предлагаемые действия

Свойство suggestedActions объекта Действие может использоваться для представления кнопок, которых пользователь может коснуться для ввода данных. В отличие от кнопок, которые появляются в функциональных карточках (и которые остаются видимыми и доступными для пользователя даже после касания), кнопки, отображаемые в области предлагаемых действий, исчезнут, как только будет сделан выбор. Дополнительные сведения см. в разделе Добавление предлагаемых действий к сообщениям.

Дополнительные ресурсы