Поделиться через

REST API плоскости данных Служба Azure SignalR — предварительная версия версии 1

  • Статья

В этой статье содержатся устаревшие интерфейсы REST API версии 1 предварительной версии для плоскости данных Служба Azure SignalR. Вместо этого используйте последнюю версию .

Доступные интерфейсы API

API Путь
post /api/v1-preview/hub/{hub}/user/{id} POST /api/v1-preview/hub/{hub}/user/{id}
post /api/v1-preview/hub/{hub}/users/{userList} POST /api/v1-preview/hub/{hub}/users/{userList}
post /api/v1-preview/hub/{hub} POST /api/v1-preview/hub/{hub}
post /api/v1-preview/hub/{hub}/group/{group} POST /api/v1-preview/hub/{hub}/group/{group}
post /api/v1-preview/hub/{hub}/groups/{groupList} POST /api/v1-preview/hub/{hub}/groups/{groupList}

post /api/v1-preview/hub/{hub}/user/{id}

POST /api/v1-preview/hub/{hub}/user/{id}

Описание.

Отправьте сообщение одному пользователю.

Параметры
Имя Расположение Description Обязательное поле Схема
hub path Имя целевого концентратора, которое должно начинаться с алфавитных символов и содержать только буквы-числовые символы или символы подчеркивания. Да строка
id path Идентификатор целевого пользователя. Да строка
message текст Да Сообщение
Отклики
Код Описание
202 Accepted

post /api/v1-preview/hub/{hub}/users/{userList}

POST /api/v1-preview/hub/{hub}/users/{userList}

Описание.

Отправьте сообщение нескольким пользователям.

Параметры
Имя Расположение Description Обязательное поле Схема
hub path Имя целевого концентратора, которое должно начинаться с алфавитных символов и содержать только буквы-числовые символы или символы подчеркивания. Да строка
userList path Разделенный запятыми список идентификаторов пользователей. Да строка
message текст Да Сообщение
Отклики
Код Описание
202 Accepted

post /api/v1-preview/hub/{hub}

POST /api/v1-preview/hub/{hub}

Описание.

Трансляция сообщения всем клиентам, подключенным к целевому концентратору.

Параметры
Имя Расположение Description Обязательное поле Схема
hub path Имя целевого концентратора, которое должно начинаться с алфавитных символов и содержать только буквы-числовые символы или символы подчеркивания. Да строка
message текст Да Сообщение
Отклики
Код Описание
202 Accepted

post /api/v1-preview/hub/{hub}/group/{group}

POST /api/v1-preview/hub/{hub}/group/{group}

Описание.

Трансляция сообщения всем клиентам в целевой группе.

Параметры
Имя Расположение Description Обязательное поле Схема
hub path Имя целевого концентратора, которое должно начинаться с алфавитных символов и содержать только буквы-числовые символы или символы подчеркивания. Да строка
group path Имя целевой группы, которое должно начинаться с алфавитных символов и содержать только буквенно-числовые символы или символы подчеркивания. Да строка
message текст Да Сообщение
Отклики
Код Описание
202 Accepted

post /api/v1-preview/hub/{hub}/groups/{groupList}

POST /api/v1-preview/hub/{hub}/groups/{groupList}

Описание.

Трансляция сообщения всем клиентам в целевых группах.

Параметры
Имя Расположение Description Обязательное поле Схема
hub path Имя целевого концентратора, которое должно начинаться с алфавитных символов и содержать только буквы-числовые символы или символы подчеркивания. Да строка
groupList path Разделенный запятыми список имен групп. Каждое имя группы должно начинаться с алфавитных символов и содержать только буквенно-числовые символы или символы подчеркивания. Да строка
message текст Да Сообщение
Отклики
Код Описание
202 Accepted

Модели

Message

Сообщение вызова метода.

Имя. Тип Описание Обязательное поле
целевой объект строка Имя целевого метода. Нет
аргументы [ объект ] Аргументы целевого метода. Нет