Чат связи Azure
Соединитель для использования функций чата Служб коммуникации Azure.
Этот соединитель доступен в следующих продуктах и регионах:
| Услуга | Class | Регионы |
|---|---|---|
| Copilot Studio | Премия | Все регионы Power Automate , кроме следующих: - Правительство США (GCC) - Правительство США (GCC High) — Облако Китая, управляемое 21Vianet - Министерство обороны США (DoD) |
| Логические приложения | Стандарт | Все регионы Logic Apps , кроме следующих: — Регионы Azure для государственных организаций — Регионы Azure Для Китая - Министерство обороны США (DoD) |
| Power Apps | Премия | Все регионы Power Apps , кроме следующих: - Правительство США (GCC) - Правительство США (GCC High) — Облако Китая, управляемое 21Vianet - Министерство обороны США (DoD) |
| Power Automate | Премия | Все регионы Power Automate , кроме следующих: - Правительство США (GCC) - Правительство США (GCC High) — Облако Китая, управляемое 21Vianet - Министерство обороны США (DoD) |
| Контакт | |
|---|---|
| Имя | Microsoft |
| URL | https://azure.microsoft.com/services/communication-services |
| Адрес электронной почты | acssolutions@microsoft.com |
| Метаданные соединителя | |
|---|---|
| Publisher | Microsoft |
| Веб-сайт | https://azure.microsoft.com/services/communication-services |
| Политика конфиденциальности | https://privacy.microsoft.com |
| Категории | Communication |
Чат служб коммуникации Azure помогает добавить текстовое взаимодействие в режиме реального времени в кроссплатформенные приложения.
Предпосылки
Для продолжения вам потребуется следующее:
- План Microsoft Power Apps или Power Automate с пользовательским компонентом соединителя
- подписка Azure
- Ресурс Служб коммуникации Azure
Получение учетных данных
1 Настройка ресурса Служб коммуникации Azure
Проверка подлинности строки подключения 2
- Вы можете создать новое подключение с помощью URL-адреса конечной точки ресурса Служб коммуникации Azure.
Начало работы с соединителем
После настройки ресурса Служб коммуникации Azure создайте маркер доступа пользователя. Используйте этот маркер для действий соединителя.
Известные проблемы и ограничения
На данный момент известных проблем или ограничений нет.
Часто задаваемые вопросы
- Как создать маркер доступа?
- Соединитель удостоверений Служб коммуникации Azure можно использовать для создания нового удостоверения пользователя, а также обновления маркеров доступа для пользователя. Это также можно сделать вручную с помощью портала для тестирования.
Создание подключения
Соединитель поддерживает следующие типы проверки подлинности:
| По умолчанию | Параметры для создания подключения. | Все регионы | Недоступен для совместного использования |
По умолчанию
Применимо: все регионы
Параметры для создания подключения.
Это недоступно для общего доступа. Если приложение power предоставляется другому пользователю, пользователю будет предложено явно создать новое подключение.
| Имя | Тип | Description | Обязательно |
|---|---|---|---|
| URL-адрес конечной точки | securestring | URL-адрес конечной точки Служб коммуникации Azure. | True |
Ограничения регулирования
| Имя | Вызовы | Период обновления |
|---|---|---|
| Вызовы API для каждого подключения | 100 | 60 секунд |
Действия
| Вывод списка потоков чата |
Вывод списка потоков чата. |
| Вывод списка сообщений в потоке чата |
Вывод списка сообщений из потока чата. |
| Добавление участников потока чата |
Добавление участников в поток чата. |
| Обновление свойств потока чата |
Обновите свойства потока чата. |
| Отправка сообщения в поток чата |
Отправка сообщения в поток чата. |
| Получение свойств потока чата |
Получение свойств потока чата. |
| Создание потока чата |
Создайте поток чата. |
| Список участников темы чата |
Вывод списка участников в потоке чата. |
| Удаление участника потока чата |
Удаление участника из потока чата. |
| Удалить тему чата |
Удаление потока чата. |
Вывод списка потоков чата
Вывод списка потоков чата.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Маркер доступа
|
Access-Token | True | string |
Маркер доступа пользователя. |
|
Время начала
|
startTime | string |
Время начала работы в формате RFC3339 (гггг-ММ-ддTHH:mm:ssZ) для получения потоков чата. |
|
|
Максимальный размер страницы
|
maxPageSize | integer |
Максимальное количество потоков чата, возвращаемых на страницу. |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Потоки чата
|
value | array of object |
Коллекция потоков чата. |
|
Идентификатор
|
value.id | string |
Идентификатор потока чата. |
|
Тема
|
value.topic | string |
Раздел потока чата. |
|
последнее полученное сообщение
|
value.lastMessageReceivedOn | string |
Метка времени в формате RFC3339 (гггг-ММ-ддTHH:мм:ssZ), когда последнее сообщение прибыло на сервер. |
|
Удалено
|
value.deletedOn | string |
Метка времени в формате RFC3339 (гггг-ММ-ддTHH:mm:ssZ) при удалении потока чата. |
|
Следующая ссылка
|
nextLink | string |
Если есть больше потоков чата, которые можно извлечь, будет заполнена следующая ссылка. |
Вывод списка сообщений в потоке чата
Вывод списка сообщений из потока чата.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Маркер доступа
|
Access-Token | True | string |
Маркер доступа пользователя. |
|
Идентификатор потока
|
chatThreadId | True | string |
Идентификатор потока чата. |
|
Время начала
|
startTime | string |
Время начала в формате RFC3339 (гггг-ММ-ддTHH:mm:ssZ) для получения сообщений. |
|
|
Максимальный размер страницы
|
maxPageSize | string |
Максимальное количество возвращаемых сообщений на страницу. |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Список сообщений
|
value | array of object |
Коллекция сообщений чата. |
|
Идентификатор
|
value.id | string |
Идентификатор сообщения чата. Этот идентификатор создается на сервере. |
|
Тип
|
value.type | string |
Тип сообщения чата. |
|
Версия
|
value.version | string |
Версия сообщения чата. |
|
Идентификатор последовательности
|
value.sequenceId | string |
Последовательность сообщения чата в беседе. |
|
сообщение
|
value.content.message | string |
Содержимое сообщения чата. |
|
initiatorCommunicationIdentifier
|
value.content.initiatorCommunicationIdentifier | CommunicationIdentifier |
Идентификатор связи. |
|
Тема
|
value.content.topic | string |
Содержимое сообщения чата для сообщений типа topicUpdated. |
|
Участники
|
value.content.participants | array of object |
Содержимое сообщения чата для сообщений типа участникаAdded или участника Удалено. |
|
communicationIdentifier
|
value.content.participants.communicationIdentifier | CommunicationIdentifier |
Идентификатор связи. |
|
Отображаемое имя отправителя
|
value.senderDisplayName | string |
Отображаемое имя отправителя сообщения чата. Это свойство используется для заполнения имени отправителя для push-уведомлений. |
|
Создано
|
value.createdOn | string |
Метка времени в формате RFC3339 (гггг-ММ-ддTHH:mm:ssZ) при поступлении сообщения чата на сервер. |
|
senderCommunicationIdentifier
|
value.senderCommunicationIdentifier | CommunicationIdentifier |
Идентификатор связи. |
|
Следующая ссылка
|
nextLink | string |
Если есть больше сообщений чата, которые можно получить, будет заполнена следующая ссылка. |
Добавление участников потока чата
Добавление участников в поток чата.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Маркер доступа
|
Access-Token | True | string |
Маркер доступа пользователя. |
|
Идентификатор потока
|
chatThreadId | True | string |
Идентификатор потока чата. |
|
Идентификатор пользователя
|
id | string | ||
|
Отображаемое имя
|
displayName | string |
Отображаемое имя участника чата. |
|
|
Time
|
shareHistoryTime | string |
Время в формате RFC3339 (гггг-ММ-ддTHH:mm:ssZ), из которого предоставляется общий доступ к журналу чата. |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
InvalidParticipants
|
invalidParticipants | array of object |
Недопустимый список участников. |
|
Цель
|
invalidParticipants.target | string |
Идентификатор целевого объекта. |
|
Code
|
invalidParticipants.code | string |
Код ошибки. |
|
Message
|
invalidParticipants.message | string |
Сообщение об ошибке. |
Обновление свойств потока чата
Обновите свойства потока чата.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Маркер доступа
|
Access-Token | True | string |
Маркер доступа пользователя. |
|
Идентификатор потока
|
chatThreadId | True | string |
Идентификатор потока чата. |
|
Раздел потока чата
|
topic | string |
Раздел потока чата. |
Отправка сообщения в поток чата
Отправка сообщения в поток чата.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Маркер доступа
|
Access-Token | True | string |
Маркер доступа пользователя. |
|
Идентификатор потока
|
chatThreadId | True | string |
Идентификатор потока чата. |
|
Content
|
content | True | string |
Содержимое сообщения. |
|
Имя
|
senderDisplayName | True | string |
Отображаемое имя отправителя сообщения. |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
id
|
id | string |
id |
Получение свойств потока чата
Получение свойств потока чата.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Маркер доступа
|
Access-Token | True | string |
Маркер доступа пользователя. |
|
Идентификатор потока
|
chatThreadId | True | string |
Идентификатор потока чата. |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Идентификатор
|
id | string |
Идентификатор потока чата. |
|
Тема
|
topic | string |
Раздел потока чата. |
|
Создано
|
createdOn | string |
Время создания потока. |
|
Удалено
|
deletedOn | string |
Время удаления потока. |
|
Необработанный идентификатор
|
createdByCommunicationIdentifier.rawId | string |
Необработанный идентификатор идентификатора. |
|
Идентификатор
|
createdByCommunicationIdentifier.communicationUser.id | string |
Идентификатор пользователя связи. |
Создание потока чата
Создайте поток чата.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Маркер доступа
|
Access-Token | True | string |
Маркер доступа пользователя. |
|
Раздел потока чата
|
topic | True | string |
Раздел потока чата. |
|
Идентификатор пользователя
|
id | string | ||
|
Имя
|
displayName | string |
Отображаемое имя участника чата. |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Идентификатор
|
chatThread.id | string |
Идентификатор потока чата |
|
Тема
|
chatThread.topic | string |
Раздел потока чата |
|
Создано
|
chatThread.createdOn | date-time |
Время создания чата |
|
createdByCommunicationIdentifier
|
chatThread.createdByCommunicationIdentifier | CommunicationIdentifier |
Идентификатор связи. |
Список участников темы чата
Вывод списка участников в потоке чата.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Маркер доступа
|
Access-Token | True | string |
Маркер доступа пользователя. |
|
Идентификатор потока
|
chatThreadId | True | string |
Идентификатор потока чата. |
|
Количество участников, которые нужно пропустить
|
skip | string |
Пропускает участников до указанной позиции в ответе. |
|
|
Максимальное количество участников на страницу
|
maxPageSize | string |
Максимальное количество участников, возвращаемых на страницу. |
Возвращаемое значение
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
value
|
value | array of object |
Участники чата. |
|
communicationIdentifier
|
value.communicationIdentifier | CommunicationIdentifier |
Идентификатор связи. |
|
Имя
|
value.displayName | string |
Отображаемое имя участника чата. |
|
Time
|
value.shareHistoryTime | string |
Время в формате RFC3339 (гггг-ММ-ддTHH:mm:ssZ), из которого предоставляется общий доступ к журналу чата. |
|
Следующая ссылка
|
nextLink | string |
Если вы можете получить больше участников чата, будет заполнена следующая ссылка. |
Удаление участника потока чата
Удаление участника из потока чата.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Маркер доступа
|
Access-Token | True | string |
Маркер доступа пользователя. |
|
Идентификатор потока
|
chatThreadId | True | string |
Идентификатор потока чата. |
|
Идентификатор пользователя
|
id | string |
Удалить тему чата
Удаление потока чата.
Параметры
| Имя | Ключ | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
Маркер доступа
|
Access-Token | True | string |
Маркер доступа пользователя. |
|
Идентификатор потока
|
chatThreadId | True | string |
Идентификатор потока чата. |
Определения
CommunicationIdentifier
Идентификатор связи.
| Имя | Путь | Тип | Описание |
|---|---|---|---|
|
Идентификатор пользователя
|
communicationUser.id | string |